Package org.eclipse.persistence.oxm.mappings

Class XMLFragmentCollectionMapping

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.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 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:
    Serialized Form

    • Constructor Detail

      • XMLFragmentCollectionMapping

        public XMLFragmentCollectionMapping()

    • Method Detail

      • setXPath

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

      • getXPath

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

      • 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
        INTERNAL: Build the nested collection from the database row.
        Overrides:
        valueFromRow in class AbstractCompositeDirectCollectionMapping
        Throws:
        DatabaseException

      • writeSingleValue

        public void writeSingleValue​(java.lang.Object attributeValue,
                             java.lang.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.

      • 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.
        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
        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.mappings.XMLContainerMapping
        Since:
        EclipseLink 2.3.3

      • getWrapperNullPolicy

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

      • setWrapperNullPolicy

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