Module org.eclipse.persistence.core

Package org.eclipse.persistence.mappings.foundation

Class AbstractCompositeObjectMapping

java.lang.Object

org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,AbstractSession,ContainerPolicy,ClassDescriptor,DatabaseField>

org.eclipse.persistence.mappings.DatabaseMapping

org.eclipse.persistence.mappings.AggregateMapping

org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

EISCompositeObjectMapping, StructureMapping, XMLCompositeObjectMapping

public abstract class AbstractCompositeObjectMapping
extends AggregateMapping

Chunks of data from non-relational data sources can have an embedded component objects. These can be mapped using this mapping. The format of the embedded data is determined by the reference descriptor.

Since:

TOPLink/Java 3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping

DatabaseMapping.WriteType

Field Summary

Fields

Modifier and Type	Field	Description
protected Converter	converter	Allows user defined conversion between the object attribute value and the database value.
protected DatabaseField	field	The aggregate object is stored in a single field.

Fields inherited from class org.eclipse.persistence.mappings.AggregateMapping

hasNestedIdentityReference, referenceClass, referenceClassName, referenceDescriptor

Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping

attributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isInSopObject, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, unconvertedProperties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCompositeObjectMapping()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract Object	buildCompositeObject(ObjectBuilder objectBuilder, AbstractRecord nestedRow, ObjectBuildingQuery query, CacheKey parentCacheKey, JoinedAttributeManager joinManger, AbstractSession targetSession)
protected abstract Object	buildCompositeRow(Object attributeValue, AbstractSession session, AbstractRecord record, DatabaseMapping.WriteType writeType)
Expression	buildExpression(Object queryObject, QueryByExamplePolicy policy, Expression expressionBuilder, Map processedObjects, 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.
void	buildShallowOriginalFromRow(AbstractRecord row, Object original, JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, AbstractSession executionSession)	INTERNAL: Builds a shallow original object.
void	cascadeDiscoverAndPersistUnregisteredNewObjects(Object object, Map newObjects, Map unregisteredExistingObjects, Map visitedObjects, UnitOfWorkImpl uow, Set cascadeErrors)	INTERNAL: Cascade discover and persist new objects during commit.
void	cascadePerformRemoveIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects)	INTERNAL: Cascade perform delete through mappings that require the cascade
void	cascadeRegisterNewIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects)	INTERNAL: Cascade registerNew for Create through mappings that require the cascade
protected Vector	collectFields()	Return the fields mapped by the mapping.
Converter	getConverter()	PUBLIC: Return the converter on the mapping.
DatabaseField	getField()	INTERNAL: The aggregate object is held in a single field.
boolean	hasConverter()	PUBLIC: Indicates if there is a converter on the mapping.
void	initialize(AbstractSession session)	INTERNAL: Initialize the mapping.
boolean	isAbstractCompositeObjectMapping()	INTERNAL:
void	setAttributeValueInObject(Object object, Object value)	INTERNAL: Set the value of the attribute mapped by this mapping.
void	setConverter(Converter converter)	PUBLIC: Set the converter on the mapping.
void	setField(DatabaseField field)	The aggregate object is held in a single field.
Object	valueFromObject(Object object, DatabaseField field, AbstractSession session)	INTERNAL: Extract and return value of the field from the object
Object	valueFromRow(AbstractRecord row, JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, CacheKey cacheKey, AbstractSession executionSession, boolean isTargetProtected, Boolean[] wasCacheUsed)	INTERNAL: Extract and return the aggregate object from the specified row.
void	writeFromObjectIntoRow(Object object, AbstractRecord record, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL: Build the value for the database field and put it in the specified database row.
void	writeFromObjectIntoRowForUpdate(WriteObjectQuery query, AbstractRecord row)	INTERNAL: If it has changed, build the value for the database field and put it in the specified database row.
void	writeFromObjectIntoRowWithChangeRecord(ChangeRecord changeRecord, AbstractRecord row, 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(AbstractRecord record, AbstractSession session)	INTERNAL: Write fields needed for insert into the template for with null values.

Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping

buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClone, buildBackupClonePart, buildClone, buildCloneFromRow, buildClonePart, buildClonePart, buildCopy, buildCopyOfAttributeValue, buildNewMergeInstanceOf, compareAttributeValues, compareForChange, compareObjects, convertClassNamesToClasses, executeEvent, fixAttributeValue, fixObjectReferences, getAttributeValueFromBackupClone, getObjectBuilder, getObjectBuilderForClass, getQueryManager, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getReferenceDescriptor, getReferenceDescriptor, hasNestedIdentityReference, isAggregateMapping, iterate, iterateOnAttributeValue, load, loadAll, mergeAttributeValue, mergeChangesIntoObject, mergeIntoObject, postDelete, postDeleteAttributeValue, postInsert, postInsertAttributeValue, postUpdate, postUpdateAttributeValue, preDelete, preDeleteAttributeValue, preInsert, preInsertAttributeValue, preUpdate, preUpdateAttributeValue, remoteInitialization, setReferenceClass, setReferenceClassName, setReferenceDescriptor, updateChangeRecord, verifyDelete, verifyDeleteOfAttributeValue

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping

addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectQueryParameters, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isCollectionMapping, 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, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitialize, postInitializeSourceAndTargetExpressions, preInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

field

protected DatabaseField field

The aggregate object is stored in a single field.

converter

protected Converter converter

Allows user defined conversion between the object attribute value and the database value.

Constructor Details

AbstractCompositeObjectMapping

protected AbstractCompositeObjectMapping()

Default constructor.

Method Details

cascadePerformRemoveIfRequired

public void cascadePerformRemoveIfRequired(Object object,
 UnitOfWorkImpl uow,
 Map visitedObjects)

INTERNAL: Cascade perform delete through mappings that require the cascade

Specified by:

cascadePerformRemoveIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

cascadeDiscoverAndPersistUnregisteredNewObjects

public void cascadeDiscoverAndPersistUnregisteredNewObjects(Object object,
 Map newObjects,
 Map unregisteredExistingObjects,
 Map visitedObjects,
 UnitOfWorkImpl uow,
 Set cascadeErrors)

INTERNAL: Cascade discover and persist new objects during commit.

Overrides:

cascadeDiscoverAndPersistUnregisteredNewObjects in class DatabaseMapping

Parameters:

object - TODO

newObjects - TODO

unregisteredExistingObjects - TODO

visitedObjects - TODO

uow - TODO

cascadeErrors - TODO

cascadeRegisterNewIfRequired

public void cascadeRegisterNewIfRequired(Object object,
 UnitOfWorkImpl uow,
 Map visitedObjects)

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

Specified by:

cascadeRegisterNewIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

collectFields

protected Vector collectFields()

Return the fields mapped by the mapping.

Overrides:

collectFields in class DatabaseMapping

Returns:

TODO

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 DatabaseField getField()

INTERNAL: The aggregate object is held in a single field.

Overrides:

getField in class DatabaseMapping

Returns:

TODO

hasConverter

public boolean hasConverter()

PUBLIC: Indicates if there is a converter on the mapping.

isAbstractCompositeObjectMapping

public boolean isAbstractCompositeObjectMapping()

INTERNAL:

Overrides:

isAbstractCompositeObjectMapping in class DatabaseMapping

Returns:

TODO

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

INTERNAL: Initialize the mapping.

Overrides:

initialize in class AggregateMapping

Throws:

DescriptorException

setAttributeValueInObject

public void setAttributeValueInObject(Object object,
 Object value)
                               throws DescriptorException

INTERNAL: Set the value of the attribute mapped by this mapping.

Overrides:

setAttributeValueInObject in class DatabaseMapping

Parameters:

object - TODO

value - TODO

Throws:

DescriptorException

setConverter

public void setConverter(Converter converter)

PUBLIC: Set the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

setField

public void setField(DatabaseField field)

The aggregate object is held in a single field.

valueFromObject

public Object valueFromObject(Object object,
 DatabaseField field,
 AbstractSession session)
                       throws DescriptorException

INTERNAL: Extract and return value of the field from the object

Overrides:

valueFromObject in class DatabaseMapping

Parameters:

object - TODO

field - TODO

session - TODO

Returns:

TODO

Throws:

DescriptorException

valueFromRow

public Object valueFromRow(AbstractRecord row,
 JoinedAttributeManager joinManager,
 ObjectBuildingQuery sourceQuery,
 CacheKey cacheKey,
 AbstractSession executionSession,
 boolean isTargetProtected,
 Boolean[] wasCacheUsed)
                    throws DatabaseException

INTERNAL: Extract and return the aggregate object from the specified row.

Overrides:

valueFromRow in class DatabaseMapping

Throws:

DatabaseException

buildShallowOriginalFromRow

public void buildShallowOriginalFromRow(AbstractRecord row,
 Object original,
 JoinedAttributeManager joinManager,
 ObjectBuildingQuery sourceQuery,
 AbstractSession executionSession)

INTERNAL: Builds a shallow original object. Only direct attributes and primary keys are populated. In this way the minimum original required for instantiating a working copy clone can be built without placing it in the shared cache (no concern over cycles).

Overrides:

buildShallowOriginalFromRow in class DatabaseMapping

Parameters:

row - TODO

original - TODO

joinManager - TODO

sourceQuery - TODO

executionSession - TODO

buildCompositeObject

protected abstract Object buildCompositeObject(ObjectBuilder objectBuilder,
 AbstractRecord nestedRow,
 ObjectBuildingQuery query,
 CacheKey parentCacheKey,
 JoinedAttributeManager joinManger,
 AbstractSession targetSession)

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
 AbstractRecord record,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)
                            throws DescriptorException

INTERNAL: Build the value for the database field and put it in the specified database row.

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

Throws:

DescriptorException

buildCompositeRow

protected abstract Object buildCompositeRow(Object attributeValue,
 AbstractSession session,
 AbstractRecord record,
 DatabaseMapping.WriteType writeType)

buildExpression

public Expression buildExpression(Object queryObject,
 QueryByExamplePolicy policy,
 Expression expressionBuilder,
 Map processedObjects,
 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

Parameters:

queryObject - TODO

policy - TODO

expressionBuilder - TODO

processedObjects - TODO

session - TODO

Returns:

TODO

writeFromObjectIntoRowForUpdate

public void writeFromObjectIntoRowForUpdate(WriteObjectQuery query,
 AbstractRecord row)
                                     throws DescriptorException

INTERNAL: If it has changed, build the value for the database field and put it in the specified database row. If any part of the aggregate object has changed, the entire object is written to the database row (i.e. partial updates are not supported).

Overrides:

writeFromObjectIntoRowForUpdate in class DatabaseMapping

Throws:

DescriptorException

writeFromObjectIntoRowWithChangeRecord

public void writeFromObjectIntoRowWithChangeRecord(ChangeRecord changeRecord,
 AbstractRecord row,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)
                                            throws DescriptorException

INTERNAL: Get the attribute value from the object and add the appropriate values to the specified database row.

Overrides:

writeFromObjectIntoRowWithChangeRecord in class DatabaseMapping

Throws:

DescriptorException

writeInsertFieldsIntoRow

public void writeInsertFieldsIntoRow(AbstractRecord record,
 AbstractSession session)

INTERNAL: Write fields needed for insert into the template for with null values.

Overrides:

writeInsertFieldsIntoRow in class DatabaseMapping