org.eclipse.jpt.core.context
Interface RelationshipMapping

All Superinterfaces:
AttributeMapping, Fetchable, org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
JavaManyToManyMapping, JavaManyToOneMapping, JavaMultiRelationshipMapping, JavaOneToManyMapping, JavaOneToOneMapping, JavaRelationshipMapping, JavaSingleRelationshipMapping, ManyToManyMapping, ManyToOneMapping, MultiRelationshipMapping, NonOwningMapping, OneToManyMapping, OneToOneMapping, OrmManyToManyMapping, OrmManyToOneMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToOneMapping, OrmRelationshipMapping, OrmSingleRelationshipMapping, SingleRelationshipMapping

public interface RelationshipMapping
extends AttributeMapping, Fetchable

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 java.lang.String DEFAULT_TARGET_ENTITY_PROPERTY
           
static java.lang.String RESOLVED_TARGET_ENTITY_PROPERTY
           
static java.lang.String SPECIFIED_TARGET_ENTITY_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.core.context.Fetchable
DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY
 
Method Summary
 Cascade getCascade()
           
 java.lang.String getDefaultTargetEntity()
           
 Entity getEntity()
          Return the Entity that owns this relationship mapping
 Entity getResolvedTargetEntity()
           
 java.lang.String getSpecifiedTargetEntity()
           
 java.lang.String getTargetEntity()
           
 boolean isRelationshipOwner()
          Return whether this mapping is the owning side of the relationship.
 void setSpecifiedTargetEntity(java.lang.String value)
           
 boolean targetEntityIsValid(java.lang.String targetEntity)
          Return whether the specified 'targetEntity' is valid.
 
Methods inherited from interface org.eclipse.jpt.core.context.Fetchable
getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch
 

Field Detail

SPECIFIED_TARGET_ENTITY_PROPERTY

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

DEFAULT_TARGET_ENTITY_PROPERTY

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

RESOLVED_TARGET_ENTITY_PROPERTY

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

getTargetEntity

java.lang.String getTargetEntity()

getSpecifiedTargetEntity

java.lang.String getSpecifiedTargetEntity()

setSpecifiedTargetEntity

void setSpecifiedTargetEntity(java.lang.String value)

getDefaultTargetEntity

java.lang.String getDefaultTargetEntity()

getResolvedTargetEntity

Entity getResolvedTargetEntity()

targetEntityIsValid

boolean targetEntityIsValid(java.lang.String targetEntity)
Return whether the specified 'targetEntity' is valid.


getCascade

Cascade getCascade()

getEntity

Entity getEntity()
Return the Entity that owns this relationship mapping

Returns:

isRelationshipOwner

boolean isRelationshipOwner()
Return whether this mapping is the owning side of the relationship. Either this is a unidirectional mapping or it is the owning side of a bidirectional relationship. If bidirectional, the owning side is the side that doesn't specify mappedBy. This is the side where a join table would be specified