Difference between revisions of "EclipseLink/Examples/MOXy"

From Eclipsepedia

Jump to: navigation, search
(EclipseLink JAXB Examples)
(67 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
[[Category:EclipseLink/Example|MOXy Examples]]
 +
<div style="margin:5px;float:right;border:1px solid #000000;padding:5px">__TOC__</div>
 +
 
The following examples are provided to assist developers with their adoption and usage of EclipseLink's JAXB and native OXM functionality.
 
The following examples are provided to assist developers with their adoption and usage of EclipseLink's JAXB and native OXM functionality.
  
Note: Any examples listed without links are place-holders. If there is an example you would like to see please add it to the list.
+
EclipseLink provides a standards-based JAXB implementation with many extensions. For an introduction to the JAXB 2.0 reference implementation please see the following page:
  
== EclipseLink JAXB Examples ==
+
* [http://java.sun.com/developer/technicalArticles/WebServices/jaxb/index.html JAXB Tutorial (jaxb.dev.java.net)]
* [EclipseLink/Examples/MOXy/JaxbClassGen | MOXy]
+
* Generating Java Source from and XML Schema
+
* Generating an XML Schema from Java Classes
+
* Creating the JAXB Context
+
  
== Using Native OXM through JAXB Examples ==
 
* Creating a native OXM aware JAXBContext
 
  
== Native Object-XML Examples ==
+
== EclipseLink MOXy Examples  ==
* Basic Usage
+
 
 +
=== General ===
 +
*[[EclipseLink/Examples/MOXy/GettingStarted|Getting Started]]
 +
*:No metadata is required to convert your existing object model to XML. Supply metadata (using annotations or XML) only when you need to fine tune the XML representation. Get started using MOXy.
 +
*[[EclipseLink/Examples/MOXy/JAXB|Using EclipseLink MOXy's JAXB]]
 +
*:Java Architecture for XML Binding (JSR 222) is the standard for XML Binding in Java. JAXB covers 100% of XML Schema concepts. Learn how to use MOXy as your JAXB provider.
 +
*[[EclipseLink/Examples/MOXy/MeetInTheMiddle/Advantages|Meet in the Middle Mapping Advantages]]
 +
*:Compare meet-in-the-middle mapping to other approaches. Normally in XML Binding solutions there is a one-to-one correspondence between the object model and the levels of nesting in the resulting XML document. Learn how to leverage MOXy's XPath-based mapping to remove these limitations.
 +
*[[EclipseLink/Examples/MOXy/EclipseLink-OXM.XML|Using EclipseLink MOXy's XML Mapping (eclipselink-oxm.xml)]]
 +
*:Externalizing the JAXB and extended mappings in an eclipselink-oxm.xml mapping file can separate the XML bindings from the domain classes.
 +
*[[EclipseLink/Examples/MOXy/XMLNameTransformer|XMLNameTransformer]]'''
 +
*:Customized XML Name Conversions.
 +
 
 +
 
 +
=== Working with JSON (NEW in 2.4) ===
 +
*[[EclipseLink/Examples/MOXy/JSON_Twitter|Twitter Example]]
 +
*:Use MOXy to process JSON returned from a Twitter query.
 +
*[[EclipseLink/Examples/MOXy/JSON_Geocode|Google Maps Geocode Example]]
 +
*:Use MOXy to process JSON returned from a Google Maps query.
 +
*[[EclipseLink/Examples/MOXy/MOXy_JSON_Provider|MOXy JSON Provider]]
 +
*:Use MOXyJsonProvider to make JAX-RS integration even easier.
 +
*[[EclipseLink/Examples/MOXy/JSON_Metadata|JSON Metadata]]
 +
*:Write MOXy bindings files in JSON.
 +
 
 +
 
 +
=== Working with JPA ===
 +
JPA provides an easy and powerful means to use Java objects to interact with a relational database. These Java objects are called entities, and have their own characteristics. Some of these characteristics (bidirectional relationships, compound keys, embedded key classes, and lazy loading) can cause challenges when mapping these objects to XML. Learn how to easily map JPA entities to XML using MOXy.
 +
 
 +
*[[EclipseLink/Examples/MOXy/JPA/Relationships|JPA Relationships]]
 +
*:Learn how to bind JPA Relationships to XML.
 +
*[[EclipseLink/Examples/MOXy/JPA/CompoundPrimaryKeys|Compound Primary Keys]]
 +
*:Learn how to bind Compound Primay Keys to XML.
 +
*[[EclipseLink/Examples/MOXy/JPA/EmbeddedIdClass|Embedded ID Classes]]
 +
*:Learn how to bind Embedded ID Classes to XML.
 +
 
 +
 
 +
=== Integration with Spring ===
 +
*[[EclipseLink/Examples/MOXy/Spring|MOXy JAXB in Spring]]
 +
*:Using static and dynamic MOXy JAXB in Spring.
 +
 
 +
 
 +
=== Mapping with XPath ===
 +
*[[EclipseLink/Examples/MOXy/XPath|XPath]]
 +
*:Map objects to XML using XPath.
 +
*[[EclipseLink/Examples/MOXy/ElementMappingByAttributeValue|XPath Mapping with Predicates]]
 +
*:Map elements based on the value of an attribute.
 +
 
 +
 
 +
=== Extensible Models ===
 +
*[[EclipseLink/Examples/MOXy/MetadataRepository|MOXY Metadata Repository]]
 +
*:Store mappings using a MetadataSource external to the running application so that mapping overrides and extended mappings can be more dynamically integrated into deployed applications
 +
*[[EclipseLink/Examples/MOXy/MultipleBindingsFiles|Multiple Bindings Files]]
 +
*:Process multiple bindings files from different locations, and create a merged set of metadata. This allows a JAXBContext to be created to represent any version of the XML document.
 +
*[[EclipseLink/Examples/MOXy/Extensible|XML Extensions]]
 +
*:Make MOXy JAXB beans extensible so that a set of additional extended mappings can be used at runtime.
 +
*[[EclipseLink/Examples/MOXy/RefreshMetadata|RefreshMetadata]]
 +
*:Update the metadata (in this example to include information about new extensions) without stopping the application.
 +
 
 +
 
 +
=== Dynamic JAXB ===
 +
Traditional JAXB maps static classes (POJOs) to XML. Dynamic JAXB uses objects (instances of DynamicEntity) with generic get/set methods instead avoiding the need for the class generation step entirely.
 +
 
 +
*[[EclipseLink/Examples/MOXy/Dynamic/StaticComparison|Static Comparison]]
 +
*:See how Dynamic JAXB compares with static JAXB.
 +
*[[EclipseLink/Examples/MOXy/Dynamic/JAXBContextFromXMLSchema|JAXBContext from XML Schema]]
 +
*:See how to bootstrap a Dynamic JAXBContext from an XML Schema.
 +
*[[EclipseLink/Examples/MOXy/Dynamic/XmlToDynamicEntity|XML to DynamicEntity]]
 +
*:Learn how to unmarshal an XML document to DynamicEntities.
 +
*[[EclipseLink/Examples/MOXy/Dynamic/DynamicEntityToXml|DynamicEntity to XML]]
 +
*:Learn how to marshal DyanamicEntities to XML.
 +
 
 +
 
 +
=== Working with SDO ===
 +
*[[EclipseLink/Examples/SDO/JAXB|Converting POJOs to/from SDO DataObjects using the POJO/SDO Bridge (via JAXB)]]
 +
*:Using SDO or SCA and want to leverage JPA to access your persistent data? Learn how to expose your objects through SDO using MOXy.
 +
 
 +
 
 +
== Using Native OXM through JAXB Examples ==
 +
* [[EclipseLink/Examples/MOXy/NativeOxmJaxbContext | Creating a Native OXM aware JAXBContext]]
 +
*:Use the EclipseLink Workbench to map Java classes to an XML Schema, and Marshal and Unmarshal XML documents using JAXB APIs.

Revision as of 10:42, 20 June 2012

The following examples are provided to assist developers with their adoption and usage of EclipseLink's JAXB and native OXM functionality.

EclipseLink provides a standards-based JAXB implementation with many extensions. For an introduction to the JAXB 2.0 reference implementation please see the following page:


EclipseLink MOXy Examples

General

  • Getting Started
    No metadata is required to convert your existing object model to XML. Supply metadata (using annotations or XML) only when you need to fine tune the XML representation. Get started using MOXy.
  • Using EclipseLink MOXy's JAXB
    Java Architecture for XML Binding (JSR 222) is the standard for XML Binding in Java. JAXB covers 100% of XML Schema concepts. Learn how to use MOXy as your JAXB provider.
  • Meet in the Middle Mapping Advantages
    Compare meet-in-the-middle mapping to other approaches. Normally in XML Binding solutions there is a one-to-one correspondence between the object model and the levels of nesting in the resulting XML document. Learn how to leverage MOXy's XPath-based mapping to remove these limitations.
  • Using EclipseLink MOXy's XML Mapping (eclipselink-oxm.xml)
    Externalizing the JAXB and extended mappings in an eclipselink-oxm.xml mapping file can separate the XML bindings from the domain classes.
  • XMLNameTransformer
    Customized XML Name Conversions.


Working with JSON (NEW in 2.4)


Working with JPA

JPA provides an easy and powerful means to use Java objects to interact with a relational database. These Java objects are called entities, and have their own characteristics. Some of these characteristics (bidirectional relationships, compound keys, embedded key classes, and lazy loading) can cause challenges when mapping these objects to XML. Learn how to easily map JPA entities to XML using MOXy.


Integration with Spring


Mapping with XPath


Extensible Models

  • MOXY Metadata Repository
    Store mappings using a MetadataSource external to the running application so that mapping overrides and extended mappings can be more dynamically integrated into deployed applications
  • Multiple Bindings Files
    Process multiple bindings files from different locations, and create a merged set of metadata. This allows a JAXBContext to be created to represent any version of the XML document.
  • XML Extensions
    Make MOXy JAXB beans extensible so that a set of additional extended mappings can be used at runtime.
  • RefreshMetadata
    Update the metadata (in this example to include information about new extensions) without stopping the application.


Dynamic JAXB

Traditional JAXB maps static classes (POJOs) to XML. Dynamic JAXB uses objects (instances of DynamicEntity) with generic get/set methods instead avoiding the need for the class generation step entirely.


Working with SDO


Using Native OXM through JAXB Examples