CollectionAccessor (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

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.RelationshipAccessor
      - org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.CollectionAccessor

All Implemented Interfaces:

MappedKeyMapAccessor

Direct Known Subclasses:

ManyToManyAccessor, OneToManyAccessor
```
public abstract class CollectionAccessor
extends RelationshipAccessor
implements MappedKeyMapAccessor
```
INTERNAL: A relational collection mapping accessor. 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:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Method Summary

All Methods Instance Methods Concrete Methods
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.lang.String`	`getDefaultFetchType()` INTERNAL: Return the default fetch type for a collection mapping.
`java.lang.Boolean`	`getDeleteAll()` INTERNAL: Used for OX mapping.
`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:
`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.
`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.
`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`	`hasMapKey()` INTERNAL:
`boolean`	`hasTemporal(boolean isForMapKey)` INTERNAL: Return true if this accessor has temporal metadata.
`void`	`initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)` INTERNAL:
`boolean`	`isCollectionAccessor()` INTERNAL: Return true if this accessor represents a collection accessor.
`boolean`	`isDeleteAll()` INTERNAL: Used by our XML writing facility.
`void`	`process()` INTERNAL: This process should do any common validation processing of collection accessors.
`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`	`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.RelationshipAccessor
getBatchFetch, getCascade, getCascadeOnDelete, getFetch, getForeignKey, getJoinColumns, getJoinFetch, getJoinFields, getJoinTable, getMappedBy, getNonCacheable, getOrphanRemoval, getPrivateOwned, getReferenceDescriptor, getTargetEntity, getTargetEntityName, hasMappedBy, isCascadeOnDelete, isLazy, isNonCacheable, isPrivateOwned, isValueHolderInterface, setBatchFetch, setCascade, setCascadeOnDelete, setFetch, setForeignKey, setJoinColumns, setJoinFetch, setJoinFields, setJoinTable, setMappedBy, setNonCacheable, setOrphanRemoval, setPrivateOwned, setTargetEntity, setTargetEntityName

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor
derivesId, getAttributeName, getAttributeType, getClassAccessor, getField, getGetMethodName, getLob, getMapKeyReferenceClass, getMapKeyReferenceClassName, getMapKeyReferenceClassWithGenerics, getMapping, getOwningDescriptor, getOwningDescriptors, getRawClass, getRawClassWithGenerics, getReferenceAccessors, getReferenceClassFromGeneric, getReferenceClassName, getReferenceClassWithGenerics, getSetMethodName, hasAttributeType, initXMLMappingAccessor, isAnnotationPresent, isBasic, isBasicCollection, isBasicMap, isDerivedIdClass, isDirectCollection, isDirectEmbeddableCollection, 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

- 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 RelationshipAccessor
  - getDefaultFetchType
```
public java.lang.String getDefaultFetchType()
```
    INTERNAL: Return the default fetch type for a collection mapping.
    
    Specified by:
    
    getDefaultFetchType in class RelationshipAccessor
  - getDeleteAll
```
public java.lang.Boolean getDeleteAll()
```
    INTERNAL: Used for OX mapping.
  - getEnumerated
```
public EnumeratedMetadata getEnumerated(boolean isForMapKey)
```
    INTERNAL: Return the enumerated metadata for this accessor.
    
    Overrides:
    
    getEnumerated in class MappingAccessor
    
    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
  - 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
  - getMapKeyClass
```
public MetadataClass getMapKeyClass()
```
    INTERNAL:
    
    Specified by:
    
    getMapKeyClass in interface MappedKeyMapAccessor
  - getMapKeyClassName
```
public java.lang.String getMapKeyClassName()
```
    INTERNAL: Used for OX mapping.
  - 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
  - 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.
  - 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.
    
    Overrides:
    
    getReferenceClass in class MappingAccessor
  - getTemporal
```
public TemporalMetadata getTemporal(boolean isForMapKey)
```
    INTERNAL: Return the temporal metadata for this accessor.
    
    Overrides:
    
    getTemporal in class MappingAccessor
    
    See Also:
    
    DirectAccessor, CollectionAccessor
  - setTemporal
```
public void setTemporal(TemporalMetadata metadata,
                        boolean isForMapKey)
```
    Description copied from class: MappingAccessor
    
    INTERNAL: Set the temporal metadata for this accessor.
    
    See Also:
    
    DirectAccessor, CollectionAccessor
  - hasEnumerated
```
public boolean hasEnumerated(boolean isForMapKey)
```
    INTERNAL: Return true if this accessor has enumerated metadata.
    
    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 MappingAccessor
    
    See Also:
    
    DirectAccessor, ElementCollectionAccessor, CollectionAccessor
  - isCollectionAccessor
```
public boolean isCollectionAccessor()
```
    INTERNAL: Return true if this accessor represents a collection accessor.
    
    Overrides:
    
    isCollectionAccessor in class MappingAccessor
  - isDeleteAll
```
public boolean isDeleteAll()
```
    INTERNAL: Used by our XML writing facility. Returns false unless m_deleteAll is both set and true
  - initXMLObject
```
public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)
```
    INTERNAL:
    
    Overrides:
    
    initXMLObject in class RelationshipAccessor
  - process
```
public void process()
```
    INTERNAL: This process should do any common validation processing of collection accessors.
    
    Overrides:
    
    process in class RelationshipAccessor
  - 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.
  - setOrderBy
```
public void setOrderBy(OrderByMetadata orderBy)
```
    INTERNAL: Used for OX mapping.
  - setOrderColumn
```
public void setOrderColumn(OrderColumnMetadata orderColumn)
```
    INTERNAL: Used for OX mapping.

Class CollectionAccessor

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Method Detail

addMapKeyConvert

equals

getDefaultFetchType

getDeleteAll

getEnumerated

getMapKey

getMapKeyAssociationOverrides

getMapKeyAttributeOverrides

getMapKeyClass

getMapKeyClassName

getMapKeyClassWithGenerics

getMapKeyColumn

getMapKeyConvert

getMapKeyConverts

getMapKeyEnumerated

getMapKeyForeignKey

getMapKeyJoinColumns

getMapKeyTemporal

getOrderBy

getReferenceClass

getTemporal

setTemporal

hasEnumerated

hasMapKey

hasTemporal

isCollectionAccessor

isDeleteAll

initXMLObject

process

setDeleteAll

setMapKey

setMapKeyAssociationOverrides

setMapKeyAttributeOverrides

setMapKeyClass

setMapKeyClassName

setMapKeyColumn

setMapKeyConverts

setMapKeyEnumerated

setMapKeyForeignKey

setMapKeyJoinColumns

setMapKeyTemporal

setOrderBy

setOrderColumn