EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.oxm.mappings
Class XMLCompositeCollectionMapping

java.lang.Object
  extended by org.eclipse.persistence.mappings.DatabaseMapping
      extended by org.eclipse.persistence.mappings.AggregateMapping
          extended by org.eclipse.persistence.mappings.foundation.AbstractCompositeCollectionMapping
              extended by org.eclipse.persistence.oxm.mappings.XMLCompositeCollectionMapping
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.internal.oxm.XMLContainerMapping, ContainerMapping, ArrayCollectionMapping, XMLMapping, XMLNillableMapping

public class XMLCompositeCollectionMapping
extends AbstractCompositeCollectionMapping
implements XMLMapping, XMLNillableMapping, org.eclipse.persistence.internal.oxm.XMLContainerMapping

Composite collection XML mappings map an attribute that contains a homogeneous collection of objects to multiple XML elements. Use composite collection XML mappings to represent one-to-many relationships. Composite collection XML mappings can reference any class that has a TopLink descriptor. The attribute in the object mapped must implement either the Java Collection interface (for example, Vector or HashSet) or Map interface (for example, Hashtable or TreeMap). The CompositeCollectionMapping class allows a reference to the mapped class and the indexing type for that class. This mapping is, by definition, privately owned.

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
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 a Composite Collection:

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="phone-number">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element name="number" type="xsd:string"/>
          </xsd:sequence>
          <xsd:attribute name="type" type="xsd:string"/>
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Code Sample
XMLCompositeCollectionMapping phoneNumbersMapping = new XMLCompositeCollectionMapping();
phoneNumbersMapping.setAttributeName("phoneNumbers");
phoneNumbersMapping.setXPath("phone-number");
phoneNumbersMapping.setReferenceClass(PhoneNumber.class);

More Information: For more information about using the XML Composite Collection 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.AbstractCompositeCollectionMapping
converter, field
 
Fields inherited from class org.eclipse.persistence.mappings.AggregateMapping
referenceClass, referenceClassName, referenceDescriptor
 
Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping
attributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, unconvertedProperties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM
 
Fields inherited from interface org.eclipse.persistence.internal.oxm.XMLContainerMapping
EMPTY_CONTAINER_DEFAULT
 
Constructor Summary
XMLCompositeCollectionMapping()
           
 
Method Summary
protected  java.lang.Object buildCompositeObject(ClassDescriptor descriptor, org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow, ObjectBuildingQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManger, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
           
protected  org.eclipse.persistence.internal.sessions.AbstractRecord buildCompositeRow(java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord parentRow, DatabaseMapping.WriteType writeType)
           
 java.lang.Object buildObjectFromNestedRow(org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected)
           
 void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
          INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings.
 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)
           
 boolean getReuseContainer()
          Return true if the original container on the object should be used if present.
 AbstractNullPolicy getWrapperNullPolicy()
           
 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.
 boolean isDefaultEmptyContainer()
          INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.
 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.
 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 setDefaultEmptyContainer(boolean defaultEmptyContainer)
          INTERNAL Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.
 void setIsWriteOnly(boolean b)
           
 void setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy keepAsElementPolicy)
           
 void setNullPolicy(AbstractNullPolicy aNullPolicy)
          Set the AbstractNullPolicy on the mapping
The default policy is NullPolicy.
 void setReuseContainer(boolean reuseContainer)
          Specify whether the original container on the object should be used if present.
 void setWrapperNullPolicy(AbstractNullPolicy policy)
           
 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: Build and return an aggregate collection from the specified row.
 void writeFromObjectIntoRow(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, 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.AbstractCompositeCollectionMapping
buildAddedElementFromChangeSet, buildBackupClonePart, buildChangeSet, buildClonePart, buildCopyOfAttributeValue, buildElementFromChangeSet, buildElementFromElement, buildRemovedElementFromChangeSet, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, collectFields, compareElements, compareElementsForChange, compareForChange, compareObjects, convertToChangeRecord, createMapComponentFromRow, fixAttributeValue, getAttributeValueFromBackupClone, getContainerPolicy, getConverter, getField, getRealCollectionAttributeValueFromObject, getStructureName, hasConverter, isAbstractCompositeCollectionMapping, isCollectionMapping, iterateOnAttributeValue, mapKeyHasChanged, mergeChangesIntoObject, mergeIntoObject, postDeleteAttributeValue, postInsertAttributeValue, postUpdateAttributeValue, preDeleteAttributeValue, preInsertAttributeValue, preUpdateAttributeValue, setContainerPolicy, setConverter, setField, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, useCollectionClass, useCollectionClassName, useListClassName, useMapClass, useMapClassName, verifyDeleteOfAttributeValue, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow
 
Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping
buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClone, buildClone, buildCloneFromRow, buildClonePart, buildCopy, buildExpression, buildNewMergeInstanceOf, compareAttributeValues, executeEvent, fixObjectReferences, getObjectBuilder, getObjectBuilderForClass, getQueryManager, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getReferenceDescriptor, isAggregateMapping, iterate, mergeAttributeValue, postDelete, postInsert, postUpdate, preDelete, preInsert, preUpdate, remoteInitialization, setReferenceClass, setReferenceClassName, setReferenceDescriptor, updateChangeRecord, verifyDelete
 
Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping
addUnconvertedProperty, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, cloneFields, collectQueryParameters, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getOrderByNormalizedExpressions, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, instantiateAttribute, isAbstractColumnMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, toString, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, 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.mappings.structures.ArrayCollectionMapping
getAttributeName, setRealAttributeValueInObject
 

Constructor Detail

XMLCompositeCollectionMapping

public XMLCompositeCollectionMapping()
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.


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 isn't declared on the reference class of this mapping, a DescriptorException will be thrown during initialize.

Parameters:
methodName - - the name of the getter 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.


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 isn't declared on the reference class of this mapping, a DescriptorException will be raised during initialize.

Parameters:
methodName - - the name of the setter method to be used.

isXMLMapping

public boolean isXMLMapping()
INTERNAL:

Overrides:
isXMLMapping in class DatabaseMapping

convertClassNamesToClasses

public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
Description copied from class: AbstractCompositeCollectionMapping
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 XMLMapping
Overrides:
convertClassNamesToClasses in class AbstractCompositeCollectionMapping

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 AbstractCompositeCollectionMapping
Throws:
DescriptorException

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

Parameters:
xpathString - String

buildCompositeObject

protected java.lang.Object buildCompositeObject(ClassDescriptor descriptor,
                                                org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow,
                                                ObjectBuildingQuery query,
                                                org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                                org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManger,
                                                org.eclipse.persistence.internal.sessions.AbstractSession targetSession)
Specified by:
buildCompositeObject in class AbstractCompositeCollectionMapping

buildCompositeRow

protected org.eclipse.persistence.internal.sessions.AbstractRecord buildCompositeRow(java.lang.Object attributeValue,
                                                                                     org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                                                     org.eclipse.persistence.internal.sessions.AbstractRecord parentRow,
                                                                                     DatabaseMapping.WriteType writeType)
Specified by:
buildCompositeRow in class AbstractCompositeCollectionMapping

writeFromObjectIntoRow

public void writeFromObjectIntoRow(java.lang.Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)
                            throws DescriptorException
INTERNAL:

Overrides:
writeFromObjectIntoRow in class AbstractCompositeCollectionMapping
Throws:
DescriptorException

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: AbstractCompositeCollectionMapping
INTERNAL: Build and return an aggregate collection from the specified row.

Overrides:
valueFromRow in class AbstractCompositeCollectionMapping
Throws:
DatabaseException

buildObjectFromNestedRow

public java.lang.Object buildObjectFromNestedRow(org.eclipse.persistence.internal.sessions.AbstractRecord nestedRow,
                                                 org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                                 ObjectBuildingQuery sourceQuery,
                                                 org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                                                 boolean isTargetProtected)

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

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 XMLMapping
Parameters:
value - - The value to be marshalled
record - - The Record the value is being marshalled too.

setNullPolicy

public void setNullPolicy(AbstractNullPolicy aNullPolicy)
Set the AbstractNullPolicy on the mapping
The default policy is NullPolicy.

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 XMLNillableMapping
Returns:

getKeepAsElementPolicy

public UnmarshalKeepAsElementPolicy getKeepAsElementPolicy()

setKeepAsElementPolicy

public void setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy keepAsElementPolicy)

getDescriptor

protected XMLDescriptor getDescriptor(XMLRecord xmlRecord,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session,
                                      javax.xml.namespace.QName rootQName)
                               throws XMLMarshalException
Throws:
XMLMarshalException

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

setIsWriteOnly

public void setIsWriteOnly(boolean b)
Specified by:
setIsWriteOnly in interface XMLMapping

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: DatabaseMapping
INTERNAL: Set the value of the attribute mapped by this mapping.

Overrides:
setAttributeValueInObject in class DatabaseMapping
Throws:
DescriptorException

getReuseContainer

public boolean getReuseContainer()
Return true if the original container on the object should be used if present. If it is not present then the container policy will be used to create the container.

Specified by:
getReuseContainer in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping

setReuseContainer

public void setReuseContainer(boolean reuseContainer)
Specify whether the original container on the object should be used if present. If it is not present then the container policy will be used to create the container.

Specified by:
setReuseContainer in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping

getInverseReferenceMapping

public XMLInverseReferenceMapping getInverseReferenceMapping()

isDefaultEmptyContainer

public boolean isDefaultEmptyContainer()
INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.

Specified by:
isDefaultEmptyContainer in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping
Since:
EclipseLink 2.3.3

setDefaultEmptyContainer

public void setDefaultEmptyContainer(boolean defaultEmptyContainer)
INTERNAL Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.

Specified by:
setDefaultEmptyContainer in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping
Since:
EclipseLink 2.3.3

getWrapperNullPolicy

public AbstractNullPolicy getWrapperNullPolicy()
Specified by:
getWrapperNullPolicy in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping

setWrapperNullPolicy

public void setWrapperNullPolicy(AbstractNullPolicy policy)
Specified by:
setWrapperNullPolicy in interface org.eclipse.persistence.internal.oxm.XMLContainerMapping

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference