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

All Superinterfaces:

AttributeMapping, FetchableMapping, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

EclipseLinkManyToManyMapping, EclipseLinkManyToManyMapping2_0, EclipseLinkManyToOneMapping, EclipseLinkManyToOneMapping2_0, EclipseLinkOneToManyMapping, EclipseLinkOneToManyMapping2_0, EclipseLinkOneToOneMapping, EclipseLinkOneToOneMapping2_0, EclipseLinkRelationshipMapping, JavaManyToManyMapping, JavaManyToOneMapping, JavaOneToManyMapping, JavaOneToOneMapping, JavaRelationshipMapping, JavaSingleRelationshipMapping, JavaSingleRelationshipMapping2_0, ManyToManyMapping, ManyToManyMapping2_0, ManyToOneMapping, ManyToOneMapping2_0, MultiRelationshipMapping, MultiRelationshipMapping2_0, OneToManyMapping, OneToManyMapping2_0, OneToOneMapping, OneToOneMapping2_0, OrmManyToManyMapping, OrmManyToOneMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToOneMapping, OrmRelationshipMapping, OrmSingleRelationshipMapping, OrmSingleRelationshipMapping2_0, OrphanRemovalMapping2_0, RelationshipMapping2_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

Nested Class Summary

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

AttributeMapping.AllMappingNamesTransformer, AttributeMapping.AllOverridableAssociationMappingNamesTransformer, AttributeMapping.AllOverridableAttributeMappingNamesTransformer, AttributeMapping.GeneratorsTransformer, AttributeMapping.IsNotTransient, AttributeMapping.IsOverridableAssociationMapping, AttributeMapping.KeyEquals, AttributeMapping.NameTransformer

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	DEFAULT_TARGET_ENTITY_PROPERTY
static String	FULLY_QUALIFIED_TARGET_ENTITY_PROPERTY
static 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

ALL_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ASSOCIATION_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ATTRIBUTE_MAPPING_NAMES_TRANSFORMER, DEFAULT_PROPERTY, GENERATORS_TRANSFORMER, IS_NOT_TRANSIENT, IS_OVERRIDABLE_ASSOCIATION_MAPPING, NAME_TRANSFORMER

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

TRANSFORMER

Method Summary

Iterable<String>	getAllTargetEntityAttributeNames() Return all attribute names on the target entity, provided target entity resolves
Cascade	getCascade()
String	getDefaultTargetEntity()
String	getFullyQualifiedTargetEntity() If the target entity is specified, this will return it fully qualified.
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()
String	getSpecifiedTargetEntity()
String	getTargetEntity()
char	getTargetEntityEnclosingTypeSeparator() Return the char to be used for browsing or creating the target entity IType.
Iterable<String>	getTargetEntityNonTransientAttributeNames() Return the names of non-transient attribute mappings on the target entity, provided target entity resolves
void	setSpecifiedTargetEntity(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

getAllMappingNames, getAllOverridableAssociationMappingNames, getAllOverridableAttributeMappingNames, getGenerators, getKey, getName, getPersistentAttribute, getPrimaryKeyColumnName, getTypeMapping, isDefault, isOverridableAssociationMapping, isOverridableAttributeMapping, isOwnedBy, isRelationshipOwner, resolveAttributeMapping, resolveOverriddenColumn, resolveOverriddenRelationship, validatesAgainstDatabase

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

SPECIFIED_TARGET_ENTITY_PROPERTY

static final String SPECIFIED_TARGET_ENTITY_PROPERTY

See Also:

Constant Field Values

DEFAULT_TARGET_ENTITY_PROPERTY

static final String DEFAULT_TARGET_ENTITY_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_TARGET_ENTITY_PROPERTY

static final String FULLY_QUALIFIED_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

String getTargetEntity()

getSpecifiedTargetEntity

String getSpecifiedTargetEntity()

setSpecifiedTargetEntity

void setSpecifiedTargetEntity(String value)

getDefaultTargetEntity

String getDefaultTargetEntity()

getResolvedTargetEntity

Entity getResolvedTargetEntity()

getAllTargetEntityAttributeNames

Iterable<String> getAllTargetEntityAttributeNames()

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

getTargetEntityNonTransientAttributeNames

Iterable<String> getTargetEntityNonTransientAttributeNames()

Return the names of non-transient attribute mappings 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)

getFullyQualifiedTargetEntity

String getFullyQualifiedTargetEntity()

If the target entity is specified, this will return it fully qualified. If not specified, it returns the default target entity, which is always fully qualified

getCascade

Cascade getCascade()