org.eclipse.jpt.core.jpa2.context
Interface CollectionMapping2_0

All Superinterfaces:

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

All Known Subinterfaces:

EclipseLinkElementCollectionMapping2_0, EclipseLinkOneToManyMapping2_0, ElementCollectionMapping2_0, JavaCollectionMapping2_0, JavaElementCollectionMapping2_0, JavaManyToManyMapping2_0, JavaOneToManyMapping2_0, ManyToManyMapping2_0, OneToManyMapping2_0, OrmCollectionMapping2_0, OrmElementCollectionMapping2_0, OrmManyToManyMapping2_0, OrmOneToManyMapping2_0

public interface CollectionMapping2_0
extends CollectionMapping

1:m, m:m, element collection are all collection mappings.

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

Version:

2.3

Nested Class Summary

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

CollectionMapping.Type

Field Summary

static java.lang.String	DEFAULT_MAP_KEY_CLASS_PROPERTY
static java.lang.String	RESOLVED_MAP_KEY_EMBEDDABLE_PROPERTY
static java.lang.String	RESOLVED_MAP_KEY_ENTITY_PROPERTY
static java.lang.String	SPECIFIED_MAP_KEY_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.context.CollectionMapping

CUSTOM_MAP_KEY_PROPERTY, DEFAULT_FETCH_TYPE, KEY_TYPE_PROPERTY, NO_MAP_KEY_PROPERTY, PK_MAP_KEY_PROPERTY, SPECIFIED_MAP_KEY_PROPERTY, VALUE_TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.context.Fetchable

DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY

Method Summary

java.lang.String	getDefaultMapKeyClass()
AttributeOverrideContainer	getMapKeyAttributeOverrideContainer()
java.lang.String	getMapKeyClass()
char	getMapKeyClassEnclosingTypeSeparator() Return the char to be used for browsing or creating the map key class IType.
Column	getMapKeyColumn() Return the map key column for this collection mapping.
Embeddable	getResolvedMapKeyEmbeddable() If the attribute type is not a map or if the map key class is a basic type this will return null.
Entity	getResolvedMapKeyEntity() If the attribute type is not a map or if the map key class is a basic type this will return null.
java.lang.String	getSpecifiedMapKeyClass()
void	setSpecifiedMapKeyClass(java.lang.String value)

Methods inherited from interface org.eclipse.jpt.core.context.CollectionMapping

candidateMapKeyNames, getKeyType, getMapKey, getMetamodelFieldMapKeyTypeName, getOrderable, getResolvedTargetType, getSpecifiedMapKey, getValueType, isCustomMapKey, isNoMapKey, isPkMapKey, setCustomMapKey, setNoMapKey, setPkMapKey, setSpecifiedMapKey

Methods inherited from interface org.eclipse.jpt.core.context.Fetchable

getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch

Field Detail

SPECIFIED_MAP_KEY_CLASS_PROPERTY

static final java.lang.String SPECIFIED_MAP_KEY_CLASS_PROPERTY

See Also:

Constant Field Values

DEFAULT_MAP_KEY_CLASS_PROPERTY

static final java.lang.String DEFAULT_MAP_KEY_CLASS_PROPERTY

See Also:

Constant Field Values

RESOLVED_MAP_KEY_EMBEDDABLE_PROPERTY

static final java.lang.String RESOLVED_MAP_KEY_EMBEDDABLE_PROPERTY

See Also:

Constant Field Values

RESOLVED_MAP_KEY_ENTITY_PROPERTY

static final java.lang.String RESOLVED_MAP_KEY_ENTITY_PROPERTY

See Also:

Constant Field Values

Method Detail

getMapKeyClass

java.lang.String getMapKeyClass()

getSpecifiedMapKeyClass

java.lang.String getSpecifiedMapKeyClass()

setSpecifiedMapKeyClass

void setSpecifiedMapKeyClass(java.lang.String value)

getDefaultMapKeyClass

java.lang.String getDefaultMapKeyClass()

getMapKeyClassEnclosingTypeSeparator

char getMapKeyClassEnclosingTypeSeparator()

Return the char to be used for browsing or creating the map key class IType.

See Also:

IType.getFullyQualifiedName(char)

getResolvedMapKeyEmbeddable

Embeddable getResolvedMapKeyEmbeddable()

If the attribute type is not a map or if the map key class is a basic type this will return null.

getResolvedMapKeyEntity

Entity getResolvedMapKeyEntity()

If the attribute type is not a map or if the map key class is a basic type this will return null.

getMapKeyColumn

Column getMapKeyColumn()

Return the map key column for this collection mapping.

getMapKeyAttributeOverrideContainer

AttributeOverrideContainer getMapKeyAttributeOverrideContainer()