| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:00 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DelegatingQueryCache (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DelegatingQueryCache (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingQueryCache.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/datacache/DelegatingDataCache.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/ExpirationEvent.html" title="class in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/DelegatingQueryCache.html" target="_top">Frames</a></li> |
| <li><a href="DelegatingQueryCache.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.datacache</div> |
| <h2 title="Class DelegatingQueryCache" class="title">Class DelegatingQueryCache</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.datacache.DelegatingQueryCache</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a>, <a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">DelegatingQueryCache</span> |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></pre> |
| <div class="block">Delegating query cache that can also perform exception translation for |
| use in facades. This cache allows its delegate to be null, in which case |
| it returns default values or all methods.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.4.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#DelegatingQueryCache(org.apache.openjpa.datacache.QueryCache)">DelegatingQueryCache</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> cache)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#DelegatingQueryCache(org.apache.openjpa.datacache.QueryCache,%20org.apache.openjpa.util.RuntimeExceptionTranslator)">DelegatingQueryCache</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> cache, |
| <a href="../../../../org/apache/openjpa/util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#addTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">addTypesChangedListener</a></strong>(<a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a> listen)</code> |
| <div class="block">Add a new types event listener to this cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#clear()">clear</a></strong>()</code> |
| <div class="block">Remove all data from this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#close()">close</a></strong>()</code> |
| <div class="block">Free the resources used by this cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#get(org.apache.openjpa.datacache.QueryKey)">get</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</code> |
| <div class="block">Return a list of oids for the given query key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#getDelegate()">getDelegate</a></strong>()</code> |
| <div class="block">Return the direct delegate.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#getInnermostDelegate()">getInnermostDelegate</a></strong>()</code> |
| <div class="block">Return the native delegate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/QueryStatistics.html" title="interface in org.apache.openjpa.kernel">QueryStatistics</a><<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#getStatistics()">getStatistics</a></strong>()</code> |
| <div class="block">Gets the simple statistics for query results.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#hashCode()">hashCode</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></strong>(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a> mgr)</code> |
| <div class="block">Initialize any resources associated with the given |
| <a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><code>DataCacheManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)">onTypesChanged</a></strong>(<a href="../../../../org/apache/openjpa/datacache/TypesChangedEvent.html" title="class in org.apache.openjpa.datacache">TypesChangedEvent</a> e)</code> |
| <div class="block">Notification that instances of persistent types have changed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#pin(org.apache.openjpa.datacache.QueryKey)">pin</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</code> |
| <div class="block">Pin the value stored under <code>qk</code> into the |
| cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#put(org.apache.openjpa.datacache.QueryKey,%20org.apache.openjpa.datacache.QueryResult)">put</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk, |
| <a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a> oids)</code> |
| <div class="block">Set the list of OIDs for the given query key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#remove(org.apache.openjpa.datacache.QueryKey)">remove</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</code> |
| <div class="block">Remove the value stored under the given query key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#removeTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">removeTypesChangedListener</a></strong>(<a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a> listen)</code> |
| <div class="block">Remove an types event listener from this cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#translate(java.lang.RuntimeException)">translate</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> re)</code> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#unpin(org.apache.openjpa.datacache.QueryKey)">unpin</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</code> |
| <div class="block">Unpin the value stored under <code>key</code> into the cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#writeLock()">writeLock</a></strong>()</code> |
| <div class="block">Obtain a write lock on the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html#writeUnlock()">writeUnlock</a></strong>()</code> |
| <div class="block">Release the write lock on the cache.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DelegatingQueryCache(org.apache.openjpa.datacache.QueryCache)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DelegatingQueryCache</h4> |
| <pre>public DelegatingQueryCache(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> cache)</pre> |
| <div class="block">Constructor. Supply delegate.</div> |
| </li> |
| </ul> |
| <a name="DelegatingQueryCache(org.apache.openjpa.datacache.QueryCache, org.apache.openjpa.util.RuntimeExceptionTranslator)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DelegatingQueryCache</h4> |
| <pre>public DelegatingQueryCache(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> cache, |
| <a href="../../../../org/apache/openjpa/util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDelegate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegate</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> getDelegate()</pre> |
| <div class="block">Return the direct delegate.</div> |
| </li> |
| </ul> |
| <a name="getInnermostDelegate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInnermostDelegate</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a> getInnermostDelegate()</pre> |
| <div class="block">Return the native delegate.</div> |
| </li> |
| </ul> |
| <a name="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="translate(java.lang.RuntimeException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translate</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> translate(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> re)</pre> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </li> |
| </ul> |
| <a name="initialize(org.apache.openjpa.datacache.DataCacheManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a> mgr)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">QueryCache</a></code></strong></div> |
| <div class="block">Initialize any resources associated with the given |
| <a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><code>DataCacheManager</code></a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTypesChanged</h4> |
| <pre>public void onTypesChanged(<a href="../../../../org/apache/openjpa/datacache/TypesChangedEvent.html" title="class in org.apache.openjpa.datacache">TypesChangedEvent</a> e)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html#onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)">TypesChangedListener</a></code></strong></div> |
| <div class="block">Notification that instances of persistent types have changed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html#onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)">onTypesChanged</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get(org.apache.openjpa.datacache.QueryKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a> get(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#get(org.apache.openjpa.datacache.QueryKey)">QueryCache</a></code></strong></div> |
| <div class="block">Return a list of oids for the given query key. This is an |
| unmodifiable list.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#get(org.apache.openjpa.datacache.QueryKey)">get</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The query results matching the given key, or null if none</dd></dl> |
| </li> |
| </ul> |
| <a name="put(org.apache.openjpa.datacache.QueryKey, org.apache.openjpa.datacache.QueryResult)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a> put(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk, |
| <a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a> oids)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#put(org.apache.openjpa.datacache.QueryKey,%20org.apache.openjpa.datacache.QueryResult)">QueryCache</a></code></strong></div> |
| <div class="block">Set the list of OIDs for the given query key. A reference |
| to the given list will be stored in the query cache, so the |
| list should not be modified after invoking this method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#put(org.apache.openjpa.datacache.QueryKey,%20org.apache.openjpa.datacache.QueryResult)">put</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The previously cached value, or <code>null</code> if |
| the key was not previously cached. See <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true#put(K,%20V)" title="class or interface in java.util"><code>Map.put(K, V)</code></a> |
| for more information.</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(org.apache.openjpa.datacache.QueryKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a> remove(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#remove(org.apache.openjpa.datacache.QueryKey)">QueryCache</a></code></strong></div> |
| <div class="block">Remove the value stored under the given query key. |
| This method is typically not invoked directly from outside |
| the <code>QueryCache</code> class. Instead, the cache should |
| be updated by implementing <a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitListener</code></a>, |
| which will result in all queries that may be invalid being dropped.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#remove(org.apache.openjpa.datacache.QueryKey)">remove</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The previously cached value, or <code>null</code> if |
| the key was not previously cached. See <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util"><code>Map.remove(java.lang.Object)</code></a> |
| for more information.</dd></dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#clear()">QueryCache</a></code></strong></div> |
| <div class="block">Remove all data from this cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#clear()">clear</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pin(org.apache.openjpa.datacache.QueryKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pin</h4> |
| <pre>public boolean pin(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#pin(org.apache.openjpa.datacache.QueryKey)">QueryCache</a></code></strong></div> |
| <div class="block">Pin the value stored under <code>qk</code> into the |
| cache. This method guarantees that <code>qk</code>'s value |
| will not be expired if the cache exceeds its capacity. It |
| causes this data to be ignored when determining whether or not |
| the cache is full, effectively increasing the total amount of |
| data stored in the cache. This method does not affect the |
| behavior of <a href="../../../../org/apache/openjpa/datacache/QueryCache.html#remove(org.apache.openjpa.datacache.QueryKey)"><code>QueryCache.remove(org.apache.openjpa.datacache.QueryKey)</code></a> or <a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html#onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)"><code>TypesChangedListener.onTypesChanged(org.apache.openjpa.datacache.TypesChangedEvent)</code></a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#pin(org.apache.openjpa.datacache.QueryKey)">pin</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>key</code>'s value was |
| pinned into the cache; <code>false</code> if the key is not in the cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="unpin(org.apache.openjpa.datacache.QueryKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpin</h4> |
| <pre>public boolean unpin(<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a> qk)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#unpin(org.apache.openjpa.datacache.QueryKey)">QueryCache</a></code></strong></div> |
| <div class="block">Unpin the value stored under <code>key</code> into the cache. |
| This method reverses a previous invocation of <a href="../../../../org/apache/openjpa/datacache/QueryCache.html#pin(org.apache.openjpa.datacache.QueryKey)"><code>QueryCache.pin(org.apache.openjpa.datacache.QueryKey)</code></a>. |
| This method does not remove anything from the cache; it merely |
| makes <code>key</code>'s value a candidate for flushing from the cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#unpin(org.apache.openjpa.datacache.QueryKey)">unpin</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>key</code>'s value was |
| unpinned from the cache; <code>false</code> if the |
| key is not in the cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="writeLock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLock</h4> |
| <pre>public void writeLock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#writeLock()">QueryCache</a></code></strong></div> |
| <div class="block">Obtain a write lock on the cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#writeLock()">writeLock</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeUnlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeUnlock</h4> |
| <pre>public void writeUnlock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#writeUnlock()">QueryCache</a></code></strong></div> |
| <div class="block">Release the write lock on the cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#writeUnlock()">writeUnlock</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addTypesChangedListener</h4> |
| <pre>public void addTypesChangedListener(<a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a> listen)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#addTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">QueryCache</a></code></strong></div> |
| <div class="block">Add a new types event listener to this cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#addTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">addTypesChangedListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTypesChangedListener</h4> |
| <pre>public boolean removeTypesChangedListener(<a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a> listen)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#removeTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">QueryCache</a></code></strong></div> |
| <div class="block">Remove an types event listener from this cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#removeTypesChangedListener(org.apache.openjpa.datacache.TypesChangedListener)">removeTypesChangedListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#close()">QueryCache</a></code></strong></div> |
| <div class="block">Free the resources used by this cache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#close()">close</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatistics()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStatistics</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/QueryStatistics.html" title="interface in org.apache.openjpa.kernel">QueryStatistics</a><<a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a>> getStatistics()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#getStatistics()">QueryCache</a></code></strong></div> |
| <div class="block">Gets the simple statistics for query results. |
| If the statistics gathering is disabled, an empty statistics is returned.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html#getStatistics()">getStatistics</a></code> in interface <code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingQueryCache.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/datacache/DelegatingDataCache.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/ExpirationEvent.html" title="class in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/datacache/DelegatingQueryCache.html" target="_top">Frames</a></li> |
| <li><a href="DelegatingQueryCache.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
