Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings

public Class ElementCollectionAccessor

extends DirectCollectionAccessor
implements MappedKeyMapAccessor
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappedKeyMapAccessor
Static Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataConstants.JPA_ASSOCIATION_OVERRIDE, .MetadataConstants.JPA_ASSOCIATION_OVERRIDES, .MetadataConstants.JPA_ATTRIBUTE_OVERRIDE, .MetadataConstants.JPA_ATTRIBUTE_OVERRIDES, .MetadataConstants.JPA_COLLECTION_TABLE, .MetadataConstants.JPA_COLUMN, .MetadataConstants.JPA_MAP_KEY, .MetadataConstants.JPA_MAP_KEY_CLASS, .MetadataConstants.JPA_MAP_KEY_COLUMN, .MetadataConstants.JPA_MAP_KEY_ENUMERATED, .MetadataConstants.JPA_MAP_KEY_JOIN_COLUMN, .MetadataConstants.JPA_MAP_KEY_JOIN_COLUMNS, .MetadataConstants.JPA_MAP_KEY_TEMPORAL, .MetadataConstants.JPA_ORDER_BY, .MetadataConstants.JPA_ORDER_COLUMN

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.
Author
Guy Pelletier
Since
EclipseLink 1.2

Field Summary

Modifier and TypeField and Description
private List<AssociationOverrideMetadata>
private List<AttributeOverrideMetadata>
private ColumnMetadata
private String
private Boolean
private MapKeyMetadata
private List<AssociationOverrideMetadata>
private List<AttributeOverrideMetadata>
private MetadataClass
private String
private ColumnMetadata
private String
private List<ConvertMetadata>
private EnumeratedMetadata
private ForeignKeyMetadata
private List<JoinColumnMetadata>
private TemporalMetadata
private OrderByMetadata
private OrderColumnMetadata
private MetadataClass
private MetadataClass
private String

Constructor Summary

AccessConstructor and Description
public
ElementCollectionAccessor()

INTERNAL: Used for OX mapping.

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

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
protected void
protected void
addAttributeOverride(AttributeOverrideMetadata attributeOverride)

INTERNAL:

public void
public boolean
equals(Object
the reference object with which to compare.
objectToCompare
)

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

INTERNAL:
public List<AssociationOverrideMetadata>
getAssociationOverrides()

INTERNAL: Used for OX mapping.

public List<AttributeOverrideMetadata>
getAttributeOverrides()

INTERNAL: Used for OX mapping.

public ColumnMetadata
getColumn()

INTERNAL: Used for OX mapping.

protected ColumnMetadata
public String
getCompositeMember()

INTERNAL: Used for OX mapping.

protected DatabaseTable
getDefaultTableForEntityMapKey()

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

INTERNAL: Return the default table to hold the foreign key of a MapKey when and Entity is used as the MapKey
public Boolean
getDeleteAll()

INTERNAL: Used for OX mapping.

public EmbeddableAccessor
public EnumeratedMetadata
getEnumerated(boolean isForMapKey)

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

INTERNAL: Return the enumerated metadata for this accessor.
protected String
public MapKeyMetadata
public List<AssociationOverrideMetadata>
public List<AttributeOverrideMetadata>
public MetadataClass
getMapKeyClass()

Implements org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappedKeyMapAccessor.getMapKeyClass.

INTERNAL: Return the map key class on this element collection accessor.
public String
getMapKeyClassName()

INTERNAL: Used for OX mapping.

public MetadataClass
getMapKeyClassWithGenerics()

Implements org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappedKeyMapAccessor.getMapKeyClassWithGenerics.

INTERNAL: Future: this method is where we would provide a more explicit reference class to support an auto-apply jpa converter.
public ColumnMetadata
public String
public List<ConvertMetadata>
public EnumeratedMetadata
getMapKeyEnumerated()

INTERNAL: Used for OX mapping.

public ForeignKeyMetadata
public List<JoinColumnMetadata>
public TemporalMetadata
getMapKeyTemporal()

INTERNAL: Used for OX mapping.

public OrderByMetadata
getOrderBy()

INTERNAL: Used for OX mapping.

public OrderColumnMetadata
getOrderColumn()

INTERNAL: Used for OX mapping.

public MetadataClass
getReferenceClass()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.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.
public MetadataDescriptor
getReferenceDescriptor()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectCollectionAccessor.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
protected MetadataClass
getTargetClass()

INTERNAL: Return the target class for this accessor.

protected String
getTargetClassName()

INTERNAL: Used for OX mapping.

public TemporalMetadata
getTemporal(boolean isForMapKey)

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

INTERNAL: Return the temporal metadata for this accessor.
public boolean
hasEnumerated(boolean isForMapKey)

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

INTERNAL: Return true if this accessor has enumerated metadata.
public int
public boolean
hasLob(boolean isForMapKey)

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

INTERNAL: Return true if this accessor has lob metadata.
public boolean
protected boolean
hasMapKeyClass()

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

INTERNAL: Return true if this accessor has a map key class specified.
public boolean
hasTemporal(boolean isForMapKey)

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

INTERNAL: Return true if this accessor has temporal metadata.
public void
public boolean
isDeleteAll()

INTERNAL: Used by our XML writing facility.

public boolean
isDirectEmbeddableCollection()

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

INTERNAL: Return true if this element collection contains embeddable objects.
public void
process()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor.process.

INTERNAL: Process the element collection metadata.
protected void
protected void
protected void
processMappingsFromEmbeddable(MetadataDescriptor embeddableDescriptor, AggregateObjectMapping nestedAggregateObjectMapping, EmbeddableMapping embeddableMapping, Map<String, AttributeOverrideMetadata> attributeOverrides, Map<String, AssociationOverrideMetadata> associationOverrides, String dotNotationName)

INTERNAL:

protected void
processMappingValueConverters(final MetadataDescriptor
Metadata descriptor for embedded collection.
embeddableDescriptor
)

INTERNAL: Process convertors registered for collection mapping.

public void
setAssociationOverrides(List<AssociationOverrideMetadata> associationOverrides)

INTERNAL: Used for OX mapping.

public void
setAttributeOverrides(List<AttributeOverrideMetadata> attributeOverrides)

INTERNAL: Used for OX mapping.

public void
setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

public void
setCompositeMember(String compositeMember)

INTERNAL: Used for OX mapping.

public void
setDeleteAll(Boolean deleteAll)

INTERNAL: Used for OX mapping.

public void
setMapKey(MapKeyMetadata mapKey)

INTERNAL: Used for OX mapping.

public void
setMapKeyAssociationOverrides(List<AssociationOverrideMetadata> mapKeyAssociationOverrides)

INTERNAL: Used for OX mapping.

public void
setMapKeyAttributeOverrides(List<AttributeOverrideMetadata> mapKeyAttributeOverrides)

INTERNAL: Used for OX mapping.

public void
public void
setMapKeyClassName(String mapKeyClassName)

INTERNAL: Used for OX mapping.

public void
setMapKeyColumn(ColumnMetadata mapKeyColumn)

INTERNAL: Used for OX mapping.

public void
setMapKeyConverts(List<ConvertMetadata> mapKeyConverts)

INTERNAL: Used for OX mapping.

public void
setMapKeyEnumerated(EnumeratedMetadata mapKeyEnumerated)

INTERNAL: Used for OX mapping.

public void
setMapKeyForeignKey(ForeignKeyMetadata mapKeyForeignKey)

INTERNAL: Used for OX mapping.

public void
setMapKeyJoinColumns(List<JoinColumnMetadata> mapKeyJoinColumns)

INTERNAL: Used for OX mapping.

public void
setMapKeyTemporal(TemporalMetadata mapKeyTemporal)

INTERNAL: Used for OX mapping.

public void
setOrderBy(OrderByMetadata orderBy)

INTERNAL: Used for OX mapping.

public void
setOrderColumn(OrderColumnMetadata orderColumn)

INTERNAL: Used for OX mapping.

public void
setTargetClassName(String targetClassName)

INTERNAL: Used for OX mapping.

public void
setTemporal(TemporalMetadata metadata, boolean isForMapKey)

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

INTERNAL: Set the temporal metadata for this accessor.
Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectCollectionAccessor:
getBatchFetchgetCascadeOnDeletegetCollectionTablegetDefaultCollectionTableNamegetDefaultFetchTypegetJoinFetchgetNonCacheablegetPrivateOwnedgetReferenceDatabaseTablegetValueConverterisCascadeOnDeleteisDirectCollectionisNonCacheableisValidDirectCollectionTypeisValidDirectMapTypeprocessprocessBatchFetchprocessDirectCollectionMappingprocessDirectMapMappingsetBatchFetchsetCascadeOnDeletesetCollectionTablesetJoinFetchsetNonCacheable