Jump to: navigation, search

Difference between revisions of "EclipseLink/DesignDocs/406697"

(Example)
(Note/Issues)
Line 96: Line 96:
 
*inheritance
 
*inheritance
 
*List<Object>
 
*List<Object>
*single case ie:not on a collection
+
*single case ie:not on a collection XMLVariableXPathObjectMapping XMLVariableXPathCollectionMapping
 
*external bindings
 
*external bindings
 
*don`t write out that property itself as nested if it is the variable field - currently need to mark that property as transient.
 
*don`t write out that property itself as nested if it is the variable field - currently need to mark that property as transient.
 
*startcollection and endcollection [ ]'s in JSON
 
*startcollection and endcollection [ ]'s in JSON
 
*add type/class to the annotation
 
*add type/class to the annotation

Revision as of 15:33, 2 May 2013

Document History

  • April 26, 2013 - Initial Draft

Requirements

API

The following annotation will be added
org.eclipse.persistence.oxm.annotations.XmlVariableNode

@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface XmlVariableNode {
    String attributeName();
}

Example

@XmlRootElement
public class Root {
 
	public String name;
 
	@XmlVariableNode(attributeName="thingName")
	public List<Thing> things;
}
 
public class Thing {
        @XmlTransient
	public String thingName;
	public String thingValue;
}
Root r = new Root();
r.name = "theRootName";
r.things = new ArrayList<Thing>();
Thing thing1 = new Thing();
thing1.thingName = "thinga";
thing1.thingValue = "thingavalue";
 
Thing thing2 = new Thing();
thing2.thingName = "thingb";
thing2.thingValue = "thingbvalue";
 
Thing thing3 = new Thing();
thing3.thingName = "thingc";
thing3.thingValue = "thingcvalue";
r.things.add(thing1);
r.things.add(thing2);
r.things.add(thing3);
marshaller.marshal(r, System.out)
XML
<root>
   <name>theRootName</name>
   <thinga>
       <thingValue>thingavalue</thingValue>
   </thinga>
   <thingb>
       <thingValue>thingbvalue</thingValue>
   </thingb>
   <thingc>
       <thingValue>thingcvalue</thingValue>
   </thingc>
</root>
marshaller.marshal(r, System.out)
JSON
{"root":{
   "name":"theRootName"
   "thinga":{
       "thingValue":"thingavalue"},   
   "thingb":{
       "thingValue":"thingbvalue"},
   "thingc":{
       "thingValue":"thingcvalue"}
}}

Design

A new mapping will be created XMLVariableXPathMapping and it will extend the AnyCollectionMapping

Note/Issues

  • inheritance
  • List<Object>
  • single case ie:not on a collection XMLVariableXPathObjectMapping XMLVariableXPathCollectionMapping
  • external bindings
  • don`t write out that property itself as nested if it is the variable field - currently need to mark that property as transient.
  • startcollection and endcollection [ ]'s in JSON
  • add type/class to the annotation