Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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"

 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<css>
+
__NOTOC__<css>
 
.editsection {display:none;}
 
.editsection {display:none;}
 
#bodyContent h2, #bodyContent h3 {margin-bottom:3px;}
 
#bodyContent h2, #bodyContent h3 {margin-bottom:3px;}
Line 10: Line 10:
 
.widetoc #toc {width:99%;}
 
.widetoc #toc {width:99%;}
 
</css>  
 
</css>  
<div class="widetoc">__TOC__</div> <div style="font-size: 0.8em;">
+
<div style="font-size: 0.8em;">
  
 
<div style="float: left; width: 49%;">
 
<div style="float: left; width: 49%;">
 
= Overview <br> =
 
= Overview <br> =
  
== [[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]] ==
+
== [[EclipseLink/UserGuide/MOXy/Overview|About EclipseLink]] [[Image:Elug_Delete.png‎ ]] ==
  
 
== [[EclipseLink/UserGuide/MOXy/Overview/JAXB|JAXB Overview ]]  [[Image:Accept.png]]  ==  
 
== [[EclipseLink/UserGuide/MOXy/Overview/JAXB|JAXB Overview ]]  [[Image:Accept.png]]  ==  
Line 23: Line 23:
 
== [[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]]  [[Image:Accept.png]] ==
 
== [[EclipseLink/UserGuide/MOXy/Runtime/Specifying the EclipseLink Runtime|Specifying the EclipseLink Runtime]]  [[Image:Accept.png]] ==
  
== Bootstrapping ==
+
== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping|Bootstrapping]] [[Image:Accept.png]] ==
  
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Single Project|From a Single Project]] [[Image:Accept.png]] ===
+
== [[EclipseLink/UserGuide/MOXy/Runtime/XML Bindings|XML Bindings]] [[Image:Accept.png]] ==
  
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Multiple Projects|From Multiple Projects]] [[Image:Accept.png]] ===
+
== [[EclipseLink/UserGuide/MOXy/Runtime/MetadataSource|MetadataSource]] [[Image:Accept.png]] ==
  
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]]  [[Image:Accept.png]] ===
+
== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/Generating Schema|Generating Schema]]  [[Image:Accept.png]] ==
  
 
== Converting XML to Objects (Unmarshalling) ==
 
== Converting XML to Objects (Unmarshalling) ==
Line 53: Line 53:
 
= Type Level  =
 
= Type Level  =
  
== [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]]  [[Image:Accept.png]] ==
+
== [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]]  [[Image:Accept.png]] ==
 
+
=== [[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element|Default Root Element]]  [[Image:Accept.png]] ===
+
  
 
== [[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]]  [[Image:Accept.png]] ==
 
== [[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]]  [[Image:Accept.png]] ==
Line 68: Line 66:
  
 
== [[EclipseLink/UserGuide/MOXy/Simple Values/Collections/XMLDirectCollectionMapping|Mapping Collections of Simple Values]]  [[Image:Accept.png]] ==
 
== [[EclipseLink/UserGuide/MOXy/Simple Values/Collections/XMLDirectCollectionMapping|Mapping Collections of Simple Values]]  [[Image:Accept.png]] ==
 +
 +
== [[EclipseLink/UserGuide/MOXy/Simple Values/Multiple Mappings|Multiple Mappings for a Single Property ]] [[Image:Accept.png]]  ==
  
 
== [[EclipseLink/UserGuide/MOXy/Simple Values/Enums|Enums]]  [[Image:Accept.png]] ==
 
== [[EclipseLink/UserGuide/MOXy/Simple Values/Enums|Enums]]  [[Image:Accept.png]] ==
Line 75: Line 75:
 
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Date and Time Types|Date and Time Types]] [[Image:Accept.png]] ===
 
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Date and Time Types|Date and Time Types]] [[Image:Accept.png]] ===
  
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Binary Types|Binary Types]]  [[Image:Elug_Delete.png‎ ]] ===
+
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Binary Types|Binary Types]]  [[Image:Accept.png‎ ]] ===
  
 
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Leveraging xsi:type|Leveraging xsi:type]] [[Image:Elug_Delete.png‎ ]] ===
 
=== [[EclipseLink/UserGuide/MOXy/Simple Values/Special Schema Types/Leveraging xsi:type|Leveraging xsi:type]] [[Image:Elug_Delete.png‎ ]] ===
Line 98: Line 98:
 
=== [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]] [[Image:Accept.png]] ===
 
=== [[EclipseLink/UserGuide/MOXy/Relationships/Bidirectional Relationships|Bidirectional Relationships]] [[Image:Accept.png]] ===
  
= Advanced XML Schema Concepts  =
+
= Advanced Concepts  =
 +
 
 +
== [[EclipseLink/UserGuide/MOXy/Advanced Concepts/Refreshing Metadata|Refreshing Metadata]] [[Image:Accept.png]]  ==
 +
 
 +
== [[EclipseLink/UserGuide/MOXy/Advanced Concepts/Customizing XML Name Conversions|Customizing XML Name Conversions]] [[Image:Accept.png]]  ==
 +
 
 +
== [[EclipseLink/UserGuide/MOXy/Advanced Concepts/Virtual Access Methods|Virtual Access Methods]] [[Image:Accept.png]] ==
  
 
== [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]] [[Image:Elug_Delete.png‎ ]]  ==
 
== [[EclipseLink/UserGuide/MOXy/Advanced XML Schema Concepts/Handling Null Values|Handling Null Values]] [[Image:Elug_Delete.png‎ ]]  ==
 +
 +
== [[EclipseLink/UserGuide/MOXy/Advanced_Concepts/XPath_Predicates|Mapping using XPath Predicates]] [[Image:Accept.png]]  ==
 +
  
 
== Choice Mappings  ==
 
== Choice Mappings  ==
Line 140: Line 149:
 
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From XML Schema]] [[Image:Accept.png]] ===
 
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From Schema|From XML Schema]] [[Image:Accept.png]] ===
  
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From OXM|From EclipseLink OXM]] [[Image:Elug about icon.png]] ===
+
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From OXM|From EclipseLink OXM]] [[Image:Accept.png]] ===
  
=== [[EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping/From sessionsxml|From EclipseLink sessions.xml]] [[Image:Elug about icon.png]] ===
+
== [[EclipseLink/UserGuide/MOXy/Runtime/Dynamic/Customizing|Customizing Generated Mappings]] [[Image:Accept.png]] ==
  
 
= Mapping JPA Entities to XML  =
 
= Mapping JPA Entities to XML  =
Line 160: Line 169:
  
 
</div> </div> <div style="clear: both;">&nbsp;</div>  
 
</div> </div> <div style="clear: both;">&nbsp;</div>  
 +
 +
'''New items for 2.3'''
 +
*Extensible Domain Models (339371)
 +
*XML Extensions (339381)
 +
*Adding mapping to XMLDescriptor at runtime (339377)
 +
*Persist metadata mods at runtime (339383)
 +
*Multiple Bindings support (339373)
 +
 +
  
 
'''Status'''
 
'''Status'''

Latest revision as of 11:12, 15 July 2011

Overview

About EclipseLink Elug Delete.png

JAXB Overview Accept.png

Runtime

Specifying the EclipseLink Runtime Accept.png

Bootstrapping Accept.png

XML Bindings Accept.png

MetadataSource Accept.png

Generating Schema Accept.png

Converting XML to Objects (Unmarshalling)

Sources (DOM, SAX, StAX, Streams) Elug Delete.png

Handling Unmapped Content Elug Delete.png

Convert Objects to XML (Marshalling)

Targets (DOM, SAX, StAX, Streams) Elug Delete.png

Properties (Formatting & Encoding) Elug Delete.png

Validating Against an XML Schema Accept.png

Events Accept.png

Querying Objects by XPath Accept.png

Binding to an Existing Document Accept.png

Type Level

Default Root Element Accept.png

Setting Up Namespace Information Accept.png

Creating Objects (Constructors & Factories) Elug Delete.png

Handling Inheritance Accept.png

Mapping Simple Values and Collections

Mapping Simple Values Accept.png

Mapping Collections of Simple Values Accept.png

Multiple Mappings for a Single Property Accept.png

Enums Accept.png

Special Schema Types

Date and Time Types Accept.png

Binary Types Accept.png

Leveraging xsi:type Elug Delete.png

Unions Accept.png

 

Mapping Relationships

Mapping Privately Owned Relationships

Mapping One-to-One Relationships Accept.png

Mapping One-to-Many Relationships Accept.png

Shared Reference Mappings

Mapping Single Key Relationships Accept.png

Mapping Composite Key Relationships Accept.png

Bidirectional Relationships Accept.png

Advanced Concepts

Refreshing Metadata Accept.png

Customizing XML Name Conversions Accept.png

Virtual Access Methods Accept.png

Handling Null Values Elug Delete.png

Mapping using XPath Predicates Accept.png

Choice Mappings

XMLChoiceObjectMapping Elug Delete.png

XMLChoiceCollectionMapping Elug Delete.png

Wildcard Content

Any Attribute Mapping Elug Delete.png

Any Element Mapping Elug Delete.png

Mapping the Unmappable

XmlAdapter Accept.png

XML Transformations Accept.png

XMLFragmentMapping Elug Delete.png

XMLFragmentCollectionMapping Elug Delete.png

Customizing Schemas Elug Delete.png

Generating Java Classes from an XML Schema

JAXB Compiler Accept.png

Dynamic JAXB

Static vs. Dynamic MOXy Accept.png

Specifying the EclipseLink Runtime Accept.png

Bootstrapping

From XML Schema Accept.png

From EclipseLink OXM Accept.png

Customizing Generated Mappings Accept.png

Mapping JPA Entities to XML

Properties Elug about icon.png

Bidirectional Relationships Elug about icon.png

Keys and Foreign Keys Elug about icon.png

Embedded Key Class Elug about icon.png

Web Services

JAX-WS Implementation Elug about icon.png

 

New items for 2.3

  • Extensible Domain Models (339371)
  • XML Extensions (339381)
  • Adding mapping to XMLDescriptor at runtime (339377)
  • Persist metadata mods at runtime (339383)
  • Multiple Bindings support (339373)


Status

Elug about icon.png - Pending Review

Accept.png - Approved

Elug Delete.png - Content pending


'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 EclipseLinkAccept.png 
    2. JAXB Overview Accept.png
    3. Metadata
    4. Annotations
    5. Static vs. Dynamic MOXy Accept.png
  2. Runtime
    Elug about icon.png Review
    1. Specifying the EclipseLink Runtime Accept.png
    2. Bootstrapping - B
      1. From a Single Project
        Elug about icon.png Review
      2. From Multiple Projects
        Elug about icon.png Review
      3. Generating Schema
        Elug about icon.png Review
    3. Dynamic JAXB Bootstrapping
      Elug about icon.png Review
      1. Specifying the EclipseLink Runtime Accept.png
      2. From an XML Schema
        Elug about icon.png Review
      3. From a Single Project
        1. From OXM using DynamicEntities
        2. From sessions.xml using DynamicEntities
          Elug about icon.pngReview
      4. From Multiple Projects
        1. From OXM using DynamicEntities
        2. From sessions.xml using DynamicEntities
          Elug about icon.png Review
    4. Querying Objects by XPath
      Elug about icon.png Review
    5. Converting XML to Objects (Unmarshalling)

      1. Sources (DOM, SAX, StAX, Sk Runtime/Using DynamicEntities|Specifying the EclipseLink Runtime</strike> Accept.png
      2. From an XML Schema
        Elug about icon.png Review
      3. From a Single Project
        1. From OXM using DynamicEntities
        2. From sessions.xml using DynamicEntities
          Elug about icon.pngReview
      4. From Multiple Projects
        1. From OXM using DynamicEntities
        2. From sessions.xml using DynamicEntities
          Elug about icon.png Review
    6. Querying Objects by XPath
      Elug about icon.png Review
    7. Converting XML to Objects (Unmarshalling)

      1. Sources (DOM, SAX, StAX, Streams)
      2. Validating Against an XML Schema
        Elug about icon.png Review
      3. Events
      4. Handling Unmapped Content
    8. Convert Objects to XML (Marshalling)
      need info
      1. Targets (DOM, SAX, StAX, Streams)
      2. Properties (Formatting & Encoding)
      3. Events
        Elug about icon.png Review
    9. Binding to an Existing Document Accept.png

  3. Type Level - A
    1. Mapping to a Type or Element - A
      1. Default Root Element Accept.png
    2. Setting Up Namespace Information Accept.png
    3. Creating Objects (Constructors & Factories)
    4. Handling Inheritance
      Elug about icon.png Review
  4. Simple Values - A
    1. Single Values - A
      1. Mapping Simple Values Accept.png
    2. Colections -A
      1. Mappng Collections of Simple Values Accept.png
    3. Enums Accept.png
    4. Special Schema Types
      1. Date and Time Types
        Elug about icon.png Review
      2. Binary Types
      3. Leveraging xsi:type
      4. Unions
        Elug about icon.png Review
  5. Relationships -A 
    1. Privately Owned - A
      1. Mapping One-to-One Relationships - A  Accept.png
      2. Mapping One-to-Many Relationships- A  Accept.png

    2. Shared Reference - A
      1. Keys and Foreign Keys - A
        1. Mapping Single Key Relationships- A Accept.png
        2. Mapping Composite Key Relationships- A Accept.png
        3. Embedded Key Class -A
          in progress
    3. Collections and Maps
      Elug about icon.png Review
    4. Bidirectional Relationships (includes XMLInverseMapping)
      Elug about icon.png Review
  6. Advanced XML Schema Concepts - B
    1. Handling Null Values  Accept.png

    2. Substitution Groups and Choices
      Elug about icon.png Review
      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
      Elug about icon.png Review
    6. XMLFragmentMapping
    7. XMLFragmentCollectionMapping
  8. Customizing Schemas
    Need info
  9. Generating Java Classes from an XML Schema  Accept.png

  10. Mapping JPA Entities to XML
    http://wiki.eclipse.org/EclipseLink/Examples/MOXy/JPA
    1. Properties
    2. Bidirectional Relationships
      Elug about icon.pngReview
    3. Keys and Foreign Keys
      Elug about icon.png Review
  11. Web Services
    Elug about icon.pngReview

Back to the top