blob: 9c47eb88056466365deb33e23e02d35afa037b11 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>Mapping Privately Owned One-to-Many Relationships | EclipseLink 2.7 EclipseLink MOXy</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" />
<meta name="date" content="2014-06-10T10:25:32Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Mapping Privately Owned One-to-Many Relationships" />
<meta name="relnum" content="Release 2.7" />
<meta name="partnum" content="" />
<link rel="stylesheet" type="text/css" href="../../dcommon/style.css" media="screen" />
<link rel="copyright" href="../../dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
<link rel="prev" href="privately_owned_relations001.htm" title="Previous" type="text/html" />
<link rel="next" href="shared_reference_relations.htm" title="Next" type="text/html" />
<!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head>
<body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:1hjujor5_fg', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div>
<div class="header"><a id="top" name="top"></a>
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" valign="top"><div class="booktitle">Developing JAXB Applications Using EclipseLink MOXy,
<b>Release 2.7</b><br /></font></td>
<td valign="bottom" align="right" width="144">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<hr />
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<tr>
<td align="center"><a href="privately_owned_relations001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="shared_reference_relations.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
<td>&nbsp;</td>
</tr>
</table>
</div>
<!-- class="header" -->
<div class="ind"><!-- End Header --><a id="BABGFHAG" name="BABGFHAG"></a><a id="TLJAX335" name="TLJAX335"></a>
<div class="sect1"><!-- infolevel="all" infotype="General" -->
<h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Mapping Privately Owned One-to-Many Relationships</font></h1>
<p>This section illustrates how to map one-to-many relationships with EclipseLink.</p>
<p>The schema in <a href="#BABJAAGI">Example 6-8</a> a typical one-to-many (1:M) relationship between Customer and PhoneNumber, as shown in <a href="#BABGDJID">Figure 6-2</a>.</p>
<div class="example"><a id="BABJAAGI" name="BABJAAGI"></a><a id="TLJAX336" name="TLJAX336"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 6-8 Sample XML Mapping</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"&gt;
&lt;xsd:element name="customer" type="customer-type"/&gt;
&lt;xsd:complexType name="customer-type"&gt;
&lt;xsd:sequence&gt;
&lt;xsd:element name="first-name" type="xsd:string"/&gt;
&lt;xsd:element name="last-name" type="xsd:string"/&gt;
&lt;xsd:element name="phone-number" type="phone-type" minOccurs="0" maxOccurs="unbounded"/&gt;
&lt;/xsd:sequence&gt;
&lt;/xsd:complexType&gt;
&lt;xsd:complexType name="phone-type"&gt;
&lt;xsd:sequence&gt;
&lt;xsd:attribute name="type" type="xsd:string"/&gt;
&lt;xsd:element name="number" type="xsd:int"/&gt;
&lt;/xsd:sequence&gt;
&lt;/xsd:complexType&gt;
&lt;/xsd:schema&gt;
</pre></div>
<!-- class="example" -->
<div class="figure"><a id="BABGDJID" name="BABGDJID"></a><a id="TLJAX337" name="TLJAX337"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Figure 6-2 One-to-many Relationship</font></em></strong></p>
<img src="img/ccxm.gif" alt="Description of Figure 6-2 follows" title="Description of Figure 6-2 follows" longdesc="img_text/ccxm.htm" /><br />
<a id="sthref124" name="sthref124" href="img_text/ccxm.htm">Description of "Figure 6-2 One-to-many Relationship"</a><br />
<br /></div>
<!-- class="figure" -->
<a id="TLJAX338" name="TLJAX338"></a>
<div class="sect2"><a id="sthref125" name="sthref125"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping to Elements</font></h2>
<p><a href="#BABECFHA">Example 6-9</a> shows how to annotate your Java class to obtain this mapping with EclipseLink. The standard JAXB <code>@XmlElement</code> annotation, when used on a Collection or array field, can achieve this.</p>
<div class="example"><a id="BABECFHA" name="BABECFHA"></a><a id="TLJAX339" name="TLJAX339"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 6-9 Using the @XmlElement Annotation</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
@XmlElement(name="first-name")
private String firstName;
@XmlElement(name="last-name")
private String lastName;
<strong>@XmlElement</strong>(name="phone-number")
private List&lt;PhoneNumber&gt; phoneNumbers;
...
}
package example;
import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.*;
@XmlAccessorType(XmlAccessType.FIELD)
public class PhoneNumber {
@XmlAttribute
private String type;
private Integer number;
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#BABGEFHC">Example 6-10</a> shows how to define your mapping information in EclipseLink's OXM metadata format.</p>
<div class="example"><a id="BABGEFHC" name="BABGEFHC"></a><a id="TLJAX340" name="TLJAX340"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 6-10 Sample XML Mapping</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
...
&lt;java-type name="Customer"&gt;
&lt;xml-root-element name="customer"/&gt;
&lt;java-attributes&gt;
&lt;xml-element java-attribute="firstName" name="first-name" type="java.lang.String"/&gt;
&lt;xml-element java-attribute="lastName" name="last-name" type="java.lang.String"/&gt;
&lt;xml-element java-attribute="phoneNumbers" name="phone-number" type="PhoneNumber" container-type="java.util.ArrayList"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
&lt;java-type name="PhoneNumber"&gt;
&lt;java-attributes&gt;
&lt;xml-attribute java-attribute="type" type="java.lang.String"/&gt;
&lt;xml-value java-attribute="number" type="java.lang.Integer"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="TLJAX341" name="TLJAX341"></a>
<div class="sect2"><a id="sthref126" name="sthref126"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Grouping Elements using the @XmlElementWrapper Annotation</font></h2>
<p>To make the elements of the Collection appear inside a grouping element, you can use <code>@XmlElementWrapper</code>:</p>
<div class="example"><a id="TLJAX342" name="TLJAX342"></a><a id="sthref127" name="sthref127"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 6-11 Using the @XmlElementWrapper Annotation</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
@XmlElement(name = "phone-number")
<strong>@XmlElementWrapper</strong>(name="phone-numbers")
private List&lt;PhoneNumber&gt; phoneNumbers;
...
}
</pre></div>
<!-- class="example" -->
<p>This will produce the following XML:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;customer&gt;
&lt;first-name&gt;Bob&lt;/first-name&gt;
&lt;last-name&gt;Smith&lt;/last-name&gt;
&lt;phone-numbers&gt;
&lt;phone-number type="Home"&gt;
&lt;number&gt;5559827222&lt;/number&gt;
&lt;/phone-number&gt;
&lt;phone-number type="Work"&gt;
&lt;number&gt;5558872216&lt;/number&gt;
&lt;/phone-number&gt;
&lt;/phone-numbers&gt;
&lt;/customer&gt;
</pre></div>
<!-- class="sect2" --></div>
<!-- class="sect1" --></div>
<!-- class="ind" -->
<!-- Start Footer -->
<div class="footer">
<hr />
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="33%" />
<col width="*" />
<col width="33%" />
<tr>
<td valign="bottom">
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<col width="*" />
<col width="48%" />
<col width="48%" />
<tr>
<td>&nbsp;</td>
<td align="center"><a href="privately_owned_relations001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="shared_reference_relations.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
</tr>
</table>
</td>
<td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br />
<td valign="bottom" align="right">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!-- class="footer" -->
<div id="copyright">Copyright &copy; 2013 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body>
</html>