| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:39 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DataCache (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <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="DataCache (OpenJPA Parent POM 2.4.1 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/DataCache.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/ConcurrentQueryCache.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface 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/DataCache.html" target="_top">Frames</a></li> |
| <li><a href="DataCache.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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="Interface DataCache" class="title">Interface DataCache</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/lib/util/Clearable.html" title="interface in org.apache.openjpa.lib.util">Clearable</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a>, <a href="../../../../org/apache/openjpa/datacache/DelegatingDataCache.html" title="class in org.apache.openjpa.datacache">DelegatingDataCache</a>, <a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.html" title="class in org.apache.openjpa.datacache">PartitionedDataCache</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">DataCache</span> |
| extends <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a>, <a href="../../../../org/apache/openjpa/lib/util/Clearable.html" title="interface in org.apache.openjpa.lib.util">Clearable</a></pre> |
| <div class="block">Interface that must be implemented by any level 2 cache used by |
| OpenJPA. Most data caches will choose to implement the |
| <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf"><code>Configurable</code></a> interface as well so that |
| they will be given the system configuration just after construction. |
| Implementations should take care not to return timed out data.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Patrick Linskey, Abe White, Pinaki Poddar</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache"><code>AbstractDataCache</code></a>, |
| <a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html#isTimedOut()"><code>DataCachePCData.isTimedOut()</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#NAME_DEFAULT">NAME_DEFAULT</a></strong></code> |
| <div class="block">The name of the default data cache: <code>default</code></div> |
| </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/DataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</a></strong>(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a> listen)</code> |
| <div class="block">Add a new expiration 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/DataCache.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/DataCache.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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)">commit</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> additions, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> newUpdates, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> existingUpdates, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> deletes)</code> |
| <div class="block">Perform a batch update of the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#contains(java.lang.Object)">contains</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Returns <code>true</code> if this cache contains data |
| corresponding to <code>oid</code>; otherwise returns |
| <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#containsAll(java.util.Collection)">containsAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</code> |
| <div class="block">Returns the indexes of the oids in this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)">get</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Return the cached object for the given oid.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getAll(java.util.List)">getAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> keys)</code> |
| <div class="block">Gets objects from the caches for a given list of keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getEvictOnBulkUpdate()">getEvictOnBulkUpdate</a></strong>()</code> |
| <div class="block">Returns whether the the cache needs to be updated when bulk updates as executed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getName()">getName</a></strong>()</code> |
| <div class="block">Returns a string name that can be used by end-user-visible |
| code to identify this cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartition(java.lang.String,%20boolean)">getPartition</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean create)</code> |
| <div class="block">Gets the named partition.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartitionNames()">getPartitionNames</a></strong>()</code> |
| <div class="block">Gets the name of the known partitions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getStatistics()">getStatistics</a></strong>()</code> |
| <div class="block">Returns number of read/write request and cache hit ratio data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.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> manager)</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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#isPartitioned()">isPartitioned</a></strong>()</code> |
| <div class="block">Affirms if this cache maintains partitions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)">pin</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Pin the value stored under <code>oid</code> into 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/DataCache.html#pinAll(java.lang.Class,%20boolean)">pinAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subs)</code> |
| <div class="block">Pin all oids for the given type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.util.Collection)">pinAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</code> |
| <div class="block">Pin all oids to the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</a></strong>(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> value)</code> |
| <div class="block">Set the cached value for the given instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)">remove</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Remove the value stored under the given oid.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.lang.Class,%20boolean)">removeAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subclasses)</code> |
| <div class="block">Evict all values of a specified type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.util.Collection)">removeAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</code> |
| <div class="block">Remove the values stored under the given oids.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</a></strong>(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a> listen)</code> |
| <div class="block">Remove an expiration event listener from 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/DataCache.html#setName(java.lang.String)">setName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Sets a string name to be used to identify this cache to end-user needs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)">unpin</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Unpin the value stored under <code>oid</code> from 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/DataCache.html#unpinAll(java.lang.Class,%20boolean)">unpinAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subs)</code> |
| <div class="block">Unpin all oids associaed with the given type from the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.util.Collection)">unpinAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</code> |
| <div class="block">Unpin all oids from 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/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</a></strong>(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> value)</code> |
| <div class="block">Update the cached value for the given instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCache.html#writeLock()">writeLock</a></strong>()</code> |
| <div class="block">Obtain a write lock on 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/DataCache.html#writeUnlock()">writeUnlock</a></strong>()</code> |
| <div class="block">Release the write lock on the cache.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NAME_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NAME_DEFAULT</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NAME_DEFAULT</pre> |
| <div class="block">The name of the default data cache: <code>default</code></div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.datacache.DataCache.NAME_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block">Returns a string name that can be used by end-user-visible |
| code to identify this cache.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2.5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>void setName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Sets a string name to be used to identify this cache to end-user needs.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2.5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="initialize(org.apache.openjpa.datacache.DataCacheManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>void initialize(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a> manager)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>void commit(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> additions, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> newUpdates, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> existingUpdates, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> deletes)</pre> |
| <div class="block">Perform a batch update of the cache. Add all <a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><code>DataCachePCData</code></a> |
| objects in <code>additions</code> and in |
| <code>newUpdates</code>, make the appropriate modifications to |
| all DataCachePCDatas in <code>existingUpdates</code>, and delete all |
| OIDs in <code>deletes</code>. |
| All changes made to cached data must be made via this |
| method. It is this method that is responsible for performing |
| any side-effects that should happen on meaningful cache changes. |
| Implementations should bear in mind that the |
| <code>deletes</code> collection may contain oids that are also |
| in the <code>additions</code> map. This is possible because it |
| is valid for a user to delete an object with a particular oid |
| and then add that object in the same batch.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>additions</code> - A collection of <a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><code>DataCachePCData</code></a> objects. |
| These represent data that have been newly created, |
| and thus must be added to the cache.</dd><dd><code>newUpdates</code> - A collection of <a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><code>DataCachePCData</code></a> objects. |
| These represent data that have been modified but |
| were not originally in the cache, and thus must be added to the cache.</dd><dd><code>existingUpdates</code> - A collection of <a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><code>DataCachePCData</code></a> objects. |
| These represent data that have been modified and |
| were originally loaded from the cache. It is |
| up to the cache implementation to decide if |
| these values must be re-enlisted in the cache. |
| Some caches may return live data from <a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><code>get(java.lang.Object)</code></a> |
| invocations, in which case these values need not be re-enlisted.</dd><dd><code>deletes</code> - A collection of object IDs that have been deleted |
| and must therefore be dropped from the cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="contains(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contains</h4> |
| <pre>boolean contains(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Returns <code>true</code> if this cache contains data |
| corresponding to <code>oid</code>; otherwise returns |
| <code>false</code>.</div> |
| </li> |
| </ul> |
| <a name="containsAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsAll</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> containsAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</pre> |
| <div class="block">Returns the indexes of the oids in this cache.</div> |
| </li> |
| </ul> |
| <a name="get(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> get(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Return the cached object for the given oid. Modifying the returned |
| object may or may not change the cached value; the <a href="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><code>update(org.apache.openjpa.datacache.DataCachePCData)</code></a> |
| method should be used to re-cache any changed objects.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the object matching the given oid, or null if none</dd></dl> |
| </li> |
| </ul> |
| <a name="put(org.apache.openjpa.datacache.DataCachePCData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> put(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> value)</pre> |
| <div class="block">Set the cached value for the given instance. This does <em>not</em> |
| result in an update of other caches. Rather, it should only be |
| used for loading clean data into the cache. Meaningful changes |
| to the state of the cache should be made via the <a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<java.lang.Object>)</code></a> method.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The previously cached value, or <code>null</code> if |
| the value was not previously cached. See <a href="http://download.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="update(org.apache.openjpa.datacache.DataCachePCData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>void update(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> value)</pre> |
| <div class="block">Update the cached value for the given instance. This does |
| <em>not</em> result in an update of other caches. Rather, it should |
| only be used for loading clean data into the cache. Meaningful changes |
| to the state of the cache should be made via the <a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<java.lang.Object>)</code></a> method. |
| A cache implementation may or may not return a live object |
| from <a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><code>get(java.lang.Object)</code></a> invocations. If an object retrieved from a |
| <a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><code>get(java.lang.Object)</code></a> operation needs to be updated, this method can be |
| invoked instead of invoking <a href="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)"><code>put(org.apache.openjpa.datacache.DataCachePCData)</code></a>. The DataCache implementation |
| can then make optimizations based on how its <a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><code>get(java.lang.Object)</code></a> method works.</div> |
| </li> |
| </ul> |
| <a name="remove(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a> remove(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Remove the value stored under the given oid. This does |
| <em>not</em> result in an update of other caches. Rather, it |
| should only be used for removing data in the cache. |
| Meaningful changes to the state of the cache should be made |
| via the <a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<java.lang.Object>)</code></a> method.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>The previously cached value, or <code>null</code> if |
| the oid was not previously cached. See <a href="http://download.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="removeAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAll</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> removeAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</pre> |
| <div class="block">Remove the values stored under the given oids.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the indexes of the removed oids</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)"><code>remove(java.lang.Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="removeAll(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAll</h4> |
| <pre>void removeAll(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subclasses)</pre> |
| <div class="block">Evict all values of a specified type.</div> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>void clear()</pre> |
| <div class="block">Remove all data from this cache. This does <em>not</em> result |
| in an update of other caches. Rather, it should only be used |
| for clearing the cache. Meaningful changes to the state of the |
| cache should be made via the <a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<org.apache.openjpa.datacache.DataCachePCData>, java.util.Collection<java.lang.Object>)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/util/Clearable.html#clear()">clear</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/util/Clearable.html" title="interface in org.apache.openjpa.lib.util">Clearable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pin(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pin</h4> |
| <pre>boolean pin(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Pin the value stored under <code>oid</code> into the cache. |
| This method guarantees that <code>oid</code>'s value will not |
| be dropped by the caching algorithm. This method does not |
| affect the behavior of <a href="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)"><code>remove(java.lang.Object)</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>oid</code>'s value was |
| pinned into the cache; <code>false</code> if the oid is not in the cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="pinAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pinAll</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> pinAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</pre> |
| <div class="block">Pin all oids to the cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the indexes of the pinned oids</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)"><code>pin(java.lang.Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="pinAll(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pinAll</h4> |
| <pre>void pinAll(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subs)</pre> |
| <div class="block">Pin all oids for the given type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subs</code> - Whether to include subclasses.</dd></dl> |
| </li> |
| </ul> |
| <a name="unpin(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpin</h4> |
| <pre>boolean unpin(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Unpin the value stored under <code>oid</code> from the cache. |
| This method reverses a previous invocation of <a href="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)"><code>pin(java.lang.Object)</code></a>. |
| This method does not remove anything from the cache; it merely |
| makes <code>oid</code>'s value a candidate for flushing from the cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>oid</code>'s value was |
| unpinned from the cache; <code>false</code> if the |
| oid is not in the cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="unpinAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpinAll</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> unpinAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> oids)</pre> |
| <div class="block">Unpin all oids from the cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the indexes of the unpinned oids</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)"><code>unpin(java.lang.Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="unpinAll(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unpinAll</h4> |
| <pre>void unpinAll(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean subs)</pre> |
| <div class="block">Unpin all oids associaed with the given type from the cache.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subs</code> - Whether to include subclasses.</dd></dl> |
| </li> |
| </ul> |
| <a name="writeLock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLock</h4> |
| <pre>void writeLock()</pre> |
| <div class="block">Obtain a write lock on the cache.</div> |
| </li> |
| </ul> |
| <a name="writeUnlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeUnlock</h4> |
| <pre>void writeUnlock()</pre> |
| <div class="block">Release the write lock on the cache.</div> |
| </li> |
| </ul> |
| <a name="addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExpirationListener</h4> |
| <pre>void addExpirationListener(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a> listen)</pre> |
| <div class="block">Add a new expiration event listener to this cache.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2.5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeExpirationListener</h4> |
| <pre>boolean removeExpirationListener(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a> listen)</pre> |
| <div class="block">Remove an expiration event listener from this cache.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2.5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <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/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="getAll(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAll</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>> getAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> keys)</pre> |
| <div class="block">Gets objects from the caches for a given list of keys. |
| The returned map has the same keys as the given keys. |
| If the cache does not contain data for a specific key, |
| the returned map still contains the key with a null value.</div> |
| </li> |
| </ul> |
| <a name="getPartition(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartition</h4> |
| <pre><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a> getPartition(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean create)</pre> |
| <div class="block">Gets the named partition. Note that a partition itself is another cache.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of the given partition.</dd><dd><code>create</code> - if true optionally create a new partition.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a partition of the given name. Or null, if either no such partition exists or can not be created.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPartitionNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionNames</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPartitionNames()</pre> |
| <div class="block">Gets the name of the known partitions.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>empty set if no partition exists.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isPartitioned()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPartitioned</h4> |
| <pre>boolean isPartitioned()</pre> |
| <div class="block">Affirms if this cache maintains partitions.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getStatistics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatistics</h4> |
| <pre><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a> getStatistics()</pre> |
| <div class="block">Returns number of read/write request and cache hit ratio data.</div> |
| </li> |
| </ul> |
| <a name="getEvictOnBulkUpdate()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEvictOnBulkUpdate</h4> |
| <pre>boolean getEvictOnBulkUpdate()</pre> |
| <div class="block">Returns whether the the cache needs to be updated when bulk updates as executed. Defaults to true.</div> |
| </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/DataCache.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/ConcurrentQueryCache.html" title="class in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface 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/DataCache.html" target="_top">Frames</a></li> |
| <li><a href="DataCache.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
