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

All Superinterfaces:

AttributeMapping, FetchableMapping, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

EclipseLinkOneToManyMapping, EclipseLinkOneToManyMapping2_0, EclipseLinkOneToOneMapping, EclipseLinkOneToOneMapping2_0, EclipseLinkRelationshipMapping, JavaManyToManyMapping, JavaManyToManyMapping2_0, JavaManyToOneMapping, JavaManyToOneMapping2_0, JavaMultiRelationshipMapping, JavaOneToManyMapping, JavaOneToManyMapping2_0, JavaOneToOneMapping, JavaOneToOneMapping2_0, JavaRelationshipMapping, JavaSingleRelationshipMapping, JavaSingleRelationshipMapping2_0, ManyToManyMapping, ManyToManyMapping2_0, ManyToOneMapping, ManyToOneMapping2_0, MultiRelationshipMapping, OneToManyMapping, OneToManyMapping2_0, OneToOneMapping, OneToOneMapping2_0, OrmManyToManyMapping, OrmManyToManyMapping2_0, OrmManyToOneMapping, OrmManyToOneMapping2_0, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToManyMapping2_0, OrmOneToOneMapping, OrmOneToOneMapping2_0, OrmRelationshipMapping, OrmSingleRelationshipMapping, OrmSingleRelationshipMapping2_0, SingleRelationshipMapping, SingleRelationshipMapping2_0

public interface RelationshipMapping
extends FetchableMapping

JPA relationship (1:1, 1:m, m:1, m:m) mapping.

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

Version:

2.3

Field Summary

static java.lang.String	DEFAULT_TARGET_ENTITY_PROPERTY
static java.lang.String	SPECIFIED_TARGET_ENTITY_PROPERTY

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

DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY

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

DEFAULT_PROPERTY

Method Summary

java.util.Iterator<java.lang.String>	allTargetEntityAttributeNames() Return all attribute names on the target entity, provided target entity resolves
Cascade	getCascade()
java.lang.String	getDefaultTargetEntity()
MappingRelationship	getRelationship() Return the meta-information used to populate the entities of the relationship
RelationshipMapping	getRelationshipOwner() Return the relationship owner or null if this is the owning side or it is a unidirectional mapping.
Entity	getResolvedTargetEntity()
java.lang.String	getSpecifiedTargetEntity()
java.lang.String	getTargetEntity()
char	getTargetEntityEnclosingTypeSeparator() Return the char to be used for browsing or creating the target entity IType.
void	setSpecifiedTargetEntity(java.lang.String value)

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

getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch

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

allMappingNames, allOverridableAssociationMappingNames, allOverridableAttributeMappingNames, getKey, getName, getPersistentAttribute, getPrimaryKeyColumnName, getTypeMapping, isDefault, isOverridableAssociationMapping, isOverridableAttributeMapping, isOwnedBy, isRelationshipOwner, resolveAttributeMapping, resolveOverriddenColumn, resolveOverriddenRelationship, validatesAgainstDatabase

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

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

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

getAdapter

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

getResource

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

Method Detail

getRelationship

MappingRelationship getRelationship()

Return the meta-information used to populate the entities of the relationship

getRelationshipOwner

RelationshipMapping getRelationshipOwner()

Return the relationship owner or null if this is the owning side or it is a unidirectional mapping.

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

allTargetEntityAttributeNames

java.util.Iterator<java.lang.String> allTargetEntityAttributeNames()

Return all attribute names on the target entity, provided target entity resolves

getTargetEntityEnclosingTypeSeparator

char getTargetEntityEnclosingTypeSeparator()

Return the char to be used for browsing or creating the target entity IType.

See Also:

IType.getFullyQualifiedName(char)

getCascade

Cascade getCascade()