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 (→Table of Contents) |
m (→Table of Contents) |
||
Line 7: | Line 7: | ||
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. | ||
− | #[[EclipseLink/UserGuide/MOXy/Overview|Overview]] <br> | + | #[[EclipseLink/UserGuide/MOXy/Overview|Overview]] <br>''Generic EclipseLink info (i.e., non-MOXy) will be used to create a separate "Welcome to EclispeLink" guide.'' |
##[[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]] <br>[[Image:Elug about icon.png]] Review | ##[[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]] <br>[[Image:Elug about icon.png]] Review | ||
##[[EclipseLink/UserGuide/MOXy/Overview/JAXB|JAXB Overview ]]<br>[[Image:Elug about icon.png]] Review | ##[[EclipseLink/UserGuide/MOXy/Overview/JAXB|JAXB Overview ]]<br>[[Image:Elug about icon.png]] Review | ||
Line 14: | Line 14: | ||
##[[EclipseLink/UserGuide/MOXy/Overview/DynamicEntities|Static vs. Dynamic MOXy]] <br>[[Image:Elug about icon.png]] Review | ##[[EclipseLink/UserGuide/MOXy/Overview/DynamicEntities|Static vs. Dynamic MOXy]] <br>[[Image:Elug about icon.png]] Review | ||
#[[EclipseLink/UserGuide/MOXy/Runtime|Runtime]] <br>[[Image:Elug about icon.png]] Review | #[[EclipseLink/UserGuide/MOXy/Runtime|Runtime]] <br>[[Image:Elug about icon.png]] Review | ||
− | ##<strike>[[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]] </strike> [[Image:Accept.png]] | + | ##<strike>[[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]] </strike> [[Image:Accept.png]] |
− | ##Bootstrapping - B <br> | + | ##Bootstrapping - B <br> ''in progress'' |
###[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project|From a Single Project]] | ###[[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/Multiple Projects|From Multiple Projects]] | ||
###[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]] | ###[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]] | ||
− | ##[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping Dynamic|Dynamic JAXB Bootstrapping]] - B <br> | + | ##[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping Dynamic|Dynamic JAXB Bootstrapping]] - B <br> ''in progress'' |
− | ###<strike>[[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime]]</strike> [[Image:Accept.png]] | + | ###<strike>[[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime]]</strike> [[Image:Accept.png]] |
###[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From an XML Schema]] <br>[[Image:Elug about icon.png]] Review | ###[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From an XML Schema]] <br>[[Image:Elug about icon.png]] Review | ||
###From a Single Project | ###From a Single Project | ||
Line 28: | Line 28: | ||
####[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From OXM using DynamicEntities|From OXM using DynamicEntities]] | ####[[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]] | ####[[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project/From sessions.xml using DynamicEntities|From sessions.xml using DynamicEntities]] | ||
− | ##[[EclipseLink/UserGuide/MOXy/Runtime/Querying Objects by XPath|Querying Objects by XPath]] | + | ##[[EclipseLink/UserGuide/MOXy/Runtime/Querying Objects by XPath|Querying Objects by XPath]] <br> ''need info'' |
− | ##[[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects|Converting XML to Objects (Unmarshalling)]] | + | ##[[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects|Converting XML to Objects (Unmarshalling)]] <br> ''in progress'' |
###[[EclipseLink/UserGuide/MOXy/Runtime/Converting XML to Objects/Sources|Sources (DOM, SAX, StAX, Streams)]] | ###[[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/Validating Against an XML Schema|Validating Against an XML Schema]] | ||
Line 41: | Line 41: | ||
#[[EclipseLink/UserGuide/MOXy/Type Level|Type Level]] - A | #[[EclipseLink/UserGuide/MOXy/Type Level|Type Level]] - A | ||
##[[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]] - A | ##[[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]] - A | ||
− | ###<strike>[[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]] </strike> [[Image:Accept.png]] | + | ###<strike>[[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]] </strike> [[Image:Accept.png]] |
− | ##<strike>[[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]] </strike> [[Image:Accept.png]] | + | ##<strike>[[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]] </strike> [[Image:Accept.png]] |
##[[EclipseLink/UserGuide/MOXy/Type Level/Creating Objects|Creating Objects (Constructors & Factories)]] | ##[[EclipseLink/UserGuide/MOXy/Type Level/Creating Objects|Creating Objects (Constructors & Factories)]] | ||
##[[EclipseLink/UserGuide/MOXy/Type Level/Handling Inheritance|Handling Inheritance]] | ##[[EclipseLink/UserGuide/MOXy/Type Level/Handling Inheritance|Handling Inheritance]] | ||
Line 58: | Line 58: | ||
#[[EclipseLink/UserGuide/MOXy/Relationships|Relationships]] -A | #[[EclipseLink/UserGuide/MOXy/Relationships|Relationships]] -A | ||
##[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned|Privately Owned]] - A | ##[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned|Privately Owned]] - A | ||
− | ###<strike> [[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-One|Mapping One-to-One Relationships]] - A </strike> [[Image:Accept.png]] | + | ###<strike>[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-One|Mapping One-to-One Relationships]] - A </strike> [[Image:Accept.png]] |
###[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-Many|One-to-Many – XMLCompositeCollectionMapping]] - A <br>[[Image:Elug about icon.png]] Review | ###[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned/One-to-Many|One-to-Many – XMLCompositeCollectionMapping]] - A <br>[[Image:Elug about icon.png]] Review | ||
##[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference|Shared Reference]] - A | ##[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference|Shared Reference]] - A | ||
###<!--[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys|Keys and Foreign Keys]] --> Keys and Foreign Keys - A | ###<!--[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys|Keys and Foreign Keys]] --> Keys and Foreign Keys - A | ||
####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Single Key|Single Key]]- A<br>[[Image:Elug about icon.png]] Review <br> | ####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Single Key|Single Key]]- A<br>[[Image:Elug about icon.png]] Review <br> | ||
− | ####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Composite Key|Composite Key]] A | + | ####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Composite Key|Composite Key]] A <br>[[Image:Elug about icon.png]] Review |
− | ####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Embedded Key Class|Embedded Key Class]] -A | + | ####[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Keys and Foreign Keys/Embedded Key Class|Embedded Key Class]] -A <br>''in progress'' |
− | ###[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-One|Many-to-One – XMLObjectReferenceMapping]] -A | + | ###[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-One|Many-to-One – XMLObjectReferenceMapping]] -A <br>''need info'' |
− | ###[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-|Many-to-Many – XMLCollectionReferenceMapping]] - A | + | ###[[EclipseLink/UserGuide/MOXy/Relationships/Shared Reference/Many-to-|Many-to-Many – XMLCollectionReferenceMapping]] - A <br>''need info'' |
##[[EclipseLink/UserGuide/MOXy/Relationships/Collections and Maps|Collections and Maps]] | ##[[EclipseLink/UserGuide/MOXy/Relationships/Collections and Maps|Collections and Maps]] | ||
##[[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]] | ##[[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]] | ||
###[[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships/XMLInverseMapping|XMLInverseMapping]] | ###[[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships/XMLInverseMapping|XMLInverseMapping]] | ||
− | #[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts|Advanced XML Schema Concepts]] - B | + | #[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts|Advanced XML Schema Concepts]] - B |
− | ##[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]] | + | ##[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]] <br>[[Image:Elug about icon.png]] Review |
− | ##[[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|Substitution Groups and Choices]] <br>''Need info'' |
###[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Substitution Groups and Choices/XMLChoiceObjectMapping|XMLChoiceObjectMapping]] | ###[[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/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|Wildcard Content]] <br>''Need info'' |
###[[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Wildcard Content/XMLAnyAttributeMapping|XMLAnyAttributeMapping]] | ###[[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/XMLAnyObjectMapping|XMLAnyObjectMapping]] | ||
Line 84: | Line 84: | ||
##[[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentMapping|XMLFragmentMapping]] | ##[[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentMapping|XMLFragmentMapping]] | ||
##[[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentCollectionMapping|XMLFragmentCollectionMapping]] | ##[[EclipseLink/UserGuide/MOXy/Mapping the Unmappable/XMLFragmentCollectionMapping|XMLFragmentCollectionMapping]] | ||
− | #[[EclipseLink/UserGuide/MOXy/Customizing Schemas|Customizing Schemas]] | + | #[[EclipseLink/UserGuide/MOXy/Customizing Schemas|Customizing Schemas]] <br>''Need info'' |
#[[EclipseLink/UserGuide/MOXy/Generating Java Classes from an XML Schema|Generating Java Classes from an XML Schema]] <br>[[Image:Elug about icon.png]] Review | #[[EclipseLink/UserGuide/MOXy/Generating Java Classes from an XML Schema|Generating Java Classes from an XML Schema]] <br>[[Image:Elug about icon.png]] Review | ||
− | #[[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML|Mapping JPA Entities to XML]] | + | #[[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML|Mapping JPA Entities to XML]] <br>''Need info'' |
##[[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Lazily Loaded Fields/Properties|Properties]] | ##[[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/Bidirectional Relationships|Bidirectional Relationships]] | ||
##[[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Keys and Foreign Keys|Keys and Foreign Keys]] | ##[[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Keys and Foreign Keys|Keys and Foreign Keys]] | ||
− | #[[EclipseLink/UserGuide/MOXy/Web Services|Web Services]] | + | #[[EclipseLink/UserGuide/MOXy/Web Services|Web Services]] <br>''Need info'' |
##[[EclipseLink/UserGuide/MOXy/Web Services/Attachments|Attachments]] | ##[[EclipseLink/UserGuide/MOXy/Web Services/Attachments|Attachments]] | ||
###[[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataMapping|XMLBinaryDataMapping]] | ###[[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataMapping|XMLBinaryDataMapping]] | ||
###[[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataCollectionMapping|XMLBinaryDataCollectionMapping]] | ###[[EclipseLink/UserGuide/MOXy/Web Services/Attachments/XMLBinaryDataCollectionMapping|XMLBinaryDataCollectionMapping]] | ||
− | #[[EclipseLink/UserGuide/MOXy/Spring|Using Eclipselink with Spring]] | + | #[[EclipseLink/UserGuide/MOXy/Spring|Using Eclipselink with Spring]] <br>''Need info'' |
Revision as of 14:32, 11 March 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.
- Overview
Generic EclipseLink info (i.e., non-MOXy) will be used to create a separate "Welcome to EclispeLink" guide.- About EclipseLink
Review - JAXB Overview
Review - Metadata
- Annotations
- Static vs. Dynamic MOXy
Review
- About EclipseLink
- Runtime
ReviewSpecifying the EclipseLink Runtime- Bootstrapping - B
in progress - Dynamic JAXB Bootstrapping - B
in progressSpecifying the EclipseLink Runtime- From an XML Schema
Review - From a Single Project
- From Multiple Projects
- Querying Objects by XPath
need info - Converting XML to Objects (Unmarshalling)
in progress - Convert Objects to XML (Marshalling)
- Binding to an Existing Document
Review
- Type Level - A
- Simple Values - A
- Single Values - A
- Colections -A
EnumsReview- Special Schema Types
- Relationships -A
- Privately Owned - A
- Shared Reference - A
- Keys and Foreign Keys - A
- Single Key- A
Review
- Composite Key A
Review - Embedded Key Class -A
in progress
- Single Key- A
- Many-to-One – XMLObjectReferenceMapping -A
need info - Many-to-Many – XMLCollectionReferenceMapping - A
need info
- Keys and Foreign Keys - A
- Collections and Maps
- Bidirectional Relationships
- Advanced XML Schema Concepts - B
- Mapping the Unmappable
- Customizing Schemas
Need info - Generating Java Classes from an XML Schema
Review - Mapping JPA Entities to XML
Need info - Web Services
Need info - Using Eclipselink with Spring
Need info