XMLCompositeObjectMapping (EclipseLink 2.6.4, API Reference)

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

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.XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>, XMLMapping, XMLNillableMapping

Direct Known Subclasses:: XMLVariableXPathObjectMapping

public class XMLCompositeObjectMapping
extends AbstractCompositeObjectMapping
implements XMLMapping, 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>, XMLNillableMapping

Composite object XML mappings represent a relationship between two classes. In XML, the "owned" class may be nested with the element tag representing the "owning" class. This mapping is, by definition, privately owned.

Composite object XML mappings can be used in the following scenarios:

Mapping into the Parent Record
Mapping to an Element
Mapping to Different Elements by Element Name
Mapping to Different Elements by Element Position

Setting the XPath: TopLink XML mappings make use of XPath statements to find the relevant data in an XML document. The XPath statement is relative to the context node specified in the descriptor. The XPath may contain path and positional information; the last node in the XPath forms the local root node for the composite object. The XPath is specified on the mapping using the setXPath method.

The following XPath statements may be used to specify the location of XML data relating to an object's name attribute:

XPath	Description
.	Indicates "self".
phone-number	The phone-number information is stored in the phone-number element.
contact-info/phone-number	The XPath statement may be used to specify any valid path.
phone-number[2]	The XPath statement may contain positional information. In this case the phone-number information is stored in the second occurrence of the phone-number element.

Mapping into the Parent Record: The composite object may be mapped into the parent record in a corresponding XML document.

XML Schema
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <xsd:element name="customer" type="customer-type"/> <xsd:complexType name="customer-type"> <xsd:sequence> <xsd:element name="first-name" type="xsd:string"/> <xsd:element name="last-name" type="xsd:string"/> <xsd:element name="street" type="xsd:string"/> <xsd:element name="city" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:schema>

Code Sample
XMLCompositeObjectMapping addressMapping = new XMLCompositeObjectMapping(); addressMapping.setAttributeName("address"); addressMapping.setXPath("."); addressMapping.setReferenceClass(Address.class);

Mapping to an Element: The composite object may be mapped to an element in a corresponding XML document.

XML Schema
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <xsd:element name="customer" type="customer-type"/> <xsd:complexType name="customer-type"> <xsd:sequence> <xsd:element name="first-name" type="xsd:string"/> <xsd:element name="last-name" type="xsd:string"/> <xsd:element name="address"> <xsd:complexType> <xsd:sequence> <xsd:element name="street" type="xsd:string"/> <xsd:element name="city" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:schema>

Code Sample
XMLCompositeObjectMapping addressMapping = new XMLCompositeObjectMapping(); addressMapping.setAttributeName("address"); addressMapping.setXPath("address"); addressMapping.setReferenceClass(Address.class);

More Information: For more information about using the XML Composite Object Mapping, see the "Understanding XML Mappings" chapter of the Oracle TopLink Developer's Guide.

See Also:: Serialized Form
Since:: Oracle TopLink 10g Release 2 (10.1.3)

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.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 and Description

XMLCompositeObjectMapping()

Constructors
Constructor and Description
`XMLCompositeObjectMapping()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`buildCompositeObject(org.eclipse.persistence.internal.descriptors.ObjectBuilder objectBuilder, org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow, ObjectBuildingQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)`
`protected java.lang.Object`	`buildCompositeRow(java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, DatabaseMapping.WriteType writeType)`
`protected org.eclipse.persistence.internal.sessions.AbstractRecord`	`buildCompositeRowForDescriptor(ClassDescriptor classDesc, java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session, XMLRecord parentRow, DatabaseMapping.WriteType writeType)`
`void`	`configureNestedRow(org.eclipse.persistence.internal.sessions.AbstractRecord parent, org.eclipse.persistence.internal.sessions.AbstractRecord child)`
`void`	`convertClassNamesToClasses(java.lang.ClassLoader classLoader)` INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings.
`java.lang.Object`	`convertDataValueToObjectValue(java.lang.Object fieldValue, Session session, XMLUnmarshaller unmarshaller)` INTERNAL
`java.lang.Object`	`convertObjectValueToDataValue(java.lang.Object value, Session session, XMLMarshaller marshaller)` INTERNAL
`AttributeAccessor`	`getContainerAccessor()` Deprecated. Replaced by getInverseReferenceMapping().getAttributeAccessor()
`java.lang.String`	`getContainerAttributeName()` Deprecated. Replaced by getInverseReferenceMapping().getAttributeName()
`java.lang.String`	`getContainerGetMethodName()` Deprecated. Replaced by getInverseReferenceMapping().getGetMethodName()
`java.lang.String`	`getContainerSetMethodName()` Deprecated. Replaced by getInverseReferenceMapping().getSetMethodName()
`protected XMLDescriptor`	`getDescriptor(XMLRecord xmlRecord, org.eclipse.persistence.internal.sessions.AbstractSession session, javax.xml.namespace.QName rootQName)`
`XMLInverseReferenceMapping`	`getInverseReferenceMapping()`
`UnmarshalKeepAsElementPolicy`	`getKeepAsElementPolicy()`
`AbstractNullPolicy`	`getNullPolicy()` INTERNAL: Get the AbstractNullPolicy from the Mapping.
`protected ClassDescriptor`	`getReferenceDescriptor(java.lang.Class theClass, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: For inheritance purposes.
`ClassDescriptor`	`getReferenceDescriptor(DOMRecord xmlRecord)`
`java.lang.String`	`getXPath()` Get the XPath String
`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`	`isWriteOnly()` INTERNAL: Some mappings support no attribute (transformation and multitenant primary key).
`boolean`	`isXMLMapping()` INTERNAL:
`void`	`preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Allow for initialization of properties and validation.
`java.lang.Object`	`readFromRowIntoObject(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, java.lang.Object targetObject, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected)` INTERNAL: Extract value from the row and set the attribute to this value in the object.
`void`	`setAttributeValueInObject(java.lang.Object object, java.lang.Object value)` INTERNAL: Set the value of the attribute mapped by this mapping.
`void`	`setContainerAccessor(AttributeAccessor anAttributeAccessor)` Deprecated. Replaced by getInverseReferenceMapping().setAttributeAccessor()
`void`	`setContainerAttributeName(java.lang.String attributeName)` Deprecated. Replaced by getInverseReferenceMapping().setAttributeName()
`void`	`setContainerGetMethodName(java.lang.String methodName)` Deprecated. Replaced by getInverseReferenceMapping().setGetMethodName()
`void`	`setContainerSetMethodName(java.lang.String methodName)` Deprecated. Replaced by getInverseReferenceMapping().setSetMethodName()
`void`	`setIsWriteOnly(boolean b)`
`void`	`setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy keepAsElementPolicy)`
`void`	`setNullPolicy(AbstractNullPolicy aNullPolicy)` Set the AbstractNullPolicy on the mapping The default policy is NullPolicy.
`void`	`setXPath(java.lang.String xpathString)` Set the Mapping field name attribute to the given XPath String
`java.lang.Object`	`valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected, java.lang.Boolean[] wasCacheUsed)` INTERNAL: Extract and return the aggregate object from the specified row.
`java.lang.Object`	`valueFromRow(java.lang.Object fieldValue, XMLRecord nestedRow, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected)`
`void`	`writeFromObjectIntoRow(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)` INTERNAL:
`void`	`writeSingleValue(java.lang.Object value, java.lang.Object parent, XMLRecord record, 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.mappings.foundation.AbstractCompositeObjectMapping
buildExpression, buildShallowOriginalFromRow, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, collectFields, getConverter, getField, hasConverter, isAbstractCompositeObjectMapping, 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, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isAttributeValueFromObjectInstantiated, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, 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, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setGetMethodName, setIsReadOnly, setProperties, setSetMethodName

- Constructor Detail
  - XMLCompositeObjectMapping
```
public XMLCompositeObjectMapping()
```
- Method Detail
  - getContainerAccessor
```
@Deprecated
public AttributeAccessor getContainerAccessor()
```
    Deprecated. Replaced by getInverseReferenceMapping().getAttributeAccessor()
    
    Gets the AttributeAccessor that is used to get and set the value of the container on the target object.
  - setContainerAccessor
```
@Deprecated
public void setContainerAccessor(AttributeAccessor anAttributeAccessor)
```
    Deprecated. Replaced by getInverseReferenceMapping().setAttributeAccessor()
    
    Sets the AttributeAccessor that is used to get and set the value of the container on the target object.
    
    Parameters:
    anAttributeAccessor - - the accessor to be used.
  - setContainerAttributeName
```
@Deprecated
public void setContainerAttributeName(java.lang.String attributeName)
```
    Deprecated. Replaced by getInverseReferenceMapping().setAttributeName()
    
    Sets the name of the backpointer attribute on the target object. Used to populate the backpointer. If the specified attribute doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.
    
    Parameters:
    attributeName - - the name of the backpointer attribute to be populated
  - getContainerAttributeName
```
@Deprecated
public java.lang.String getContainerAttributeName()
```
    Deprecated. Replaced by getInverseReferenceMapping().getAttributeName()
    
    Gets the name of the backpointer attribute on the target object. Used to populate the backpointer.
  - setContainerGetMethodName
```
@Deprecated
public void setContainerGetMethodName(java.lang.String methodName)
```
    Deprecated. Replaced by getInverseReferenceMapping().setGetMethodName()
    
    Sets the method name to be used when accessing the value of the back pointer on the target object of this mapping. If the specified method doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.
    
    Parameters:
    methodName - - the getter method to be used.
  - setContainerSetMethodName
```
@Deprecated
public void setContainerSetMethodName(java.lang.String methodName)
```
    Deprecated. Replaced by getInverseReferenceMapping().setSetMethodName()
    
    Sets the name of the method to be used when setting the value of the back pointer on the target object of this mapping. If the specified method doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.
    
    Parameters:
    methodName - - the setter method to be used.
  - getContainerGetMethodName
```
@Deprecated
public java.lang.String getContainerGetMethodName()
```
    Deprecated. Replaced by getInverseReferenceMapping().getGetMethodName()
    
    Gets the name of the method to be used when accessing the value of the back pointer on the target object of this mapping.
  - getContainerSetMethodName
```
@Deprecated
public java.lang.String getContainerSetMethodName()
```
    Deprecated. Replaced by getInverseReferenceMapping().getSetMethodName()
    
    Gets the name of the method to be used when setting the value of the back pointer on the target object of this mapping.
  - convertClassNamesToClasses
```
public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
```
    Description copied from class: AggregateMapping
    
    INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.
    
    Specified by:
    
    convertClassNamesToClasses 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:
    
    convertClassNamesToClasses in interface XMLMapping
    
    Overrides:
    
    convertClassNamesToClasses in class AggregateMapping
  - initialize
```
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException
```
    INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.
    
    Overrides:
    
    initialize in class AbstractCompositeObjectMapping
    
    Throws:
    
    DescriptorException
  - initializeReferenceDescriptorAndField
```
protected void initializeReferenceDescriptorAndField(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
  - setNullPolicy
```
public void setNullPolicy(AbstractNullPolicy aNullPolicy)
```
    Set the AbstractNullPolicy on the mapping
    The default policy is NullPolicy.
    
    Specified by:
    
    setNullPolicy in interface 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>
    
    Specified by:
    
    setNullPolicy in interface XMLNillableMapping
    
    Parameters:
    aNullPolicy -
  - getNullPolicy
```
public AbstractNullPolicy getNullPolicy()
```
    INTERNAL: Get the AbstractNullPolicy from the Mapping.
    The default policy is NullPolicy.
    
    Specified by:
    
    getNullPolicy in interface 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>
    
    Specified by:
    
    getNullPolicy in interface XMLNillableMapping
    
    Returns:
  - isXMLMapping
```
public boolean isXMLMapping()
```
    INTERNAL:
    
    Overrides:
    
    isXMLMapping in class DatabaseMapping
  - getXPath
```
public java.lang.String getXPath()
```
    Get the XPath String
    
    Returns:
    String the XPath String associated with this Mapping
  - setXPath
```
public void setXPath(java.lang.String xpathString)
```
    Set the Mapping field name attribute to the given XPath String
    
    Specified by:
    
    setXPath in interface 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>
    
    Parameters:
    xpathString - String
  - buildCompositeRow
```
protected java.lang.Object buildCompositeRow(java.lang.Object attributeValue,
                                 org.eclipse.persistence.internal.sessions.AbstractSession session,
                                 org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                                 DatabaseMapping.WriteType writeType)
```
    Specified by:
    
    buildCompositeRow in class AbstractCompositeObjectMapping
  - buildCompositeRowForDescriptor
```
protected org.eclipse.persistence.internal.sessions.AbstractRecord buildCompositeRowForDescriptor(ClassDescriptor classDesc,
                                                                                      java.lang.Object attributeValue,
                                                                                      org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                                                      XMLRecord parentRow,
                                                                                      DatabaseMapping.WriteType writeType)
```
  - buildCompositeObject
```
protected java.lang.Object buildCompositeObject(org.eclipse.persistence.internal.descriptors.ObjectBuilder objectBuilder,
                                    org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow,
                                    ObjectBuildingQuery query,
                                    org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                    org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                    org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
```
    Specified by:
    
    buildCompositeObject in class AbstractCompositeObjectMapping
  - readFromRowIntoObject
```
public java.lang.Object readFromRowIntoObject(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                                     org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                     java.lang.Object targetObject,
                                     org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                     ObjectBuildingQuery sourceQuery,
                                     org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                                     boolean isTargetProtected)
                                       throws DatabaseException
```
    Description copied from class: DatabaseMapping
    
    INTERNAL: Extract value from the row and set the attribute to this value in the object. return value as this value will have been converted to the appropriate type for the object.
    
    Overrides:
    
    readFromRowIntoObject in class DatabaseMapping
    
    Throws:
    
    DatabaseException
  - valueFromRow
```
public java.lang.Object valueFromRow(java.lang.Object fieldValue,
                            XMLRecord nestedRow,
                            org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                            ObjectBuildingQuery sourceQuery,
                            org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                            boolean isTargetProtected)
                              throws DatabaseException
```
    Throws:
    
    DatabaseException
  - valueFromRow
```
public java.lang.Object valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                            org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                            ObjectBuildingQuery sourceQuery,
                            org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                            org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                            boolean isTargetProtected,
                            java.lang.Boolean[] wasCacheUsed)
                              throws DatabaseException
```
    Description copied from class: AbstractCompositeObjectMapping
    
    INTERNAL: Extract and return the aggregate object from the specified row.
    
    Overrides:
    
    valueFromRow in class AbstractCompositeObjectMapping
    
    Throws:
    
    DatabaseException
  - writeFromObjectIntoRow
```
public void writeFromObjectIntoRow(java.lang.Object object,
                          org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                          org.eclipse.persistence.internal.sessions.AbstractSession session,
                          DatabaseMapping.WriteType writeType)
                            throws DescriptorException
```
    INTERNAL:
    
    Overrides:
    
    writeFromObjectIntoRow in class AbstractCompositeObjectMapping
    
    Throws:
    
    DescriptorException
  - writeSingleValue
```
public void writeSingleValue(java.lang.Object value,
                    java.lang.Object parent,
                    XMLRecord record,
                    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
    
    Parameters:
    value - - The value to be marshalled
    record - - The Record the value is being marshalled too.
  - configureNestedRow
```
public void configureNestedRow(org.eclipse.persistence.internal.sessions.AbstractRecord parent,
                      org.eclipse.persistence.internal.sessions.AbstractRecord child)
```
  - getReferenceDescriptor
```
public ClassDescriptor getReferenceDescriptor(DOMRecord xmlRecord)
```
  - getReferenceDescriptor
```
protected ClassDescriptor getReferenceDescriptor(java.lang.Class theClass,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    Description copied from class: AggregateMapping
    
    INTERNAL: For inheritance purposes.
    
    Overrides:
    
    getReferenceDescriptor in class AggregateMapping
  - getKeepAsElementPolicy
```
public UnmarshalKeepAsElementPolicy getKeepAsElementPolicy()
```
    Specified by:
    
    getKeepAsElementPolicy in interface 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>
  - setKeepAsElementPolicy
```
public void setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy keepAsElementPolicy)
```
    Specified by:
    
    setKeepAsElementPolicy in interface 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>
  - getDescriptor
```
protected XMLDescriptor getDescriptor(XMLRecord xmlRecord,
                          org.eclipse.persistence.internal.sessions.AbstractSession session,
                          javax.xml.namespace.QName rootQName)
                               throws XMLMarshalException
```
    Throws:
    
    XMLMarshalException
  - setIsWriteOnly
```
public void setIsWriteOnly(boolean b)
```
    Specified by:
    
    setIsWriteOnly in interface 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>
    
    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 XMLMapping
    
    Overrides:
    
    isWriteOnly in class DatabaseMapping
  - preInitialize
```
public void preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                   throws DescriptorException
```
    Description copied from class: DatabaseMapping
    
    INTERNAL: Allow for initialization of properties and validation.
    
    Overrides:
    
    preInitialize in class DatabaseMapping
    
    Throws:
    
    DescriptorException
  - setAttributeValueInObject
```
public void setAttributeValueInObject(java.lang.Object object,
                             java.lang.Object value)
                               throws DescriptorException
```
    Description copied from class: AbstractCompositeObjectMapping
    
    INTERNAL: Set the value of the attribute mapped by this mapping.
    
    Specified by:
    
    setAttributeValueInObject 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:
    
    setAttributeValueInObject in class AbstractCompositeObjectMapping
    
    Throws:
    
    DescriptorException
  - getInverseReferenceMapping
```
public XMLInverseReferenceMapping getInverseReferenceMapping()
```
    Specified by:
    
    getInverseReferenceMapping in interface 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>
  - convertObjectValueToDataValue
```
public java.lang.Object convertObjectValueToDataValue(java.lang.Object value,
                                             Session session,
                                             XMLMarshaller marshaller)
```
    INTERNAL
    
    Specified by:
    
    convertObjectValueToDataValue in interface org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>
    
    Since:
    
    EclipseLink 2.5.0
  - convertDataValueToObjectValue
```
public java.lang.Object convertDataValueToObjectValue(java.lang.Object fieldValue,
                                             Session session,
                                             XMLUnmarshaller unmarshaller)
```
    INTERNAL
    
    Specified by:
    
    convertDataValueToObjectValue in interface org.eclipse.persistence.internal.oxm.mappings.XMLConverterMapping<XMLMarshaller,Session,XMLUnmarshaller>
    
    Since:
    
    EclipseLink 2.5.0

Class XMLCompositeObjectMapping

Nested Class Summary

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

XMLCompositeObjectMapping

Method Detail

getContainerAccessor

setContainerAccessor

setContainerAttributeName

getContainerAttributeName

setContainerGetMethodName

setContainerSetMethodName

getContainerGetMethodName

getContainerSetMethodName

convertClassNamesToClasses

initialize

initializeReferenceDescriptorAndField

setNullPolicy

getNullPolicy

isXMLMapping

getXPath

setXPath

buildCompositeRow

buildCompositeRowForDescriptor

buildCompositeObject

readFromRowIntoObject

valueFromRow

valueFromRow

writeFromObjectIntoRow

writeSingleValue

configureNestedRow

getReferenceDescriptor

getReferenceDescriptor

getKeepAsElementPolicy

setKeepAsElementPolicy

getDescriptor

setIsWriteOnly

isWriteOnly

preInitialize

setAttributeValueInObject

getInverseReferenceMapping

convertObjectValueToDataValue

convertDataValueToObjectValue