org.eclipse.jpt.core.context
Interface SingleRelationshipMapping

All Superinterfaces:
AttributeMapping, Fetchable, org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model, Nullable, RelationshipMapping
All Known Subinterfaces:
JavaManyToOneMapping, JavaOneToOneMapping, JavaSingleRelationshipMapping, ManyToOneMapping, OneToOneMapping, OrmManyToOneMapping, OrmOneToOneMapping, OrmSingleRelationshipMapping

public interface SingleRelationshipMapping
extends RelationshipMapping, Nullable

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static FetchType DEFAULT_FETCH_TYPE
           
static java.lang.String DEFAULT_JOIN_COLUMN
           
static java.lang.String SPECIFIED_JOIN_COLUMNS_LIST
           
 
Fields inherited from interface org.eclipse.jpt.core.context.RelationshipMapping
DEFAULT_TARGET_ENTITY_PROPERTY, RESOLVED_TARGET_ENTITY_PROPERTY, SPECIFIED_TARGET_ENTITY_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.Fetchable
DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.Nullable
DEFAULT_OPTIONAL, DEFAULT_OPTIONAL_PROPERTY, SPECIFIED_OPTIONAL_PROPERTY
 
Method Summary
 JoinColumn addSpecifiedJoinColumn(int index)
          Add a specified join column to the join table return the object representing it.
 boolean containsSpecifiedJoinColumns()
           
 JoinColumn getDefaultJoinColumn()
          Return the default join column or null.
<T extends JoinColumn>
java.util.ListIterator<T>
joinColumns()
          Return a list iterator of the join columns whether specified or default.
 int joinColumnsSize()
          Return the number of join columns, both specified and default.
 void moveSpecifiedJoinColumn(int targetIndex, int sourceIndex)
          Move the specified join column from the source index to the target index.
 void removeSpecifiedJoinColumn(int index)
          Remove the specified join column from the join table.
 void removeSpecifiedJoinColumn(JoinColumn joinColumn)
          Remove the specified join column at the index from the join table.
<T extends JoinColumn>
java.util.ListIterator<T>
specifiedJoinColumns()
          Return a list iterator of the specified join columns.
 int specifiedJoinColumnsSize()
          Return the number of specified join columns.
 
Methods inherited from interface org.eclipse.jpt.core.context.RelationshipMapping
getCascade, getDefaultTargetEntity, getEntity, getResolvedTargetEntity, getSpecifiedTargetEntity, getTargetEntity, isRelationshipOwner, setSpecifiedTargetEntity, targetEntityIsValid
 
Methods inherited from interface org.eclipse.jpt.core.context.Fetchable
getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch
 
Methods inherited from interface org.eclipse.jpt.core.context.Nullable
getDefaultOptional, getOptional, getSpecifiedOptional, setSpecifiedOptional
 

Field Detail

DEFAULT_FETCH_TYPE

static final FetchType DEFAULT_FETCH_TYPE

SPECIFIED_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_JOIN_COLUMNS_LIST
See Also:
Constant Field Values

DEFAULT_JOIN_COLUMN

static final java.lang.String DEFAULT_JOIN_COLUMN
See Also:
Constant Field Values
Method Detail

joinColumns

<T extends JoinColumn> java.util.ListIterator<T> joinColumns()
Return a list iterator of the join columns whether specified or default. This will not be null.


joinColumnsSize

int joinColumnsSize()
Return the number of join columns, both specified and default.


specifiedJoinColumns

<T extends JoinColumn> java.util.ListIterator<T> specifiedJoinColumns()
Return a list iterator of the specified join columns. This will not be null.


specifiedJoinColumnsSize

int specifiedJoinColumnsSize()
Return the number of specified join columns.


getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()
Return the default join column or null. A default join column only exists if there are no specified join columns.


addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn(int index)
Add a specified join column to the join table return the object representing it.


removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)
Remove the specified join column from the join table.


removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(JoinColumn joinColumn)
Remove the specified join column at the index from the join table.


moveSpecifiedJoinColumn

void moveSpecifiedJoinColumn(int targetIndex,
                             int sourceIndex)
Move the specified join column from the source index to the target index.


containsSpecifiedJoinColumns

boolean containsSpecifiedJoinColumns()