org.eclipse.jpt.core.context
Interface RelationshipReference

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
EclipseLinkOneToManyRelationshipReference, JavaJoinColumnEnabledRelationshipReference, JavaJoinTableEnabledRelationshipReference, JavaManyToManyRelationshipReference, JavaManyToOneRelationshipReference, JavaOneToManyRelationshipReference, JavaOneToOneRelationshipReference, JavaOwnableRelationshipReference, JavaPrimaryKeyJoinColumnEnabledRelationshipReference, JavaRelationshipReference, JoinColumnEnabledRelationshipReference, JoinTableEnabledRelationshipReference, ManyToManyRelationshipReference, ManyToOneRelationshipReference, OneToManyRelationshipReference, OneToOneRelationshipReference, OrmJoinColumnEnabledRelationshipReference, OrmJoinTableEnabledRelationshipReference, OrmManyToManyRelationshipReference, OrmManyToOneRelationshipReference, OrmOneToManyRelationshipReference, OrmOneToOneRelationshipReference, OrmOwnableRelationshipReference, OrmPrimaryKeyJoinColumnEnabledRelationshipReference, OrmRelationshipReference, OwnableRelationshipReference, PrimaryKeyJoinColumnEnabledRelationshipReference

public interface RelationshipReference
extends JpaContextNode

A RelationshipReference represents the meta-information required to populate the entities involved in a RelationshipMapping. This might includes join table information, join column information, and/or "mappedBy" information, to name a few.

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.

See Also:
RelationshipMapping

Field Summary
static java.lang.String PREDOMINANT_JOINING_STRATEGY_PROPERTY
          String associated with changes to the predominant strategy property
 
Method Summary
 JoiningStrategy getPredominantJoiningStrategy()
           
 RelationshipMapping getRelationshipMapping()
           
 boolean isOwnedBy(RelationshipMapping mapping)
          Returns whether the given mapping is the owning side of a relationship with this relationship reference
 boolean isRelationshipOwner()
          Return whether this is the owning side of the relationship.
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.jpt.core.IResourcePart
getResource
 

Field Detail

PREDOMINANT_JOINING_STRATEGY_PROPERTY

static final java.lang.String PREDOMINANT_JOINING_STRATEGY_PROPERTY
String associated with changes to the predominant strategy property

See Also:
Constant Field Values
Method Detail

getRelationshipMapping

RelationshipMapping getRelationshipMapping()

isRelationshipOwner

boolean isRelationshipOwner()
Return whether this is the owning side of the relationship.

See Also:
RelationshipMapping#isRelationshipOwner()}

isOwnedBy

boolean isOwnedBy(RelationshipMapping mapping)
Returns whether the given mapping is the owning side of a relationship with this relationship reference


getPredominantJoiningStrategy

JoiningStrategy getPredominantJoiningStrategy()