org.eclipse.jpt.jpa.core.context.orm
Interface OrmMappingRelationship

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, MappingRelationship, Model, Relationship, SpecifiedRelationship

All Known Subinterfaces:

EclipseLinkOrmOneToManyRelationship, EclipseLinkOrmOneToManyRelationship2_0, OrmManyToManyRelationship, OrmManyToOneRelationship, OrmManyToOneRelationship2_0, OrmMappingJoinColumnRelationship, OrmMappingJoinTableRelationship, OrmOneToManyRelationship, OrmOneToManyRelationship2_0, OrmOneToOneRelationship, OrmOneToOneRelationship2_0, OrmPrimaryKeyJoinColumnRelationship

public interface OrmMappingRelationship
extends MappingRelationship

orm.xml mapping relationship (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.

Since:

2.2

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

Fields inherited from interface org.eclipse.jpt.jpa.core.context.Relationship

STRATEGY_PROPERTY

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

TRANSFORMER

Method Summary

OrmRelationshipMapping	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).
void	initializeFrom(OrmMappingRelationship oldRelationship) Called when converting one orm.xml relationship mapping to another; to preserve any specified strategies.
void	initializeFromJoinColumnRelationship(OrmJoinColumnRelationship oldRelationship) Double-dispatch
void	initializeFromJoinTableRelationship(OrmJoinTableRelationship oldRelationship) Double-dispatch
void	initializeFromMappedByRelationship(OrmMappedByRelationship oldRelationship) Double-dispatch
void	initializeFromPrimaryKeyJoinColumnRelationship(OrmPrimaryKeyJoinColumnRelationship oldRelationship) Double-dispatch NB: For now, only one-to-one mappings use a primary key join column relationship....
void	initializeOn(OrmMappingRelationship newRelationship) Called by initializeFrom(OrmMappingRelationship) (on the old relationship) so we can use double-dispatching.

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

isOverridable, isOwnedBy, isOwner, isTargetForeignKey

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

getStrategy

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

getEntity, getTypeMapping, isVirtual

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

Method Detail

getMapping

OrmRelationshipMapping getMapping()

Description copied from interface: Relationship

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).

Specified by:

getMapping in interface Relationship

initializeFrom

void initializeFrom(OrmMappingRelationship oldRelationship)

Called when converting one orm.xml relationship mapping to another; to preserve any specified strategies. Typically handled via delegation to initializeOn(OrmMappingRelationship).

NB: There is no corresponding method on the Java mapping relationship because Java mapping conversions simply change the mapping annotation and leave the [sibling] "relationship" annotations in place; while orm.xml mapping conversions must move the [nested] "relationship" XML elements to the new mapping XML element.

initializeOn

void initializeOn(OrmMappingRelationship newRelationship)

Called by initializeFrom(OrmMappingRelationship) (on the old relationship) so we can use double-dispatching.

See Also:

initializeFromJoinColumnRelationship(OrmJoinColumnRelationship), initializeFromJoinTableRelationship(OrmJoinTableRelationship), initializeFromMappedByRelationship(OrmMappedByRelationship), initializeFromPrimaryKeyJoinColumnRelationship(OrmPrimaryKeyJoinColumnRelationship)

initializeFromJoinColumnRelationship

void initializeFromJoinColumnRelationship(OrmJoinColumnRelationship oldRelationship)

Double-dispatch

See Also:

initializeOn(OrmMappingRelationship)

initializeFromJoinTableRelationship

void initializeFromJoinTableRelationship(OrmJoinTableRelationship oldRelationship)

Double-dispatch

See Also:

initializeOn(OrmMappingRelationship)

initializeFromMappedByRelationship

void initializeFromMappedByRelationship(OrmMappedByRelationship oldRelationship)

Double-dispatch

See Also:

initializeOn(OrmMappingRelationship)

initializeFromPrimaryKeyJoinColumnRelationship

void initializeFromPrimaryKeyJoinColumnRelationship(OrmPrimaryKeyJoinColumnRelationship oldRelationship)

Double-dispatch

NB: For now, only one-to-one mappings use a primary key join column relationship....

See Also:

initializeOn(OrmMappingRelationship)