| <!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>@PrimaryKey | 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:25Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="@PrimaryKey" /> |
| <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_plsqlrecord.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="a_privateowned.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 /> |
| </td><td> </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> </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"></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_plsqlrecord.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_privateowned.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="BGEBBFJE" name="BGEBBFJE"></a><a id="TLJPA503" name="TLJPA503"></a> |
| <hr /> |
| <div class="refsect1"> |
| <h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">@PrimaryKey</font></h2> |
| <p>Use <code>@PrimaryKey</code> to allow advanced configuration of the ID.</p> |
| <p>A validation policy can be given that allows specifying if zero is a valid ID value. The set of primary key columns can also be specified precisely.</p> |
| <a id="sthref298" name="sthref298"></a> |
| <p><strong><br /><span class="refsubsect">Annotation Elements</span></strong></p> |
| <p><a href="#BGEBGEAB">Table 2-53</a> describes this annotation's elements.</p> |
| <div class="tblhruleformalwide"><a id="TLJPA504" name="TLJPA504"></a><a id="sthref299" name="sthref299"></a><a id="BGEBGEAB" name="BGEBGEAB"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Table 2-53 @PrimaryKey Annotation Elements</font></em></strong></p> |
| <table class="HRuleFormalWide" title="@PrimaryKey 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-t63"><font face="Arial, Helvetica, sans-serif"><strong>Annotation Element</strong></font></th> |
| <th align="left" valign="bottom" id="r1c2-t63"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th> |
| <th align="left" valign="bottom" id="r1c3-t63"><font face="Arial, Helvetica, sans-serif"><strong>Default</strong></font></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t63" headers="r1c1-t63"> |
| <p><code>cacheKeyType</code></p> |
| </td> |
| <td align="left" headers="r2c1-t63 r1c2-t63"> |
| <p>(Optional) Configures the cache key type to store the object in the cache.</p> |
| </td> |
| <td align="left" headers="r2c1-t63 r1c3-t63"> |
| <p><code>AUTO</code></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t63" headers="r1c1-t63"> |
| <p><code>columns</code></p> |
| </td> |
| <td align="left" headers="r3c1-t63 r1c2-t63"> |
| <p>(Optional) Directly specify the primary key columns. This can be used instead of <code>@Id</code> if the primary key includes a non basic field, such as a foreign key, or a inheritance discriminator, embedded, or transformation mapped field.</p> |
| </td> |
| <td align="left" headers="r3c1-t63 r1c3-t63"><br /></td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t63" headers="r1c1-t63"> |
| <p><code>validation</code></p> |
| </td> |
| <td align="left" headers="r4c1-t63 r1c2-t63"> |
| <p>(Optional) Configures what ID validation is done:</p> |
| <ul> |
| <li> |
| <p><code>NULL</code> – EclipseLink interprets zero values as zero. This permits primary keys to use a value of zero.</p> |
| </li> |
| <li> |
| <p><code>ZERO</code> (default) – EclipseLink interprets zero as null.</p> |
| </li> |
| <li> |
| <p><code>NEGATIVE</code> – EclipseLink interprets negative values as null.</p> |
| </li> |
| <li> |
| <p><code>NONE</code> – EclipseLink does not validate the ID value.</p> |
| </li> |
| </ul> |
| <p>By default <code>0</code> is not a valid ID value, this can be used to allow 0 ID values.</p> |
| </td> |
| <td align="left" headers="r4c1-t63 r1c3-t63"> |
| <p><code>ZERO</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="tblhruleformalwide" --> |
| <a id="sthref300" name="sthref300"></a> |
| <p><strong><br /><span class="refsubsect">Usage</span></strong></p> |
| <p>By default, EclipseLink interprets zero as <code>null</code> for primitive types that cannot be null (such as <code>int</code> and <code>long</code>), causing zero to be an invalid value for primary keys. You can modify this setting by using the <code>@PrimaryKey</code> annotation to configure an <code>IdValidation</code> for an entity class. Use the <code>eclipselink.<a href="p_id_validation.htm#CACEEGCC">id-validation</a></code> property to configure an <code>IdValidation</code> for the entire persistence unit.</p> |
| <p>Setting the <code>validation</code> element also affects how EclipseLink generates IDs: new IDs are generated only for IDs that are not valid (<code>null</code> or <code>0</code>, by default); setting to <code>NONE</code> disables ID generation.</p> |
| <a id="sthref301" name="sthref301"></a> |
| <p><strong><br /><span class="refsubsect">Examples</span></strong></p> |
| <p><a href="#BGEJFGAG">Example 2-91</a> shows how to use this annotation.</p> |
| <div class="example"><a id="BGEJFGAG" name="BGEJFGAG"></a><a id="TLJPA505" name="TLJPA505"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-91 Using @PrimaryKey Annotation</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <strong>@PrimaryKey(validation=IdValidation.ZERO)</strong> |
| public class Employee implements Serializable, Cloneable { |
| ... |
| } |
| </pre></div> |
| <!-- class="example" --> |
| <p><a href="#BGEGDFHI">Example 2-92</a> shows how to use the <code><primary-key></code> element in your <code>eclipselink-orm.xml</code> file.</p> |
| <div class="example"><a id="BGEGDFHI" name="BGEGDFHI"></a><a id="TLJPA506" name="TLJPA506"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-92 Using @<primary-key> XML</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <entity name="Employee" class="foo.Employee" access="PROPERTY"> |
| <strong><primary-key validation="ZERO"/</strong>> |
| ... |
| </entity> |
| </pre></div> |
| <!-- class="example" --> |
| <a id="sthref302" name="sthref302"></a> |
| <p><strong><br /><span class="refsubsect">See Also</span></strong></p> |
| <p>For more information, see:</p> |
| <ul> |
| <li> |
| <p>"@Id"<br /> |
| <code><a href="http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Entities/Ids/Id">http://wiki.eclipse.org/EclipseLink/UserGuide/JPA/Basic_JPA_Development/Entities/Ids/Id</a></code></p> |
| </li> |
| <li> |
| <p><a href="p_id_validation.htm#CACEEGCC">"id-validation"</a></p> |
| </li> |
| <li> |
| <p><a href="annotations_ref.htm#CACGCEIJ">"Entity Annotations"</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_plsqlrecord.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_privateowned.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 /> |
| </td><td> </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> </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"></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 --></body> |
| </html> |
