org.eclipse.jpt.jpa.core.jpa2.context
Interface ElementCollectionMapping2_0

All Superinterfaces:

AttributeMapping, AttributeMapping2_0, CollectionMapping, CollectionMapping2_0, ConvertibleKeyMapping2_0, ConvertibleMapping, FetchableMapping, IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model

All Known Subinterfaces:

EclipseLinkElementCollectionMapping2_0, JavaElementCollectionMapping2_0, OrmElementCollectionMapping2_0

public interface ElementCollectionMapping2_0
extends CollectionMapping2_0, ConvertibleMapping

JPA 2.0 element collection 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.3

Nested Class Summary

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

CollectionMapping.Type

Field Summary

static String	DEFAULT_TARGET_CLASS_PROPERTY
static String	FULLY_QUALIFIED_TARGET_CLASS_PROPERTY
static String	SPECIFIED_TARGET_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.CollectionMapping2_0

DEFAULT_MAP_KEY_CLASS_PROPERTY, DEFAULT_MAP_KEY_JOIN_COLUMN_PROPERTY, FULLY_QUALIFIED_MAP_KEY_CLASS_PROPERTY, SPECIFIED_MAP_KEY_CLASS_PROPERTY, SPECIFIED_MAP_KEY_JOIN_COLUMNS_LIST

Fields inherited from interface org.eclipse.jpt.jpa.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.jpa.core.context.FetchableMapping

DEFAULT_FETCH_PROPERTY, SPECIFIED_FETCH_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.ConvertibleKeyMapping2_0

MAP_KEY_CONVERTER_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.AttributeMapping2_0

STANDARD_METAMODEL_FIELD_MODIFIERS

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

CONVERTER_PROPERTY

Method Summary

CollectionTable2_0	getCollectionTable() Return the mapping's collection table.
String	getDefaultTargetClass()
Entity	getEntity() Return the entity that owns the mapping.
String	getFullyQualifiedTargetClass() If the target class is specified, this will return it fully qualified.
String	getSpecifiedTargetClass()
String	getTargetClass()
char	getTargetClassEnclosingTypeSeparator() Return the character to be used for browsing or creating the target class IType.
AssociationOverrideContainer	getValueAssociationOverrideContainer()
AttributeOverrideContainer	getValueAttributeOverrideContainer()
Column	getValueColumn() Return the mapping's value column.
void	setSpecifiedTargetClass(String value)

Methods inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.CollectionMapping2_0

addSpecifiedMapKeyJoinColumn, addSpecifiedMapKeyJoinColumn, getDefaultMapKeyClass, getDefaultMapKeyJoinColumn, getFullyQualifiedMapKeyClass, getMapKeyAttributeOverrideContainer, getMapKeyClass, getMapKeyClassEnclosingTypeSeparator, getMapKeyColumn, getMapKeyJoinColumns, getMapKeyJoinColumnsSize, getSpecifiedMapKeyClass, getSpecifiedMapKeyJoinColumn, getSpecifiedMapKeyJoinColumns, getSpecifiedMapKeyJoinColumnsSize, hasSpecifiedMapKeyJoinColumns, moveSpecifiedMapKeyJoinColumn, removeSpecifiedMapKeyJoinColumn, removeSpecifiedMapKeyJoinColumn, setSpecifiedMapKeyClass

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

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

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

getDefaultFetch, getFetch, getSpecifiedFetch, setSpecifiedFetch

Methods inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.ConvertibleKeyMapping2_0

getMapKeyConverter, setMapKeyConverter

Methods inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.AttributeMapping2_0

getMetamodelField, getMetamodelTypeName

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

getConverter, setConverter

Field Detail

SPECIFIED_TARGET_CLASS_PROPERTY

static final String SPECIFIED_TARGET_CLASS_PROPERTY

See Also:

Constant Field Values

DEFAULT_TARGET_CLASS_PROPERTY

static final String DEFAULT_TARGET_CLASS_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_TARGET_CLASS_PROPERTY

static final String FULLY_QUALIFIED_TARGET_CLASS_PROPERTY

See Also:

Constant Field Values

Method Detail

getEntity

Entity getEntity()

Return the entity that owns the mapping. This is just a convenience method that calls AttributeMapping.getTypeMapping() and returns null if it is not an Entity.

getTargetClass

String getTargetClass()

getSpecifiedTargetClass

String getSpecifiedTargetClass()

setSpecifiedTargetClass

void setSpecifiedTargetClass(String value)

getDefaultTargetClass

String getDefaultTargetClass()

getFullyQualifiedTargetClass

String getFullyQualifiedTargetClass()

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

getTargetClassEnclosingTypeSeparator

char getTargetClassEnclosingTypeSeparator()

Return the character to be used for browsing or creating the target class IType.

See Also:

IType.getFullyQualifiedName(char)

getCollectionTable

CollectionTable2_0 getCollectionTable()

Return the mapping's collection table. This will not be null.

getValueColumn

Column getValueColumn()

Return the mapping's value column.

getValueAttributeOverrideContainer

AttributeOverrideContainer getValueAttributeOverrideContainer()

getValueAssociationOverrideContainer

AssociationOverrideContainer getValueAssociationOverrideContainer()