blob: e8b9cc0d12b1c6ce154799b94872c393b7848084 [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>Element collection mapping</title>
<meta name="copyright" content="Copyright (c) 2000, 2009 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Oracle - initial API and implementation" />
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 1.0.11" />
<meta name="date" content="2013-01-03T9:24:51Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Element collection mapping" />
<meta name="relnum" content="Release 3.3" />
<meta name="partnum" content="Release 3.3" />
<link rel="copyright" href="dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="stylesheet" href="dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" />
</head>
<body>
<p class="betadraftsubtitle">Beta Draft: 2013-01-03</p>
<p><a id="CIHHJEBJ" name="CIHHJEBJ"></a></p>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h1>Element collection mapping<a id="sthref209" name="sthref209"></a><a id="sthref210" name="sthref210"></a><a id="sthref211" name="sthref211"></a></h1>
<p>Use an <span class="bold">Element Collection</span> to define a collection of <span class="bold">Basic</span> objects. The Basic values are stored in a separate collection table. Because the target is a Basic value (instead of an Entity), you can easily define collections of simple values without having to define a class for the value.</p>
<p>To create an element collection mapping:</p>
<ol>
<li>
<p>In the <a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a>, right-click the field to map. Select <span class="bold">Map As &gt; Element Collection</span>. The <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a> displays the properties for the selected field.</p>
<div class="figure"><a id="sthref212" name="sthref212"></a>
<p class="titleinfigure">JPA Details, Element collection mapping</p>
<img src="img/jpa_details_elementcollection.png" alt="PA Details, Element collection mapping" title="PA Details, Element collection mapping" /><br /></div>
<!-- class="figure" --></li>
<li>
<p>Complete each field in the <a href="reference034.htm#CACBCGDI">Element Collection Mapping</a> area.</p>
</li>
<li>
<p>Complete the remaining areas in the <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a>.</p>
</li>
</ol>
<p>Eclipse adds the following annotations to the field:</p>
<pre xml:space="preserve" class="oac_no_warn">
@ElementCollection
@CollectionTable(
name="<span class="italic">&lt;TABLE_NAME&gt;</span>",
joinColumns=@JoinColumn(name="<span class="italic">&lt;COLUMN_TABLE&gt;</span>")
)
@Column(name="<span class="italic">&lt;COLUMN_TABLE&gt;</span>")
</pre>
<a id="sthref213" name="sthref213"></a>
<p class="subhead2">Related tasks</p>
<ul>
<li>
<p><a href="task_mapping.htm#BABDGBIJ">Mapping an entity</a></p>
</li>
</ul>
<a id="sthref214" name="sthref214"></a>
<p class="subhead2">Related references</p>
<ul>
<li>
<p><a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a></p>
</li>
<li>
<p><a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a></p>
</li>
<li>
<p><a href="tasks011.htm#BABBABCE">Basic mapping</a></p>
</li>
<li>
<p><a href="reference053.htm#CIADGCID">Converters</a></p>
</li>
<li>
<p><a href="reference046.htm#CACBIJFD">Ordering</a></p>
</li>
<li>
<p><a href="reference044.htm#CACJBFEA">Value</a></p>
</li>
</ul>
<a id="sthref215" name="sthref215"></a>
<p class="subhead2">Related concepts</p>
<ul>
<li>
<p><a href="concept_mapping.htm#BABBDJFI">Understanding OR mappings</a></p>
</li>
<li>
<p><a href="concepts001.htm#BABBGFJG">Understanding Java Persistence API</a></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<!-- Start Footer -->
<div class="footer">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="86%" />
<col width="*" />
<tr>
<td align="left"><span class="copyrightlogo">Copyright&nbsp;&copy;&nbsp;2011, 2013,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span><br />
<a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td>
</tr>
</table>
</div>
<!-- class="footer" -->
</body>
</html>