org.eclipse.jpt.jpa.core.context
Interface Relationship

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

EclipseLinkJavaOneToManyRelationship, EclipseLinkJavaOneToManyRelationship2_0, EclipseLinkOneToManyRelationship, EclipseLinkOneToManyRelationship2_0, EclipseLinkOrmOneToManyRelationship, EclipseLinkOrmOneToManyRelationship2_0, JavaJoinColumnRelationship, JavaJoinTableRelationship, JavaManyToManyRelationship, JavaManyToOneRelationship, JavaManyToOneRelationship2_0, JavaMappedByRelationship, JavaMappingJoinColumnRelationship, JavaMappingJoinTableRelationship, JavaMappingRelationship, JavaOneToManyRelationship, JavaOneToManyRelationship2_0, JavaOneToOneRelationship, JavaOneToOneRelationship2_0, JavaPrimaryKeyJoinColumnRelationship, JavaSpecifiedOverrideRelationship, JavaSpecifiedOverrideRelationship2_0, JoinColumnRelationship, JoinTableRelationship, ManyToManyRelationship, ManyToOneRelationship, ManyToOneRelationship2_0, MappedByRelationship, MappingRelationship, OneToManyRelationship, OneToManyRelationship2_0, OneToOneRelationship, OneToOneRelationship2_0, OrmJoinColumnRelationship, OrmJoinTableRelationship, OrmManyToManyRelationship, OrmManyToOneRelationship, OrmManyToOneRelationship2_0, OrmMappedByRelationship, OrmMappingJoinColumnRelationship, OrmMappingJoinTableRelationship, OrmMappingRelationship, OrmOneToManyRelationship, OrmOneToManyRelationship2_0, OrmOneToOneRelationship, OrmOneToOneRelationship2_0, OrmPrimaryKeyJoinColumnRelationship, OrmSpecifiedOverrideRelationship, OrmSpecifiedOverrideRelationship2_0, OverrideRelationship, OverrideRelationship2_0, PrimaryKeyJoinColumnRelationship, SpecifiedJoinColumnRelationship, SpecifiedJoinTableRelationship, SpecifiedOverrideRelationship, SpecifiedOverrideRelationship2_0, SpecifiedRelationship, VirtualJoinColumnRelationship, VirtualJoinTableRelationship, VirtualOverrideRelationship, VirtualOverrideRelationship2_0, VirtualRelationship

public interface Relationship
extends JpaContextModel

A relationship contains the settings describing how entities are related in a RelationshipMapping or SpecifiedAssociationOverride:

• join column
• join table
• "mapped by"
• primary key join column

Supported mappings:

• 1:1
• 1:m
• m:1
• m:m

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, SpecifiedAssociationOverride

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String

STRATEGY_PROPERTY String associated with changes to the predominant strategy property

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

Entity	getEntity() Return the entity that contains the relationship's mapping or override.
RelationshipMapping	getMapping() Return the relationship's mapping; which for a mapping relationship is the relationship's parent, but in the case of an override is the overridden mapping (from a superclass or embeddable type).
RelationshipStrategy	getStrategy() Return the current strategy, this is never null.
TypeMapping	getTypeMapping() Return the type mapping that contains the relationship's mapping or override.
boolean	isVirtual() Return whether the the relationship is virtual.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

STRATEGY_PROPERTY

static final String STRATEGY_PROPERTY

String associated with changes to the predominant strategy property

See Also:

Constant Field Values

Method Detail

getMapping

RelationshipMapping getMapping()

Return the relationship's mapping; which for a mapping relationship is the relationship's parent, but in the case of an override is the overridden mapping (from a superclass or embeddable type).

getTypeMapping

TypeMapping getTypeMapping()

Return the type mapping that contains the relationship's mapping or override.

getEntity

Entity getEntity()

Return the entity that contains the relationship's mapping or override. This is just a convenience method that calls getTypeMapping() and returns null if the result is not an Entity.

getStrategy

RelationshipStrategy getStrategy()

Return the current strategy, this is never null.

isVirtual

boolean isVirtual()

Return whether the the relationship is virtual.