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

All Superinterfaces:

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

All Known Subinterfaces:

EclipseLinkElementCollectionMapping2_0, EclipseLinkManyToManyMapping2_0, EclipseLinkOneToManyMapping2_0, ElementCollectionMapping2_0, JavaCollectionMapping2_0, JavaElementCollectionMapping2_0, ManyToManyMapping2_0, MultiRelationshipMapping2_0, OneToManyMapping2_0, OrmCollectionMapping2_0, OrmElementCollectionMapping2_0

public interface CollectionMapping2_0
extends CollectionMapping, AttributeMapping2_0, ConvertibleKeyMapping2_0

JPA 2.0 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

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

CollectionMapping.Type

Field Summary

static String	DEFAULT_MAP_KEY_CLASS_PROPERTY
static String	DEFAULT_MAP_KEY_JOIN_COLUMN_PROPERTY Change notification identifier for "defaultMapKeyJoinColumn" property
static String	FULLY_QUALIFIED_MAP_KEY_CLASS_PROPERTY
static String	SPECIFIED_MAP_KEY_CLASS_PROPERTY
static String	SPECIFIED_MAP_KEY_JOIN_COLUMNS_LIST Change notification identifier for "specifiedMapKeyJoinColumns" 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

Method Summary

JoinColumn	addSpecifiedMapKeyJoinColumn() Add a specified map key join column to the relationship.
JoinColumn	addSpecifiedMapKeyJoinColumn(int index) Add a specified map key join column to the relationship.
String	getDefaultMapKeyClass()
JoinColumn	getDefaultMapKeyJoinColumn() Return the default map key join column.
String	getFullyQualifiedMapKeyClass() If the map key class is specified, this will return it fully qualified.
AttributeOverrideContainer	getMapKeyAttributeOverrideContainer()
String	getMapKeyClass()
char	getMapKeyClassEnclosingTypeSeparator() Return the character to be used for browsing or creating the map key class IType.
Column	getMapKeyColumn() Return the map key column for this collection mapping.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn>	getMapKeyJoinColumns() Return the map key join columns whether specified or default.
int	getMapKeyJoinColumnsSize() Return the number of map key join columns, whether specified and default.
String	getSpecifiedMapKeyClass()
JoinColumn	getSpecifiedMapKeyJoinColumn(int index) Return the specified map key join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn>	getSpecifiedMapKeyJoinColumns() Return the specified map key join columns.
int	getSpecifiedMapKeyJoinColumnsSize() Return the number of specified join columns.
boolean	hasSpecifiedMapKeyJoinColumns() Return whether the mapping has any specified map key join columns.
void	moveSpecifiedMapKeyJoinColumn(int targetIndex, int sourceIndex) Move the specified map key join column from the source index to the target index.
void	removeSpecifiedMapKeyJoinColumn(int index) Remove the specified map key join column.
void	removeSpecifiedMapKeyJoinColumn(JoinColumn joinColumn) Remove the specified map key join column.
void	setSpecifiedMapKeyClass(String value)

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

Field Detail

SPECIFIED_MAP_KEY_CLASS_PROPERTY

static final String SPECIFIED_MAP_KEY_CLASS_PROPERTY

See Also:

Constant Field Values

DEFAULT_MAP_KEY_CLASS_PROPERTY

static final String DEFAULT_MAP_KEY_CLASS_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_MAP_KEY_CLASS_PROPERTY

static final String FULLY_QUALIFIED_MAP_KEY_CLASS_PROPERTY

See Also:

Constant Field Values

SPECIFIED_MAP_KEY_JOIN_COLUMNS_LIST

static final String SPECIFIED_MAP_KEY_JOIN_COLUMNS_LIST

Change notification identifier for "specifiedMapKeyJoinColumns" list

See Also:

Constant Field Values

DEFAULT_MAP_KEY_JOIN_COLUMN_PROPERTY

static final String DEFAULT_MAP_KEY_JOIN_COLUMN_PROPERTY

Change notification identifier for "defaultMapKeyJoinColumn" property

See Also:

Constant Field Values

Method Detail

getMapKeyClass

String getMapKeyClass()

getSpecifiedMapKeyClass

String getSpecifiedMapKeyClass()

setSpecifiedMapKeyClass

void setSpecifiedMapKeyClass(String value)

getDefaultMapKeyClass

String getDefaultMapKeyClass()

getMapKeyClassEnclosingTypeSeparator

char getMapKeyClassEnclosingTypeSeparator()

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

See Also:

IType.getFullyQualifiedName(char)

getFullyQualifiedMapKeyClass

String getFullyQualifiedMapKeyClass()

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

getMapKeyColumn

Column getMapKeyColumn()

Return the map key column for this collection mapping.

getMapKeyAttributeOverrideContainer

AttributeOverrideContainer getMapKeyAttributeOverrideContainer()

getMapKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyJoinColumn> getMapKeyJoinColumns()

Return the map key join columns whether specified or default.

getMapKeyJoinColumnsSize

int getMapKeyJoinColumnsSize()

Return the number of map key join columns, whether specified and default.

getSpecifiedMapKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn> getSpecifiedMapKeyJoinColumns()

Return the specified map key join columns.

getSpecifiedMapKeyJoinColumnsSize

int getSpecifiedMapKeyJoinColumnsSize()

Return the number of specified join columns.

hasSpecifiedMapKeyJoinColumns

boolean hasSpecifiedMapKeyJoinColumns()

Return whether the mapping has any specified map key join columns. (Equivalent to getSpecifiedMapKeyJoinColumnsSize() != 0.)

getSpecifiedMapKeyJoinColumn

JoinColumn getSpecifiedMapKeyJoinColumn(int index)

Return the specified map key join column at the specified index.

addSpecifiedMapKeyJoinColumn

JoinColumn addSpecifiedMapKeyJoinColumn()

Add a specified map key join column to the relationship.

addSpecifiedMapKeyJoinColumn

JoinColumn addSpecifiedMapKeyJoinColumn(int index)

Add a specified map key join column to the relationship.

removeSpecifiedMapKeyJoinColumn

void removeSpecifiedMapKeyJoinColumn(int index)

Remove the specified map key join column.

removeSpecifiedMapKeyJoinColumn

void removeSpecifiedMapKeyJoinColumn(JoinColumn joinColumn)

Remove the specified map key join column.

moveSpecifiedMapKeyJoinColumn

void moveSpecifiedMapKeyJoinColumn(int targetIndex,
                                   int sourceIndex)

Move the specified map key join column from the source index to the target index.

getDefaultMapKeyJoinColumn

JoinColumn getDefaultMapKeyJoinColumn()

Return the default map key join column. If there are specified map key join columns, there is no default join column. There are also times that there may be no default map key join column even if there are no specified map key join columns.