Module eclipselink
Package org.eclipse.persistence.oxm.mappings

Class XMLDirectMapping

  • All Implemented Interfaces:
    Serializable, Cloneable, org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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.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>, MapComponentMapping, MapKeyMapping, XMLMapping, XMLNillableMapping
    Direct Known Subclasses:
    XMLBinaryDataMapping, XMLFragmentMapping
    public class XMLDirectMapping
extends AbstractDirectMapping
implements XMLMapping, org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>, XMLNillableMapping

    XML Direct Mappings map a Java attribute directly to XML attribute or text node.

    XML Direct Mappings can be used in the following scenarios:

    • Mapping to a Text Node
    • Mapping to an Attribute
    • Mapping to a Specified Schema Type
    • Mapping to a List Field
    • Mapping to a Union Field
    • Mapping to a Union of Lists
    • Mapping to a Union of Unions
    • Mapping with a Simple Type Translator

    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 node type, path, and positional information. 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 statements
    XPath Description
    @name The "@" character indicates that the node is an attribute.
    text() "text()" indicates that the node is a text node. In this case the name value in the text node belongs to the context node.
    full-name/text() The name information is stored in the text node of the full-name element.
    personal-info/name/text() The XPath statement may be used to specify any valid path.
    name[2]/text() The XPath statement may contain positional information. In this case the name information is stored in the text node of the second occurrence of the name element.

    Mapping to a Specific Schema Type: In most cases TopLink can determine the target format in the XML document. However, there are cases where you must specify which one of a number of possible targets TopLink should use. For example, a java.util.Calendar could be marshalled to a schema date, time, or dateTime, or a byte[] could be marshalled to a schema hexBinary or base64Binary node.

    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="picture" type="xsd:hexBinary"/>
          <xsd:element name="resume" type="xsd:base64Binary"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:schema>

    Code Sample
    XMLDirectMapping pictureMapping = new XMLDirectMapping();
    pictureMapping.setAttributeName("picture");
    pictureMapping.setXPath("picture/text()");
    XMLField pictureField = (XMLField) pictureMapping.getField();
    pictureField.setSchemaType(XMLConstants.HEX_BINARY_QNAME);

    Mapping to a Union Field:

    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="shoe-size" type="size-type"/>
        </xsd:sequence>
      </xsd:complexType>
      <xsd:simpleType name="size-type">
        <xsd:union memberTypes="xsd:decimal xsd:string"/>
      </xsd:simpleType>
    </xsd:schema>

    Code Sample
    XMLDirectMapping shoeSizeMapping = new XMLDirectMapping();
    shoeSizeMapping.setAttributeName("shoeSize");
    XMLUnionField shoeSizeField = new XMLUnionField();
    shoeSizeField.setXPath("shoe-size/text()");
    shoeSizeField.addSchemaType(XMLConstants.DECIMAL_QNAME);
    shoeSizeField.addSchemaType(XMLConstants.STRING_QNAME);
    shoeSizeMapping.setField(shoeSizeField);

    Preserving the Node Type: If the type of a node is not defined in your XML schema, you can configure an XML Direct Mapping to use the xsi:type attribute to provide type information.

    Code Sample
    XMLDirectMapping numberMapping = new XMLDirectMapping();
    numberMapping.setAttributeName("number");
    numberMapping.setXPath("number/text()");
    XMLField numberField = (XMLField) numberMapping.getField();
    numberField.setIsTypedTextField(true);

    More Information: For more information about using the XML Direct 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)

    • Field Detail

      • isCDATA

        public boolean isCDATA

    • Constructor Detail

      • XMLDirectMapping

        public XMLDirectMapping()

    • Method Detail

      • setXPath

        public void setXPath​(String xpathString)
        Set the Mapping field name attribute to the given XPath String
        Specified by:
        setXPath in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>
        Parameters:
        xpathString - String

      • getAttributeValue

        public Object getAttributeValue​(Object fieldValue,
                                org.eclipse.persistence.internal.sessions.AbstractSession session,
                                org.eclipse.persistence.internal.oxm.record.AbstractUnmarshalRecord record)
        INTERNAL: Allows for subclasses to convert the attribute value.
        Specified by:
        getAttributeValue in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • getFieldValue

        public Object getFieldValue​(Object attributeValue,
                            org.eclipse.persistence.internal.core.sessions.CoreAbstractSession session,
                            org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord record)
        INTERNAL: Convert the attribute value to a field value. Process any converter if defined, and check for null values.
        Specified by:
        getFieldValue in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • getXPath

        public String getXPath()
        Get the XPath String
        Specified by:
        getXPath in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>
        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 query,
                           org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                           org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                           boolean isTargetProtected,
                           Boolean[] wasCacheUsed)
        INTERNAL: Return the mapping's attribute value from the row. The execution session is passed for the case of building a UnitOfWork clone directly from a row, the session set in the query will not know which platform to use for converting the value. Allows the correct session to be passed in.
        Overrides:
        valueFromRow in class AbstractDirectMapping

      • writeFromObjectIntoRow

        public void writeFromObjectIntoRow​(Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)
        INTERNAL: Get a value from the object and set that in the respective field of the row.
        Overrides:
        writeFromObjectIntoRow in class AbstractDirectMapping

      • writeValueIntoRow

        protected void writeValueIntoRow​(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                 org.eclipse.persistence.internal.helper.DatabaseField aField,
                                 Object fieldValue)
        Description copied from class: AbstractColumnMapping
        INTERNAL:
        Specified by:
        writeValueIntoRow in class AbstractDirectMapping

      • writeSingleValue

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

      • setIsCDATA

        public void setIsCDATA​(boolean CDATA)
        Specified by:
        setIsCDATA in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • isNormalizingStringValues

        public boolean isNormalizingStringValues()
        PUBLIC: Returns true if this mapping is normalizing string values on unmarshal before setting them in the object. Normalize replaces any CR, LF or Tab characters with a single space character.

      • setNormalizingStringValues

        public void setNormalizingStringValues​(boolean normalize)
        PUBLIC: Indicates that this mapping should normalize all string values before setting them in the object on unmarshal. Normalize replaces any CR, LF or Tab characters with a single space character.
        Specified by:
        setNormalizingStringValues in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • setCollapsingStringValues

        public void setCollapsingStringValues​(boolean collapse)
        PUBLIC: Indicates that this mapping should collapse all string values before setting them in the object on unmarshal. Collapse removes leading and trailing whitespaces, and replaces any sequence of whitepsace characters with a single space.
        Specified by:
        setCollapsingStringValues in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • isCollapsingStringValues

        public boolean isCollapsingStringValues()
        PUBLIC: Returns true if this mapping should collapse all string values before setting them in the object on unmarshal. Collapse removes leading and trailing whitespaces, and replaces any sequence of whitepsace characters with a single space.

      • isNullValueMarshalled

        public boolean isNullValueMarshalled()
        PUBLIC: Returns true if this mapping's value should be marshalled, in the case that it is equal to the default null value.

      • setNullValueMarshalled

        public void setNullValueMarshalled​(boolean value)
        PUBLIC: Set whether this mapping's value should be marshalled, in the case that it is equal to the default null value.
        Specified by:
        setNullValueMarshalled in interface org.eclipse.persistence.internal.oxm.mappings.DirectMapping<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>

      • convertObjectValueToDataValue

        public Object convertObjectValueToDataValue​(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 Object convertDataValueToObjectValue​(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