org.eclipse.jpt.jpa.core.jpa2.context.orm
Interface OrmCollectionMapping2_0

All Superinterfaces:

AttributeMapping, AttributeMapping2_0, CollectionMapping, CollectionMapping2_0, ConvertibleKeyMapping2_0, FetchableMapping, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OrmAttributeMapping, OrmConvertibleKeyMapping2_0, TypeRefactoringParticipant

All Known Subinterfaces:

OrmElementCollectionMapping2_0

public interface OrmCollectionMapping2_0
extends CollectionMapping2_0, OrmConvertibleKeyMapping2_0

orm.xml 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

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

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

TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer

Field Summary

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

Fields inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmAttributeMapping

DEFAULT_ATTRIBUTE_TYPE_PROPERTY, FULLY_QUALIFIED_ATTRIBUTE_TYPE_PROPERTY, NAME_PROPERTY, SPECIFIED_ATTRIBUTE_TYPE_PROPERTY

Method Summary

OrmSpecifiedJoinColumn	addSpecifiedMapKeyJoinColumn() Add a specified map key join column to the relationship.
OrmSpecifiedJoinColumn	addSpecifiedMapKeyJoinColumn(int index) Add a specified map key join column to the relationship.
OrmSpecifiedJoinColumn	getDefaultMapKeyJoinColumn() Return the default map key join column.
OrmAttributeOverrideContainer	getMapKeyAttributeOverrideContainer()
OrmSpecifiedJoinColumn	getSpecifiedMapKeyJoinColumn(int index) Return the specified map key join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends OrmSpecifiedJoinColumn>	getSpecifiedMapKeyJoinColumns() Return the specified map key join columns.

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

getDefaultMapKeyClass, getFullyQualifiedMapKeyClass, getMapKeyClass, getMapKeyClassEnclosingTypeSeparator, getMapKeyColumn, getMapKeyJoinColumns, getMapKeyJoinColumnsSize, getSpecifiedMapKeyClass, 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.orm.OrmConvertibleKeyMapping2_0

getMapKeyConverter

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

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

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmAttributeMapping

addXmlAttributeMappingTo, getAttributeType, getDefaultAttributeType, getFullyQualifiedAttributeType, getNameTextRange, getParent, getPersistentAttribute, getSelectionTextRange, getSpecifiedAttributeType, getTypeMapping, getXmlAttributeMapping, getXmlSequence, initializeFromOrmAttributeMapping, initializeFromOrmBasicMapping, initializeFromOrmEmbeddedIdMapping, initializeFromOrmEmbeddedMapping, initializeFromOrmIdMapping, initializeFromOrmManyToManyMapping, initializeFromOrmManyToOneMapping, initializeFromOrmOneToManyMapping, initializeFromOrmOneToOneMapping, initializeFromOrmTransientMapping, initializeFromOrmVersionMapping, initializeOn, removeXmlAttributeMappingFrom, setName, setSpecifiedAttributeType

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

createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits

Method Detail

getMapKeyAttributeOverrideContainer

OrmAttributeOverrideContainer getMapKeyAttributeOverrideContainer()

Specified by:

getMapKeyAttributeOverrideContainer in interface CollectionMapping2_0

getSpecifiedMapKeyJoinColumns

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

Description copied from interface: CollectionMapping2_0

Return the specified map key join columns.

Specified by:

getSpecifiedMapKeyJoinColumns in interface CollectionMapping2_0

getSpecifiedMapKeyJoinColumn

OrmSpecifiedJoinColumn getSpecifiedMapKeyJoinColumn(int index)

Description copied from interface: CollectionMapping2_0

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

Specified by:

getSpecifiedMapKeyJoinColumn in interface CollectionMapping2_0

addSpecifiedMapKeyJoinColumn

OrmSpecifiedJoinColumn addSpecifiedMapKeyJoinColumn()

Description copied from interface: CollectionMapping2_0

Add a specified map key join column to the relationship.

Specified by:

addSpecifiedMapKeyJoinColumn in interface CollectionMapping2_0

addSpecifiedMapKeyJoinColumn

OrmSpecifiedJoinColumn addSpecifiedMapKeyJoinColumn(int index)

Description copied from interface: CollectionMapping2_0

Add a specified map key join column to the relationship.

Specified by:

addSpecifiedMapKeyJoinColumn in interface CollectionMapping2_0

getDefaultMapKeyJoinColumn

OrmSpecifiedJoinColumn getDefaultMapKeyJoinColumn()

Description copied from interface: CollectionMapping2_0

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.

Specified by:

getDefaultMapKeyJoinColumn in interface CollectionMapping2_0