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/Relationships/Privately Owned/One-to-One"

m (Replacing page with 'Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/privately_owned_relationships001.htm')
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{EclipseLink_UserGuide
+
Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/privately_owned_relationships001.htm
|eclipselink=y
+
|eclipselinktype=MOXy
+
|info=y
+
|toc=y
+
}}
+
 
+
=Mapping One-to-One Relationships=
+
This section demonstrates several ways to map a one-to-one relationship between objects.
+
 
+
==Mapping to a Complex Type==
+
Given the XML schema in this example, the figure below illustrates a one-to-one relationship between two complex types.
+
 
+
<source lang="xml">
+
<?xml version="1.0" encoding="UTF-8"?>
+
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+
 
+
  <xsd:element name="customer" type="customer-type"/>
+
 
+
  <xsd:complexType name="customer-type">
+
      <xsd:element name="address" type="address-type"/>
+
  </xsd:complexType>
+
 
+
  <xsd:complexType name="phone-type">
+
      <xsd:element name="area-code" type="xsd:int"/>
+
      <xsd:element name="number" type="xsd:int"/>
+
      <xsd:element name="extension" type="xsd:int"/>
+
  </xsd:complexType>
+
 
+
</xsd:schema>
+
</source>
+
 
+
[[Image:onetoone.png]]<br><br>
+
 
+
The following example shows how to annotate your Java class to obtain this mapping with EclipseLink. All that is needed is the standard JAXB <tt>@XmlElement</tt> annotation.
+
 
+
<source lang="java">
+
@XmlRootElement
+
@XmlAccessorType(XmlAccessType.FIELD)
+
public class Customer {
+
  @XmlElement(name="phone-number")
+
  private PhoneNumber phoneNumber;
+
 
+
  ...
+
}
+
 
+
@XmlAccessorType(XmlAccessType.FIELD)
+
public class PhoneNumber {
+
  @XmlElement(name="area-code")
+
  private Integer areaCode;
+
 
+
  private Integer number;
+
 
+
  private Integer extension;
+
 
+
  ...
+
}
+
</source>
+
 
+
The example below shows how to to define your mapping information in EclipseLink's OXM metadata format.
+
 
+
<source lang="xml">
+
...
+
<java-type name="Customer">
+
  <xml-root-element name="customer"/>
+
  <java-attributes>
+
      <xml-element java-attribute="phoneNumber" name="phone-number" type="PhoneNumber"/>
+
  </java-attributes>
+
</java-type>
+
 
+
<java-type name="PhoneNumber">
+
  <java-attributes>
+
      <xml-value java-attribute="areaCode" name="area-code" type="java.lang.Integer"/>
+
      <xml-value java-attribute="number" type="java.lang.Integer"/>
+
      <xml-value java-attribute="extension" type="java.lang.Integer"/>
+
  </java-attributes>
+
</java-type>
+
...
+
</source>
+
 
+
=="Self" Mappings==
+
 
+
EclipseLink allows you to configure your one-to-one mapping such that the data from the target object will appear inside the source object's XML element.  Using the example above, this means that the "<tt>PhoneNumber</tt>" information would appear directly under the "<tt>customer</tt>" element, and not wrapped in a "<tt>phone-number</tt>" element.  This is referred to as a "self" mapping, and is achieved by setting the target object's XPath to "'''.'''" (dot).  The following example demonstrates a self mapping declared in annotations.
+
 
+
<source lang="java">
+
@XmlRootElement
+
@XmlAccessorType(XmlAccessType.FIELD)
+
public class Customer {
+
  @XmlPath(".")
+
  private PhoneNumber phoneNumber;
+
 
+
  ...
+
}
+
 
+
public class PhoneNumber {
+
  ...
+
}
+
</source>
+
 
+
The example below shows a self mapping defined on EclipseLink OXM metadata format.
+
 
+
<source lang="xml">
+
...
+
<java-type name="Customer">
+
  <xml-root-element name="customer"/>
+
  <java-attributes>
+
      <xml-element java-attribute="phoneNumber" type="PhoneNumber" xml-path="."/>
+
  </java-attributes>
+
</java-type>
+
 
+
<java-type name="PhoneNumber">
+
  ...
+
</java-type>
+
...
+
</source>
+
 
+
Using a self mapping, the following XML will be produced:
+
 
+
<source lang="xml">
+
<customer>
+
  <area-code>613</area-code>
+
  <number>2883000</number>
+
  <extension>1547</extension>
+
</customer>
+
</source>
+
 
+
 
+
{{EclipseLink_MOXy
+
|version=2.2.0 DRAFT
+
|previous=[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned|Privately owned]]
+
|next=[[EclipseLink/UserGuide/MOXy/Relationships/Privately_Owned/One-to-Many|One-to-many]]
+
|up=[[EclipseLink/UserGuide/MOXy/Relationships/Privately Owned|Privately owned]]
+
}}
+

Latest revision as of 10:21, 8 November 2012

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

Back to the top