Revision as of 10:16, 8 April 2010

XMLAnyObjectMapping

Requirements

Provide support for XML any object 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 object 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 object mapping for 'stuff':

<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="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="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="junk/stuff" write-only="true" />

Example:

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

org.example.Employee.java

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

Deployment XML

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.

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.