| <!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>@ExistenceChecking | EclipseLink 2.4.x Java Persistence API (JPA) Extensions Reference</title> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.11" /> |
| <meta name="date" content="2013-07-12T8:36:29Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="@ExistenceChecking" /> |
| <meta name="relnum" content="Release 2.4" /> |
| <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_excludedefaultmappings.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="a_fetchattribute.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, |
| Release 2.4</div></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_excludedefaultmappings.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_fetchattribute.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="BABICJEJ" name="BABICJEJ"></a><a id="TLJPA401" name="TLJPA401"></a> |
| <hr /> |
| <div class="refsect1"> |
| <h2 class="refsect1"><font face="arial, helvetica, sans-serif" color="#330099">@ExistenceChecking</font></h2> |
| <p>Use <code>@ExistenceChecking</code> to specify how EclipseLink should check to determine if an entity is new or exists.</p> |
| <p>On <code>merge()</code> operations, use <code>@ExistenceChecking</code> to specify if EclipseLink uses only the cache to determine if an object exists, or if the object should be read (from the database or cache). By default the object will be read from the database.</p> |
| <a id="sthref118" name="sthref118"></a> |
| <p><strong><br /><span class="refsubsect">Annotation Elements</span></strong></p> |
| <p><a href="#CEGHFAIB">Table 2-20</a> describes this annotation's elements.</p> |
| <div class="tblhruleformalwide"><a id="TLJPA402" name="TLJPA402"></a><a id="sthref119" name="sthref119"></a><a id="CEGHFAIB" name="CEGHFAIB"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Table 2-20 @ExistenceChecking Annotation Elements</font></em></strong></p> |
| <table class="HRuleFormalWide" title="@ExistenceChecking 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="25%" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t28"><font face="Arial, Helvetica, sans-serif"><strong>Annotation Element</strong></font></th> |
| <th align="left" valign="bottom" id="r1c2-t28"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th> |
| <th align="left" valign="bottom" id="r1c3-t28"><font face="Arial, Helvetica, sans-serif"><strong>Default</strong></font></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t28" headers="r1c1-t28"> |
| <p><code>ExistenceType</code></p> |
| </td> |
| <td align="left" headers="r2c1-t28 r1c2-t28"> |
| <p>(Optional) Set the existence checking type:</p> |
| <ul> |
| <li> |
| <p><code>ASSUME_EXISTENCE</code></p> |
| </li> |
| <li> |
| <p><code>ASSUME_NON_EXISTENCE</code></p> |
| </li> |
| <li> |
| <p><code>CHECK_CHACHE</code></p> |
| </li> |
| <li> |
| <p><code>CHECK_DATABASE</code></p> |
| </li> |
| </ul> |
| </td> |
| <td align="left" headers="r2c1-t28 r1c3-t28"> |
| <p><code>CHECK_CACHE</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="tblhruleformalwide" --> |
| <a id="sthref120" name="sthref120"></a> |
| <p><strong><br /><span class="refsubsect">Usage</span></strong></p> |
| <p>You can specify <code>@ExistenceChecking</code> on an Entity or MappedSuperclass.</p> |
| <p>EclipseLink supports the following existence checking types:</p> |
| <ul> |
| <li> |
| <p><code>ASSUME_EXISTENCE</code> – If the object's primary key does not include <code>null</code> then it must exist. You may use this option if the application guarantees or does not care about the existence check.</p> |
| </li> |
| <li> |
| <p><code>ASSUME_NON_EXISTENCE</code> – Assume that the object does not exist. You may use this option if the application guarantees or does not care about the existence check. This will always force an <code>INSERT</code> operation.</p> |
| </li> |
| <li> |
| <p><code>CHECK_CHACHE</code> – If the object's primary key does not include <code>null</code> and it is in the cache, then it must exist.</p> |
| </li> |
| <li> |
| <p><code>CHECK_DATABASE</code> – Perform a <code>SELECT</code> on the database.</p> |
| </li> |
| </ul> |
| <a id="sthref121" name="sthref121"></a> |
| <p><strong><br /><span class="refsubsect">Examples</span></strong></p> |
| <p><a href="#CEGDGCHF">Example 2-41</a> shows how to use this annotation.</p> |
| <div class="example"><a id="CEGDGCHF" name="CEGDGCHF"></a><a id="TLJPA54003" name="TLJPA54003"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-41 Using @ExistenceChecking Annotation</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @Entity |
| @Cache(type=CacheType.HARD_WEAK, expiryTimeOfDay=@TimeOfDay(hour=1)) |
| <strong>@ExistenceChecking(ExistenceType.CHECK_DATABASE)</strong> |
| public class Employee implements Serializable { |
| ... |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <a id="sthref122" name="sthref122"></a> |
| <p><strong><br /><span class="refsubsect">See Also</span></strong></p> |
| <p>For more information, see:</p> |
| <ul> |
| <li> |
| <p><a href="a_cache.htm#CHDBBIHE">"@Cache"</a></p> |
| </li> |
| <li> |
| <p>"Enhancing Performance" in <em>Solutions Guide for EclispeLink</em></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_excludedefaultmappings.htm"><img src="../../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="a_fetchattribute.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, 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 --><!-- 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> |