oracle.toplink.essentials.mappings

Class ObjectReferenceMapping

java.lang.Object

oracle.toplink.essentials.mappings.DatabaseMapping

oracle.toplink.essentials.mappings.ForeignReferenceMapping

oracle.toplink.essentials.mappings.ObjectReferenceMapping

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

OneToOneMapping

public abstract class ObjectReferenceMapping
extends ForeignReferenceMapping

Purpose: Abstract class for 1:1, varibale 1:1 and reference mappings

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector<DatabaseField>	foreignKeyFields Keeps track of which fields are foreign keys on a per field basis (can have mixed foreign key relationships).
protected boolean	isForeignKeyRelationship Keeps track if any of the fields are foreign keys.

Fields inherited from class oracle.toplink.essentials.mappings.ForeignReferenceMapping

cascadeMerge, cascadePersist, cascadeRefresh, cascadeRemove, hasCustomSelectionQuery, indirectionPolicy, isPrivateOwned, referenceClass, referenceClassName, referenceDescriptor, relationshipPartner, relationshipPartnerAttributeName, selectionQuery, tempInitSession

Fields inherited from class oracle.toplink.essentials.mappings.DatabaseMapping

attributeAccessor, descriptor, fields, isOptional, isReadOnly, isRemotelyInitialized, NO_FIELDS, NO_WEIGHT, primaryKeyMapping, properties, weight, WEIGHT_1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectReferenceMapping()

Method Summary

Modifier and Type	Method and Description
Object	buildBackupCloneForPartObject(Object attributeValue, Object clone, Object backup, UnitOfWorkImpl unitOfWork) INTERNAL: Used during building the backup shallow copy to copy the vector without re-registering the target objects.
ChangeRecord	buildChangeRecord(Object clone, ObjectChangeSet owner, AbstractSession session) INTERNAL: Directly build a change record without comparison
Object	buildCloneForPartObject(Object attributeValue, Object original, Object clone, UnitOfWorkImpl unitOfWork, boolean isExisting) INTERNAL: Require for cloning, the part must be cloned.
void	buildCopy(Object copy, Object original, ObjectCopyingPolicy policy) INTERNAL: Copy of the attribute of the object.
protected boolean	cacheKeysAreEqual(CacheKey cacheKey1, CacheKey cacheKey2) INTERNAL:
void	cascadePerformRemoveIfRequired(Object object, UnitOfWorkImpl uow, IdentityHashtable visitedObjects) INTERNAL: Cascade registerNew for Create through mappings that require the cascade
void	cascadeRegisterNewIfRequired(Object object, UnitOfWorkImpl uow, IdentityHashtable visitedObjects) INTERNAL: Cascade registerNew for Create through mappings that require the cascade
protected Vector<DatabaseField>	collectFields() INTERNAL: Return all the fields populated by this mapping, these are foreign keys only.
ChangeRecord	compareForChange(Object clone, Object backUp, ObjectChangeSet owner, AbstractSession session) INTERNAL: This method was created in VisualAge.
protected boolean	compareObjectsWithoutPrivateOwned(Object firstObject, Object secondObject, AbstractSession session) INTERNAL: Compare the references of the two objects are the same, not the objects themselves.
protected boolean	compareObjectsWithPrivateOwned(Object firstObject, Object secondObject, AbstractSession session) INTERNAL: Compare the references of the two objects are the same, and the objects themselves are the same.
UnitOfWorkValueHolder	createUnitOfWorkValueHolder(ValueHolderInterface attributeValue, Object original, Object clone, AbstractRecord row, UnitOfWorkImpl unitOfWork, boolean buildDirectlyFromRow) INTERNAL: Builder the unit of work value holder.
AbstractRecord	extractPrimaryKeyRowForSourceObject(Object domainObject, AbstractSession session) INTERNAL: Extract the reference pk for rvh usage in remote model.
Vector	extractPrimaryKeysForReferenceObject(Object domainObject, AbstractSession session) INTERNAL: Extract the reference pk for rvh usage in remote model.
Vector	extractPrimaryKeysForReferenceObjectFromRow(AbstractRecord row) INTERNAL: Return the primary key for the reference object (i.e.
Vector	extractPrimaryKeysFromRealReferenceObject(Object object, AbstractSession session) INTERNAL: Extract the reference pk for rvh usage in remote model.
ClassDescriptor	getDescriptorForTarget(Object object, AbstractSession session) INTERNAL: Return a descriptor for the target of this mapping
Vector<DatabaseField>	getForeignKeyFields() INTERNAL: Returns the foreign key names associated with the mapping.
protected Vector	getPrimaryKeyForObject(Object object, AbstractSession session) INTERNAL:
Object	getRealAttributeValueFromObject(Object object, AbstractSession session) INTERNAL: Object reference must unwrap the reference object if required.
boolean	hasConstraintDependency() INTERNAL: The returns if the mapping has any constraint dependencies, such as foreign keys and join tables.
protected void	insert(WriteObjectQuery query) INTERNAL: Insert the referenced objects.
ObjectReferenceChangeRecord	internalBuildChangeRecord(Object newValue, ObjectChangeSet owner, AbstractSession session) INTERNAL: Directly build a change record based on the newValue without comparison
boolean	isChangeTrackingSupported() INTERNAL: Return if this mapping supports change tracking.
boolean	isForeignKeyRelationship() INTERNAL: Return if the 1-1 mapping has a foreign key dependency to its target.
boolean	isObjectReferenceMapping() INTERNAL: Related mapping should implement this method to return true.
void	iterateOnRealAttributeValue(DescriptorIterator iterator, Object realAttributeValue) INTERNAL: Iterate on the attribute value.
void	mergeChangesIntoObject(Object target, ChangeRecord changeRecord, Object source, MergeManager mergeManager) INTERNAL: Merge changes from the source to the target object.
void	mergeIntoObject(Object target, boolean isTargetUnInitialized, Object source, MergeManager mergeManager) INTERNAL: Merge changes from the source to the target object.
void	postDelete(WriteObjectQuery query) INTERNAL: Delete the referenced objects.
void	postInsert(WriteObjectQuery query) INTERNAL: Insert privately owned parts
void	postUpdate(WriteObjectQuery query) INTERNAL: Update privately owned parts
void	preDelete(WriteObjectQuery query) INTERNAL: Delete the referenced objects.
void	preInsert(WriteObjectQuery query) INTERNAL: Insert privately owned parts
void	preUpdate(WriteObjectQuery query) INTERNAL: Update privately owned parts
protected Object	readPrivateOwnedForObject(ObjectLevelModifyQuery modifyQuery) INTERNAL: Reads the private owned object.
protected void	setForeignKeyFields(Vector<DatabaseField> foreignKeyFields) INTERNAL: Set the foreign key fields associated with the mapping.
void	setIsForeignKeyRelationship(boolean isForeignKeyRelationship) INTERNAL: Set if the 1-1 mapping has a foreign key dependency to its target.
void	setNewValueInChangeRecord(Object newValue, ObjectReferenceChangeRecord changeRecord, ObjectChangeSet owner, AbstractSession session) INTERNAL: Set the newValue in the change record
protected void	update(WriteObjectQuery query) INTERNAL: Update the private owned part.
void	updateChangeRecord(Object clone, Object newValue, Object oldValue, ObjectChangeSet objectChangeSet, UnitOfWorkImpl uow) INTERNAL: Either create a new change record or update the change record with the new value.
boolean	verifyDelete(Object object, AbstractSession session) INTERNAL: To verify if the specified object is deleted or not.
void	writeFromObjectIntoRowForUpdate(WriteObjectQuery query, AbstractRecord databaseRow) INTERNAL: Get a value from the object and set that in the respective field of the row.
void	writeFromObjectIntoRowForWhereClause(ObjectLevelModifyQuery query, AbstractRecord databaseRow) INTERNAL: Get a value from the object and set that in the respective field of the row.

Methods inherited from class oracle.toplink.essentials.mappings.ForeignReferenceMapping

buildBackupClone, buildClone, buildCloneFromRow, clone, compareObjects, convertClassNamesToClasses, dontDoMerge, dontUseIndirection, getAttributeValueFromObject, getAttributeValueWithClonedValueHolders, getIndirectionPolicy, getJoinCriteria, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationshipPartner, getRelationshipPartnerAttributeName, getSelectionCriteria, getSelectionQuery, getTempSession, hasCustomSelectionQuery, initialize, initializeReferenceDescriptor, initializeSelectionQuery, isAttributeValueInstantiated, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, isForeignReferenceMapping, isPrivateOwned, iterate, prepareHistoricalQuery, prepareNestedJoins, privateOwnedRelationship, setCascadeAll, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setCustomSelectionQuery, setHasCustomSelectionQuery, setIndirectionPolicy, setIsPrivateOwned, setRealAttributeValueInObject, setReferenceClass, setReferenceClassName, setReferenceDescriptor, setRelationshipPartner, setRelationshipPartnerAttributeName, setSelectionCall, setSelectionCriteria, setSelectionQuery, setSelectionSQLString, setTempSession, setUsesIndirection, shouldInitializeSelectionCriteria, shouldMergeCascadeParts, shouldMergeCascadeReference, shouldObjectModifyCascadeToParts, shouldObjectModifyCascadeToPartsForPreDelete, shouldUseValueFromRowWithJoin, trimRowForJoin, trimRowForJoin, useBasicIndirection, usesIndirection, useWeavedIndirection, validateBeforeInitialization, valueFromRow, valueFromRowInternal, valueFromRowInternalWithJoin

Methods inherited from class oracle.toplink.essentials.mappings.DatabaseMapping

addToCollectionChangeRecord, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeMerge, cloneFields, extractNestedExpressions, getAttributeAccessor, getAttributeClassification, getAttributeName, getContainerPolicy, getDescriptor, getField, getFieldClassification, getFields, getGetMethodName, getProperties, getProperty, getRealCollectionAttributeValueFromObject, getReferenceClassDescriptor, getSetMethodName, getWeight, hasDependency, hasInverseConstraintDependency, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCascadedLockingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isJoiningSupported, isManyToManyMapping, isNestedTableMapping, isObjectTypeMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isSerializedObjectMapping, isStructureMapping, isTransformationMapping, isTypeConversionMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, performDataModificationEvent, postInitialize, preInitialize, prepareCascadeLockingPolicy, readFromRowIntoObject, readFromRowIntoObject, readOnly, readWrite, rehashFieldDependancies, removeFromCollectionChangeRecord, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setDescriptor, setFields, setGetMethodName, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setProperties, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, validateAfterInitialization, valueFromObject, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRow, writeFromObjectIntoRowForShallowDelete, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Field Detail

isForeignKeyRelationship

protected boolean isForeignKeyRelationship

Keeps track if any of the fields are foreign keys.

foreignKeyFields

protected Vector<DatabaseField> foreignKeyFields

Keeps track of which fields are foreign keys on a per field basis (can have mixed foreign key relationships).

Constructor Detail

ObjectReferenceMapping

protected ObjectReferenceMapping()

Method Detail

buildBackupCloneForPartObject

public Object buildBackupCloneForPartObject(Object attributeValue,
                                            Object clone,
                                            Object backup,
                                            UnitOfWorkImpl unitOfWork)

INTERNAL: Used during building the backup shallow copy to copy the vector without re-registering the target objects. For 1-1 or ref the reference is from the clone so it is already registered.

Specified by:

buildBackupCloneForPartObject in class ForeignReferenceMapping

buildCloneForPartObject

public Object buildCloneForPartObject(Object attributeValue,
                                      Object original,
                                      Object clone,
                                      UnitOfWorkImpl unitOfWork,
                                      boolean isExisting)

INTERNAL: Require for cloning, the part must be cloned. Ignore the objects, use the attribute value.

Specified by:

buildCloneForPartObject in class ForeignReferenceMapping

buildCopy

public void buildCopy(Object copy,
                      Object original,
                      ObjectCopyingPolicy policy)

INTERNAL: Copy of the attribute of the object. This is NOT used for unit of work but for templatizing an object.

Overrides:

buildCopy in class DatabaseMapping

compareForChange

public ChangeRecord compareForChange(Object clone,
                                     Object backUp,
                                     ObjectChangeSet owner,
                                     AbstractSession session)

INTERNAL: This method was created in VisualAge.

Specified by:

compareForChange in class DatabaseMapping

Returns:

prototype.changeset.ChangeRecord

internalBuildChangeRecord

public ObjectReferenceChangeRecord internalBuildChangeRecord(Object newValue,
                                                             ObjectChangeSet owner,
                                                             AbstractSession session)

INTERNAL: Directly build a change record based on the newValue without comparison

setNewValueInChangeRecord

public void setNewValueInChangeRecord(Object newValue,
                                      ObjectReferenceChangeRecord changeRecord,
                                      ObjectChangeSet owner,
                                      AbstractSession session)

INTERNAL: Set the newValue in the change record

compareObjectsWithoutPrivateOwned

protected boolean compareObjectsWithoutPrivateOwned(Object firstObject,
                                                    Object secondObject,
                                                    AbstractSession session)

INTERNAL: Compare the references of the two objects are the same, not the objects themselves. Used for independent relationships. This is used for testing and validation purposes.

Specified by:

compareObjectsWithoutPrivateOwned in class ForeignReferenceMapping

compareObjectsWithPrivateOwned

protected boolean compareObjectsWithPrivateOwned(Object firstObject,
                                                 Object secondObject,
                                                 AbstractSession session)

INTERNAL: Compare the references of the two objects are the same, and the objects themselves are the same. Used for private relationships. This is used for testing and validation purposes.

Specified by:

compareObjectsWithPrivateOwned in class ForeignReferenceMapping

getDescriptorForTarget

public ClassDescriptor getDescriptorForTarget(Object object,
                                              AbstractSession session)

INTERNAL: Return a descriptor for the target of this mapping

See Also:

Bug 2612571

getRealAttributeValueFromObject

public Object getRealAttributeValueFromObject(Object object,
                                              AbstractSession session)

INTERNAL: Object reference must unwrap the reference object if required.

Overrides:

getRealAttributeValueFromObject in class ForeignReferenceMapping

isObjectReferenceMapping

public boolean isObjectReferenceMapping()

INTERNAL: Related mapping should implement this method to return true.

Overrides:

isObjectReferenceMapping in class DatabaseMapping

iterateOnRealAttributeValue

public void iterateOnRealAttributeValue(DescriptorIterator iterator,
                                        Object realAttributeValue)

INTERNAL: Iterate on the attribute value. The value holder has already been processed.

Specified by:

iterateOnRealAttributeValue in class ForeignReferenceMapping

mergeChangesIntoObject

public void mergeChangesIntoObject(Object target,
                                   ChangeRecord changeRecord,
                                   Object source,
                                   MergeManager mergeManager)

INTERNAL: Merge changes from the source to the target object. Which is the original from the parent UnitOfWork

Specified by:

mergeChangesIntoObject in class DatabaseMapping

mergeIntoObject

public void mergeIntoObject(Object target,
                            boolean isTargetUnInitialized,
                            Object source,
                            MergeManager mergeManager)

INTERNAL: Merge changes from the source to the target object.

Specified by:

mergeIntoObject in class DatabaseMapping

collectFields

protected Vector<DatabaseField> collectFields()

INTERNAL: Return all the fields populated by this mapping, these are foreign keys only.

Overrides:

collectFields in class DatabaseMapping

getForeignKeyFields

public Vector<DatabaseField> getForeignKeyFields()

INTERNAL: Returns the foreign key names associated with the mapping. These are the fields that will be populated by the 1-1 mapping when writting.

setForeignKeyFields

protected void setForeignKeyFields(Vector<DatabaseField> foreignKeyFields)

INTERNAL: Set the foreign key fields associated with the mapping. These are the fields that will be populated by the 1-1 mapping when writting.

isForeignKeyRelationship

public boolean isForeignKeyRelationship()

INTERNAL: Return if the 1-1 mapping has a foreign key dependency to its target. This is true if any of the foreign key fields are true foreign keys, i.e. populated on write from the targets primary key.

setIsForeignKeyRelationship

public void setIsForeignKeyRelationship(boolean isForeignKeyRelationship)

INTERNAL: Set if the 1-1 mapping has a foreign key dependency to its target. This is true if any of the foreign key fields are true foreign keys, i.e. populated on write from the targets primary key.

preInsert

public void preInsert(WriteObjectQuery query)
               throws DatabaseException,
                      OptimisticLockException

INTERNAL: Insert privately owned parts

Overrides:

preInsert in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

readPrivateOwnedForObject

protected Object readPrivateOwnedForObject(ObjectLevelModifyQuery modifyQuery)
                                    throws DatabaseException

INTERNAL: Reads the private owned object.

Throws:

DatabaseException

preUpdate

public void preUpdate(WriteObjectQuery query)
               throws DatabaseException,
                      OptimisticLockException

INTERNAL: Update privately owned parts

Overrides:

preUpdate in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

postDelete

public void postDelete(WriteObjectQuery query)
                throws DatabaseException,
                       OptimisticLockException

INTERNAL: Delete the referenced objects.

Overrides:

postDelete in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

postInsert

public void postInsert(WriteObjectQuery query)
                throws DatabaseException,
                       OptimisticLockException

INTERNAL: Insert privately owned parts

Overrides:

postInsert in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

postUpdate

public void postUpdate(WriteObjectQuery query)
                throws DatabaseException,
                       OptimisticLockException

INTERNAL: Update privately owned parts

Overrides:

postUpdate in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

preDelete

public void preDelete(WriteObjectQuery query)
               throws DatabaseException,
                      OptimisticLockException

INTERNAL: Delete the referenced objects.

Overrides:

preDelete in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

cascadePerformRemoveIfRequired

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

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

Specified by:

cascadePerformRemoveIfRequired in class DatabaseMapping

cascadeRegisterNewIfRequired

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

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

Specified by:

cascadeRegisterNewIfRequired in class DatabaseMapping

cacheKeysAreEqual

protected boolean cacheKeysAreEqual(CacheKey cacheKey1,
                                    CacheKey cacheKey2)

INTERNAL:

getPrimaryKeyForObject

protected Vector getPrimaryKeyForObject(Object object,
                                        AbstractSession session)

INTERNAL:

hasConstraintDependency

public boolean hasConstraintDependency()

INTERNAL: The returns if the mapping has any constraint dependencies, such as foreign keys and join tables.

Overrides:

hasConstraintDependency in class DatabaseMapping

createUnitOfWorkValueHolder

public UnitOfWorkValueHolder createUnitOfWorkValueHolder(ValueHolderInterface attributeValue,
                                                         Object original,
                                                         Object clone,
                                                         AbstractRecord row,
                                                         UnitOfWorkImpl unitOfWork,
                                                         boolean buildDirectlyFromRow)

INTERNAL: Builder the unit of work value holder.

Overrides:

createUnitOfWorkValueHolder in class ForeignReferenceMapping

Parameters:

buildDirectlyFromRow - indicates that we are building the clone directly from a row as opposed to building the original from the row, putting it in the shared cache, and then cloning the original.

extractPrimaryKeyRowForSourceObject

public AbstractRecord extractPrimaryKeyRowForSourceObject(Object domainObject,
                                                          AbstractSession session)

INTERNAL: Extract the reference pk for rvh usage in remote model.

extractPrimaryKeysForReferenceObject

public Vector extractPrimaryKeysForReferenceObject(Object domainObject,
                                                   AbstractSession session)

INTERNAL: Extract the reference pk for rvh usage in remote model.

extractPrimaryKeysForReferenceObjectFromRow

public Vector extractPrimaryKeysForReferenceObjectFromRow(AbstractRecord row)

INTERNAL: Return the primary key for the reference object (i.e. the object object referenced by domainObject and specified by mapping). This key will be used by a RemoteValueHolder.

extractPrimaryKeysFromRealReferenceObject

public Vector extractPrimaryKeysFromRealReferenceObject(Object object,
                                                        AbstractSession session)

INTERNAL: Extract the reference pk for rvh usage in remote model.

insert

protected void insert(WriteObjectQuery query)
               throws DatabaseException,
                      OptimisticLockException

INTERNAL: Insert the referenced objects.

Throws:

DatabaseException

OptimisticLockException

update

protected void update(WriteObjectQuery query)
               throws DatabaseException,
                      OptimisticLockException

INTERNAL: Update the private owned part.

Throws:

DatabaseException

OptimisticLockException

verifyDelete

public boolean verifyDelete(Object object,
                            AbstractSession session)
                     throws DatabaseException

INTERNAL: To verify if the specified object is deleted or not.

Overrides:

verifyDelete in class DatabaseMapping

Throws:

DatabaseException

writeFromObjectIntoRowForUpdate

public void writeFromObjectIntoRowForUpdate(WriteObjectQuery query,
                                            AbstractRecord databaseRow)

INTERNAL: Get a value from the object and set that in the respective field of the row. But before that check if the reference object is instantiated or not.

Overrides:

writeFromObjectIntoRowForUpdate in class DatabaseMapping

writeFromObjectIntoRowForWhereClause

public void writeFromObjectIntoRowForWhereClause(ObjectLevelModifyQuery query,
                                                 AbstractRecord databaseRow)

INTERNAL: Get a value from the object and set that in the respective field of the row.

Overrides:

writeFromObjectIntoRowForWhereClause in class DatabaseMapping

isChangeTrackingSupported

public boolean isChangeTrackingSupported()

INTERNAL: Return if this mapping supports change tracking.

Overrides:

isChangeTrackingSupported in class DatabaseMapping

updateChangeRecord

public void updateChangeRecord(Object clone,
                               Object newValue,
                               Object oldValue,
                               ObjectChangeSet objectChangeSet,
                               UnitOfWorkImpl uow)

INTERNAL: Either create a new change record or update the change record with the new value. This is used by attribute change tracking.

Overrides:

updateChangeRecord in class DatabaseMapping

buildChangeRecord

public ChangeRecord buildChangeRecord(Object clone,
                                      ObjectChangeSet owner,
                                      AbstractSession session)

INTERNAL: Directly build a change record without comparison

Overrides:

buildChangeRecord in class DatabaseMapping