Package org.eclipse.persistence.oxm.mappings

Class XMLFragmentCollectionMapping

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.foundation.AbstractCompositeDirectCollectionMapping
org.eclipse.persistence.oxm.mappings.XMLFragmentCollectionMapping
All Implemented Interfaces:
Serializable, Cloneable, org.eclipse.persistence.internal.oxm.mappings.FragmentCollectionMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,Session,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.XMLContainerMapping, ContainerMapping, ArrayCollectionMapping, XMLMapping
public class XMLFragmentCollectionMapping extends AbstractCompositeDirectCollectionMapping implements org.eclipse.persistence.internal.oxm.mappings.FragmentCollectionMapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,Session,XMLRecord>, XMLMapping

Purpose: This mapping provides a means to keep a part of the xml tree as a collection of DOM elements.

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 fragment. The XPath is specified on the mapping using the setXPath method.

XPath statements
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.

Sample Configuration: 


 XMLFragmentCollectionMapping mapping = new XMLFragmentCollectionMapping();
 mapping.setAttributeName("phoneNumbers");
 mapping.setXPath("contact-info/phone-number");
See Also:

  • Constructor Details

    • XMLFragmentCollectionMapping

      public XMLFragmentCollectionMapping()

  • Method Details

    • isXMLMapping

      public boolean isXMLMapping()
      INTERNAL:
      Overrides:
      isXMLMapping in class DatabaseMapping

    • initialize

      public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorException
      INTERNAL: Initialize the mapping.
      Overrides:
      initialize in class AbstractCompositeDirectCollectionMapping
      Throws:
      DescriptorException

    • setXPath

      public void setXPath(String xpathString)
      Set the Mapping field name attribute to the given XPath String
      Parameters:
      xpathString - String

    • getXPath

      public String getXPath()
      Get the XPath String
      Returns:
      String the XPath String associated with this Mapping

    • valueFromRow

      public 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, Boolean[] wasCacheUsed) throws DatabaseException
      INTERNAL: Build the nested collection from the database row.
      Overrides:
      valueFromRow in class AbstractCompositeDirectCollectionMapping
      Throws:
      DatabaseException

    • writeFromObjectIntoRow

      public void writeFromObjectIntoRow(Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)
      INTERNAL:
      Overrides:
      writeFromObjectIntoRow in class AbstractCompositeDirectCollectionMapping

    • isAbstractCompositeDirectCollectionMapping

      public boolean isAbstractCompositeDirectCollectionMapping()
      Description copied from class: AbstractCompositeDirectCollectionMapping
      INTERNAL:
      Specified by:
      isAbstractCompositeDirectCollectionMapping 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:
      isAbstractCompositeDirectCollectionMapping in class AbstractCompositeDirectCollectionMapping

    • writeSingleValue

      public void writeSingleValue(Object attributeValue, Object parent, XMLRecord row, 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:
      attributeValue - - The value to be marshalled
      row - - The Record the value is being marshalled too.

    • 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(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 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 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.mappings.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.mappings.XMLContainerMapping

    • 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.mappings.XMLContainerMapping

    • 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.mappings.XMLContainerMapping

    • getWrapperNullPolicy

      public AbstractNullPolicy getWrapperNullPolicy()
      Description copied from interface: org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping
      Get the Wrapper NullPolicy from the Mapping.
      Specified by:
      getWrapperNullPolicy in interface org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping

    • setWrapperNullPolicy

      public void setWrapperNullPolicy(AbstractNullPolicy policy)
      Description copied from interface: org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping
      Set the Wrapper NullPolicy on the Mapping.
      Specified by:
      setWrapperNullPolicy in interface org.eclipse.persistence.internal.oxm.mappings.XMLContainerMapping