Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.mappings

Class XMLInverseReferenceMapping

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.oxm.mappings.XMLInverseReferenceMapping

All Implemented Interfaces:

Serializable, Cloneable, InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>, Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>, ContainerMapping

public class XMLInverseReferenceMapping
extends AggregateMapping
implements InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>, ContainerMapping

This mapping is used to map a back-pointer. It represents the "opposite" of one of the following relationship mappings:

• XMLCompositeObjectMapping
• XMLCompositeCollectionMapping
• XMLObjectReferenceMapping
• XMLCollectionReferenceMapping

When configuring an XMLInverseReferenceMapping, the "mappedBy" field must be set to the field on the reference class that maps to this Descriptor. For example:

// EMPLOYEE has a collection of PHONEs (phoneNumbers)
// PHONE has a back-pointer to EMPLOYEE (owningEmployee)

// EMPLOYEE Descriptor
XMLCompositeCollectionMapping phone = new XMLCompositeCollectionMapping();
phone.setReferenceClassName("org.example.PhoneNumber");
phone.setAttributeName("phoneNumbers");
...

// PHONE Descriptor
XMLInverseReferenceMapping owningEmployee = new XMLInverseReferenceMapping();
owningEmployee.setReferenceClassName("org.example.Employee");
owningEmployee.setMappedBy("phoneNumbers");
owningEmployee.setAttributeName("owningEmployee");
...


See Also:

• Serialized Form

Nested Class Summary

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

DatabaseMapping.WriteType

Field Summary

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

Constructor	Description
XMLInverseReferenceMapping()

Method Summary

Modifier and Type	Method	Description
void	buildBackupClone(Object clone, Object backup, UnitOfWorkImpl unitOfWork)	INTERNAL: Clone the attribute from the clone and assign it to the backup.
void	buildClone(Object original, CacheKey cacheKey, Object clone, Integer refreshCascade, AbstractSession cloningSession)	INTERNAL: Clone the attribute from the original and assign it to the clone.
void	buildCloneFromRow(AbstractRecord databaseRow, JoinedAttributeManager joinManager, Object clone, CacheKey sharedCacheKey, ObjectBuildingQuery sourceQuery, UnitOfWorkImpl unitOfWork, AbstractSession executionSession)	INTERNAL: A combination of readFromRowIntoObject and buildClone.
void	cascadePerformRemoveIfRequired(Object object, UnitOfWorkImpl uow, Map visitedObjects)	INTERNAL: Cascade registerNew for Create 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
ChangeRecord	compareForChange(Object clone, Object backup, ObjectChangeSet owner, AbstractSession session)	INTERNAL: Compare the changes between two aggregates.
boolean	compareObjects(Object firstObject, Object secondObject, AbstractSession session)	INTERNAL: Compare the attributes belonging to this mapping for the objects.
void	fixObjectReferences(Object object, Map<Object,ObjectDescriptor> objectDescriptors, Map<Object,Object> processedObjects, ObjectLevelReadQuery query, DistributedSession session)	INTERNAL: An object has been serialized from the server to the remote client.
ContainerPolicy	getContainerPolicy()	INTERNAL: Return the mapping's containerPolicy.
DatabaseMapping	getInlineMapping()
String	getMappedBy()
void	initialize(AbstractSession session)	INTERNAL: Initialize the reference descriptor.
boolean	isXMLMapping()	INTERNAL: All relational mappings should implement this method to return true.
void	iterate(DescriptorIterator iterator)	INTERNAL: Iterate on the appropriate attribute value.
void	mergeChangesIntoObject(Object target, ChangeRecord changeRecord, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Merge changes from the source to the target object.
void	mergeIntoObject(Object target, boolean isTargetUninitialized, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Merge changes from the source to the target object.
void	postInitialize(AbstractSession session)	INTERNAL: Allow for initialization of properties and validation that have dependecies no the descriptor being initialized.
void	preInitialize(AbstractSession session)	INTERNAL: Allow for initialization of properties and validation.
void	setContainerPolicy(ContainerPolicy containerPolicy)	PUBLIC: Set the mapping's container policy.
void	setInlineMapping(DatabaseMapping inlineMapping)
void	setMappedBy(String mappedBy)
void	useCollectionClass(Class<?> concreteClass)	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useCollectionClassName(String concreteClass)	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useListClassName(String concreteClass)	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useMapClass(Class<?> concreteClass, String methodName)	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	useMapClassName(String concreteClass, String methodName)	PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
void	writeSingleValue(Object value, Object object, XMLRecord record, AbstractSession session)

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

buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClonePart, buildClonePart, buildClonePart, buildCopy, buildCopyOfAttributeValue, buildExpression, buildNewMergeInstanceOf, compareAttributeValues, convertClassNamesToClasses, executeEvent, fixAttributeValue, getAttributeValueFromBackupClone, getObjectBuilder, getObjectBuilderForClass, getQueryManager, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getReferenceDescriptor, getReferenceDescriptor, hasNestedIdentityReference, isAggregateMapping, iterateOnAttributeValue, load, loadAll, mergeAttributeValue, 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, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectFields, collectQueryParameters, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getField, 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, isAbstractCompositeObjectMapping, 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, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitializeSourceAndTargetExpressions, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setAttributeValueInObject, 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, valueFromObject, valueFromResultSet, valueFromRow, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.InverseReferenceMapping

getGetMethodName, getReferenceClassName, setReferenceClassName

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Mapping

convertClassNamesToClasses, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDescriptor, getField, getReferenceDescriptor, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setGetMethodName, setIsReadOnly, setProperties, setSetMethodName

Constructor Details

XMLInverseReferenceMapping

public XMLInverseReferenceMapping()

Method Details

isXMLMapping

public boolean isXMLMapping()

Description copied from class: DatabaseMapping

INTERNAL: All relational mappings should implement this method to return true.

Overrides:

isXMLMapping in class DatabaseMapping

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

Description copied from class: AggregateMapping

INTERNAL: Initialize the reference descriptor.

Overrides:

initialize in class AggregateMapping

Throws:

DescriptorException

preInitialize

public void preInitialize(AbstractSession session)

Description copied from class: DatabaseMapping

INTERNAL: Allow for initialization of properties and validation.

Overrides:

preInitialize in class DatabaseMapping

postInitialize

public void postInitialize(AbstractSession session)
                    throws DescriptorException

Description copied from class: DatabaseMapping

INTERNAL: Allow for initialization of properties and validation that have dependecies no the descriptor being initialized.

Overrides:

postInitialize in class DatabaseMapping

Throws:

DescriptorException

getMappedBy

public String getMappedBy()

setMappedBy

public void setMappedBy(String mappedBy)

Specified by:

setMappedBy in interface InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>

buildBackupClone

public void buildBackupClone(Object clone,
 Object backup,
 UnitOfWorkImpl unitOfWork)

Description copied from class: AggregateMapping

INTERNAL: Clone the attribute from the clone and assign it to the backup.

Overrides:

buildBackupClone in class AggregateMapping

Parameters:

clone - TODO

backup - TODO

unitOfWork - TODO

buildClone

public void buildClone(Object original,
 CacheKey cacheKey,
 Object clone,
 Integer refreshCascade,
 AbstractSession cloningSession)

Description copied from class: AggregateMapping

INTERNAL: Clone the attribute from the original and assign it to the clone.

Overrides:

buildClone in class AggregateMapping

Parameters:

original - TODO

cacheKey - TODO

clone - TODO

refreshCascade - TODO

cloningSession - TODO

buildCloneFromRow

public void buildCloneFromRow(AbstractRecord databaseRow,
 JoinedAttributeManager joinManager,
 Object clone,
 CacheKey sharedCacheKey,
 ObjectBuildingQuery sourceQuery,
 UnitOfWorkImpl unitOfWork,
 AbstractSession executionSession)

Description copied from class: AggregateMapping

INTERNAL: A combination of readFromRowIntoObject and buildClone.

buildClone assumes the attribute value exists on the original and can simply be copied.

readFromRowIntoObject assumes that one is building an original.

Both of the above assumptions are false in this method, and actually attempts to do both at the same time.

Extract value from the row and set the attribute to this value in the working copy clone. In order to bypass the shared cache when in transaction a UnitOfWork must be able to populate working copies directly from the row.

Overrides:

buildCloneFromRow in class AggregateMapping

Parameters:

databaseRow - TODO

joinManager - TODO

clone - TODO

sharedCacheKey - TODO

sourceQuery - TODO

unitOfWork - TODO

executionSession - TODO

cascadePerformRemoveIfRequired

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

Description copied from class: DatabaseMapping

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

Specified by:

cascadePerformRemoveIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

cascadeRegisterNewIfRequired

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

Description copied from class: DatabaseMapping

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

Specified by:

cascadeRegisterNewIfRequired in class DatabaseMapping

Parameters:

object - TODO

uow - TODO

visitedObjects - TODO

compareForChange

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

Description copied from class: AggregateMapping

INTERNAL: Compare the changes between two aggregates. Return a change record holding the changes.

Overrides:

compareForChange in class AggregateMapping

Parameters:

clone - TODO

backup - TODO

owner - TODO

session - TODO

Returns:

prototype.changeset.ChangeRecord TODO

compareObjects

public boolean compareObjects(Object firstObject,
 Object secondObject,
 AbstractSession session)

Description copied from class: AggregateMapping

INTERNAL: Compare the attributes belonging to this mapping for the objects.

Overrides:

compareObjects in class AggregateMapping

Parameters:

firstObject - TODO

secondObject - TODO

session - TODO

Returns:

TODO

fixObjectReferences

public void fixObjectReferences(Object object,
 Map<Object,ObjectDescriptor> objectDescriptors,
 Map<Object,Object> processedObjects,
 ObjectLevelReadQuery query,
 DistributedSession session)

Description copied from class: AggregateMapping

INTERNAL: An object has been serialized from the server to the remote client. Replace the transient attributes of the remote value holders with client-side objects.

Overrides:

fixObjectReferences in class AggregateMapping

Parameters:

object - TODO

objectDescriptors - TODO

processedObjects - TODO

query - TODO

session - TODO

iterate

public void iterate(DescriptorIterator iterator)

Description copied from class: AggregateMapping

INTERNAL: Iterate on the appropriate attribute value.

Overrides:

iterate in class AggregateMapping

mergeChangesIntoObject

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

Description copied from class: AggregateMapping

INTERNAL: Merge changes from the source to the target object. With aggregates the merge must cascade to the object changes for the aggregate object because aggregate objects have no identity outside of themselves. The actual aggregate object does not need to be replaced, because even if the clone references another aggregate it appears the same to TopLink

Overrides:

mergeChangesIntoObject in class AggregateMapping

mergeIntoObject

public void mergeIntoObject(Object target,
 boolean isTargetUninitialized,
 Object source,
 MergeManager mergeManager,
 AbstractSession targetSession)

Description copied from class: AggregateMapping

INTERNAL: Merge changes from the source to the target object. This merge is only called when a changeSet for the target does not exist or the target is uninitialized

Overrides:

mergeIntoObject in class AggregateMapping

setContainerPolicy

public void setContainerPolicy(ContainerPolicy containerPolicy)

Description copied from interface: ContainerMapping

PUBLIC: Set the mapping's container policy.

Specified by:

setContainerPolicy in interface ContainerMapping

Specified by:

setContainerPolicy in interface InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>

getContainerPolicy

public ContainerPolicy getContainerPolicy()

Description copied from class: DatabaseMapping

INTERNAL: Return the mapping's containerPolicy.

Specified by:

getContainerPolicy in interface ContainerMapping

Specified by:

getContainerPolicy in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>

Overrides:

getContainerPolicy in class DatabaseMapping

Returns:

TODO

useCollectionClass

public void useCollectionClass(Class<?> concreteClass)

Description copied from interface: ContainerMapping

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

The container class must implement (directly or indirectly) the java.util.Collection interface.

Specified by:

useCollectionClass in interface ContainerMapping

Specified by:

useCollectionClass in interface InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>

useCollectionClassName

public void useCollectionClassName(String concreteClass)

Description copied from interface: ContainerMapping

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

The container class must implement (directly or indirectly) the java.util.Collection interface.

Specified by:

useCollectionClassName in interface ContainerMapping

useListClassName

public void useListClassName(String concreteClass)

Description copied from interface: ContainerMapping

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.

The container class must implement (directly or indirectly) the java.util.List interface.

Specified by:

useListClassName in interface ContainerMapping

useMapClass

public void useMapClass(Class<?> concreteClass,
 String methodName)

Description copied from interface: ContainerMapping

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects. The key used to index a value in the Map is the value returned by a call to the specified zero-argument method. The method must be implemented by the class (or a superclass) of any value to be inserted into the Map.

The container class must implement (directly or indirectly) the java.util.Map interface.

To facilitate resolving the method, the mapping's referenceClass must set before calling this method.

Specified by:

useMapClass in interface ContainerMapping

useMapClassName

public void useMapClassName(String concreteClass,
 String methodName)

Description copied from interface: ContainerMapping

PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects. The key used to index a value in the Map is the value returned by a call to the specified zero-argument method. The method must be implemented by the class (or a superclass) of any value to be inserted into the Map.

The container class must implement (directly or indirectly) the java.util.Map interface.

To facilitate resolving the method, the mapping's referenceClass must set before calling this method.

Specified by:

useMapClassName in interface ContainerMapping

getInlineMapping

public DatabaseMapping getInlineMapping()

Specified by:

getInlineMapping in interface InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>

setInlineMapping

public void setInlineMapping(DatabaseMapping inlineMapping)

Specified by:

setInlineMapping in interface InverseReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,DatabaseMapping,XMLRecord>

writeSingleValue

public void writeSingleValue(Object value,
 Object object,
 XMLRecord record,
 AbstractSession session)

Specified by:

writeSingleValue in interface Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>