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

Class DirectCollectionAccessor

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

Direct Known Subclasses:

BasicCollectionAccessor, ElementCollectionAccessor

public abstract class DirectCollectionAccessor
extends DirectAccessor

An abstract direct collection accessor. Used to support DirectCollection, DirectMap, AggregateCollection through the ElementCollection, BasicCollection and BasicMap metadata. 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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
java.lang.String	getBatchFetch() INTERNAL: Used for OX mapping.
java.lang.Integer	getBatchFetchSize() INTERNAL: Used for OX mapping.
java.lang.Boolean	getCascadeOnDelete() INTERNAL: Used for OX mapping.
CollectionTableMetadata	getCollectionTable() INTERNAL: Used for OX mapping.
java.lang.String	getDefaultFetchType() INTERNAL:
java.lang.String	getJoinFetch() INTERNAL: Used for OX mapping.
java.lang.Boolean	getNonCacheable() INTERNAL: Used for OX mapping.
java.lang.String	getPrivateOwned() INTERNAL: Used for OX mapping.
MetadataDescriptor	getReferenceDescriptor() INTERNAL: In a direct collection case, there is no notion of a reference descriptor, therefore we return this accessors descriptor.
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
java.lang.Boolean	isCascadeOnDelete() INTERNAL:
boolean	isDirectCollection() INTERNAL: Return true if this accessor represents a direct collection mapping, which include basic collection, basic map and element collection accessors.
boolean	isNonCacheable() INTERNAL: Used for OX mapping.
void	setBatchFetch(java.lang.String batchFetch) INTERNAL: Used for OX mapping.
void	setBatchFetchSize(java.lang.Integer batchFetchSize) INTERNAL: Used for OX mapping.
void	setCascadeOnDelete(java.lang.Boolean cascadeOnDelete) INTERNAL: Used for OX mapping.
void	setCollectionTable(CollectionTableMetadata collectionTable) INTERNAL: Used for OX mapping.
void	setJoinFetch(java.lang.String joinFetch) INTERNAL: Used for OX mapping.
void	setNonCacheable(java.lang.Boolean nonCacheable) INTERNAL: Used for OX mapping.

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

getConvert, getEnumerated, getEnumerated, getFetch, getLob, getLob, getOptional, getTemporal, getTemporal, hasEnumerated, hasLob, hasTemporal, isOptional, setConvert, setEnumerated, setFetch, setLob, setOptional, setTemporal

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

derivesId, getAttributeName, getAttributeType, getClassAccessor, getField, getGetMethodName, getMapKey, getMapKeyReferenceClass, getMapKeyReferenceClassName, getMapping, getOwningDescriptor, getOwningDescriptors, getRawClass, getReferenceAccessors, getReferenceClass, getReferenceClassFromGeneric, getReferenceClassName, getSetMethodName, hasAttributeType, hasMapKey, initXMLMappingAccessor, isAnnotationPresent, isBasic, isBasicCollection, isBasicMap, isCollectionAccessor, isDerivedIdClass, 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, getStructConverters, getTypeConverters, getUnionPartitioning, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, merge, process, processConverters, processPartitioned, setAccess, setAccessMethods, setConverters, setDescriptor, setHashPartitioning, setName, setObjectTypeConverters, setPartitioned, setPartitioning, setPinnedPartitioning, setProperties, setRangePartitioning, setReplicationPartitioning, setRoundRobinPartitioning, setStructConverters, setTypeConverters, setUnionPartitioning, setValuePartitioning

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

getAccessibleObjectName, getEntityMappings, getJavaClass, getJavaClassName, 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

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Overrides:

equals in class DirectAccessor

getBatchFetch

public java.lang.String getBatchFetch()

INTERNAL: Used for OX mapping.

getCascadeOnDelete

public java.lang.Boolean getCascadeOnDelete()

INTERNAL: Used for OX mapping.

getBatchFetchSize

public java.lang.Integer getBatchFetchSize()

INTERNAL: Used for OX mapping.

setBatchFetchSize

public void setBatchFetchSize(java.lang.Integer batchFetchSize)

INTERNAL: Used for OX mapping.

getCollectionTable

public CollectionTableMetadata getCollectionTable()

INTERNAL: Used for OX mapping.

getDefaultFetchType

public java.lang.String getDefaultFetchType()

INTERNAL:

Specified by:

getDefaultFetchType in class DirectAccessor

getJoinFetch

public java.lang.String getJoinFetch()

INTERNAL: Used for OX mapping.

getPrivateOwned

public java.lang.String getPrivateOwned()

INTERNAL: Used for OX mapping.

getReferenceDescriptor

public MetadataDescriptor getReferenceDescriptor()

INTERNAL: In a direct collection case, there is no notion of a reference descriptor, therefore we return this accessors descriptor.

Overrides:

getReferenceDescriptor in class MappingAccessor

getNonCacheable

public java.lang.Boolean getNonCacheable()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class DirectAccessor

isCascadeOnDelete

public java.lang.Boolean isCascadeOnDelete()

INTERNAL:

isDirectCollection

public boolean isDirectCollection()

INTERNAL: Return true if this accessor represents a direct collection mapping, which include basic collection, basic map and element collection accessors.

Overrides:

isDirectCollection in class MappingAccessor

isNonCacheable

public boolean isNonCacheable()

INTERNAL: Used for OX mapping.

setBatchFetch

public void setBatchFetch(java.lang.String batchFetch)

INTERNAL: Used for OX mapping.

setCascadeOnDelete

public void setCascadeOnDelete(java.lang.Boolean cascadeOnDelete)

INTERNAL: Used for OX mapping.

setCollectionTable

public void setCollectionTable(CollectionTableMetadata collectionTable)

INTERNAL: Used for OX mapping.

setNonCacheable

public void setNonCacheable(java.lang.Boolean nonCacheable)

INTERNAL: Used for OX mapping.

setJoinFetch

public void setJoinFetch(java.lang.String joinFetch)

INTERNAL: Used for OX mapping.