blob: 4fc932e119dd66e71aedb9dae39eccb21e248d19 [file] [log] [blame]
<!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>AbstractDataCache (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="AbstractDataCache (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/AbstractDataCache.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>Prev Class</li>
<li><a href="../../../../org/apache/openjpa/datacache/AbstractQueryCache.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/AbstractDataCache.html" target="_top">Frames</a></li>
<li><a href="AbstractDataCache.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 AbstractDataCache" class="title">Class AbstractDataCache</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.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><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">org.apache.openjpa.lib.util.concurrent.AbstractConcurrentEventManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.datacache.AbstractDataCache</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a>, <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>, <a href="../../../../org/apache/openjpa/lib/util/EventManager.html" title="interface in org.apache.openjpa.lib.util">EventManager</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractDataCache</span>
extends <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a>
implements <a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>, <a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></pre>
<div class="block">Abstract <a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache"><code>DataCache</code></a> implementation that provides various
statistics, logging, and timeout functionality common across cache
implementations.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Patrick Linskey, Abe White</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.datacache.AbstractDataCache">Serialized Form</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">&nbsp;</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>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_evictOnBulkUpdate">_evictOnBulkUpdate</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_excludedTypes">_excludedTypes</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_includedTypes">_includedTypes</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html" title="interface in org.apache.openjpa.datacache">CacheStatisticsSPI</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_stats">_stats</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#conf">conf</a></strong></code>
<div class="block">The configuration set by the system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#log">log</a></strong></code>
<div class="block">The log to use.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.lib.util.concurrent.AbstractConcurrentEventManager">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.lib.util.concurrent.<a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a></h3>
<code><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#_listeners">_listeners</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.datacache.DataCache">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#NAME_DEFAULT">NAME_DEFAULT</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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">&nbsp;</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/AbstractDataCache.html#AbstractDataCache()">AbstractDataCache</a></strong>()</code>&nbsp;</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">&nbsp;</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/AbstractDataCache.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>&nbsp;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/AbstractDataCache.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</a></strong>(<a href="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</a>&nbsp;event)</code>
<div class="block">This method is part of the <a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitListener</code></a> interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#clear()">clear</a></strong>()</code>
<div class="block">Remove all data from this cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#clearInternal()">clearInternal</a></strong>()</code>
<div class="block">Clear 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/AbstractDataCache.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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#close(boolean)">close</a></strong>(boolean&nbsp;clear)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<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>&gt;&nbsp;deletes)</code>
<div class="block">Perform a batch update of the 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/AbstractDataCache.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>&nbsp;key)</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="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/AbstractDataCache.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>&lt;<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>&gt;&nbsp;keys)</code>
<div class="block">Returns the indexes of the oids in 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/AbstractDataCache.html#endConfiguration()">endConfiguration</a></strong>()</code>
<div class="block">Invoked upon completion of bean property configuration for this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#fireEvent(java.lang.Object,%20java.lang.Object)">fireEvent</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>&nbsp;event,
<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>&nbsp;listener)</code>
<div class="block">Implement this method to fire the given event to the given listener.</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/AbstractDataCache.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>&nbsp;key)</code>
<div class="block">Return the cached object for the given oid.</div>
</td>
</tr>
<tr class="altColor">
<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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>&lt;<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>&gt;&nbsp;keys)</code>
<div class="block">Returns the objects for the given key List.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getEnableStatistics()">getEnableStatistics</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<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/AbstractDataCache.html#getEvictionSchedule()">getEvictionSchedule</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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="altColor">
<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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getExcludedTypes()">getExcludedTypes</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract <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/AbstractDataCache.html#getInternal(java.lang.Object)">getInternal</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>&nbsp;oid)</code>
<div class="block">Return the object for the given oid.</div>
</td>
</tr>
<tr class="altColor">
<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/AbstractDataCache.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="rowColor">
<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/AbstractDataCache.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>&nbsp;name,
boolean&nbsp;create)</code>
<div class="block">Gets the named partition.</div>
</td>
</tr>
<tr class="altColor">
<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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getPartitionNames()">getPartitionNames</a></strong>()</code>
<div class="block">Gets the name of the known partitions.</div>
</td>
</tr>
<tr class="rowColor">
<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/AbstractDataCache.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="altColor">
<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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getTypes()">getTypes</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>&nbsp;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/AbstractDataCache.html#isClosed()">isClosed</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#isPartitioned()">isPartitioned</a></strong>()</code>
<div class="block">Affirms if this cache maintains partitions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#keyRemoved(java.lang.Object,%20boolean)">keyRemoved</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>&nbsp;key,
boolean&nbsp;expired)</code>
<div class="block">Invoke when a key is removed from 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/AbstractDataCache.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>&nbsp;key)</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/AbstractDataCache.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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;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/AbstractDataCache.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>&lt;<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>&gt;&nbsp;keys)</code>
<div class="block">Pin all oids to the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinInternal(java.lang.Object)">pinInternal</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>&nbsp;oid)</code>
<div class="block">Pin an object to the cache.</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/AbstractDataCache.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>&nbsp;data)</code>
<div class="block">Set the cached value for the given instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#putAllInternal(java.util.Collection)">putAllInternal</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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;pcs)</code>
<div class="block">Add all of the given objects to the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract <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/AbstractDataCache.html#putInternal(java.lang.Object,%20org.apache.openjpa.datacache.DataCachePCData)">putInternal</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>&nbsp;oid,
<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;pc)</code>
<div class="block">Add the given object to the cache, returning the old object under the
given oid.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#recacheUpdates()">recacheUpdates</a></strong>()</code>
<div class="block">Return <code>true</code> if updates to data already in the
cache (either in <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</code></a> or the <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><code>update(org.apache.openjpa.datacache.DataCachePCData)</code></a>)
should be put back into the cache.</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/AbstractDataCache.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>&nbsp;key)</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/AbstractDataCache.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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subClasses)</code>
<div class="block">Remove the objects of the given class from the cache.</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/AbstractDataCache.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>&lt;<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>&gt;&nbsp;keys)</code>
<div class="block">Remove the values stored under the given oids.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllInternal(java.lang.Class,%20boolean)">removeAllInternal</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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subclasses)</code>
<div class="block">Evict objects in cache by class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllInternal(java.util.Collection)">removeAllInternal</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>&lt;<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>&gt;&nbsp;oids)</code>
<div class="block">Remove all objects under the given oids from the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllTypeNamesInternal(java.util.Collection)">removeAllTypeNamesInternal</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>&lt;<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>&gt;&nbsp;classNames)</code>
<div class="block">Remove all objects of the given class names from the 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/AbstractDataCache.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>&nbsp;listen)</code>
<div class="block">Remove an expiration event listener from this cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <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/AbstractDataCache.html#removeInternal(java.lang.Object)">removeInternal</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>&nbsp;oid)</code>
<div class="block">Remove the object under the given oid from the cache.</div>
</td>
</tr>
<tr class="rowColor">
<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/AbstractDataCache.html#selectCache(org.apache.openjpa.kernel.OpenJPAStateManager)">selectCache</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a></strong>(<a href="../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a>&nbsp;conf)</code>
<div class="block">Invoked prior to setting bean properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEnableStatistics(boolean)">setEnableStatistics</a></strong>(boolean&nbsp;enable)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEvictionSchedule(java.lang.String)">setEvictionSchedule</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>&nbsp;s)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEvictOnBulkUpdate(boolean)">setEvictOnBulkUpdate</a></strong>(boolean&nbsp;b)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setExcludedTypes(java.util.Set)">setExcludedTypes</a></strong>(<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>&lt;<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>&gt;&nbsp;types)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setExcludedTypes(java.lang.String)">setExcludedTypes</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>&nbsp;types)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>&nbsp;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="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setTypes(java.util.Set)">setTypes</a></strong>(<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>&lt;<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>&gt;&nbsp;types)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setTypes(java.lang.String)">setTypes</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>&nbsp;types)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#startConfiguration()">startConfiguration</a></strong>()</code>
<div class="block">Invoked before bean property configuration is begun on this object.</div>
</td>
</tr>
<tr class="altColor">
<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/AbstractDataCache.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>&nbsp;key)</code>
<div class="block">Unpin the value stored under <code>oid</code> from 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/AbstractDataCache.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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subs)</code>
<div class="block">Unpin all oids associaed with the given type from the cache.</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/AbstractDataCache.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>&lt;<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>&gt;&nbsp;keys)</code>
<div class="block">Unpin all oids from the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpinInternal(java.lang.Object)">unpinInternal</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>&nbsp;oid)</code>
<div class="block">Unpin an object 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/AbstractDataCache.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>&nbsp;data)</code>
<div class="block">Update the cached value for the given instance.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.util.concurrent.AbstractConcurrentEventManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.lib.util.concurrent.<a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a></h3>
<code><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#addListener(java.lang.Object)">addListener</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object)">fireEvent</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#getListeners()">getListeners</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#hasListener(java.lang.Object)">hasListener</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#hasListeners()">hasListeners</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#isFailFast()">isFailFast</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#newListenerCollection()">newListenerCollection</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#removeListener(java.lang.Object)">removeListener</a>, <a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#setFailFast(boolean)">setFailFast</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="http://download.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://download.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>, <a href="http://download.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://download.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.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://download.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://download.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://download.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://download.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>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.datacache.DataCache">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#writeLock()">writeLock</a>, <a href="../../../../org/apache/openjpa/datacache/DataCache.html#writeUnlock()">writeUnlock</a></code></li>
</ul>
</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="_stats">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_stats</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html" title="interface in org.apache.openjpa.datacache">CacheStatisticsSPI</a> _stats</pre>
</li>
</ul>
<a name="conf">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conf</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a> conf</pre>
<div class="block">The configuration set by the system.</div>
</li>
</ul>
<a name="log">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</a> log</pre>
<div class="block">The log to use.</div>
</li>
</ul>
<a name="_includedTypes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_includedTypes</h4>
<pre>protected&nbsp;<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>&lt;<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>&gt; _includedTypes</pre>
</li>
</ul>
<a name="_excludedTypes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_excludedTypes</h4>
<pre>protected&nbsp;<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>&lt;<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>&gt; _excludedTypes</pre>
</li>
</ul>
<a name="_evictOnBulkUpdate">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_evictOnBulkUpdate</h4>
<pre>protected&nbsp;boolean _evictOnBulkUpdate</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractDataCache()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractDataCache</h4>
<pre>public&nbsp;AbstractDataCache()</pre>
</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>public&nbsp;<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>&nbsp;getName()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getName()">DataCache</a></code></strong></div>
<div class="block">Returns a string name that can be used by end-user-visible
code to identify this cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;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>&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#setName(java.lang.String)">DataCache</a></code></strong></div>
<div class="block">Sets a string name to be used to identify this cache to end-user needs.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#setName(java.lang.String)">setName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="setEnableStatistics(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableStatistics</h4>
<pre>public&nbsp;void&nbsp;setEnableStatistics(boolean&nbsp;enable)</pre>
</li>
</ul>
<a name="getEnableStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnableStatistics</h4>
<pre>public&nbsp;void&nbsp;getEnableStatistics()</pre>
</li>
</ul>
<a name="getEvictionSchedule()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvictionSchedule</h4>
<pre>public&nbsp;<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>&nbsp;getEvictionSchedule()</pre>
</li>
</ul>
<a name="setEvictionSchedule(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEvictionSchedule</h4>
<pre>public&nbsp;void&nbsp;setEvictionSchedule(<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>&nbsp;s)</pre>
</li>
</ul>
<a name="initialize(org.apache.openjpa.datacache.DataCacheManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>&nbsp;manager)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">DataCache</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/DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</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>public&nbsp;void&nbsp;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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;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>&lt;<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>&gt;&nbsp;deletes)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)">DataCache</a></code></strong></div>
<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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)">commit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>DataCache.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>public&nbsp;boolean&nbsp;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>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#contains(java.lang.Object)">DataCache</a></code></strong></div>
<div class="block">Returns <code>true</code> if this cache contains data
corresponding to <code>oid</code>; otherwise returns
<code>false</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#contains(java.lang.Object)">contains</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="containsAll(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsAll</h4>
<pre>public&nbsp;<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>&nbsp;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>&lt;<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>&gt;&nbsp;keys)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#containsAll(java.util.Collection)">DataCache</a></code></strong></div>
<div class="block">Returns the indexes of the oids in this cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#containsAll(java.util.Collection)">containsAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="get(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;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>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)">DataCache</a></code></strong></div>
<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>DataCache.update(org.apache.openjpa.datacache.DataCachePCData)</code></a>
method should be used to re-cache any changed objects.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)">get</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the object matching the given oid, or null if none</dd></dl>
</li>
</ul>
<a name="getAll(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;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>&lt;<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>&gt;&nbsp;keys)</pre>
<div class="block">Returns the objects for the given key List.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getAll(java.util.List)">getAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="put(org.apache.openjpa.datacache.DataCachePCData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;put(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;data)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">DataCache</a></code></strong></div>
<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>DataCache.commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</code></a> method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>public&nbsp;void&nbsp;update(<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;data)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">DataCache</a></code></strong></div>
<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>DataCache.commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</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>DataCache.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>DataCache.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>DataCache.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>DataCache.get(java.lang.Object)</code></a> method works.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;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>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)">DataCache</a></code></strong></div>
<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>DataCache.commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</code></a> method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)">remove</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>public&nbsp;<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>&nbsp;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>&lt;<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>&gt;&nbsp;keys)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.util.Collection)">DataCache</a></code></strong></div>
<div class="block">Remove the values stored under the given oids.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.util.Collection)">removeAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>DataCache.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>public&nbsp;void&nbsp;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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subClasses)</pre>
<div class="block">Remove the objects of the given class from the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.lang.Class,%20boolean)">removeAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="pin(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pin</h4>
<pre>public&nbsp;boolean&nbsp;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>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)">DataCache</a></code></strong></div>
<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>DataCache.remove(java.lang.Object)</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)">pin</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>public&nbsp;<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>&nbsp;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>&lt;<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>&gt;&nbsp;keys)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.util.Collection)">DataCache</a></code></strong></div>
<div class="block">Pin all oids to the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.util.Collection)">pinAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>DataCache.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>public&nbsp;void&nbsp;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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subs)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.lang.Class,%20boolean)">DataCache</a></code></strong></div>
<div class="block">Pin all oids for the given type.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.lang.Class,%20boolean)">pinAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>public&nbsp;boolean&nbsp;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>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)">DataCache</a></code></strong></div>
<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>DataCache.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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)">unpin</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>public&nbsp;<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>&nbsp;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>&lt;<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>&gt;&nbsp;keys)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.util.Collection)">DataCache</a></code></strong></div>
<div class="block">Unpin all oids from the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.util.Collection)">unpinAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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>DataCache.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>public&nbsp;void&nbsp;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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subs)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.lang.Class,%20boolean)">DataCache</a></code></strong></div>
<div class="block">Unpin all oids associaed with the given type from the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.lang.Class,%20boolean)">unpinAll</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dd><code>subs</code> - Whether to include subclasses.</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#clear()">DataCache</a></code></strong></div>
<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>DataCache.commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</code></a> method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/util/Clearable.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<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="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#close()">DataCache</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/DataCache.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</a></code>&nbsp;in interface&nbsp;<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="close(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>protected&nbsp;void&nbsp;close(boolean&nbsp;clear)</pre>
</li>
</ul>
<a name="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>public&nbsp;boolean&nbsp;isClosed()</pre>
</li>
</ul>
<a name="addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addExpirationListener</h4>
<pre>public&nbsp;void&nbsp;addExpirationListener(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a>&nbsp;listen)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">DataCache</a></code></strong></div>
<div class="block">Add a new expiration event listener to this cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeExpirationListener</h4>
<pre>public&nbsp;boolean&nbsp;removeExpirationListener(<a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a>&nbsp;listen)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">DataCache</a></code></strong></div>
<div class="block">Remove an expiration event listener from this cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterCommit</h4>
<pre>public&nbsp;void&nbsp;afterCommit(<a href="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</a>&nbsp;event)</pre>
<div class="block">This method is part of the <a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitListener</code></a> interface. If
your cache subclass relies on OpenJPA for clustering support, make it
implement <code>RemoteCommitListener</code>. This method will take
care of invalidating entries from remote commits.</div>
</li>
</ul>
<a name="keyRemoved(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyRemoved</h4>
<pre>protected&nbsp;void&nbsp;keyRemoved(<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>&nbsp;key,
boolean&nbsp;expired)</pre>
<div class="block">Invoke when a key is removed from this cache. Propagates the
expiration event on to all expiration listeners registered
with this class.</div>
</li>
</ul>
<a name="recacheUpdates()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recacheUpdates</h4>
<pre>protected&nbsp;boolean&nbsp;recacheUpdates()</pre>
<div class="block">Return <code>true</code> if updates to data already in the
cache (either in <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)"><code>commit(java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;org.apache.openjpa.datacache.DataCachePCData&gt;, java.util.Collection&lt;java.lang.Object&gt;)</code></a> or the <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><code>update(org.apache.openjpa.datacache.DataCachePCData)</code></a>)
should be put back into the cache. Returns false by default.</div>
</li>
</ul>
<a name="getInternal(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInternal</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;getInternal(<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>&nbsp;oid)</pre>
<div class="block">Return the object for the given oid.</div>
</li>
</ul>
<a name="putInternal(java.lang.Object, org.apache.openjpa.datacache.DataCachePCData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putInternal</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;putInternal(<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>&nbsp;oid,
<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;pc)</pre>
<div class="block">Add the given object to the cache, returning the old object under the
given oid.</div>
</li>
</ul>
<a name="putAllInternal(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putAllInternal</h4>
<pre>protected&nbsp;void&nbsp;putAllInternal(<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>&lt;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&gt;&nbsp;pcs)</pre>
<div class="block">Add all of the given objects to the cache.</div>
</li>
</ul>
<a name="removeInternal(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeInternal</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a>&nbsp;removeInternal(<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>&nbsp;oid)</pre>
<div class="block">Remove the object under the given oid from the cache.</div>
</li>
</ul>
<a name="removeAllInternal(java.lang.Class, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllInternal</h4>
<pre>protected abstract&nbsp;void&nbsp;removeAllInternal(<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>&lt;?&gt;&nbsp;cls,
boolean&nbsp;subclasses)</pre>
<div class="block">Evict objects in cache by class.</div>
</li>
</ul>
<a name="removeAllInternal(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllInternal</h4>
<pre>protected&nbsp;void&nbsp;removeAllInternal(<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>&lt;<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>&gt;&nbsp;oids)</pre>
<div class="block">Remove all objects under the given oids from the cache.</div>
</li>
</ul>
<a name="removeAllTypeNamesInternal(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllTypeNamesInternal</h4>
<pre>protected&nbsp;void&nbsp;removeAllTypeNamesInternal(<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>&lt;<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>&gt;&nbsp;classNames)</pre>
<div class="block">Remove all objects of the given class names from the cache.</div>
</li>
</ul>
<a name="clearInternal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearInternal</h4>
<pre>protected abstract&nbsp;void&nbsp;clearInternal()</pre>
<div class="block">Clear the cache.</div>
</li>
</ul>
<a name="pinInternal(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pinInternal</h4>
<pre>protected abstract&nbsp;boolean&nbsp;pinInternal(<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>&nbsp;oid)</pre>
<div class="block">Pin an object to the cache.</div>
</li>
</ul>
<a name="unpinInternal(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unpinInternal</h4>
<pre>protected abstract&nbsp;boolean&nbsp;unpinInternal(<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>&nbsp;oid)</pre>
<div class="block">Unpin an object from the cache.</div>
</li>
</ul>
<a name="getPartition(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartition</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;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>&nbsp;name,
boolean&nbsp;create)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartition(java.lang.String,%20boolean)">DataCache</a></code></strong></div>
<div class="block">Gets the named partition. Note that a partition itself is another cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartition(java.lang.String,%20boolean)">getPartition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<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></dl>
</li>
</ul>
<a name="getPartitionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionNames</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getPartitionNames()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartitionNames()">DataCache</a></code></strong></div>
<div class="block">Gets the name of the known partitions.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartitionNames()">getPartitionNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>empty set if no partition exists.</dd></dl>
</li>
</ul>
<a name="isPartitioned()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartitioned</h4>
<pre>public&nbsp;boolean&nbsp;isPartitioned()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#isPartitioned()">DataCache</a></code></strong></div>
<div class="block">Affirms if this cache maintains partitions.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#isPartitioned()">isPartitioned</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="getStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatistics</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a>&nbsp;getStatistics()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getStatistics()">DataCache</a></code></strong></div>
<div class="block">Returns number of read/write request and cache hit ratio data.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getStatistics()">getStatistics</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="setConfiguration(org.apache.openjpa.lib.conf.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfiguration</h4>
<pre>public&nbsp;void&nbsp;setConfiguration(<a href="../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</a>&nbsp;conf)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">Configurable</a></code></strong></div>
<div class="block">Invoked prior to setting bean properties.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code></dd>
</dl>
</li>
</ul>
<a name="startConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startConfiguration</h4>
<pre>public&nbsp;void&nbsp;startConfiguration()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">Configurable</a></code></strong></div>
<div class="block">Invoked before bean property configuration is begun on this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">startConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code></dd>
</dl>
</li>
</ul>
<a name="endConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endConfiguration</h4>
<pre>public&nbsp;void&nbsp;endConfiguration()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">Configurable</a></code></strong></div>
<div class="block">Invoked upon completion of bean property configuration for this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">endConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code></dd>
</dl>
</li>
</ul>
<a name="fireEvent(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fireEvent</h4>
<pre>protected&nbsp;void&nbsp;fireEvent(<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>&nbsp;event,
<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>&nbsp;listener)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object,%20java.lang.Object)">AbstractConcurrentEventManager</a></code></strong></div>
<div class="block">Implement this method to fire the given event to the given listener.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object,%20java.lang.Object)">fireEvent</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypes</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getTypes()</pre>
</li>
</ul>
<a name="getExcludedTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExcludedTypes</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getExcludedTypes()</pre>
</li>
</ul>
<a name="setTypes(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTypes</h4>
<pre>public&nbsp;void&nbsp;setTypes(<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>&lt;<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>&gt;&nbsp;types)</pre>
</li>
</ul>
<a name="setTypes(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTypes</h4>
<pre>public&nbsp;void&nbsp;setTypes(<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>&nbsp;types)</pre>
</li>
</ul>
<a name="setExcludedTypes(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludedTypes</h4>
<pre>public&nbsp;void&nbsp;setExcludedTypes(<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>&lt;<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>&gt;&nbsp;types)</pre>
</li>
</ul>
<a name="setExcludedTypes(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExcludedTypes</h4>
<pre>public&nbsp;void&nbsp;setExcludedTypes(<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>&nbsp;types)</pre>
</li>
</ul>
<a name="selectCache(org.apache.openjpa.kernel.OpenJPAStateManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectCache</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;selectCache(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</pre>
</li>
</ul>
<a name="getEvictOnBulkUpdate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvictOnBulkUpdate</h4>
<pre>public&nbsp;boolean&nbsp;getEvictOnBulkUpdate()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getEvictOnBulkUpdate()">DataCache</a></code></strong></div>
<div class="block">Returns whether the the cache needs to be updated when bulk updates as executed. Defaults to true.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html#getEvictOnBulkUpdate()">getEvictOnBulkUpdate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="setEvictOnBulkUpdate(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setEvictOnBulkUpdate</h4>
<pre>public&nbsp;void&nbsp;setEvictOnBulkUpdate(boolean&nbsp;b)</pre>
</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/AbstractDataCache.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>Prev Class</li>
<li><a href="../../../../org/apache/openjpa/datacache/AbstractQueryCache.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/AbstractDataCache.html" target="_top">Frames</a></li>
<li><a href="AbstractDataCache.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>