org.eclipse.persistence.internal.jpa.metadata.accessors.mappings

Class ElementCollectionAccessor

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectCollectionAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.ElementCollectionAccessor

All Implemented Interfaces:

MappedKeyMapAccessor

public class ElementCollectionAccessor
extends DirectCollectionAccessor
implements MappedKeyMapAccessor

An element collection accessor. Used to support DirectCollection, DirectMap, AggregateCollection. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be handled in the merge method. (merging is done at the accessor/mapping level) - any metadata mapped from XML to this class must be initialized in the initXMLObject method. - methods should be preserved in alphabetical order.

Since:

EclipseLink 1.2

Author:

Guy Pelletier

Constructor Summary

Constructors

Constructor and Description
ElementCollectionAccessor() INTERNAL: Used for OX mapping.
ElementCollectionAccessor(MetadataAnnotation elementCollection, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor) INTERNAL:

Method Summary

Modifier and Type	Method and Description
void	addMapKeyConvert(ConvertMetadata convert) INTERNAL: A map key convert from an annotation specification.
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
java.util.List<AssociationOverrideMetadata>	getAssociationOverrides() INTERNAL: Used for OX mapping.
java.util.List<AttributeOverrideMetadata>	getAttributeOverrides() INTERNAL: Used for OX mapping.
ColumnMetadata	getColumn() INTERNAL: Used for OX mapping.
java.lang.String	getCompositeMember() INTERNAL: Used for OX mapping.
java.lang.Boolean	getDeleteAll() INTERNAL: Used for OX mapping.
EmbeddableAccessor	getEmbeddableAccessor() INTERNAL:
EnumeratedMetadata	getEnumerated(boolean isForMapKey) INTERNAL: Return the enumerated metadata for this accessor.
MapKeyMetadata	getMapKey() INTERNAL: Used for OX mapping.
java.util.List<AssociationOverrideMetadata>	getMapKeyAssociationOverrides() INTERNAL: Used for OX mapping.
java.util.List<AttributeOverrideMetadata>	getMapKeyAttributeOverrides() INTERNAL: Used for OX mapping.
MetadataClass	getMapKeyClass() INTERNAL: Return the map key class on this element collection accessor.
java.lang.String	getMapKeyClassName() INTERNAL: Used for OX mapping.
MetadataClass	getMapKeyClassWithGenerics() INTERNAL: Future: this method is where we would provide a more explicit reference class to support an auto-apply jpa converter.
ColumnMetadata	getMapKeyColumn() INTERNAL: Used for OX mapping.
java.lang.String	getMapKeyConvert() INTERNAL:
java.util.List<ConvertMetadata>	getMapKeyConverts() INTERNAL: Used for OX mapping.
EnumeratedMetadata	getMapKeyEnumerated() INTERNAL: Used for OX mapping.
ForeignKeyMetadata	getMapKeyForeignKey() INTERNAL: Used for OX mapping.
java.util.List<JoinColumnMetadata>	getMapKeyJoinColumns() INTERNAL: Used for OX mapping.
TemporalMetadata	getMapKeyTemporal() INTERNAL: Used for OX mapping.
OrderByMetadata	getOrderBy() INTERNAL: Used for OX mapping.
OrderColumnMetadata	getOrderColumn() INTERNAL: Used for OX mapping.
MetadataClass	getReferenceClass() INTERNAL: If a targetEntity is specified in metadata, it will be set as the reference class, otherwise we will look to extract one from generics.
MetadataDescriptor	getReferenceDescriptor() INTERNAL: In an element collection case, when the collection is not an embeddable collection, there is no notion of a reference descriptor, therefore we return this accessors descriptor
TemporalMetadata	getTemporal(boolean isForMapKey) INTERNAL: Return the temporal metadata for this accessor.
boolean	hasEnumerated(boolean isForMapKey) INTERNAL: Return true if this accessor has enumerated metadata.
boolean	hasLob(boolean isForMapKey) INTERNAL: Return true if this accessor has lob metadata.
boolean	hasMapKey() INTERNAL:
boolean	hasTemporal(boolean isForMapKey) INTERNAL: Return true if this accessor has temporal metadata.
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
boolean	isDeleteAll() INTERNAL: Used by our XML writing facility.
boolean	isDirectEmbeddableCollection() INTERNAL: Return true if this element collection contains embeddable objects.
void	process() INTERNAL: Process the element collection metadata.
void	setAssociationOverrides(java.util.List<AssociationOverrideMetadata> associationOverrides) INTERNAL: Used for OX mapping.
void	setAttributeOverrides(java.util.List<AttributeOverrideMetadata> attributeOverrides) INTERNAL: Used for OX mapping.
void	setColumn(ColumnMetadata column) INTERNAL: Used for OX mapping.
void	setCompositeMember(java.lang.String compositeMember) INTERNAL: Used for OX mapping.
void	setDeleteAll(java.lang.Boolean deleteAll) INTERNAL: Used for OX mapping.
void	setMapKey(MapKeyMetadata mapKey) INTERNAL: Used for OX mapping.
void	setMapKeyAssociationOverrides(java.util.List<AssociationOverrideMetadata> mapKeyAssociationOverrides) INTERNAL: Used for OX mapping.
void	setMapKeyAttributeOverrides(java.util.List<AttributeOverrideMetadata> mapKeyAttributeOverrides) INTERNAL: Used for OX mapping.
void	setMapKeyClass(MetadataClass mapKeyClass) INTERNAL:
void	setMapKeyClassName(java.lang.String mapKeyClassName) INTERNAL: Used for OX mapping.
void	setMapKeyColumn(ColumnMetadata mapKeyColumn) INTERNAL: Used for OX mapping.
void	setMapKeyConverts(java.util.List<ConvertMetadata> mapKeyConverts) INTERNAL: Used for OX mapping.
void	setMapKeyEnumerated(EnumeratedMetadata mapKeyEnumerated) INTERNAL: Used for OX mapping.
void	setMapKeyForeignKey(ForeignKeyMetadata mapKeyForeignKey) INTERNAL: Used for OX mapping.
void	setMapKeyJoinColumns(java.util.List<JoinColumnMetadata> mapKeyJoinColumns) INTERNAL: Used for OX mapping.
void	setMapKeyTemporal(TemporalMetadata mapKeyTemporal) INTERNAL: Used for OX mapping.
void	setOrderBy(OrderByMetadata orderBy) INTERNAL: Used for OX mapping.
void	setOrderColumn(OrderColumnMetadata orderColumn) INTERNAL: Used for OX mapping.
void	setTargetClassName(java.lang.String targetClassName) INTERNAL: Used for OX mapping.
void	setTemporal(TemporalMetadata metadata, boolean isForMapKey) INTERNAL: Set the temporal metadata for this accessor.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectCollectionAccessor

getBatchFetch, getCascadeOnDelete, getCollectionTable, getDefaultFetchType, getJoinFetch, getNonCacheable, getPrivateOwned, isCascadeOnDelete, isDirectCollection, isNonCacheable, setBatchFetch, setCascadeOnDelete, setCollectionTable, setJoinFetch, setNonCacheable

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor

getConvert, getConverts, getEnumerated, getFetch, getLob, getLob, getOptional, getTemporal, isOptional, setConverts, setEnumerated, setFetch, setLob, setOptional, setTemporal

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor

derivesId, getAttributeName, getAttributeType, getClassAccessor, getField, getGetMethodName, getMapKeyReferenceClass, getMapKeyReferenceClassName, getMapKeyReferenceClassWithGenerics, getMapping, getOwningDescriptor, getOwningDescriptors, getRawClass, getRawClassWithGenerics, getReferenceAccessors, getReferenceClassFromGeneric, getReferenceClassName, getReferenceClassWithGenerics, getSetMethodName, hasAttributeType, initXMLMappingAccessor, isAnnotationPresent, isBasic, isBasicCollection, isBasicMap, isCollectionAccessor, isDerivedIdClass, isEmbedded, isEmbeddedId, isId, isManyToMany, isManyToOne, isMapAccessor, isMappedKeyMapAccessor, isMultitenantId, isOneToMany, isOneToOne, isProcessed, isRelationship, isSerialized, isTransient, isVariableOneToOne, setAttributeType, setClassAccessor, setField, toString, usesFieldAccess, usesPropertyAccess, usesVirtualAccess

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getConverters, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getIdentifier, getJavaClass, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, merge, processConverters, processPartitioned, setAccess, setAccessMethods, setConverters, setDescriptor, setHashPartitioning, setName, setObjectTypeConverters, setPartitioned, setPartitioning, setPinnedPartitioning, setProperties, setRangePartitioning, setReplicationPartitioning, setRoundRobinPartitioning, setSerializedConverters, setStructConverters, setTypeConverters, setUnionPartitioning, setValuePartitioning

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ElementCollectionAccessor

public ElementCollectionAccessor()

INTERNAL: Used for OX mapping.

ElementCollectionAccessor

public ElementCollectionAccessor(MetadataAnnotation elementCollection,
                                 MetadataAccessibleObject accessibleObject,
                                 ClassAccessor classAccessor)

INTERNAL:

Method Detail

addMapKeyConvert

public void addMapKeyConvert(ConvertMetadata convert)

INTERNAL: A map key convert from an annotation specification. In XML, this list is populated using the map-key-convert element. In annotations there is only a single Convert annotation and map key converts are identified with an attribute name on the convert beginning with "key".

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Overrides:

equals in class DirectCollectionAccessor

getAssociationOverrides

public java.util.List<AssociationOverrideMetadata> getAssociationOverrides()

INTERNAL: Used for OX mapping.

getAttributeOverrides

public java.util.List<AttributeOverrideMetadata> getAttributeOverrides()

INTERNAL: Used for OX mapping.

getColumn

public ColumnMetadata getColumn()

INTERNAL: Used for OX mapping.

getCompositeMember

public java.lang.String getCompositeMember()

INTERNAL: Used for OX mapping.

getDeleteAll

public java.lang.Boolean getDeleteAll()

INTERNAL: Used for OX mapping.

getEmbeddableAccessor

public EmbeddableAccessor getEmbeddableAccessor()

INTERNAL:

getEnumerated

public EnumeratedMetadata getEnumerated(boolean isForMapKey)

INTERNAL: Return the enumerated metadata for this accessor.

Overrides:

getEnumerated in class DirectAccessor

See Also:

DirectAccessor, ElementCollectionAccessor, CollectionAccessor

getMapKey

public MapKeyMetadata getMapKey()

INTERNAL: Used for OX mapping.

Specified by:

getMapKey in interface MappedKeyMapAccessor

Overrides:

getMapKey in class MappingAccessor

See Also:

CollectionAccessor, ElementCollectionAccessor

getMapKeyClass

public MetadataClass getMapKeyClass()

INTERNAL: Return the map key class on this element collection accessor.

Specified by:

getMapKeyClass in interface MappedKeyMapAccessor

getMapKeyClassWithGenerics

public MetadataClass getMapKeyClassWithGenerics()

INTERNAL: Future: this method is where we would provide a more explicit reference class to support an auto-apply jpa converter. Per the spec auto-apply converters are applied against basics only.

Specified by:

getMapKeyClassWithGenerics in interface MappedKeyMapAccessor

getMapKeyAssociationOverrides

public java.util.List<AssociationOverrideMetadata> getMapKeyAssociationOverrides()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyAssociationOverrides in interface MappedKeyMapAccessor

getMapKeyAttributeOverrides

public java.util.List<AttributeOverrideMetadata> getMapKeyAttributeOverrides()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyAttributeOverrides in interface MappedKeyMapAccessor

getMapKeyClassName

public java.lang.String getMapKeyClassName()

INTERNAL: Used for OX mapping.

getMapKeyColumn

public ColumnMetadata getMapKeyColumn()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyColumn in interface MappedKeyMapAccessor

getMapKeyConvert

public java.lang.String getMapKeyConvert()

INTERNAL:

Specified by:

getMapKeyConvert in interface MappedKeyMapAccessor

getMapKeyConverts

public java.util.List<ConvertMetadata> getMapKeyConverts()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyConverts in interface MappedKeyMapAccessor

getMapKeyEnumerated

public EnumeratedMetadata getMapKeyEnumerated()

INTERNAL: Used for OX mapping.

getMapKeyForeignKey

public ForeignKeyMetadata getMapKeyForeignKey()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyForeignKey in interface MappedKeyMapAccessor

getMapKeyJoinColumns

public java.util.List<JoinColumnMetadata> getMapKeyJoinColumns()

INTERNAL: Used for OX mapping.

Specified by:

getMapKeyJoinColumns in interface MappedKeyMapAccessor

getMapKeyTemporal

public TemporalMetadata getMapKeyTemporal()

INTERNAL: Used for OX mapping.

getOrderBy

public OrderByMetadata getOrderBy()

INTERNAL: Used for OX mapping.

getOrderColumn

public OrderColumnMetadata getOrderColumn()

INTERNAL: Used for OX mapping.

getReferenceClass

public MetadataClass getReferenceClass()

INTERNAL: If a targetEntity is specified in metadata, it will be set as the reference class, otherwise we will look to extract one from generics.

MappedSuperclass descriptors return Void when their parameterized generic reference class is null

Overrides:

getReferenceClass in class MappingAccessor

getReferenceDescriptor

public MetadataDescriptor getReferenceDescriptor()

INTERNAL: In an element collection case, when the collection is not an embeddable collection, there is no notion of a reference descriptor, therefore we return this accessors descriptor

Overrides:

getReferenceDescriptor in class DirectCollectionAccessor

getTemporal

public TemporalMetadata getTemporal(boolean isForMapKey)

INTERNAL: Return the temporal metadata for this accessor.

Overrides:

getTemporal in class DirectAccessor

See Also:

DirectAccessor, CollectionAccessor

hasEnumerated

public boolean hasEnumerated(boolean isForMapKey)

INTERNAL: Return true if this accessor has enumerated metadata.

Overrides:

hasEnumerated in class DirectAccessor

See Also:

DirectAccessor, ElementCollectionAccessor, CollectionAccessor

hasLob

public boolean hasLob(boolean isForMapKey)

INTERNAL: Return true if this accessor has lob metadata.

Overrides:

hasLob in class DirectAccessor

See Also:

DirectAccessor, ElementCollectionAccessor, CollectionAccessor

hasMapKey

public boolean hasMapKey()

INTERNAL:

Overrides:

hasMapKey in class MappingAccessor

See Also:

CollectionAccessor, ElementCollectionAccessor, BasicMapAccessor

hasTemporal

public boolean hasTemporal(boolean isForMapKey)

INTERNAL: Return true if this accessor has temporal metadata.

Overrides:

hasTemporal in class DirectAccessor

See Also:

DirectAccessor, ElementCollectionAccessor, CollectionAccessor

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class DirectCollectionAccessor

isDeleteAll

public boolean isDeleteAll()

INTERNAL: Used by our XML writing facility. Returns false unless m_deleteAll is both set and true

isDirectEmbeddableCollection

public boolean isDirectEmbeddableCollection()

INTERNAL: Return true if this element collection contains embeddable objects.

Overrides:

isDirectEmbeddableCollection in class MappingAccessor

process

public void process()

INTERNAL: Process the element collection metadata.

Specified by:

process in class MetadataAccessor

setAssociationOverrides

public void setAssociationOverrides(java.util.List<AssociationOverrideMetadata> associationOverrides)

INTERNAL: Used for OX mapping.

setAttributeOverrides

public void setAttributeOverrides(java.util.List<AttributeOverrideMetadata> attributeOverrides)

INTERNAL: Used for OX mapping.

setColumn

public void setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

setCompositeMember

public void setCompositeMember(java.lang.String compositeMember)

INTERNAL: Used for OX mapping.

setDeleteAll

public void setDeleteAll(java.lang.Boolean deleteAll)

INTERNAL: Used for OX mapping.

setMapKey

public void setMapKey(MapKeyMetadata mapKey)

INTERNAL: Used for OX mapping.

setMapKeyAssociationOverrides

public void setMapKeyAssociationOverrides(java.util.List<AssociationOverrideMetadata> mapKeyAssociationOverrides)

INTERNAL: Used for OX mapping.

setMapKeyAttributeOverrides

public void setMapKeyAttributeOverrides(java.util.List<AttributeOverrideMetadata> mapKeyAttributeOverrides)

INTERNAL: Used for OX mapping.

setMapKeyClass

public void setMapKeyClass(MetadataClass mapKeyClass)

INTERNAL:

Specified by:

setMapKeyClass in interface MappedKeyMapAccessor

setMapKeyClassName

public void setMapKeyClassName(java.lang.String mapKeyClassName)

INTERNAL: Used for OX mapping.

setMapKeyColumn

public void setMapKeyColumn(ColumnMetadata mapKeyColumn)

INTERNAL: Used for OX mapping.

setMapKeyConverts

public void setMapKeyConverts(java.util.List<ConvertMetadata> mapKeyConverts)

INTERNAL: Used for OX mapping.

setMapKeyEnumerated

public void setMapKeyEnumerated(EnumeratedMetadata mapKeyEnumerated)

INTERNAL: Used for OX mapping.

setMapKeyForeignKey

public void setMapKeyForeignKey(ForeignKeyMetadata mapKeyForeignKey)

INTERNAL: Used for OX mapping.

setMapKeyJoinColumns

public void setMapKeyJoinColumns(java.util.List<JoinColumnMetadata> mapKeyJoinColumns)

INTERNAL: Used for OX mapping.

setMapKeyTemporal

public void setMapKeyTemporal(TemporalMetadata mapKeyTemporal)

INTERNAL: Used for OX mapping.

setTemporal

public void setTemporal(TemporalMetadata metadata,
                        boolean isForMapKey)

Description copied from class: MappingAccessor

INTERNAL: Set the temporal metadata for this accessor.

Overrides:

setTemporal in class DirectAccessor

See Also:

DirectAccessor, CollectionAccessor

setOrderBy

public void setOrderBy(OrderByMetadata orderBy)

INTERNAL: Used for OX mapping.

setOrderColumn

public void setOrderColumn(OrderColumnMetadata orderColumn)

INTERNAL: Used for OX mapping.

setTargetClassName

public void setTargetClassName(java.lang.String targetClassName)

INTERNAL: Used for OX mapping.