org.eclipse.jpt.core.context
Interface CollectionMapping

All Superinterfaces:

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

All Known Subinterfaces:

CollectionMapping2_0, EclipseLinkElementCollectionMapping2_0, EclipseLinkOneToManyMapping, EclipseLinkOneToManyMapping2_0, ElementCollectionMapping2_0, JavaCollectionMapping2_0, JavaElementCollectionMapping2_0, JavaManyToManyMapping, JavaManyToManyMapping2_0, JavaMultiRelationshipMapping, JavaOneToManyMapping, JavaOneToManyMapping2_0, ManyToManyMapping, ManyToManyMapping2_0, MultiRelationshipMapping, OneToManyMapping, OneToManyMapping2_0, OrmCollectionMapping2_0, OrmElementCollectionMapping2_0, OrmManyToManyMapping, OrmManyToManyMapping2_0, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToManyMapping2_0

public interface CollectionMapping
extends AttributeMapping, Fetchable

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

static class

CollectionMapping.Type

Field Summary

static java.lang.String	CUSTOM_MAP_KEY_PROPERTY
static FetchType	DEFAULT_FETCH_TYPE
static java.lang.String	KEY_TYPE_PROPERTY
static java.lang.String	NO_MAP_KEY_PROPERTY
static java.lang.String	PK_MAP_KEY_PROPERTY
static java.lang.String	SPECIFIED_MAP_KEY_PROPERTY
static java.lang.String	VALUE_TYPE_PROPERTY

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

DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY

Method Summary

java.util.Iterator<java.lang.String>	candidateMapKeyNames()
CollectionMapping.Type	getKeyType()
java.lang.String	getMapKey()
java.lang.String	getMetamodelFieldMapKeyTypeName()
Orderable	getOrderable()
PersistentType	getResolvedTargetType()
java.lang.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(java.lang.String mapKey)

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

getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch

Field Detail

DEFAULT_FETCH_TYPE

static final FetchType DEFAULT_FETCH_TYPE

VALUE_TYPE_PROPERTY

static final java.lang.String VALUE_TYPE_PROPERTY

See Also:

Constant Field Values

KEY_TYPE_PROPERTY

static final java.lang.String KEY_TYPE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_MAP_KEY_PROPERTY

static final java.lang.String SPECIFIED_MAP_KEY_PROPERTY

See Also:

Constant Field Values

NO_MAP_KEY_PROPERTY

static final java.lang.String NO_MAP_KEY_PROPERTY

See Also:

Constant Field Values

PK_MAP_KEY_PROPERTY

static final java.lang.String PK_MAP_KEY_PROPERTY

See Also:

Constant Field Values

CUSTOM_MAP_KEY_PROPERTY

static final java.lang.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

java.lang.String getMapKey()

getSpecifiedMapKey

java.lang.String getSpecifiedMapKey()

setSpecifiedMapKey

void setSpecifiedMapKey(java.lang.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)

candidateMapKeyNames

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

getMetamodelFieldMapKeyTypeName

java.lang.String getMetamodelFieldMapKeyTypeName()