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/UserGuide/MOXy/Type Level/Mapping to a Type or Element/Default Root Element"

m (Replacing page with 'Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/type_level001.htm')
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{EclipseLink_UserGuide
+
Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/type_level001.htm
|eclipselink=y
+
|eclipselinktype=MOXy
+
|info=y
+
|api=y
+
|apis= * [http://www.eclipse.org/eclipselink/api/latest/javax/xml/bind/annotation/XmlRootElement.html XmlRootElement]
+
|toc=y
+
}}
+
 
+
=Default Root Element=
+
 
+
At least one of your mapped classes must have a default root element defined.  This tells EclipseLink what the top-level root of your XML document will be.  Consider the <tt>Customer</tt> and <tt>Address</tt> classes shown in this example:
+
 
+
[[Image:Defaultrootelement.png]]<br><br>
+
 
+
These classes correspond to the XML schema, shown in this example.
+
 
+
<source lang="xml">
+
<xsd:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+
  <xsd:complexType name="address-type">
+
      <xsd:sequence>
+
        <element name="street" type="xsd:string"/>
+
        <element name="city" type="xsd:string"/>
+
      </xsd:sequence>
+
  </xsd:complexType>
+
 
+
  <xsd:element name="customer" type="customer-type"/>
+
 
+
  <xsd:complexType name="customer-type">
+
      <xsd:sequence>
+
        <xsd:element name="name" type="xsd:string"/>
+
        <xsd:element name="billing-address" type="address-type"/>
+
        <xsd:element name="shipping-address" type="address-type"/>
+
      </xsd:sequence>
+
  </xsd:complexType>
+
</xsd:schema>
+
</source>
+
 
+
When an instance of the <tt>Customer</tt> class is persisted to XML, the EclipseLink runtime performs the following:
+
<ol>
+
<li> Gets the default root element.The <tt>Customer</tt> class instance corresponds to the root of the XML document. The EclipseLink runtime uses the default root element specified on the descriptor (<tt>customer</tt>) to start the XML document. EclipseLink then uses the mappings on the descriptor to marshal the object's attributes:
+
<div class="pre">
+
<customer>
+
    <name>…</name>
+
</customer>
+
</div>
+
</li>
+
<li> When the EclipseLink runtime encounters an object attribute such as <tt>billingAddress</tt>, it checks the mapping associated with it to determine with what element (<tt>billing-address</tt>) to continue:
+
<div class="pre">
+
<customer>
+
    <name>…</name>
+
    <billing-address/>
+
</customer>
+
</div>
+
<br>
+
The EclipseLink runtime checks the mapping's reference descriptor (<tt>Address</tt>) to determine what attributes to persist:
+
<div class="pre">
+
<customer>
+
    <name>…</name>
+
    <billing-address>
+
        <street>…</street>
+
        <city>…</city>
+
+
    </billing-address>
+
</customer>
+
</div>
+
</li>
+
</ol>
+
 
+
{{EclipseLink_Note
+
|note=The undefined document root element of a referenced object is ignored during marshalling with an any collection mapping and object mapping.
+
}}
+
 
+
 
+
 
+
{{EclipseLink_MOXy
+
|previous=[[EclipseLink/UserGuide/MOXy/Type Level/Mapping to a Type or Element|Mapping to a Type or Element]]
+
|next=[[EclipseLink/UserGuide/MOXy/Type Level/Setting Up Namespace Information|Setting Up Namespace Information]]
+
|up=[[EclipseLink/UserGuide/MOXy/Mapping to a Type or Element|Mapping to a Type or Element]]
+
|version=2.2.0
+
}}
+

Latest revision as of 09:49, 8 November 2012

Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/type_level001.htm

Back to the top