| <!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>@MapKeyConvert | EclipseLink 2.5.x Java Persistence API (JPA) Extensions Reference</title> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.17" /> |
| <meta name="date" content="2013-10-03T12:33:24Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="@MapKeyConvert" /> |
| <meta name="relnum" content="Release 2.5" /> |
| <link rel="stylesheet" type="text/css" href="../../../dcommon/style.css" media="screen" /> |
| <link rel="copyright" href="http://www.eclipse.org/org/documents/epl-v10.php" 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="a_joinfields.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="a_multitenant.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:4sqnhke2any', 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">Java Persistence API (JPA) Extensions Reference for EclipseLink, |
| <b>Release 2.5</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> </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 /> |
| <span class="mini">Contents</span></a></td><td> </td><td align="center"><a href="../../../" target="_top" class="external text" title="Other searches" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini">Other Searches</span></a></td><td> </td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"><br /><span class="mini">PDF</span></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a> |
| </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="a_joinfields.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_multitenant.htm"><img src="../../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| <td> </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="header" --> |
| <div class="ind"><!-- End Header --><a id="BEHBBCDB" name="BEHBBCDB"></a><a id="TLJPA435" name="TLJPA435"></a> |
| <hr /> |
| <div class="refsect1"> |
| <h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">@MapKeyConvert</font></h2> |
| <p>Use <code>@MapKeyConvert</code> to specify a named converter to be used with the corresponding mapped attribute key column.</p> |
| <a id="sthref181" name="sthref181"></a> |
| <p><strong><br /><span class="refsubsect">Annotation Elements</span></strong></p> |
| <p><a href="#BEHBBBEH">Table 2-31</a> describes this annotation's elements.</p> |
| <div class="tblhruleformalwide"><a id="TLJPA436" name="TLJPA436"></a><a id="sthref182" name="sthref182"></a><a id="BEHBBBEH" name="BEHBBBEH"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Table 2-31 @MapKeyConvert Annotation Elements</font></em></strong></p> |
| <table class="HRuleFormalWide" title="@MapKeyConvert Annotation Elements" summary="This table describes this annotation’s elements." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0"> |
| <col width="23%" /> |
| <col width="*" /> |
| <col width="20%" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t40"><font face="Arial, Helvetica, sans-serif"><strong>Annotation Element</strong></font></th> |
| <th align="left" valign="bottom" id="r1c2-t40"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th> |
| <th align="left" valign="bottom" id="r1c3-t40"><font face="Arial, Helvetica, sans-serif"><strong>Default</strong></font></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t40" headers="r1c1-t40"> |
| <p><code>value</code></p> |
| </td> |
| <td align="left" headers="r2c1-t40 r1c2-t40"> |
| <p>(Optional) Name of the converter to use:</p> |
| <ul> |
| <li> |
| <p><code>serialized</code></p> |
| </li> |
| <li> |
| <p><code>class-instance</code></p> |
| </li> |
| <li> |
| <p><code>none</code></p> |
| </li> |
| <li> |
| <p>custom converter</p> |
| </li> |
| </ul> |
| </td> |
| <td align="left" headers="r2c1-t40 r1c3-t40"> |
| <p>none</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="tblhruleformalwide" --> |
| <a id="sthref183" name="sthref183"></a> |
| <p><strong><br /><span class="refsubsect">Usage</span></strong></p> |
| <p>Use <code>@MapKeyConvert</code> to convert the key value used in a <code>@MapKeyColumn</code> to have a different type or value than the database column.</p> |
| <p>The <code>@MapKeyConvert</code> annotation has the following reserved names:</p> |
| <ul> |
| <li> |
| <p><code>serialized</code>: Will use a <code>SerializedObjectConverter</code> on the associated mapping. When using a <code>SerializedObjectConverter</code> the database representation is a binary field holding a serialized version of the object and the object-model representation is a the actual object</p> |
| </li> |
| <li> |
| <p><code>class-instance</code>: Will use an ClassInstanceConverter on the associated mapping. When using a ClassInstanceConverter the database representation is a String representing the Class name and the object-model representation is an instance of that class built with a no-args constructor</p> |
| </li> |
| <li> |
| <p><code>none</code> - Will place no converter on the associated mapping. This can be used to override a situation where either another converter is defaulted or another converter is set.</p> |
| </li> |
| </ul> |
| <p>If you do not use one of these reserved names, you must define a custom converter, using the <code>@Converter</code> annotation.</p> |
| <a id="sthref184" name="sthref184"></a> |
| <p><strong><br /><span class="refsubsect">Examples</span></strong></p> |
| <p><a href="#BEHEHJJC">Example 2-56</a> shows using a <code>@MapKeyConvert</code> annotation to apply a converter to a map's key.</p> |
| <div class="example"><a id="BEHEHJJC" name="BEHEHJJC"></a><a id="TLJPA437" name="TLJPA437"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-56 Using @MapKeyConvert Annotation</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @Entity |
| public class Entity |
| … |
| @ElementCollection |
| @MapKeyColumn(name=”BANK”) |
| @Column(name=”ACCOUNT”) |
| @Convert(“Long2String”) |
| <strong>@MapKeyConvert</strong>(“CreditLine”) |
| public Map<String,Long> getCreditLines() { |
| return creditLines; |
| } |
| </pre></div> |
| <!-- class="example" --> |
| <p><a href="#BEHCFGDH">Example 2-57</a> shows how to use the <code><map-key-convert></code> element in the <code>eclipselink-orm.xml</code> file.</p> |
| <div class="example"><a id="BEHCFGDH" name="BEHCFGDH"></a><a id="TLJPA438" name="TLJPA438"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-57 Using <map-key-convert> XML</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <element-collection name="creditLines"> |
| <strong><map-key-convert></strong>CreditLine</map-key-convert> |
| <map-key-column name="BANK"/> |
| <column name="ACCOUNT"/> |
| <convert>Long2String</convert> |
| <object-type-converter name="CreditLine"> |
| <conversion-value data-value="RBC" object-value="RoyalBank"/> |
| <conversion-value data-value="CIBC" object-value="CanadianImperial"/> |
| <conversion-value data-value="SB" object-value="Scotiabank"/> |
| <conversion-value data-value="TD" object-value="TorontoDominion"/> |
| </object-type-converter> |
| <type-converter name="Long2String" data-type="String" object-type="Long"/> |
| <collection-table name="EMP_CREDITLINES"> |
| <join-column name="EMP_ID"/> |
| </collection-table> |
| </element-collection> |
| </pre></div> |
| <!-- class="example" --> |
| <a id="sthref185" name="sthref185"></a> |
| <p><strong><br /><span class="refsubsect">See Also</span></strong></p> |
| <p>For more information, see:</p> |
| <ul> |
| <li> |
| <p><a href="a_converter.htm#CHDEHJEB">"@Converter"</a></p> |
| </li> |
| <li> |
| <p><a href="a_convert.htm#BEHGJHCD">"@Convert"</a></p> |
| </li> |
| </ul> |
| </div> |
| <!-- class="refsect1" --></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> </td> |
| <td align="center"><a href="a_joinfields.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_multitenant.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> |
| |
| <td valign="bottom" align="right"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225"> |
| <tr> |
| <td> </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 /> |
| <span class="mini">Contents</span></a></td><td> </td><td align="center"><a href="../../../" target="_top" class="external text" title="Other searches" rel="nofollow"><img src="../../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini">Other Searches</span></a></td><td> </td><td align="center"><a href="../../eclipselink_jpa_extensions.pdf" title="PDF" target="_blank"><img src="../../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"><br /><span class="mini">PDF</span></a></td><td align="center"><a href="#disqus_thread" title="Comments""><img src="../../../dcommon/images/comments.png" style="padding-right:5px;border:0" alt="Comments"><br /><span class="mini">Comments</span></a> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| <div id="copyright">Copyright © 2012 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 --><!-- START: Disqus --><div id="disqus_thread"></div> <script type="text/javascript"> var disqus_developer = 1;var disqus_shortname = 'eclipselinkdoc'; (function() { var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js'; (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); </script> <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript> <a href="http://disqus.com" class="dsq-brlink">Comments powered by <span class="logo-disqus">Disqus</span></a><!-- END: Disqus --></body> |
| </html> |
