Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

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

m
m
Line 5: Line 5:
 
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.
 
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.
  
# Overview
+
# [[EclipseLink/UserGuide/MOXy/Overview|Overview]]
# Runtime
+
## [[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]]
## Specifying the EclipseLink Runtime
+
# [[EclipseLink/UserGuide/MOXy/Runtime|Runtime]]
## Bootstrapping
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]]
### Single Project
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping|Bootstrapping]]
### Multiple Projects
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project|Single Projects]]
### Schema Generation
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Multiple Projects|Multiple Projects]]
## Querying Objects by XPath
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]]
## Convert XML to Objects (Unmarshalling)
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Querying Objects by XPath|Querying Objects by XPath]]
### Sources (DOM, SAX, StAX, Streams)
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects|Converting XML to Objects (Unmarshalling)]]
### Validating Against an XML Schema
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Sources|Sources (DOM, SAX, StAX, Streams)]]
### Events
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Validating Against an XML Schema|Validating Against an XML]]
### Handling Unmapped Content
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Events|Events]]
## Convert Objects to XML (Marshalling)
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Handling Unmapped Content|Handling Unmapped Content]]
### Targets (DOM, SAX, StAX, Streams)
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML|Convert Objects to XML (Marshalling)]]
### Properties (Formatting & Encoding)
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Targets|Targets (DOM, SAX, StAX, Streams)]]
### Events
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Properties|Properties (Formatting & Encoding)]]
## Binding to an Existing Document
+
### [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Events|Events]]
# Type Level
+
## [[EclipseLink/UserGuide/MOXy/Runtime/Binding to an Existing Document|Binding to an Existing Document]]
## Mapping to a Type or Element
+
# [[EclipseLink/UserGuide/MOXy/Type Level|Type Level]]
### Default Root Element
+
## [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]]
## Setting Up Namespace Information
+
### [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]]
## Object Creation (Constructors & Factories)
+
## [[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]]
## Handling Inheritance
+
## [[EclipseLink/UserGuide/MOXy/Type Level/Creating Objects|Creating Objects (Constructors & Factories)]]
# Simple Values
+
## [[EclipseLink/UserGuide/MOXy/Type Level/Handling Inheritance|Handling Inheritance]]
## Single Value – XMLDirectMapping
+
# [[EclipseLink/UserGuide/MOXy/Simple Values|Simple Values]]
## Collection – XMLDirectCollectionMapping
+
## [[EclipseLink/UserGuide/MOXy/Simple Values/Single Values|Single Values]]
## Enums
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Single Values/XMLDirectMapping|XMLDirectMapping]]
## Special Schema Types
+
## [[EclipseLink/UserGuide/MOXy/Simple Values/Collections|Collections]]
### Date/Time Types
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Collections/XMLDirectCollectionMapping|XMLDirectCollectionMapping]]
### Binary Types
+
## [[EclipseLink/UserGuide/MOXy/Simple Values/Enums|Enums]]
### Leveraging xsi:type
+
## [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types|Special Schema Types]]
### Unions
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Date and Time Types|Date and Time Types]]
# Relationships
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Binary Types|Binary Types]]
## Privately Owned
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Leveraging xsi:type|Leveraging xsi:type]]
### One-to-One – XMLCompositeObjectMapping
+
### [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Unions|Unions]]
### One-to-Many – XMLCompositeCollectionMapping
+
# [[EclipseLink/UserGuide/MOXy/Relationships|Relationships]]
## Shared Reference
+
## [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned|Privately Owned]]
### Keys & Foreign Keys
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-One|One-to-One – XMLCompositeObjectMapping]]
#### Single Key
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-Many|One-to-Many – XMLCompositeCollectionMapping]]
#### Composite Key
+
## [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference|Shared Reference]]
#### Embedded Key Class
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys|Keys and Foreign Keys]]
### Many-to-One – XMLObjectReferenceMapping
+
#### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Single Key|Single Key]]
### Many-to-Many – XMLCollectionReferenceMapping
+
#### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Composite Key|Composite Key]]
## Collections/Maps
+
#### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Embedded Key Class|Embedded Key Class]]
## Bidirectional Relationships
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-One|Many-to-One – XMLObjectReferenceMapping]]
### XMLInverseMapping
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-|Many-to-Many – XMLCollectionReferenceMapping]]
# Advanced XML Schema Concepts
+
## [[EclipseLink/UserGuide/MOXy/Relationships/Collections and Maps|Collections and Maps]]
## Handling Null Values
+
## [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]]
## Substitution Groups & Choice
+
### [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships/XMLInverseMapping|XMLInverseMapping]]
### XMLChoiceObjectMapping
+
# [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts|Advanced XML Schema Concepts]]
### XMLChoiceCollectionMapping
+
## [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]]
## Wildcard Content
+
## [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices|Substitution Groups and Choices]]
### XMLAnyAttributeMapping
+
### [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices/XMLChoiceObjectMapping|XMLChoiceObjectMapping]]
### XMLAnyObjectMapping
+
### [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices/XMLChoiceCollectionMapping|XMLChoiceCollectionMapping]]
### XMLAnyCollectionMapping
+
## [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content|Wildcard Content]]
# Mapping the Unmappable
+
### [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyAttributeMapping|XMLAnyAttributeMapping]]
## Converters
+
### [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyObjectMapping|XMLAnyObjectMapping]]
## Transformation Mapping
+
### [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyCollectionMapping|XMLAnyCollectionMapping]]
## XMLFragmentMapping
+
# [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable|Mapping the Unmappable]]
## XMLFragmentCollectionMapping
+
## [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/Converters|Converters]]
# Schema Customization
+
## [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/Transformation Mapping|Transformation Mapping]]
# Generating Java Classes from an XML Schema
+
## [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentMapping|XMLFragmentMapping]]
# Mapping JPA Entities to XML
+
## [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentCollectionMapping|XMLFragmentCollectionMapping]]
## Lazily Loaded Fields/Properties
+
# [[EclipseLink/UserGuide/MOXy/Customizing Schemas|Customizing Schemas]]
## Bidirectional Relationships
+
# [[EclipseLink/UserGuide/MOXy/Generating Java Classes from an XML Schema|Generating Java Classes from an XML Schema]]
## Keys & Foreign Keys
+
# [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML|Mapping JPA Entities to XML]]
# Web Services
+
## [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Lazily Loaded Fields/Properties|Properties]]
## Attachments
+
## [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Bidirectional Relationships|Bidirectional Relationships]]
### XMLBinaryDataMapping
+
## [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Keys and Foreign Keys|Keys and Foreign Keys]]
### XMLBinaryDataCollectionMappig
+
# [[EclipseLink/UserGuide/MOXy/Web Services|Web Services]]
 +
## [[EclipseLink/UserGuide/MOXy/Web Services/Attachments|Attachments]]
 +
### [[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataMapping|XMLBinaryDataMapping]]
 +
### [[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataCollectionMapping|XMLBinaryDataCollectionMapping]]

Revision as of 15:23, 22 June 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. Single Projects
      2. Multiple Projects
      3. Generating Schema
    3. Querying Objects by XPath
    4. Converting XML to Objects (Unmarshalling)
      1. Sources (DOM, SAX, StAX, Streams)
      2. Validating Against an XML
      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

Back to the top