Difference between revisions of "EclipseLink/Development/Documentation/MOXy"

Revision as of 10:56, 5 April 2011

EclipseLink MOXy User's Guide (under development)

Table of Contents

The following is the proposed TOC which is currently under development. Where applicable, show where existing ELUG wiki pages can be mined for initial content.

1. Overview
   Generic EclipseLink info (i.e., non-MOXy) will be used to create a separate "Welcome to EclispeLink" guide.
   1. About EclipseLink 
      
   2. JAXB Overview
      
   3. Metadata
   4. Annotations
   5. Static vs. Dynamic MOXy 
      Review
2. Runtime
   Review
   1. Specifying the EclipseLink Runtime
   2. Bootstrapping - B
      
      1. From a Single Project
         Review
      2. From Multiple Projects
         Review
      3. Generating Schema
         Review
         
   3. Dynamic JAXB Bootstrapping
      Review
      in progress
      http://wiki.eclipse.org/EclipseLink/Development/2.1/DynamicMOXy/296967/Documentation
      1. Specifying the EclipseLink Runtime
      2. From an XML Schema
         Review
      3. From a Single Project
         1. From OXM using DynamicEntities
         2. From sessions.xml using DynamicEntities
      4. From Multiple Projects
         1. From OXM using DynamicEntities
         2. From sessions.xml using DynamicEntities
   4. Querying Objects by XPath
      Review
   5. Converting XML to Objects (Unmarshalling)
      in progress
      1. Sources (DOM, SAX, StAX, Streams)
      2. Validating Against an XML Schema
      3. Events
      4. Handling Unmapped Content
   6. Convert Objects to XML (Marshalling)
      need info
      1. Targets (DOM, SAX, StAX, Streams)
      2. Properties (Formatting & Encoding)
      3. Events
   7. Binding to an Existing Document
      
      
3. Type Level - A
   1. Mapping to a Type or Element - A
      1. Default Root Element
   2. Setting Up Namespace Information
   3. Creating Objects (Constructors & Factories)
   4. Handling Inheritance (need info)
      1. http://bdoughan.blogspot.com/2010/11/jaxb-and-inheritance-using-xsitype.html
      2. http://bdoughan.blogspot.com/2010/11/jaxb-and-inheritance-using-substitution.html
      3. http://bdoughan.blogspot.com/2010/11/jaxb-and-inheritance-moxy-extension.html
4. Simple Values - A
   1. Single Values - A
      1. Mapping Simple Values
   2. Colections -A
      1. Mappng Collections of Simple Values
   3. Enums
   4. Special Schema Types
      1. Date and Time Types (more info)
         1. http://bdoughan.blogspot.com/2011/01/jaxb-and-datetime-properties.html
      2. Binary Types
      3. Leveraging xsi:type
      4. Unions
5. Relationships -A 
   1. Privately Owned - A
      1. Mapping One-to-One Relationships - A 
      2. Mapping One-to-Many Relationships- A 
         
         
   2. Shared Reference - A
      1. Keys and Foreign Keys - A
         1. Mapping Single Key Relationships- A
            
         2. Mapping Composite Key Relationships- A
            
         3. Embedded Key Class -A
            in progress
   3. Collections and Maps
      in progress
   4. Bidirectional Relationships
      in progress
      1. http://bdoughan.blogspot.com/2010/07/jpa-entities-to-xml-bidirectional.html
      2. XMLInverseMapping
6. Advanced XML Schema Concepts - B
   1. Handling Null Values 
      
      
   2. Substitution Groups and Choices
      Need info
      1. http://bdoughan.blogspot.com/2010/11/jaxb-and-inheritance-using-substitution.html
      2. XMLChoiceObjectMapping
      3. XMLChoiceCollectionMapping
   3. Wildcard Content
      Need info
      1. http://bdoughan.blogspot.com/2010/08/using-xmlanyelement-to-build-generic.html
      2. XMLAnyAttributeMapping
      3. XMLAnyObjectMapping
      4. XMLAnyCollectionMapping
7. Mapping the Unmappable
   1. http://bdoughan.blogspot.com/2010/07/xmladapter-jaxbs-secret-weapon.html
   2. http://bdoughan.blogspot.com/2010/12/jaxb-and-immutable-objects.html
   3. http://bdoughan.blogspot.com/2010/08/xmltransformation-going-beyond.html
   4. Converters
   5. Transformation Mapping
   6. XMLFragmentMapping
   7. XMLFragmentCollectionMapping
8. Customizing Schemas
   Need info
9. Generating Java Classes from an XML Schema 
   
   
10. Mapping JPA Entities to XML
    Need info
    1. http://wiki.eclipse.org/EclipseLink/Examples/MOXy/JPA
    2. Properties
    3. Bidirectional Relationships
    4. Keys and Foreign Keys
11. Web Services
    Need info
    1. Attachments
       1. http://bdoughan.blogspot.com/2011/03/jaxb-web-services-and-binary-data.html
       2. XMLBinaryDataMapping
       3. XMLBinaryDataCollectionMapping
12. Using Eclipselink with Spring