AbstractCompositeCollectionMapping (Oracle Fusion Middleware Java API Reference for Oracle TopLink)

java.lang.Object
- org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField>
- - org.eclipse.persistence.mappings.DatabaseMapping
  - - org.eclipse.persistence.mappings.AggregateMapping
    - - org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ContainerMapping, ArrayCollectionMapping

Direct Known Subclasses:

EISCompositeCollectionMapping, ObjectArrayMapping, XMLCompositeCollectionMapping
```
public abstract class AbstractCompositeCollectionMapping
extends AggregateMapping
implements ContainerMapping, ArrayCollectionMapping
```
Define an embedded collection of objects. This is used in structured data-types, such as EIS, NoSQL and object-relational Array (varray, nested table) data-types. The target objects must be aggregate (embedded) and are stored with the parent object.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping
  DatabaseMapping.WriteType

Constructor Summary

Constructors
Constructor and Description

AbstractCompositeCollectionMapping()
Default constructor.

Constructors
Constructor and Description
`AbstractCompositeCollectionMapping()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`buildAddedElementFromChangeSet(java.lang.Object changeSet, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Build and return a new element based on the change set.
`java.lang.Object`	`buildChangeSet(java.lang.Object element, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Build and return a change set for the specified element.
`java.lang.Object`	`buildElementFromElement(java.lang.Object element, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Build and return a new element based on the specified element.
`Expression`	`buildExpression(java.lang.Object queryObject, QueryByExamplePolicy policy, Expression expressionBuilder, java.util.Map processedObjects, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: In case Query By Example is used, this method builds and returns an expression that corresponds to a single attribute and it's value.
`java.lang.Object`	`buildRemovedElementFromChangeSet(java.lang.Object changeSet, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Build and return a new element based on the change set.
`void`	`cascadeDiscoverAndPersistUnregisteredNewObjects(java.lang.Object object, java.util.Map newObjects, java.util.Map unregisteredExistingObjects, java.util.Map visitedObjects, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Set cascadeErrors)` INTERNAL: Cascade discover and persist new objects during commit.
`void`	`cascadePerformRemoveIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade perform delete through mappings that require the cascade
`void`	`cascadeRegisterNewIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade registerNew for Create through mappings that require the cascade
`boolean`	`compareElements(java.lang.Object element1, java.lang.Object element2, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Compare the non-null elements and return true if they are alike.
`boolean`	`compareElementsForChange(java.lang.Object element1, java.lang.Object element2, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Compare the non-null elements and return true if they are alike.
`org.eclipse.persistence.internal.sessions.ChangeRecord`	`compareForChange(java.lang.Object clone, java.lang.Object backup, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Build and return the change record that results from comparing the two direct collection attributes.
`boolean`	`compareObjects(java.lang.Object object1, java.lang.Object object2, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Compare the attributes belonging to this mapping for the objects.
`void`	`convertClassNamesToClasses(java.lang.ClassLoader classLoader)` INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings.
`java.lang.Object`	`createMapComponentFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow, ObjectBuildingQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, org.eclipse.persistence.internal.sessions.AbstractSession session, boolean isTargetProtected)` INTERNAL Called when a DatabaseMapping is used to map the key in a collection.
`org.eclipse.persistence.internal.queries.ContainerPolicy`	`getContainerPolicy()` INTERNAL: Return the mapping's containerPolicy.
`Converter`	`getConverter()` PUBLIC: Return the converter on the mapping.
`org.eclipse.persistence.internal.helper.DatabaseField`	`getField()` INTERNAL: Return the field mapped by this mapping.
`java.lang.Object`	`getRealCollectionAttributeValueFromObject(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Convenience method.
`boolean`	`hasConverter()` PUBLIC: Indicates if there is a converter on the mapping.
`void`	`initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: The mapping is initialized with the given session.
`boolean`	`isAbstractCompositeCollectionMapping()` INTERNAL:
`boolean`	`isCollectionMapping()` INTERNAL: Related mapping should implement this method to return true.
`boolean`	`mapKeyHasChanged(java.lang.Object element, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Return whether the element's user-defined Map key has changed since it was cloned from the original version.
`void`	`mergeChangesIntoObject(java.lang.Object target, org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, java.lang.Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Merge changes from the source to the target object.
`void`	`mergeIntoObject(java.lang.Object target, boolean isTargetUnInitialized, java.lang.Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Merge changes from the source to the target object.
`void`	`postDeleteAttributeValue(DeleteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`postInsertAttributeValue(WriteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`postUpdateAttributeValue(WriteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`preDeleteAttributeValue(DeleteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`preInsertAttributeValue(WriteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`preUpdateAttributeValue(WriteObjectQuery query, java.lang.Object attributeValue)` The message is passed to its reference class descriptor.
`void`	`setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)` ADVANCED: Set the mapping's containerPolicy.
`void`	`setConverter(Converter converter)` PUBLIC: Set the converter on the mapping.
`void`	`setField(org.eclipse.persistence.internal.helper.DatabaseField field)` Set the field in the mapping.
`void`	`simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToAdd, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.AbstractSession session)` ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
`void`	`simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object changeSetToRemove, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.AbstractSession session)` ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
`void`	`useCollectionClass(java.lang.Class concreteContainerClass)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useCollectionClassName(java.lang.String concreteContainerClassName)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useListClassName(java.lang.String concreteContainerClassName)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useMapClass(java.lang.Class concreteContainerClass, java.lang.String methodName)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useMapClassName(java.lang.String concreteContainerClassName, java.lang.String methodName)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`java.lang.Object`	`valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected, java.lang.Boolean[] wasCacheUsed)` INTERNAL: Build and return an aggregate collection from the specified row.
`void`	`writeFromObjectIntoRow(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)` INTERNAL: Get the attribute value from the object and add the appropriate values to the specified database row.
`void`	`writeFromObjectIntoRowForUpdate(WriteObjectQuery writeQuery, org.eclipse.persistence.internal.sessions.AbstractRecord row)` INTERNAL: Get the attribute value from the object and add the changed values to the specified database row.
`void`	`writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)` INTERNAL: Get the attribute value from the object and add the appropriate values to the specified database row.
`void`	`writeInsertFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Write fields needed for insert into the template with null values.

Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping
buildBackupClone, buildClone, buildCloneFromRow, buildCopy, fixObjectReferences, getReferenceClass, getReferenceClassName, getReferenceDescriptor, hasNestedIdentityReference, isAggregateMapping, iterate, load, loadAll, postDelete, postInsert, postUpdate, preDelete, preInsert, preUpdate, remoteInitialization, setReferenceClass, setReferenceClassName, updateChangeRecord, verifyDelete

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping
addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, collectQueryParameters, createCloneValueHolder, derivesId, earlyPreDelete, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitialize, postInitializeSourceAndTargetExpressions, preInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, toString, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.mappings.structures.ArrayCollectionMapping
getAttributeName, setRealAttributeValueInObject

Constructor Detail
- AbstractCompositeCollectionMapping
```
public AbstractCompositeCollectionMapping()
```
  Default constructor.

Method Detail

buildAddedElementFromChangeSet

public java.lang.Object buildAddedElementFromChangeSet(java.lang.Object changeSet,
                                              org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                              org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: Build and return a new element based on the change set.

Specified by:: buildAddedElementFromChangeSet in interface ArrayCollectionMapping

buildChangeSet

public java.lang.Object buildChangeSet(java.lang.Object element,
                              org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                              org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Build and return a change set for the specified element.

Specified by:: buildChangeSet in interface ArrayCollectionMapping

buildElementFromElement

public java.lang.Object buildElementFromElement(java.lang.Object element,
                                       org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                       org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: Build and return a new element based on the specified element.

Specified by:: buildElementFromElement in interface ArrayCollectionMapping

buildExpression

public Expression buildExpression(java.lang.Object queryObject,
                         QueryByExamplePolicy policy,
                         Expression expressionBuilder,
                         java.util.Map processedObjects,
                         org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: In case Query By Example is used, this method builds and returns an expression that corresponds to a single attribute and it's value.

Overrides:: buildExpression in class AggregateMapping

buildRemovedElementFromChangeSet

public java.lang.Object buildRemovedElementFromChangeSet(java.lang.Object changeSet,
                                                org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: Build and return a new element based on the change set.

Specified by:: buildRemovedElementFromChangeSet in interface ArrayCollectionMapping

cascadePerformRemoveIfRequired

public void cascadePerformRemoveIfRequired(java.lang.Object object,
                                  org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                  java.util.Map visitedObjects)

INTERNAL: Cascade perform delete through mappings that require the cascade

Specified by:: cascadePerformRemoveIfRequired in class DatabaseMapping

cascadeDiscoverAndPersistUnregisteredNewObjects

public void cascadeDiscoverAndPersistUnregisteredNewObjects(java.lang.Object object,
                                                   java.util.Map newObjects,
                                                   java.util.Map unregisteredExistingObjects,
                                                   java.util.Map visitedObjects,
                                                   org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                                   java.util.Set cascadeErrors)

INTERNAL: Cascade discover and persist new objects during commit.

Overrides:: cascadeDiscoverAndPersistUnregisteredNewObjects in class DatabaseMapping

cascadeRegisterNewIfRequired

public void cascadeRegisterNewIfRequired(java.lang.Object object,
                                org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                java.util.Map visitedObjects)

INTERNAL: Cascade registerNew for Create through mappings that require the cascade

Specified by:: cascadeRegisterNewIfRequired in class DatabaseMapping

compareElements

public boolean compareElements(java.lang.Object element1,
                      java.lang.Object element2,
                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Compare the non-null elements and return true if they are alike.

Specified by:: compareElements in interface ArrayCollectionMapping

compareElementsForChange

public boolean compareElementsForChange(java.lang.Object element1,
                               java.lang.Object element2,
                               org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Compare the non-null elements and return true if they are alike.

Specified by:: compareElementsForChange in interface ArrayCollectionMapping

convertClassNamesToClasses
```
public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
```
INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

Overrides:

convertClassNamesToClasses in class AggregateMapping

Parameters:

classLoader -

getContainerPolicy
```
public org.eclipse.persistence.internal.queries.ContainerPolicy getContainerPolicy()
```
INTERNAL: Return the mapping's containerPolicy.

Specified by:

getContainerPolicy in interface ContainerMapping

Overrides:

getContainerPolicy in class DatabaseMapping

getConverter
```
public Converter getConverter()
```
PUBLIC: Return the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

getField
```
public org.eclipse.persistence.internal.helper.DatabaseField getField()
```
INTERNAL: Return the field mapped by this mapping.

Overrides:

getField in class DatabaseMapping

getRealCollectionAttributeValueFromObject
```
public java.lang.Object getRealCollectionAttributeValueFromObject(java.lang.Object object,
                                                         org.eclipse.persistence.internal.sessions.AbstractSession session)
                                                           throws DescriptorException
```
INTERNAL: Convenience method. Return the value of an attribute, unwrapping value holders if necessary. If the value is null, build a new container.

Specified by:

getRealCollectionAttributeValueFromObject in interface ArrayCollectionMapping

Overrides:

getRealCollectionAttributeValueFromObject in class DatabaseMapping

Throws:

DescriptorException

hasConverter
```
public boolean hasConverter()
```
PUBLIC: Indicates if there is a converter on the mapping.

isAbstractCompositeCollectionMapping
```
public boolean isAbstractCompositeCollectionMapping()
```
INTERNAL:

Overrides:

isAbstractCompositeCollectionMapping in class DatabaseMapping

initialize
```
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException
```
INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.

Overrides:

initialize in class AggregateMapping

Throws:

DescriptorException

mapKeyHasChanged
```
public boolean mapKeyHasChanged(java.lang.Object element,
                       org.eclipse.persistence.internal.sessions.AbstractSession session)
```
INTERNAL: Return whether the element's user-defined Map key has changed since it was cloned from the original version. Aggregate elements cannot change their keys without detection.

Specified by:

mapKeyHasChanged in interface ArrayCollectionMapping