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.
Difference between revisions of "EclipseLink/Development/Documentation/MOXy"
< EclipseLink | Development | Documentation
m |
m |
||
Line 1: | Line 1: | ||
− | '''[[EclipseLink/UserGuide/MOXy|EclipseLink MOXy User's Guide]]''' (under development) | + | '''[[EclipseLink/UserGuide/MOXy|EclipseLink MOXy User's Guide]]''' (under development) <css> |
− | <css> | + | |
.editsection {display:none;} | .editsection {display:none;} | ||
#bodyContent h2, #bodyContent h3 {margin-bottom:3px;} | #bodyContent h2, #bodyContent h3 {margin-bottom:3px;} | ||
Line 9: | Line 8: | ||
h3 span.mw-headline {font-size:0.9em;margin-left:1em;font-weight:normal;} | h3 span.mw-headline {font-size:0.9em;margin-left:1em;font-weight:normal;} | ||
h4 span.mw-headline {margin-left:2em;font-weight:normal;} | h4 span.mw-headline {margin-left:2em;font-weight:normal;} | ||
− | </css> | + | </css> |
− | <div style="width:100%">__TOC__</div> | + | <div style="width: 100%;">__TOC__</div> <div style="font-size: 0.8em;"><div style="float: left; width: 50%;"> |
− | <div style="font-size:0.8em;"> | + | = [[EclipseLink/UserGuide/MOXy/Overview|Overview]] = |
− | <div style="float:left;width:50%;"> | + | |
− | =[[EclipseLink/UserGuide/MOXy/Overview|Overview]] | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | == [[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]] == | |
− | + | ||
− | + | ||
− | ==[[EclipseLink/UserGuide/MOXy/ | + | == [[EclipseLink/UserGuide/MOXy/Overview/JAXB|JAXB Overview ]] == |
− | + | ||
− | + | ||
− | == | + | == Metadata == |
− | + | ||
− | + | ||
− | == | + | == Annotations == |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | ==[[EclipseLink/UserGuide/MOXy/ | + | == [[EclipseLink/UserGuide/MOXy/Overview/DynamicEntities|Static vs. Dynamic MOXy]] == |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | = [[EclipseLink/UserGuide/MOXy/Runtime|Runtime]] = | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | == [[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]] == | |
− | ==[[EclipseLink/UserGuide/MOXy/ | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | </ | + | == Bootstrapping == |
− | </div> | + | |
− | <div style="clear:both;"> </div> | + | === [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project|From a Single Project]] === |
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Multiple Projects|From Multiple Projects]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping Dynamic|Dynamic JAXB]] == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From an XML Schema]] === | ||
+ | |||
+ | === From a Single Project === | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From OXM using DynamicEntities|From OXM using DynamicEntities]] ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From sessions.xml using DynamicEntities|From sessions.xml using DynamicEntities]] ==== | ||
+ | |||
+ | === From Multiple Projects === | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From OXM using DynamicEntities|From OXM using DynamicEntities]] ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Multiple Project/From sessions.xml using DynamicEntities|From sessions.xml using DynamicEntities]] ==== | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Runtime/Querying Objects by XPath|Querying Objects by XPath]] == | ||
+ | |||
+ | == Converting XML to Objects (Unmarshalling) == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Sources|Sources (DOM, SAX, StAX, Sk Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From an XML Schema]] === | ||
+ | |||
+ | === From a Single Project === | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From OXM using DynamicEntities|From OXM using DynamicEntities]] ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From sessions.xml using DynamicEntities|From sessions.xml using DynamicEntities]] ==== | ||
+ | |||
+ | === From Multiple Projects === | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From OXM using DynamicEntities|From OXM using DynamicEntities]] = ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Multiple Project/From sessions.xml using DynamicEntities|From sessions.xml using DynamicEntities]] ==== | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Runtime/Querying Objects by XPath|Querying Objects by XPath]] == | ||
+ | |||
+ | == Converting XML to Objects (Unmarshalling) == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Sources|Sources (DOM, SAX, StAX, Streams)]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Validating Against an XML Schema|Validating Against an XML Schema]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Events|Events]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Handling Unmapped Content|Handling Unmapped Content]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML|Convert Objects to XML (Marshalling)]] == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Targets|Targets (DOM, SAX, StAX, Streams)]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Properties|Properties (Formatting & Encoding)]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Runtime/Convert Objects to XML/Events|Events]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Runtime/Binding to an Existing Document|Binding to an Existing Document]] == | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Type Level|Type Level]] = | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]] == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Type Level/Creating Objects|Creating Objects (Constructors & Factories)]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Type Level/Handling Inheritance|Handling Inheritance]] == | ||
+ | |||
+ | = <!-- [[EclipseLink/UserGuide/MOXy/Simple Values|Simple Values]] --> Simple Values = | ||
+ | |||
+ | == <!-- [[EclipseLink/UserGuide/MOXy/Simple Values/Single Values|Single Values]] --> Single Values == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Single Values/XMLDirectMapping|Mapping Simple Values]] === | ||
+ | |||
+ | == <!-- [[EclipseLink/UserGuide/MOXy/Simple Values/Collections|Collections]] --> Colections == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Collections/XMLDirectCollectionMapping|Mappng Collections of Simple Values]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Simple Values/Enums|Enums]] == | ||
+ | |||
+ | == Special Schema Types == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Date and Time Types|Date and Time Types]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Binary Types|Binary Types]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Leveraging xsi:type|Leveraging xsi:type]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Unions|Unions]] === | ||
+ | </div> <div style="clear: right;"> </div> <div> | ||
+ | = Relationships = | ||
+ | |||
+ | == Privately Owned == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-One|Mapping One-to-One Relationships]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-Many|Mapping One-to-Many Relationships]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference|Shared Reference]] == | ||
+ | |||
+ | === <!--[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys|Keys and Foreign Keys]] --> Keys and Foreign Keys === | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Single Key|Mapping Single Key Relationships]] ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Composite Key|Mapping Composite Key Relationships]] ==== | ||
+ | |||
+ | ==== [[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Embedded Key Class|Embedded Key Class]] ==== | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Relationships/Collections and Maps|Collections and Maps]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]] (includes [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships/XMLInverseMapping|XMLInverseMapping]]) == | ||
+ | |||
+ | = Advanced XML Schema Concepts = | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices|Substitution Groups and Choices]] == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices/XMLChoiceObjectMapping|XMLChoiceObjectMapping]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices/XMLChoiceCollectionMapping|XMLChoiceCollectionMapping]] === | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content|Wildcard Content]] == | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyAttributeMapping|XMLAnyAttributeMapping]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyObjectMapping|XMLAnyObjectMapping]] === | ||
+ | |||
+ | === [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyCollectionMapping|XMLAnyCollectionMapping]] === | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable|Mapping the Unmappable]] = | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/Converters|Converters]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/Transformation Mapping|Transformation Mapping]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentMapping|XMLFragmentMapping]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentCollectionMapping|XMLFragmentCollectionMapping]] == | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Customizing Schemas|Customizing Schemas]] = | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Generating Java Classes from an XML Schema|Generating Java Classes from an XML Schema]] = | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML|Mapping JPA Entities to XML]] = | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Lazily Loaded Fields/Properties|Properties]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Bidirectional Relationships|Bidirectional Relationships]] == | ||
+ | |||
+ | == [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Keys and Foreign Keys|Keys and Foreign Keys]] == | ||
+ | |||
+ | = [[EclipseLink/UserGuide/MOXy/Web Services|Web Services]] = | ||
+ | </div> </div> <div style="clear: both;"> </div> | ||
--- | --- | ||
Revision as of 13:36, 20 April 2011
EclipseLink MOXy User's Guide (under development)
Contents
- 1 Overview
- 2 Runtime
- 2.1 Specifying the EclipseLink Runtime
- 2.2 Bootstrapping
- 2.3 Dynamic JAXB
- 2.4 Querying Objects by XPath
- 2.5 Converting XML to Objects (Unmarshalling)
- 2.6 Querying Objects by XPath
- 2.7 Converting XML to Objects (Unmarshalling)
- 2.8 Convert Objects to XML (Marshalling)
- 2.9 Binding to an Existing Document
- 3 Type Level
- 4 Simple Values
- 5 Relationships
- 6 Advanced XML Schema Concepts
- 7 Mapping the Unmappable
- 8 Customizing Schemas
- 9 Generating Java Classes from an XML Schema
- 10 Mapping JPA Entities to XML
- 11 Web Services
- 12 Table of Contents
Overview
About EclipseLink
JAXB Overview
Metadata
Annotations
Static vs. Dynamic MOXy
Runtime
Specifying the EclipseLink Runtime
Bootstrapping
From a Single Project
From Multiple Projects
Generating Schema
Dynamic JAXB
Specifying the EclipseLink Runtime
From an XML Schema
From a Single Project
From OXM using DynamicEntities
From sessions.xml using DynamicEntities
From Multiple Projects
From OXM using DynamicEntities
From sessions.xml using DynamicEntities
Querying Objects by XPath
Converting XML to Objects (Unmarshalling)
Sources (DOM, SAX, StAX, Sk Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime
From an XML Schema
From a Single Project
From OXM using DynamicEntities
From sessions.xml using DynamicEntities
From Multiple Projects
From OXM using DynamicEntities =
From sessions.xml using DynamicEntities
Querying Objects by XPath
Converting XML to Objects (Unmarshalling)
Sources (DOM, SAX, StAX, Streams)
Validating Against an XML Schema
Events
Handling Unmapped Content
Convert Objects to XML (Marshalling)
Targets (DOM, SAX, StAX, Streams)
Properties (Formatting & Encoding)
Events
Binding to an Existing Document
Type Level
Mapping to a Type or Element
Default Root Element
Setting Up Namespace Information
Creating Objects (Constructors & Factories)
Handling Inheritance
Simple Values
Single Values
Mapping Simple Values
Colections
Mappng Collections of Simple Values
Enums
Special Schema Types
Date and Time Types
Binary Types
Leveraging xsi:type
Unions
Relationships
Privately Owned
Mapping One-to-One Relationships
Mapping One-to-Many Relationships
Keys and Foreign Keys
Mapping Single Key Relationships
Mapping Composite Key Relationships
Embedded Key Class
Collections and Maps
Bidirectional Relationships (includes XMLInverseMapping)
Advanced XML Schema Concepts
Handling Null Values
Substitution Groups and Choices
XMLChoiceObjectMapping
XMLChoiceCollectionMapping
Wildcard Content
XMLAnyAttributeMapping
XMLAnyObjectMapping
XMLAnyCollectionMapping
Mapping the Unmappable
Converters
Transformation Mapping
XMLFragmentMapping
XMLFragmentCollectionMapping
Customizing Schemas
Generating Java Classes from an XML Schema
Mapping JPA Entities to XML
Properties
Bidirectional Relationships
Keys and Foreign Keys
Web Services
---
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.
- Overview
Generic EclipseLink info (i.e., non-MOXy) will be used to create a separate "Welcome to EclispeLink" guide.About EclipseLink
JAXB Overview
- Metadata
- Annotations
- Static vs. Dynamic MOXy
Review
- Runtime
ReviewSpecifying the EclipseLink Runtime- Bootstrapping - B
- From a Single Project
Review - From Multiple Projects
Review - Generating Schema
Review
- From a Single Project
- Dynamic JAXB Bootstrapping
Review
Specifying the EclipseLink Runtime- From an XML Schema
Review - From a Single Project
- From Multiple Projects
- Querying Objects by XPath
Review - Converting XML to Objects (Unmarshalling)
- Sources (DOM, SAX, StAX, Sk Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime</strike>
- From an XML Schema
Review - From a Single Project
- From Multiple Projects
- Querying Objects by XPath
Review - Converting XML to Objects (Unmarshalling)
- Convert Objects to XML (Marshalling)
need info Binding to an Existing Document
- Type Level - A
- Simple Values - A
- Single Values - A
- Colections -A
Enums- Special Schema Types
- Date and Time Types
Review
- Binary Types
- Leveraging xsi:type
- Unions
Review
- Date and Time Types
- Relationships -A
- Privately Owned - A
- Shared Reference - A
- Keys and Foreign Keys - A
Mapping Single Key Relationships- A
Mapping Composite Key Relationships- A
- Embedded Key Class -A
in progress
- Keys and Foreign Keys - A
- Collections and Maps
Review
- Bidirectional Relationships (includes XMLInverseMapping)
Review
- Advanced XML Schema Concepts - B
Handling Null Values
- Substitution Groups and Choices
Review - Wildcard Content
Need info
- Mapping the Unmappable
- http://bdoughan.blogspot.com/2010/07/xmladapter-jaxbs-secret-weapon.html
- http://bdoughan.blogspot.com/2010/12/jaxb-and-immutable-objects.html
- http://bdoughan.blogspot.com/2010/08/xmltransformation-going-beyond.html
- Converters
- Transformation Mapping
Review - XMLFragmentMapping
- XMLFragmentCollectionMapping
- Customizing Schemas
Need info Generating Java Classes from an XML Schema
- Mapping JPA Entities to XML
http://wiki.eclipse.org/EclipseLink/Examples/MOXy/JPA- Properties
- Bidirectional Relationships
Review - Keys and Foreign Keys
Review
- Web Services
Review