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

All Superinterfaces:

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

All Known Subinterfaces:

CollectionMapping2_0, EclipseLinkElementCollectionMapping2_0, EclipseLinkManyToManyMapping, EclipseLinkManyToManyMapping2_0, EclipseLinkOneToManyMapping, EclipseLinkOneToManyMapping2_0, ElementCollectionMapping2_0, JavaCollectionMapping2_0, JavaElementCollectionMapping2_0, JavaManyToManyMapping, JavaOneToManyMapping, ManyToManyMapping, ManyToManyMapping2_0, MultiRelationshipMapping, MultiRelationshipMapping2_0, OneToManyMapping, OneToManyMapping2_0, OrmCollectionMapping2_0, OrmElementCollectionMapping2_0, OrmManyToManyMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping

public interface CollectionMapping
extends FetchableMapping

JPA collection mapping (e.g. 1:m, m:m, element collection)

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

Nested Class Summary

static class

CollectionMapping.Type

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	CUSTOM_MAP_KEY_PROPERTY
static FetchType	DEFAULT_FETCH_TYPE
static String	KEY_TYPE_PROPERTY
static String	NO_MAP_KEY_PROPERTY
static String	PK_MAP_KEY_PROPERTY
static String	SPECIFIED_MAP_KEY_PROPERTY
static String	VALUE_TYPE_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>	getCandidateMapKeyNames()
CollectionMapping.Type	getKeyType()
String	getMapKey()
String	getMetamodelFieldMapKeyTypeName()
Orderable	getOrderable()
PersistentType	getResolvedTargetType()
String	getSpecifiedMapKey()
CollectionMapping.Type	getValueType()
boolean	isCustomMapKey()
boolean	isNoMapKey()
boolean	isPkMapKey()
void	setCustomMapKey(boolean customMapKey)
void	setNoMapKey(boolean noMapKey)
void	setPkMapKey(boolean pkMapKey)
void	setSpecifiedMapKey(String mapKey)

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

DEFAULT_FETCH_TYPE

static final FetchType DEFAULT_FETCH_TYPE

VALUE_TYPE_PROPERTY

static final String VALUE_TYPE_PROPERTY

See Also:

Constant Field Values

KEY_TYPE_PROPERTY

static final String KEY_TYPE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_MAP_KEY_PROPERTY

static final String SPECIFIED_MAP_KEY_PROPERTY

See Also:

Constant Field Values

NO_MAP_KEY_PROPERTY

static final String NO_MAP_KEY_PROPERTY

See Also:

Constant Field Values

PK_MAP_KEY_PROPERTY

static final String PK_MAP_KEY_PROPERTY

See Also:

Constant Field Values

CUSTOM_MAP_KEY_PROPERTY

static final String CUSTOM_MAP_KEY_PROPERTY

See Also:

Constant Field Values

Method Detail

getOrderable

Orderable getOrderable()

getResolvedTargetType

PersistentType getResolvedTargetType()

getValueType

CollectionMapping.Type getValueType()

getKeyType

CollectionMapping.Type getKeyType()

getMapKey

String getMapKey()

getSpecifiedMapKey

String getSpecifiedMapKey()

setSpecifiedMapKey

void setSpecifiedMapKey(String mapKey)

isNoMapKey

boolean isNoMapKey()

setNoMapKey

void setNoMapKey(boolean noMapKey)

isPkMapKey

boolean isPkMapKey()

setPkMapKey

void setPkMapKey(boolean pkMapKey)

isCustomMapKey

boolean isCustomMapKey()

setCustomMapKey

void setCustomMapKey(boolean customMapKey)

getCandidateMapKeyNames

Iterable<String> getCandidateMapKeyNames()

getMetamodelFieldMapKeyTypeName

String getMetamodelFieldMapKeyTypeName()