blob: c86ac6ee53a9b5a59d546d8ed23dfdb5176b9e49 [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 Collections of Simple Values | 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 Collections of Simple Values" />
<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="simple_values001.htm" title="Previous" type="text/html" />
<link rel="next" href="simple_values003.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="simple_values001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="simple_values003.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="CHDHEDHA" name="CHDHEDHA"></a><a id="TLJAX256" name="TLJAX256"></a>
<div class="sect1"><!-- infolevel="all" infotype="General" -->
<h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Mapping Collections of Simple Values</font></h1>
<p>This section demonstrates several ways to map a collection of simple Java values directly to XML text nodes.</p>
<ul>
<li>
<p><a href="#CHDEBEAH">Mapping to Text Nodes</a></p>
</li>
<li>
<p><a href="#CHDHHIBD">Mapping to Text Nodes with a Grouping Element</a></p>
</li>
<li>
<p><a href="#CHDIHAGJ">Mapping to a List Element</a></p>
</li>
<li>
<p><a href="#CHDDGGJC">Mapping a Collection of XmlAttributes or XmlValues</a></p>
</li>
</ul>
<a id="CHDEBEAH" name="CHDEBEAH"></a><a id="TLJAX257" name="TLJAX257"></a>
<div class="sect2">
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping to Text Nodes</font></h2>
<p>Given the XML schema in <a href="#CHDJIJBH">Example 4-25</a>, <a href="#CHDBIDCE">Figure 4-10</a> illustrates the mapping of a Java collection to elements in a corresponding XML document.</p>
<div class="example"><a id="CHDJIJBH" name="CHDJIJBH"></a><a id="TLJAX258" name="TLJAX258"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-25 Sample XML Schema</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="email-address" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/&gt;
&lt;/xsd:sequence&gt;
&lt;/xsd:complexType&gt;
&lt;/xsd:schema&gt;
</pre></div>
<!-- class="example" -->
<div class="figure"><a id="CHDBIDCE" name="CHDBIDCE"></a><a id="TLJAX259" name="TLJAX259"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Figure 4-10 XML Direct Collection Mapping to Text Nodes</font></em></strong></p>
<img src="img/dc.gif" alt="XML Direct Collection Mapping" title="XML Direct Collection Mapping" longdesc="img_text/dc.htm" /><br />
<a id="sthref75" name="sthref75" href="img_text/dc.htm">Description of "Figure 4-10 XML Direct Collection Mapping to Text Nodes"</a><br />
<br /></div>
<!-- class="figure" -->
<p><a href="#CHDBHGHJ">Example 4-26</a> shows how to annotate your Java class to obtain this mapping with EclipseLink. All that is needed is the standard JAXB <code>@XmlElement</code> annotation.</p>
<div class="example"><a id="CHDBHGHJ" name="CHDBHGHJ"></a><a id="TLJAX260" name="TLJAX260"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-26 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="email-address")
private List&lt;String&gt; emailAddress;
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGCGDF">Example 4-27</a> shows how to define your mapping information in EclipseLink's OXM metadata format.</p>
<div class="example"><a id="CHDGCGDF" name="CHDGCGDF"></a><a id="TLJAX261" name="TLJAX261"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-27 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="emailAddresses" name="email-address"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="CHDHHIBD" name="CHDHHIBD"></a><a id="TLJAX262" name="TLJAX262"></a>
<div class="sect2">
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping to Text Nodes with a Grouping Element</font></h2>
<p>Given the XML schema in <a href="#CHDBDBEH">Example 4-28</a>, <a href="#CHDDEJFD">Figure 4-11</a> illustrates the mapping of a Java collection to elements in a corresponding XML document, using a grouping element to organize the elements of the collection.</p>
<div class="example"><a id="CHDBDBEH" name="CHDBDBEH"></a><a id="TLJAX263" name="TLJAX263"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-28 Sample XML Schema</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="email-address" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/&gt;
&lt;/xsd:sequence&gt;
&lt;/xsd:complexType&gt;
&lt;/xsd:schema&gt;
</pre></div>
<!-- class="example" -->
<div class="figure"><a id="CHDDEJFD" name="CHDDEJFD"></a><a id="TLJAX264" name="TLJAX264"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Figure 4-11 XML Direct Collection Mapping to Text Nodes with a Grouping Element</font></em></strong></p>
<img src="img/dcge.gif" alt="XML Direct Collection Mapping" title="XML Direct Collection Mapping" longdesc="img_text/dcge.htm" /><br />
<a id="sthref76" name="sthref76" href="img_text/dcge.htm">Description of "Figure 4-11 XML Direct Collection Mapping to Text Nodes with a Grouping Element"</a><br />
<br /></div>
<!-- class="figure" -->
<p><a href="#CHDBHBIF">Example 4-29</a> shows how to annotate your Java class to obtain this mapping with EclipseLink. We specify the grouping element with the <code>@XmlElementWrapper</code> annotation.</p>
<div class="example"><a id="CHDBHBIF" name="CHDBHBIF"></a><a id="TLJAX265" name="TLJAX265"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-29 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="email-address")
<strong>@XmlElementWrapper</strong>(name="email-addresses")
private List&lt;String&gt; emailAddresses;
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#CHDFCAGG">Example 4-30</a> shows how to define your mapping information in EclipseLink's OXM metadata format.</p>
<div class="example"><a id="CHDFCAGG" name="CHDFCAGG"></a><a id="TLJAX266" name="TLJAX266"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-30 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="emailAddresses" name="email-address"&gt;
&lt;xml-element-wrapper name="email-addresses"/&gt;
&lt;/xml-element&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="CHDIHAGJ" name="CHDIHAGJ"></a><a id="TLJAX267" name="TLJAX267"></a>
<div class="sect2">
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping to a List Element</font></h2>
<p>Given the XML schema in <a href="#CHDGBCBI">Example 4-31</a>, <a href="#CHDGBHHE">Figure 4-12</a> illustrates a mapping to an <code>xsd:list</code> type in a corresponding XML document. Using this mapping, you can represent the collection of simple Java objects as a <code>String</code> of white space delimited tokens in XML. Here, the tasks list contains three entries: <strong>Design</strong>, <strong>Code</strong> and <strong>Test</strong>.</p>
<div class="example"><a id="CHDGBCBI" name="CHDGBCBI"></a><a id="TLJAX268" name="TLJAX268"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-31 Sample XML Schema</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="employee" type="employee-type"/&gt;
&lt;xsd:complexType name="employee-type"&gt;
&lt;xsd:sequence&gt;
&lt;xsd:element name="tasks" type="tasks-type"/&gt;
&lt;/xsd:sequence&gt;
&lt;/xsd:complexType&gt;
&lt;xsd:simpleType name="tasks-type"&gt;
&lt;<strong>xsd:list</strong> itemType="xsd:string"/&gt;
&lt;/xsd:simpleType&gt;
&lt;/xsd:schema&gt;
</pre></div>
<!-- class="example" -->
<div class="figure"><a id="CHDGBHHE" name="CHDGBHHE"></a><a id="TLJAX269" name="TLJAX269"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Figure 4-12 XML Direct Mapping to a List Field</font></em></strong></p>
<img src="img/dcxmstn.gif" alt="XMLDirect Mapping to a List Field" title="XMLDirect Mapping to a List Field" longdesc="img_text/dcxmstn.htm" /><br />
<a id="sthref77" name="sthref77" href="img_text/dcxmstn.htm">Description of "Figure 4-12 XML Direct Mapping to a List Field"</a><br />
<br /></div>
<!-- class="figure" -->
<p><a href="#CHDHDGFF">Example 4-32</a> shows how to annotate your Java class to obtain this mapping with EclipseLink.</p>
<div class="example"><a id="CHDHDGFF" name="CHDHDGFF"></a><a id="TLJAX270" name="TLJAX270"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-32 Using the @XmlList 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 Employee {
<strong>@XmlList</strong>
private List&lt;String&gt; tasks;
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#CHDEIEDI">Example 4-33</a> shows how to define your mapping information in EclipseLink's OXM metadata format.</p>
<div class="example"><a id="CHDEIEDI" name="CHDEIEDI"></a><a id="TLJAX271" name="TLJAX271"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-33 Sample XML Mapping</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
...
&lt;java-type name="Employee"&gt;
&lt;xml-root-element name="employee"/&gt;
&lt;java-attributes&gt;
&lt;xml-element java-attribute="tasks" xml-list="true"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="CHDDGGJC" name="CHDDGGJC"></a><a id="TLJAX272" name="TLJAX272"></a>
<div class="sect2">
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping a Collection of XmlAttributes or XmlValues</font></h2>
<p><code>@XmlList</code> can also be used in conjunction with <code>@XmlAttribute</code> or <code>@XmlValue</code>, as shown in <a href="#CHDGGBBB">Example 4-34</a>. The collection will be represented as a space-separated string in the attribute.</p>
<div class="example"><a id="CHDGGBBB" name="CHDGGBBB"></a><a id="TLJAX273" name="TLJAX273"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-34 Java Annotations</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 {
@XmlAttribute
@XmlList
private List&lt;Integer&gt; ids;
...
}
package example;
import javax.xml.bind.annotation.*;
@XmlRootElement(name="phone-numbers")
@XmlAccessorType(XmlAccessType.FIELD)
public class PhoneNumbers {
@XmlValue
@XmlList
private List&lt;String&gt; numbers;
...
}
</pre></div>
<!-- class="example" -->
<div class="example"><a id="TLJAX274" name="TLJAX274"></a><a id="sthref78" name="sthref78"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-35 EclipseLink OXM Metadata</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-attribute java-attribute="ids" xml-list="true"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
...
&lt;java-type name="PhoneNumbers"&gt;
&lt;xml-root-element name="phone-numbers"/&gt;
&lt;java-attributes&gt;
&lt;xml-value java-attribute="numbers" xml-list="true"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
...
</pre></div>
<!-- class="example" -->
<div class="example"><a id="TLJAX275" name="TLJAX275"></a><a id="sthref79" name="sthref79"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-36 Example XML Documents</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;customer ids="726 1982 1989 2991"/&gt;
&lt;phone-numbers&gt;6132883982 6139828817 18882982298&lt;/phone-numbers&gt;
</pre></div>
<!-- class="example" --></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="simple_values001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="simple_values003.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>