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/2.1/DynamicMOXy/296967/BootstrapFromXSD"
(→Phase 4) |
|||
(31 intermediate revisions by the same user not shown) | |||
Line 103: | Line 103: | ||
</source> | </source> | ||
− | * The <tt>targetNamespace</tt> and <tt>elementFormDefault</tt> property will result in an <tt>XmlSchema</tt> annotation on the generated <tt>package-info</tt> class. | + | * The <tt>targetNamespace</tt> and <tt>elementFormDefault</tt> property will result in an <tt>@XmlSchema</tt> annotation on the generated <tt>package-info</tt> class. |
− | * The inheritance relationship between <tt>person</tt>, <tt>customer</tt>, and <tt>employee</tt> will result in an <tt>XmlSeeAlso</tt> annotation on the generated <tt>Person</tt> class. | + | * The inheritance relationship between <tt>person</tt>, <tt>customer</tt>, and <tt>employee</tt> will result in an <tt>@XmlSeeAlso</tt> annotation on the generated <tt>Person</tt> class. |
==== Limitations ==== | ==== Limitations ==== | ||
− | * XJC does not interpret the <tt>attributeFormDefault</tt> property during schema parsing, and will therefore not generate this property in the <tt>XmlSchema</tt> annotation. | + | * XJC does not interpret the <tt>attributeFormDefault</tt> property during schema parsing, and will therefore not generate this property in the <tt>@XmlSchema</tt> annotation. |
− | * There is no XML Schema construct that will result in an <tt>XmlTransient</tt> annotation being generated. | + | * There is no XML Schema construct that will result in an <tt>@XmlTransient</tt> annotation being generated. |
<br><br> | <br><br> | ||
Line 178: | Line 178: | ||
</source> | </source> | ||
− | * The <tt>name</tt> property of the root element will appear in the <tt>XmlRootElement</tt> annotation's <tt>name</tt> property. | + | * The <tt>name</tt> property of the root element will appear in the <tt>@XmlRootElement</tt> annotation's <tt>name</tt> property. |
− | * The order of the elements of the <tt>person</tt> type will be captured in the <tt>XmlType</tt> annotation's <tt>propOrder</tt> property. | + | * The order of the elements of the <tt>person</tt> type will be captured in the <tt>@XmlType</tt> annotation's <tt>propOrder</tt> property. |
==== Limitations ==== | ==== Limitations ==== | ||
− | * There is no XML Schema construct that will result in the generation of <tt>XmlAccessorOrder</tt> or <tt>XmlAccessorType</tt> annotations. | + | * There is no XML Schema construct that will result in the generation of <tt>@XmlAccessorOrder</tt> or <tt>@XmlAccessorType</tt> annotations. |
<br><br> | <br><br> | ||
Line 246: | Line 246: | ||
==== Limitations ==== | ==== Limitations ==== | ||
− | * There is no XML Schema construct that will result in the generation of an <tt>XmlAdapter</tt> annotation. | + | * There is no XML Schema construct that will result in the generation of an <tt>@XmlAdapter</tt> annotation. |
<br><br> | <br><br> | ||
Line 303: | Line 303: | ||
| align="center" | X | | align="center" | X | ||
|} | |} | ||
+ | |||
+ | <br> | ||
+ | |||
+ | The following example schema demonstrates how these annotations will be derived from the schema: | ||
+ | |||
+ | ==== Example Schemas ==== | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <!-- XmlList --> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="codes" type="myns:codes"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | <xs:simpleType name="codes"> | ||
+ | <xs:list itemType="xs:string"/> | ||
+ | </xs:simpleType> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * An <tt>xs:simpleType</tt> containing an <tt>xs:list</tt> results in an <tt>@XmlList</tt> annotation on the <tt>codes</tt> field | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <!-- XmlValue --> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person" type="myns:person"/> | ||
+ | |||
+ | <xs:complexType name="person"> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="salary" type="myns:cdn_currency"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | |||
+ | <xs:complexType name="cdn_currency"> | ||
+ | <xs:simpleContent> | ||
+ | <xs:extension base="xs:decimal"/> | ||
+ | </xs:simpleContent> | ||
+ | </xs:complexType> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * An <tt>xs:complexType</tt> containing <tt>xs:simpleContent</tt> results in an <tt>@XmlValue</tt> annotation on the <tt>value</tt> field of the <tt>CdnCurrency</tt> type. | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <!-- XmlAnyElement / XmlAnyAttribute --> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:any/> | ||
+ | </xs:sequence> | ||
+ | <xs:anyAttribute/> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * The <tt>xs:any</tt> element results in the generation of an <tt>any</tt> field on <tt>Person</tt>, annotated with <tt>@XmlAnyElement</tt>. | ||
+ | * The <tt>xs:anyAttribute</tt> element results in the generation of an <tt>otherAttributes</tt> field on <tt>Person</tt>, annotated with <tt>@XmlAnyAttribute</tt>. | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <!-- XmlMixed --> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType mixed="true"> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="title" type="xs:string"/> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="rewardPoints" type="xs:positiveInteger"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * <tt>mixed=true</tt> results in the generation of a <tt>content</tt> field on <tt>Person</tt>, annotated with <tt>@XmlMixed</tt> (as well as <tt>@XmlElementRefs</tt> for each possible value) | ||
+ | |||
+ | ==== Limitations ==== | ||
+ | |||
+ | * There is no XML Schema construct that will result in an <tt>@XmlElementWrapper</tt> annotation being generated. | ||
<br><br> | <br><br> | ||
Line 316: | Line 415: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlID.html XmlID<br>] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlID.html XmlID<br>] | ||
Line 324: | Line 422: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlIDREF.html XmlIDREF]<br> | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlIDREF.html XmlIDREF]<br> | ||
Line 348: | Line 429: | ||
| align="center" | X<br> | | align="center" | X<br> | ||
| align="center" | X<br> | | align="center" | X<br> | ||
− | | | + | |} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | } | + | |
− | <xs:complexType name=" | + | <br> |
− | + | ||
− | + | The following example schema demonstrates how these annotations will be derived from the schema: | |
− | + | ||
− | + | ==== Example Schema ==== | |
− | + | ||
− | + | <source lang="xml"> | |
− | </xs:complexType> | + | <?xml version="1.0" encoding="UTF-8"?> |
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="data"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="person" type="myns:person"/> | ||
+ | <xs:element name="company" type="myns:company"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | <xs:complexType name="person"> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="company" type="xs:IDREF"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | |||
+ | <xs:complexType name="company"> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="address" type="xs:string"/> | ||
+ | </xs:sequence> | ||
+ | <xs:attribute name="id" type="xs:ID"/> | ||
+ | </xs:complexType> | ||
+ | |||
+ | </xs:schema> | ||
</source> | </source> | ||
− | + | ||
+ | * The <tt>id</tt> attribute, of type <tt>xs:ID</tt>, in the <tt>company</tt> type results in an <tt>@XmlID</tt> annotation on the <tt>id</tt> field. | ||
+ | * The <tt>company</tt> element, of type <tt>xs:IDREF</tt>, in the <tt>person</tt> type results in an <tt>@XmlIDREF</tt> annotation on the <tt>company</tt> field. | ||
+ | |||
+ | ==== Limitations ==== | ||
+ | |||
+ | * Currently disabled due to bug [https://bugs.eclipse.org/bugs/show_bug.cgi?id=307939 Bug 307939] | ||
<br><br> | <br><br> | ||
Line 379: | Line 487: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElements.html XmlElements] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElements.html XmlElements] | ||
Line 387: | Line 494: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementRef.html XmlElementRef] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementRef.html XmlElementRef] | ||
Line 412: | Line 501: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementRefs.html XmlElementRefs] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementRefs.html XmlElementRefs] | ||
Line 451: | Line 508: | ||
| align="center" | X<br> | | align="center" | X<br> | ||
| align="center" | X<br> | | align="center" | X<br> | ||
− | |||
− | |||
|} | |} | ||
+ | |||
+ | <br> | ||
+ | |||
+ | The following example schema demonstrates how these annotations will be derived from the schema: | ||
+ | |||
+ | ==== Example Schema ==== | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:choice minOccurs="1" maxOccurs="unbounded"> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | <xs:element name="reference-number" type="xs:int"/> | ||
+ | </xs:choice> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * The <tt>xs:choice</tt> will result in the generation of a <tt>nameOrReferenceNumber</tt> field, which is annotated with <tt>@XmlElements</tt> (with one <tt>@XmlElement</tt> annotation for both <tt>name</tt> and <tt>reference-number</tt>. | ||
+ | * <tt>@XmlElementRefs</tt> is covered along with the <tt>@XmlMixed</tt> annotation from Phase 4. | ||
<br><br> | <br><br> | ||
Line 467: | Line 549: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlSchemaType.html XmlSchemaType] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlSchemaType.html XmlSchemaType] | ||
Line 475: | Line 556: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlSchemaTypes.html XmlSchemaTypes] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlSchemaTypes.html XmlSchemaTypes] | ||
Line 495: | Line 563: | ||
| align="center" | <br> | | align="center" | <br> | ||
| align="center" | <br> | | align="center" | <br> | ||
− | |||
|} | |} | ||
+ | |||
+ | <br> | ||
+ | |||
+ | The following example schema demonstrates how these annotations will be derived from the schema: | ||
+ | |||
+ | ==== Example Schema ==== | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="date-of-birth" type="xs:date"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | * The <tt>dateOfBirth</tt> attribute will be annotated with <tt>@XmlSchemaType</tt>, because its XML type, <tt>xs:date</tt>, is an XML datatype (not a primitive type). | ||
+ | |||
+ | ==== Limitations ==== | ||
+ | |||
+ | * There is no XML Schema construct that will result in an <tt>@XmlSchemaTypes</tt> annotation being generated. | ||
<br><br> | <br><br> | ||
Line 510: | Line 604: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlEnum.html XmlEnum] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlEnum.html XmlEnum] | ||
Line 518: | Line 611: | ||
| align="center" | | | align="center" | | ||
| align="center" | | | align="center" | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlEnumValue.html XmlEnumValue] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlEnumValue.html XmlEnumValue] | ||
Line 537: | Line 618: | ||
| align="center" | X<br> | | align="center" | X<br> | ||
| align="center" | X<br> | | align="center" | X<br> | ||
− | |||
|} | |} | ||
+ | |||
+ | <br> | ||
+ | |||
+ | The following example schema demonstrates how these annotations will be derived from the schema: | ||
+ | |||
+ | ==== Example Schema ==== | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="person"> | ||
+ | <xs:complexType> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="quadrant" type="myns:compass-direction"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | </xs:element> | ||
+ | |||
+ | <xs:simpleType name="compass-direction"> | ||
+ | <xs:restriction base="xs:string"> | ||
+ | <xs:enumeration value="NORTH"/> | ||
+ | <xs:enumeration value="SOUTH"/> | ||
+ | <xs:enumeration value="EAST"/> | ||
+ | <xs:enumeration value="WEST"/> | ||
+ | </xs:restriction> | ||
+ | </xs:simpleType> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | ==== Limitations ==== | ||
+ | |||
+ | * Waiting on [https://bugs.eclipse.org/bugs/show_bug.cgi?id=308367 Bug 308367]. | ||
<br><br> | <br><br> | ||
Line 552: | Line 666: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlInlineBinaryData.html XmlInlineBinaryData] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlInlineBinaryData.html XmlInlineBinaryData] | ||
Line 560: | Line 673: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
|} | |} | ||
+ | |||
+ | <br> | ||
+ | |||
+ | * There is no XML Schema construct that will result in an <tt>@XmlInlineBinaryData</tt> annotation being generated. | ||
<br><br> | <br><br> | ||
Line 575: | Line 691: | ||
! Field | ! Field | ||
! Method | ! Method | ||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementDecl.html XmlElementDecl] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlElementDecl.html XmlElementDecl] | ||
Line 583: | Line 698: | ||
| align="center" | X | | align="center" | X | ||
| align="center" | X | | align="center" | X | ||
− | |||
− | |||
|- | |- | ||
| [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlRegistry.html XmlRegistry] | | [http://java.sun.com/javase/6/docs/api/javax/xml/bind/annotation/XmlRegistry.html XmlRegistry] | ||
Line 592: | Line 705: | ||
| align="center" | | | align="center" | | ||
| align="center" | | | align="center" | | ||
− | |||
− | |||
|} | |} | ||
<br> | <br> | ||
+ | |||
+ | The following example schema demonstrates how these annotations will be derived from the schema: | ||
+ | |||
+ | ==== Example Schema ==== | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <xs:schema ...> | ||
+ | |||
+ | <xs:element name="individuo" type="myns:person"/> | ||
+ | |||
+ | <xs:complexType name="person"> | ||
+ | <xs:sequence> | ||
+ | <xs:element name="name" type="xs:string"/> | ||
+ | </xs:sequence> | ||
+ | </xs:complexType> | ||
+ | |||
+ | </xs:schema> | ||
+ | </source> | ||
+ | |||
+ | |||
+ | * The element declaration for <tt>individuo</tt> will result in an <tt>@XmlElementDecl</tt> annotation on the generated <tt>ObjectFactory</tt> class. | ||
+ | * As a result of the <tt>@XmlElementDecl</tt> annotation, <tt>ObjectFactory</tt> will also be annotated with an <tt>@XmlRegistry</tt>. | ||
+ | |||
+ | <br><br> | ||
== Design == | == Design == |
Latest revision as of 11:36, 13 April 2010
Dynamic MOXy - Bootstrapping from XML Schema
Overview
Support for bootstrapping a DynamicJAXBContext from an XML Schema file (XSD) will be implemented in multiple phases. For each phase, test schemas will be created that would result in the following annotations being generated by XJC. A DynamicJAXBContext will then be created from each schema, and an example object will be marshalled. The resulting document will be inspected to ensure that it was marshalled properly, according to the annotations being tested.
Generating a DynamicJAXBContext with XJC
A DynamicJAXBContext is created from an XSD in the following way:
- The schema is parsed using com.sun.tools.xjc.api.SchemaCompiler, resulting in a com.sun.codemodel.JCodeModel being generated.
- JCodeModel contains XJC representations (com.sun.codemodel.JDefinedClass) of the classes to be generated. We iterate over the collection of JDefinedClasses to create EclipseLink representations of the same classes (org.eclipse.persistence.jaxb.javamodel.xjc.*)
- This collection of EclipseLink javamodel classes is then passed to org.eclipse.persistence.jaxb.compiler.Generator, which generates a standard EclipseLink project.
- A Dynamic Project is then created from the standard project via DynamicTypeBuilder.loadDynamicProject().
- An org.eclipse.persistence.oxm.XMLContext is then created from the Dynamic Project, and a DynamicJAXBContext is returned backed by this XMLContext.
Development Phases
Phase 1
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlNs | xml-ns | ||||
XmlSchema | xml-schema | X | |||
XmlSeeAlso | xml-see-also | X | |||
XmlTransient | xml-transient | X | X | X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema targetNamespace="myNamespace" xmlns:myns="myNamespace" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="qualified" elementFormDefault="qualified"> <xs:element name="person" type="myns:person"/> <xs:complexType name="person"> <xs:sequence> <xs:element name="name" type="xs:string"/> </xs:sequence> </xs:complexType> <xs:complexType name="customer"> <xs:complexContent> <xs:extension base="myns:person"> <xs:sequence> <xs:element name="customer-id" type="xs:int"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="employee"> <xs:complexContent> <xs:extension base="myns:person"> <xs:sequence> <xs:element name="employee-id" type="xs:string"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:schema>
- The targetNamespace and elementFormDefault property will result in an @XmlSchema annotation on the generated package-info class.
- The inheritance relationship between person, customer, and employee will result in an @XmlSeeAlso annotation on the generated Person class.
Limitations
- XJC does not interpret the attributeFormDefault property during schema parsing, and will therefore not generate this property in the @XmlSchema annotation.
- There is no XML Schema construct that will result in an @XmlTransient annotation being generated.
Phase 2
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlAccessorOrder | xml-accessor-order | X | X | ||
XmlAccessorType | xml-accessor-type | X | X | ||
XmlRootElement | xml-root-element | X | |||
XmlType | xml-type | X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema targetNamespace="myNamespace" xmlns:myns="myNamespace" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="qualified" elementFormDefault="qualified"> <xs:element name="individuo" type="myns:person"/> <xs:complexType name="person"> <xs:sequence> <xs:element name="id" type="xs:int"/> <xs:element name="first-name" type="xs:string"/> <xs:element name="last-name" type="xs:string"/> <xs:element name="phone-number" type="xs:string"/> <xs:element name="email" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:schema>
- The name property of the root element will appear in the @XmlRootElement annotation's name property.
- The order of the elements of the person type will be captured in the @XmlType annotation's propOrder property.
Limitations
- There is no XML Schema construct that will result in the generation of @XmlAccessorOrder or @XmlAccessorType annotations.
Phase 3
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlAttribute | xml-attribute | X | X | ||
XmlElement | xml-element | X | X | ||
XmlAdapter | xml-java-type-adapter | X | X | X | X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema targetNamespace="myNamespace" xmlns:myns="myNamespace" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="person" type="myns:person"/> <xs:complexType name="person"> <xs:sequence> <xs:element name="type" type="xs:string"/> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:schema>
- The type field of the generated class will be annotated with @XmlElement.
- The id field of the generated class will be annotated with @XmlAttribute.
Limitations
- There is no XML Schema construct that will result in the generation of an @XmlAdapter annotation.
Phase 4
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlElementWrapper | xml-element-wrapper | X | X | ||
XmlList | xml-list | X | X | ||
XmlValue | xml-value | X | X | ||
XmlAnyElement | xml-any-element | X | X | ||
XmlAnyAttribute | xml-any-attribute | X | X | ||
XmlMixed | xml-mixed | X | X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schemas
<!-- XmlList --> <?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:element name="codes" type="myns:codes"/> </xs:sequence> </xs:complexType> </xs:element> <xs:simpleType name="codes"> <xs:list itemType="xs:string"/> </xs:simpleType> </xs:schema>
- An xs:simpleType containing an xs:list results in an @XmlList annotation on the codes field
<!-- XmlValue --> <?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person" type="myns:person"/> <xs:complexType name="person"> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:element name="salary" type="myns:cdn_currency"/> </xs:sequence> </xs:complexType> <xs:complexType name="cdn_currency"> <xs:simpleContent> <xs:extension base="xs:decimal"/> </xs:simpleContent> </xs:complexType> </xs:schema>
- An xs:complexType containing xs:simpleContent results in an @XmlValue annotation on the value field of the CdnCurrency type.
<!-- XmlAnyElement / XmlAnyAttribute --> <?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:any/> </xs:sequence> <xs:anyAttribute/> </xs:complexType> </xs:element> </xs:schema>
- The xs:any element results in the generation of an any field on Person, annotated with @XmlAnyElement.
- The xs:anyAttribute element results in the generation of an otherAttributes field on Person, annotated with @XmlAnyAttribute.
<!-- XmlMixed --> <?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType mixed="true"> <xs:sequence> <xs:element name="title" type="xs:string"/> <xs:element name="name" type="xs:string"/> <xs:element name="rewardPoints" type="xs:positiveInteger"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
- mixed=true results in the generation of a content field on Person, annotated with @XmlMixed (as well as @XmlElementRefs for each possible value)
Limitations
- There is no XML Schema construct that will result in an @XmlElementWrapper annotation being generated.
Phase 5
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlID |
xml-id | X | X | ||
XmlIDREF |
xml-idref | X |
X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="data"> <xs:complexType> <xs:sequence> <xs:element name="person" type="myns:person"/> <xs:element name="company" type="myns:company"/> </xs:sequence> </xs:complexType> </xs:element> <xs:complexType name="person"> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:element name="company" type="xs:IDREF"/> </xs:sequence> </xs:complexType> <xs:complexType name="company"> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:element name="address" type="xs:string"/> </xs:sequence> <xs:attribute name="id" type="xs:ID"/> </xs:complexType> </xs:schema>
- The id attribute, of type xs:ID, in the company type results in an @XmlID annotation on the id field.
- The company element, of type xs:IDREF, in the person type results in an @XmlIDREF annotation on the company field.
Limitations
- Currently disabled due to bug Bug 307939
Phase 6
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlElements | xml-elements | X | X | ||
XmlElementRef | xml-element-ref | X | X | ||
XmlElementRefs | xml-element-refs | X |
X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType> <xs:sequence> <xs:choice minOccurs="1" maxOccurs="unbounded"> <xs:element name="name" type="xs:string"/> <xs:element name="reference-number" type="xs:int"/> </xs:choice> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
- The xs:choice will result in the generation of a nameOrReferenceNumber field, which is annotated with @XmlElements (with one @XmlElement annotation for both name and reference-number.
- @XmlElementRefs is covered along with the @XmlMixed annotation from Phase 4.
Phase 7
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlSchemaType | xml-schema-type | X | X | X | |
XmlSchemaTypes | xml-schema-types | X | |
|
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType> <xs:sequence> <xs:element name="date-of-birth" type="xs:date"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
- The dateOfBirth attribute will be annotated with @XmlSchemaType, because its XML type, xs:date, is an XML datatype (not a primitive type).
Limitations
- There is no XML Schema construct that will result in an @XmlSchemaTypes annotation being generated.
Phase 8
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlEnum | xml-enum | X | |||
XmlEnumValue | xml-enum-value | X |
X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="person"> <xs:complexType> <xs:sequence> <xs:element name="quadrant" type="myns:compass-direction"/> </xs:sequence> </xs:complexType> </xs:element> <xs:simpleType name="compass-direction"> <xs:restriction base="xs:string"> <xs:enumeration value="NORTH"/> <xs:enumeration value="SOUTH"/> <xs:enumeration value="EAST"/> <xs:enumeration value="WEST"/> </xs:restriction> </xs:simpleType> </xs:schema>
Limitations
- Waiting on Bug 308367.
Phase 9
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlInlineBinaryData | xml-inline-binary-data | X | X | X |
- There is no XML Schema construct that will result in an @XmlInlineBinaryData annotation being generated.
Phase 10
Annotation | XML Metadata Tag | Package | Type | Field | Method |
---|---|---|---|---|---|
XmlElementDecl | xml-element-decl | X | X | ||
XmlRegistry | xml-registry | X |
The following example schema demonstrates how these annotations will be derived from the schema:
Example Schema
<?xml version="1.0" encoding="UTF-8"?> <xs:schema ...> <xs:element name="individuo" type="myns:person"/> <xs:complexType name="person"> <xs:sequence> <xs:element name="name" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:schema>
- The element declaration for individuo will result in an @XmlElementDecl annotation on the generated ObjectFactory class.
- As a result of the @XmlElementDecl annotation, ObjectFactory will also be annotated with an @XmlRegistry.
Design
When constructing a DynamicJAXBContext
from XML Schema, we can use APIs from the Java XJC compiler to parse a schema and create Java class definitions (XJC's JCodeModel
) in memory, then pass these class definitions to an EclipseLink Generator
(org.eclipse.persistence.jaxb.compiler.Generator
) to generate an EclipseLink project. After we have created this project, we can use the DynamicTypeBuilder
to create a dynamic project, generating Java classes in memory along the way.
First, we use XJC API to parse an XSD and generate a JCodeModel
. Note that this code stops short of actually generating .java
files, it only generates an in-memory representation of the Java files that would normally be created.
// Use XJC API to parse the schema and generate its JCodeModel SchemaCompiler sc = XJC.createSchemaCompiler(); InputSource inputSource = new InputSource(schemaInputStream); sc.parseSchema(inputSource); S2JJAXBModel model = sc.bind(); JCodeModel jCodeModel = model.generateCode(new Plugin[0], null);
We can then wrap these XJC classes in our own implentations of EclipseLink's JAXB JavaModel
classes. This will allow us to use the Generator
to create an EclipseLink project and mappings. The JavaModel
interfaces define "wrappers" for the various Java language constructs that make up the domain model (e.g. classes, methods, constructors, annotations, packages, etc). For example:
public class XJCJavaFieldImpl implements JavaField { // XJC's definition of a Field protected JFieldVar xjcField; ... public int getModifiers() { return xjcField.mods().getValue(); } public String getName() { return xjcField.name(); } ... }
Creating the JavaModel
classes:
// Create EclipseLink JavaModel objects for each of XJC's JDefinedClasses ArrayList<JDefinedClass> classesToProcess = new ArrayList<JDefinedClass>(); Iterator<JPackage> packages = jCodeModel.packages(); while (packages.hasNext()) { JPackage pkg = packages.next(); Iterator<JDefinedClass> classes = pkg.classes(); while (classes.hasNext()) { JDefinedClass cls = classes.next(); classesToProcess.add(cls); } } JavaClass[] jotClasses = createClassModelFromXJC(classesToProcess, jCodeModel);
At this point, we can instantiate a Generator
and obtain a "dry" EclipseLink project, which we can then turn into a dynamic project with generated in-memory classes. Finally, we create and store an XMLContext
and a DynamicHelper
:
// Use the JavaModel to setup a Generator to generate an EclipseLink project XJCJavaModelImpl javaModel = new XJCJavaModelImpl(Thread.currentThread().getContextClassLoader(), jCodeModel); XJCJavaModelInputImpl javaModelInput = new XJCJavaModelInputImpl(jotClasses, javaModel); Generator g = new Generator(javaModelInput); Project p = g.generateProject(); // Make a Dynamic Project from this project, because these classes do not exist on the classpath DynamicClassLoader dynamicClassLoader; if (classLoader instanceof DynamicClassLoader) { dynamicClassLoader = classLoader; } else { dynamicClassLoader = new DynamicClassLoader(classLoader); } Project dp = DynamicTypeBuilder.loadDynamicProject(p, null, dynamicClassLoader); this.xmlContext = new XMLContext(dp); this.dynamicHelper = new DynamicHelper(xmlContext.getSession(0));