Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.mappings

Class XMLObjectReferenceMapping

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.XMLObjectReferenceMapping

All Implemented Interfaces:

Serializable, Cloneable, Mapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,XMLRecord>, ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>, XMLMapping

Direct Known Subclasses:

XMLCollectionReferenceMapping

public class XMLObjectReferenceMapping
extends AggregateMapping
implements ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>, XMLMapping

TopLink OXM version of a 1-1 mapping. A list of source-target key field associations is used to link the source xpaths to their related target xpaths, and hence their primary key (unique identifier) values used when (un)marshalling. This mapping has a Vector of XMLFields as opposed to a single XMLField. It is important to note that each target xpath is assumed to be set as a primary key field on the target (reference) class descriptor - this is necessary in order to locate the correct target object instance in the session cache when resolving mapping references.

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 HashMap	sourceToTargetKeyFieldAssociations
protected Vector	sourceToTargetKeys

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
XMLObjectReferenceMapping()	PUBLIC: The default constructor initializes the sourceToTargetKeyFieldAssociations and sourceToTargetKeys data structures.

Method Summary

Modifier and Type	Method	Description
void	addSourceToTargetKeyFieldAssociation(String srcXPath, String tgtXPath)	PUBLIC: Add a source-target xpath pair to the map.
void	addSourceToTargetKeyFieldAssociation(XMLField srcField, XMLField tgtField)
Object	buildFieldValue(Object targetObject, XMLField xmlFld, AbstractSession session)	INTERNAL: Retrieve the target object's primary key value that is mapped to a given source xpath (in the source-target key field association list).
void	buildReference(UnmarshalRecord record, XMLField xmlField, Object object, AbstractSession session)	INTERNAL: Create (if necessary) and populate a reference object that will be used during the mapping reference resolution phase after unmarshalling is complete.
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
Vector	getFields()	INTERNAL: Return a list of XMLFields based on the source XPath values in the source-target key field associations list.
XMLInverseReferenceMapping	getInverseReferenceMapping()
protected QName	getSchemaType(XMLField xmlField, Object value, AbstractSession session)	Return a QName representation the schema type for a given XMLField, if applicable.
protected QName	getSingleValueToWriteForUnion(XMLUnionField xmlField, Object value, AbstractSession session)	Return a single QName representation for a given XMLUnionField, if applicable.
HashMap	getSourceToTargetKeyFieldAssociations()	INTERNAL: Return a list of source-target xmlfield pairs.
protected String	getValueToWrite(QName schemaType, Object value, AbstractSession session)	Return a string representation of a given value, based on a given schema type.
void	initialize(AbstractSession session)	INTERNAL: Register a ReferenceResolver as an event listener on the session, if one doesn't already exist.
boolean	isObjectReferenceMapping()	INTERNAL: Related mapping should implement this method to return true.
boolean	isWriteOnly()	INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).
boolean	isXMLMapping()	INTERNAL: Indicates that this is an XML mapping.
void	preInitialize(AbstractSession session)	INTERNAL: Allow for initialization of properties and validation.
Object	readFromRowIntoObject(AbstractRecord databaseRow, JoinedAttributeManager joinManager, Object targetObject, CacheKey parentCacheKey, ObjectBuildingQuery sourceQuery, AbstractSession executionSession, boolean isTargetProtected)	INTERNAL: Extract the primary key values from the row, then create an org.eclipse.persistence.internal.oxm.Reference instance and store it on the session's org.eclipse.persistence.internal.oxm.ReferenceResolver.
void	setAttributeValueInObject(Object object, Object value)	INTERNAL: Set the value of the attribute mapped by this mapping.
void	setField(DatabaseField field)
void	setIsWriteOnly(boolean b)
void	setSourceToTargetKeyFieldAssociations(HashMap sourceToTargetKeyFieldAssociations)	INTERNAL: Set the list of source-target xmlfield pairs.
void	writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL: Write the attribute value from the object to the row.
void	writeSingleValue(Object value, Object parent, XMLRecord row, AbstractSession session)	INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath.

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

buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClone, buildBackupClonePart, buildClone, buildCloneFromRow, buildClonePart, buildClonePart, buildCopy, buildCopyOfAttributeValue, buildExpression, 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, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectFields, collectQueryParameters, convertConverterClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDerivedIdMapping, getDescriptor, getField, getFieldClassification, 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, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitialize, postInitializeSourceAndTargetExpressions, prepareCascadeLockingPolicy, readFromResultSetIntoObject, 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, valueFromObject, valueFromResultSet, valueFromRow, valueFromRow, writeFromAttributeIntoRow, 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.Mapping

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

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

getReferenceClass, getReferenceClassName, setReferenceClassName

Methods inherited from interface org.eclipse.persistence.oxm.mappings.XMLMapping

convertClassNamesToClasses

Field Details

sourceToTargetKeyFieldAssociations

protected HashMap sourceToTargetKeyFieldAssociations

sourceToTargetKeys

protected Vector sourceToTargetKeys

Constructor Details

XMLObjectReferenceMapping

public XMLObjectReferenceMapping()

PUBLIC: The default constructor initializes the sourceToTargetKeyFieldAssociations and sourceToTargetKeys data structures.

Method Details

addSourceToTargetKeyFieldAssociation

public void addSourceToTargetKeyFieldAssociation(String srcXPath,
 String tgtXPath)

PUBLIC: Add a source-target xpath pair to the map.

Specified by:

addSourceToTargetKeyFieldAssociation in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

addSourceToTargetKeyFieldAssociation

public void addSourceToTargetKeyFieldAssociation(XMLField srcField,
 XMLField tgtField)

buildFieldValue

public Object buildFieldValue(Object targetObject,
 XMLField xmlFld,
 AbstractSession session)

INTERNAL: Retrieve the target object's primary key value that is mapped to a given source xpath (in the source-target key field association list).

Specified by:

buildFieldValue in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

Returns:

null if the target object is null, the reference class is null, or a primary key field name does not exist on the reference descriptor that matches the target field name - otherwise, return the associated primary key value

buildReference

public void buildReference(UnmarshalRecord record,
 XMLField xmlField,
 Object object,
 AbstractSession session)

INTERNAL: Create (if necessary) and populate a reference object that will be used during the mapping reference resolution phase after unmarshalling is complete.

Specified by:

buildReference in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

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

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

getFields

public Vector getFields()

INTERNAL: Return a list of XMLFields based on the source XPath values in the source-target key field associations list.

Specified by:

getFields in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

Overrides:

getFields in class DatabaseMapping

Returns:

TODO

getSchemaType

protected QName getSchemaType(XMLField xmlField,
 Object value,
 AbstractSession session)

Return a QName representation the schema type for a given XMLField, if applicable. Note: This method performs the same functionality as 'getSchemaType' in org.eclipse.persistence.internal.oxm.XMLSimpleMappingNodeValue.

getSingleValueToWriteForUnion

protected QName getSingleValueToWriteForUnion(XMLUnionField xmlField,
 Object value,
 AbstractSession session)

Return a single QName representation for a given XMLUnionField, if applicable. Note: This method performs the same functionality as 'getSingleValueToWriteForUnion' in org.eclipse.persistence.internal.oxm.XMLSimpleMappingNodeValue.

getSourceToTargetKeyFieldAssociations

public HashMap getSourceToTargetKeyFieldAssociations()

INTERNAL: Return a list of source-target xmlfield pairs.

Specified by:

getSourceToTargetKeyFieldAssociations in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

getValueToWrite

protected String getValueToWrite(QName schemaType,
 Object value,
 AbstractSession session)

Return a string representation of a given value, based on a given schema type. Note: This method performs the same functionality as 'getValueToWrite' in org.eclipse.persistence.internal.oxm.XMLSimpleMappingNodeValue.

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

INTERNAL: Register a ReferenceResolver as an event listener on the session, if one doesn't already exist. Each source/target field will have a namespace resolver set as well.

Overrides:

initialize in class AggregateMapping

Throws:

DescriptorException

See Also:

• ReferenceResolver
• NamespaceResolver

preInitialize

public void preInitialize(AbstractSession session)
                   throws DescriptorException

Description copied from class: DatabaseMapping

INTERNAL: Allow for initialization of properties and validation.

Overrides:

preInitialize in class DatabaseMapping

Throws:

DescriptorException

isXMLMapping

public boolean isXMLMapping()

INTERNAL: Indicates that this is an XML mapping.

Overrides:

isXMLMapping in class DatabaseMapping

readFromRowIntoObject

public Object readFromRowIntoObject(AbstractRecord databaseRow,
 JoinedAttributeManager joinManager,
 Object targetObject,
 CacheKey parentCacheKey,
 ObjectBuildingQuery sourceQuery,
 AbstractSession executionSession,
 boolean isTargetProtected)
                             throws DatabaseException

INTERNAL: Extract the primary key values from the row, then create an org.eclipse.persistence.internal.oxm.Reference instance and store it on the session's org.eclipse.persistence.internal.oxm.ReferenceResolver.

Overrides:

readFromRowIntoObject in class DatabaseMapping

Throws:

DatabaseException

setField

public void setField(DatabaseField field)

setSourceToTargetKeyFieldAssociations

public void setSourceToTargetKeyFieldAssociations(HashMap sourceToTargetKeyFieldAssociations)

INTERNAL: Set the list of source-target xmlfield pairs.

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
 AbstractRecord row,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)

INTERNAL: Write the attribute value from the object to the row.

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

writeSingleValue

public void writeSingleValue(Object value,
 Object parent,
 XMLRecord row,
 AbstractSession session)

Description copied from interface: XMLMapping

INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath. Used for Sequenced marshalling.

Specified by:

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

Specified by:

writeSingleValue in interface XMLMapping

Parameters:

value - - The value to be marshalled

row - - The Record the value is being marshalled too.

setIsWriteOnly

public void setIsWriteOnly(boolean b)

Specified by:

setIsWriteOnly in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

Specified by:

setIsWriteOnly in interface XMLMapping

isWriteOnly

public boolean isWriteOnly()

Description copied from class: DatabaseMapping

INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).

Specified by:

isWriteOnly in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

Specified by:

isWriteOnly in interface XMLMapping

Overrides:

isWriteOnly in class DatabaseMapping

Returns:

TODO

setAttributeValueInObject

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

Description copied from class: DatabaseMapping

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

Specified by:

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

Overrides:

setAttributeValueInObject in class DatabaseMapping

Parameters:

object - TODO

value - TODO

Throws:

DescriptorException

getInverseReferenceMapping

public XMLInverseReferenceMapping getInverseReferenceMapping()

Specified by:

getInverseReferenceMapping in interface ObjectReferenceMapping<AbstractSession,AttributeAccessor,ContainerPolicy,ClassDescriptor,DatabaseField,UnmarshalRecord,XMLField,XMLRecord>

isObjectReferenceMapping

public boolean isObjectReferenceMapping()

Description copied from class: DatabaseMapping

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

Overrides:

isObjectReferenceMapping in class DatabaseMapping