Package org.eclipse.persistence.oxm.mappings

Class XMLVariableXPathObjectMapping

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

org.eclipse.persistence.oxm.mappings.XMLCompositeObjectMapping

org.eclipse.persistence.oxm.mappings.XMLVariableXPathObjectMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.oxm.mappings.CompositeObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,UnmarshalKeepAsElementPolicy,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>, XMLMapping, XMLNillableMapping

public class XMLVariableXPathObjectMapping
extends XMLCompositeObjectMapping
implements org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>, XMLMapping

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 java.lang.String	variableAttributeName
protected java.lang.String	variableGetMethodName
protected java.lang.String	variableSetMethodName

Fields inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping

converter, 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

Constructor	Description
XMLVariableXPathObjectMapping()

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.persistence.internal.sessions.AbstractRecord	buildCompositeRow(XMLField variableField, java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord parentRow, DatabaseMapping.WriteType writeType)
protected java.util.Vector	collectFields()	Return the fields mapped by the mapping.
java.util.Vector	getFields()	INTERNAL: Returns a vector of all the fields this mapping represents.
AttributeAccessor	getVariableAttributeAccessor()
java.lang.String	getVariableAttributeName()
java.lang.String	getVariableGetMethodName()
java.lang.String	getVariableSetMethodName()
org.eclipse.persistence.internal.oxm.XPathFragment	getXPathFragmentForValue(java.lang.Object obj, org.eclipse.persistence.internal.oxm.NamespaceResolver nr, boolean isNamespaceAware, char namespaceSep)
void	initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)	INTERNAL: The mapping is initialized with the given session.
protected void	initializeReferenceDescriptorAndField(org.eclipse.persistence.internal.sessions.AbstractSession session)
boolean	isAbstractCompositeObjectMapping()	INTERNAL:
boolean	isAttribute()
void	setAttribute(boolean isAttribute)
void	setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)
void	setVariableAttributeName(java.lang.String variableAttributeName)
void	setVariableGetMethodName(java.lang.String variableGetMethodName)
void	setVariableSetMethodName(java.lang.String variableSetMethodName)
void	writeSingleValue(java.lang.Object value, java.lang.Object parent, XMLRecord xmlRow, org.eclipse.persistence.internal.sessions.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.oxm.mappings.XMLCompositeObjectMapping

buildCompositeObject, buildCompositeRow, buildCompositeRowForDescriptor, configureNestedRow, convertClassNamesToClasses, convertDataValueToObjectValue, convertObjectValueToDataValue, getContainerAccessor, getContainerAttributeName, getContainerGetMethodName, getContainerSetMethodName, getDescriptor, getInverseReferenceMapping, getKeepAsElementPolicy, getNullPolicy, getReferenceDescriptor, getReferenceDescriptor, getXPath, isWriteOnly, isXMLMapping, preInitialize, readFromRowIntoObject, setAttributeValueInObject, setContainerAccessor, setContainerAttributeName, setContainerGetMethodName, setContainerSetMethodName, setIsWriteOnly, setKeepAsElementPolicy, setNullPolicy, setXPath, valueFromRow, valueFromRow, writeFromObjectIntoRow

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping

buildExpression, buildShallowOriginalFromRow, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, getConverter, getField, hasConverter, setConverter, setField, valueFromObject, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow

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

buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClone, buildBackupClonePart, buildClone, buildCloneFromRow, buildClonePart, buildClonePart, buildCopy, buildCopyOfAttributeValue, buildNewMergeInstanceOf, compareAttributeValues, compareForChange, compareObjects, executeEvent, fixAttributeValue, fixObjectReferences, getAttributeValueFromBackupClone, getObjectBuilder, getObjectBuilderForClass, getQueryManager, getReferenceClass, getReferenceClassName, 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, 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, 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, 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

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

getReferenceClass, getReferenceClassName, hasConverter, setConverter, setField, setReferenceClass, setReferenceClassName

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

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

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

setConverter, setIsWriteOnly, setReferenceClassName

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

convertDataValueToObjectValue, convertObjectValueToDataValue

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

convertClassNamesToClasses, isWriteOnly, setIsWriteOnly

Field Detail

variableAttributeName

protected java.lang.String variableAttributeName

variableGetMethodName

protected java.lang.String variableGetMethodName

variableSetMethodName

protected java.lang.String variableSetMethodName

Constructor Detail

XMLVariableXPathObjectMapping

public XMLVariableXPathObjectMapping()

Method Detail

initialize

public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException

Description copied from class: XMLCompositeObjectMapping

INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.

Overrides:

initialize in class XMLCompositeObjectMapping

Throws:

DescriptorException

collectFields

protected java.util.Vector collectFields()

Description copied from class: AbstractCompositeObjectMapping

Return the fields mapped by the mapping.

Overrides:

collectFields in class AbstractCompositeObjectMapping

getFields

public java.util.Vector getFields()

Description copied from class: DatabaseMapping

INTERNAL: Returns a vector of all the fields this mapping represents.

Overrides:

getFields in class DatabaseMapping

initializeReferenceDescriptorAndField

protected void initializeReferenceDescriptorAndField(org.eclipse.persistence.internal.sessions.AbstractSession session)

Overrides:

initializeReferenceDescriptorAndField in class XMLCompositeObjectMapping

isAbstractCompositeObjectMapping

public boolean isAbstractCompositeObjectMapping()

Description copied from class: AbstractCompositeObjectMapping

INTERNAL:

Specified by:

isAbstractCompositeObjectMapping in interface org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>

Overrides:

isAbstractCompositeObjectMapping in class AbstractCompositeObjectMapping

getVariableAttributeName

public java.lang.String getVariableAttributeName()

setVariableAttributeName

public void setVariableAttributeName(java.lang.String variableAttributeName)

Specified by:

setVariableAttributeName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

getVariableGetMethodName

public java.lang.String getVariableGetMethodName()

setVariableGetMethodName

public void setVariableGetMethodName(java.lang.String variableGetMethodName)

Specified by:

setVariableGetMethodName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

getVariableSetMethodName

public java.lang.String getVariableSetMethodName()

setVariableSetMethodName

public void setVariableSetMethodName(java.lang.String variableSetMethodName)

Specified by:

setVariableSetMethodName in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

getVariableAttributeAccessor

public AttributeAccessor getVariableAttributeAccessor()

Specified by:

getVariableAttributeAccessor in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

setVariableAttributeAccessor

public void setVariableAttributeAccessor(AttributeAccessor variableAttributeAccessor)

Specified by:

setVariableAttributeAccessor in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

writeSingleValue

public void writeSingleValue(java.lang.Object value,
                             java.lang.Object parent,
                             XMLRecord xmlRow,
                             org.eclipse.persistence.internal.sessions.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 org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>

Specified by:

writeSingleValue in interface XMLMapping

Overrides:

writeSingleValue in class XMLCompositeObjectMapping

Parameters:

value - - The value to be marshalled

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

buildCompositeRow

protected org.eclipse.persistence.internal.sessions.AbstractRecord buildCompositeRow(XMLField variableField,
                                                                                     java.lang.Object attributeValue,
                                                                                     org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                                                     org.eclipse.persistence.internal.sessions.AbstractRecord parentRow,
                                                                                     DatabaseMapping.WriteType writeType)

getXPathFragmentForValue

public org.eclipse.persistence.internal.oxm.XPathFragment getXPathFragmentForValue(java.lang.Object obj,
                                                                                   org.eclipse.persistence.internal.oxm.NamespaceResolver nr,
                                                                                   boolean isNamespaceAware,
                                                                                   char namespaceSep)

Specified by:

getXPathFragmentForValue in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

isAttribute

public boolean isAttribute()

Specified by:

isAttribute in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>

setAttribute

public void setAttribute(boolean isAttribute)

Specified by:

setAttribute in interface org.eclipse.persistence.internal.oxm.mappings.VariableXPathObjectMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,Converter,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLMarshaller,Session,XMLUnmarshaller,XMLRecord>