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

Revision as of 11:43, 29 November 2010

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
   1. About EclipseLink
2. Runtime
   1. Specifying the EclipseLink Runtime
   2. Bootstrapping
      1. Introduction *
      2. From an XML Schema *
      3. From a Single Project
         1. From OXM using DynamicEntities *
      4. From Multiple Projects
      5. Generating Schema
   3. Querying Objects by XPath
   4. Converting XML to Objects (Unmarshalling)
      1. Sources (DOM, SAX, StAX, Streams)
      2. Validating Against an XML Schema
      3. Events
      4. Handling Unmapped Content
   5. Convert Objects to XML (Marshalling)
      1. Targets (DOM, SAX, StAX, Streams)
      2. Properties (Formatting & Encoding)
      3. Events
   6. Binding to an Existing Document
3. Type Level
   1. Mapping to a Type or Element
      1. Default Root Element
   2. Setting Up Namespace Information
   3. Creating Objects (Constructors & Factories)
   4. Handling Inheritance
4. Simple Values
   1. Single Values
      1. XMLDirectMapping
   2. Collections
      1. XMLDirectCollectionMapping
   3. Enums
   4. Special Schema Types
      1. Date and Time Types
      2. Binary Types
      3. Leveraging xsi:type
      4. Unions
5. Relationships
   1. Privately Owned
      1. One-to-One – XMLCompositeObjectMapping
      2. One-to-Many – XMLCompositeCollectionMapping
   2. Shared Reference
      1. Keys and Foreign Keys
         1. Single Key
         2. Composite Key
         3. Embedded Key Class
      2. Many-to-One – XMLObjectReferenceMapping
      3. Many-to-Many – XMLCollectionReferenceMapping
   3. Collections and Maps
   4. Bidirectional Relationships
      1. XMLInverseMapping
6. Advanced XML Schema Concepts
   1. Handling Null Values
   2. Substitution Groups and Choices
      1. XMLChoiceObjectMapping
      2. XMLChoiceCollectionMapping
   3. Wildcard Content
      1. XMLAnyAttributeMapping
      2. XMLAnyObjectMapping
      3. XMLAnyCollectionMapping
7. Mapping the Unmappable
   1. Converters
   2. Transformation Mapping
   3. XMLFragmentMapping
   4. XMLFragmentCollectionMapping
8. Customizing Schemas
9. Generating Java Classes from an XML Schema
10. Mapping JPA Entities to XML
    1. Properties
    2. Bidirectional Relationships
    3. Keys and Foreign Keys
11. Web Services
    1. Attachments
       1. XMLBinaryDataMapping
       2. XMLBinaryDataCollectionMapping