EclipseLink/DesignDocs/293925/MOXyExtensions/XmlAnyCollectionMapping

XMLAnyCollectionMapping

Requirements

Provide support for XML any collection mapping configuration via XML metadata file.

The following should be configurable:

• Path-based mappings
• Positional mappings
• Read only
• Write only
• Get/set method names

Design

Basic XML any collection mapping support

We will extend our current xml-any-element support to allow any mapping configuration. We will need to modify the XSD such that xml-path, xml-access-methods, read-only, etc. can be set on xml-any-element. For example, the following XML metadata snippet would be used to setup an any collection mapping for 'stuff', where the stuff attribute is a List:

<xml-any-element java-attribute="stuff" />

If stuff was to be mapped to junk/stuff, then the following would be used:

<xml-any-element java-attribute="stuff" xml-path="things/junk/stuff" />

Read Only

The following demonstrates how an xml-any-element can be set as read-only:

<xml-any-element java-attribute="stuff" xml-path="things/junk/stuff" read-only="true" />

Write Only

The following demonstrates how an xml-any-element can be set as write-only:

<xml-any-element java-attribute="stuff" xml-path="things/junk/stuff" write-only="true" />

Equivalent annotations

@javax.xml.bind.annotation.XmlAnyElement
@org.eclipse.persistence.oxm.annotations.XmlPath("things/junk/stuff")
public List<Object> stuff;

Example:

The following example will demonstrate how to configure XML any collection mappings via XML metadata by using xml-any-element.

org.example.Employee.java

package org.example;
 
public class Employee {
    public List<Object> stuff;
 
    public List<Object> getStuff() {
        return stuff;
    }
 
    public void setStuff(List<Object> stuff) {
        this.stuff = stuff;
    }
}

Deployment XML

<class-mapping-descriptor xsi:type="xml-class-mapping-descriptor">
  <class>org.example.Employee</class>
  <alias>Employee</alias>
  <attribute-mappings>
    <attribute-mapping xsi:type="xml-any-collection-mapping">
      <attribute-name>stuff</attribute-name>
      <get-method>getStuff</get-method>
      <set-method>setStuff</set-method>
      <field name="things/junk/s:stuff" xsi:type="node"/>
      <container xsi:type="list-container-policy">
        <collection-type>java.util.Vector</collection-type>
      </container>
      <keep-as-element-policy>KEEP_NONE_AS_ELEMENT</keep-as-element-policy>
    </attribute-mapping>
  </attribute-mappings>
  <default-root-element>employee</default-root-element>
  <default-root-element-field name="employee"/>
  <namespace-resolver>
    <namespaces>
      <namespace>
        <prefix>s</prefix>
        <namespace-uri>http://www.example.com/stuff</namespace-uri>
      </namespace>
    </namespaces>
  </namespace-resolver>
</class-mapping-descriptor>

XML Instance Document

<?xml version="1.0" encoding="UTF-8"?>
<employee xmlns:s="http://www.example.com/stuff">
  <things>
    <junk>
      <s:stuff>Some Stuff</s:stuff>
    </junk>
  </things> 
</employee>

org/example/eclipselink-oxm.xml

This XML file demonstrates configuring XML any object mappings on the "org.example.Employee" class.

<?xml version="1.0" encoding="US-ASCII"?>
<xml-bindings xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm">
    <xml-schema>
        <xml-ns namespace-uri="http://www.example.com/stuff" prefix="s"/>
    </xml-schema>
    <java-types>
        <java-type name="org.example.Employee">
            <xml-root-element name="employee" />
            <java-attributes>
                <xml-any-element java-attribute="stuff" xml-path="things/junk/s:stuff" xml-mixed="true">
                    <xml-access-methods get-method="getStuff" set-method="setStuff" />
                </xml-any-element>
            </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

Open Issues

This section lists the open issues that are still pending that must be decided prior to fully implementing this project's requirements.

Issue#	Owner	Description/Notes

Decisions

This section lists decisions made. These are intended to document the resolution of open issues or constraints added to the project that are important.

Issue#	Description/Notes	Decision