org.eclipse.jpt.core.context.orm
Interface OrmSingleRelationshipMapping

All Superinterfaces:
AttributeMapping, Fetchable, org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model, Nullable, OrmAttributeMapping, OrmJpaContextNode, OrmRelationshipMapping, RelationshipMapping, SingleRelationshipMapping
All Known Subinterfaces:
OrmManyToOneMapping, OrmOneToOneMapping

public interface OrmSingleRelationshipMapping
extends OrmRelationshipMapping, SingleRelationshipMapping

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
 
Fields inherited from interface org.eclipse.jpt.core.context.orm.OrmAttributeMapping
JAVA_PERSISTENT_ATTRIBUTE_PROPERTY, NAME_PROPERTY
 
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.SingleRelationshipMapping
DEFAULT_FETCH_TYPE, DEFAULT_JOIN_COLUMN, 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
 OrmJoinColumn addSpecifiedJoinColumn(int index)
          Add a specified join column to the join table return the object representing it.
 OrmJoinColumn getDefaultJoinColumn()
          Return the default join column or null.
 java.util.ListIterator<OrmJoinColumn> joinColumns()
          Return a list iterator of the join columns whether specified or default.
 java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()
          Return a list iterator of the specified join columns.
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmAttributeMapping
addToResourceModel, contains, getJavaPersistentAttribute, getName, getPersistentAttribute, getSelectionTextRange, getXmlSequence, initializeFromOrmAttributeMapping, initializeFromOrmBasicMapping, initializeFromOrmEmbeddedIdMapping, initializeFromOrmEmbeddedMapping, initializeFromOrmIdMapping, initializeFromOrmManyToManyMapping, initializeFromOrmManyToOneMapping, initializeFromOrmOneToManyMapping, initializeFromOrmOneToOneMapping, initializeFromOrmTransientMapping, initializeFromOrmVersionMapping, initializeOn, removeFromResourceModel, setName
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmJpaContextNode
addToMessages, getValidationTextRange
 
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.SingleRelationshipMapping
containsSpecifiedJoinColumns, joinColumnsSize, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumnsSize
 
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
 

Method Detail

joinColumns

java.util.ListIterator<OrmJoinColumn> joinColumns()
Description copied from interface: SingleRelationshipMapping
Return a list iterator of the join columns whether specified or default. This will not be null.

Specified by:
joinColumns in interface SingleRelationshipMapping

getDefaultJoinColumn

OrmJoinColumn getDefaultJoinColumn()
Description copied from interface: SingleRelationshipMapping
Return the default join column or null. A default join column only exists if there are no specified join columns.

Specified by:
getDefaultJoinColumn in interface SingleRelationshipMapping

specifiedJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()
Description copied from interface: SingleRelationshipMapping
Return a list iterator of the specified join columns. This will not be null.

Specified by:
specifiedJoinColumns in interface SingleRelationshipMapping

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn(int index)
Description copied from interface: SingleRelationshipMapping
Add a specified join column to the join table return the object representing it.

Specified by:
addSpecifiedJoinColumn in interface SingleRelationshipMapping