View source for EclipseLink/Examples/SDO/JAXB

==Overview==

The JAXBHelperContext is a bridge between POJOs and SDO DataObjects.  The bridge is based on their corresponding XML representations.  For the POJOs the XML representation is specified using JAXB annotations or object-to-XML mappings.

==Create the JAXBHelperContext==
The JAXBHelperContext is instantiated using a JAXBContext.  This JAXBContext represents the object-to-XML mapping for the POJOs.  If static DataObjects are being used, a second constructor is offered that takes a ClassLoader as a parameter.
<pre>
JAXBContext jaxbContext = JAXBContext.newInstance("com.example.customer");
JAXBHelperContext jaxbHelperContext = new JAXBHelperContext(jaxbContext);
</pre>
For help on creating a JAXBContext see:
* [[EclipseLink/Examples/MOXy/JAXB#Creating_a_JAXBContext_using_jaxb.properties | Creating a JAXBContext using jaxb.properties]]
* [[EclipseLink/Examples/MOXy/NativeOxmJaxbContext | Creating a Native OXM aware JAXBContext]]

==Define the SDO Metadata==
An XML schema can be used to create the SDO metadata.  This is the same schema that the POJOs are mapped to.  This step has been separated so that SDO annotations could be added to the XML schema.
<pre>
jaxbHelperContext.getXSDHelper().define(xmlSchema);
</pre>

==Get the SDO Type for a POJO==
From the JAXBHelperContext you can determine the SDO type from a POJO class.  This provides quick access to the necessary SDO metadata, to work with the data as SDO DataObjects.
<pre>
Type customerType = jaxbHelperContext.getType(Customer.class);
DataObject customerDO = jaxbHelperContext.getDataFactory().create(customerType);
</pre>

==Convert a POJO to a SDO DataObject==
POJOs corresponding to the types in the JAXBContext, can be converted to SDO DataObjects using the "wrap" operation on JAXBHelperContext.  This operation should be called on the root POJO.
<pre>
Customer customer = new Customer();
Address address new Address();
address.setStreet("123 Any Street");
customer.set(address);

DataObject customerDO = jaxbHelperContext.wrap(customer);
customerDO.getString("address/street");  // returns "123 Any Street"
</pre>
Multiple calls to wrap for the same instance POJO return the same instance of DataObject, in other words the following is always true:
<pre>
jaxbHelperContext.wrap(customer123) == jaxbHelperContext.wrap(customer123)
jaxbHelperContext.wrap(customer123) != jaxbHelperContext.wrap(customer456)
</pre>

The wrap operation may also be called on a collection POJOS.
<pre>
List<DataObject> dataObjects = jaxbHelperContext.wrap(pojoCollection);
</pre>

==Convert a SDO DataObject to a POJO==
SDO DataObjects corresponding to POJOs with types in the JAXBContext, can be converted to POJOs using the "unwrap" operation on JAXBHelperContext.
<pre>
Type customerType = jaxbHelperContext.getType(Customer.class);
DataObject customerDO = jaxbHelperContext.getDataFactory().create(customerType);
DataObject addressDO = customerDO.create("address");
addressDO.set("street", "123 Any Street");
 
Customer customer = (Customer) jaxbHelperContext.unwrap(customerDO);
customer.getAddress().getStreet();  // returns "123 Any Street"
</pre>
Multiple calls to unwrap for the same DataObject must return the same instance of Object, in other words the following is always true:
<pre>
jaxbHelperContext.unwrap(customerDO123) == jaxbHelperContext.unwrap(customerDO123)
jaxbHelperContext.unwrap(customerDO123) != jaxbHelperContext.unwrap(customerDO456)
customer123 == jaxbHelperContext.unwrap(jaxbHelperContext.wrap(customer123))
</pre>
The unwrap operation may also be called on a collection of SDO DataObjects.
<pre>
List<Object> objects = jaxbHelperContext.unwrap(dataObjectCollection);
</pre>