blob: d9a746e48a0c5394ac743fa4fc7d5bfbc994ae02 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:17 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.datacache (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.openjpa.datacache (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/conf/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/openjpa/ee/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.datacache</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA Data Cache</strong>
OpenJPA's data and query caching frameworks.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a></td>
<td class="colLast">
<div class="block">A policy determines whether a given entity should be cached and if true, in which named partition of the
cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a></td>
<td class="colLast">
<div class="block">Counts number of read/write requests and hit ratio for a cache in total and
per-class basis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsSPI.html" title="interface in org.apache.openjpa.datacache">CacheStatisticsSPI</a></td>
<td class="colLast">
<div class="block">The provider extensions to the CacheStatistics interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></td>
<td class="colLast">
<div class="block">Interface that must be implemented by any level 2 cache used by
OpenJPA.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></td>
<td class="colLast">
<div class="block">Manages the system's data and query caches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a></td>
<td class="colLast">
<div class="block">Specialized <a href="../../../../org/apache/openjpa/kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a> implementation for data caching.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.Timed.html" title="interface in org.apache.openjpa.datacache">DataCachePCDataGenerator.Timed</a></td>
<td class="colLast">
<div class="block">Simple interface to give access to expiration time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a></td>
<td class="colLast">
<div class="block">An entity that wishes to be notified when cache keys expire.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></td>
<td class="colLast">
<div class="block">Interface that must be implemented by any level 2 query cache
used by OpenJPA.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a></td>
<td class="colLast">
<div class="block">An entity that wishes to be notified when types change.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/AbstractQueryCache.html" title="class in org.apache.openjpa.datacache">AbstractQueryCache</a></td>
<td class="colLast">
<div class="block">Abstract <a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache"><code>QueryCache</code></a> implementation that provides various
statistics, logging, and timeout functionality common across cache
implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/AbstractQueryCache.Default.html" title="class in org.apache.openjpa.datacache">AbstractQueryCache.Default</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A default implementation of query statistics for the Query result cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/CacheStatisticsImpl.html" title="class in org.apache.openjpa.datacache">CacheStatisticsImpl</a></td>
<td class="colLast">
<div class="block">The default CacheStatistics(SPI) implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a></td>
<td class="colLast">
<div class="block">Cron-style clearable eviction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache"><code>DataCache</code></a> implementation that is optimized for concurrent
access.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/ConcurrentQueryCache.html" title="class in org.apache.openjpa.datacache">ConcurrentQueryCache</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache"><code>QueryCache</code></a> implementation that is optimized for concurrent
access.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html" title="class in org.apache.openjpa.datacache">DataCacheManagerImpl</a></td>
<td class="colLast">
<div class="block">Default data cache manager provides handle to utilities <a href="../../../../org/apache/openjpa/enhance/PCDataGenerator.html" title="class in org.apache.openjpa.enhance">PCDataGenerator</a>, <a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a>
and <a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a> for the cache operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/openjpa/enhance/PCDataGenerator.html" title="class in org.apache.openjpa.enhance"><code>PCDataGenerator</code></a> instance which generates properly
synchronized instances suitable for use in the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCachePCDataImpl.html" title="class in org.apache.openjpa.datacache">DataCachePCDataImpl</a></td>
<td class="colLast">
<div class="block">Specialized <a href="../../../../org/apache/openjpa/kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a> implementation for data caching.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCacheStoreManager.html" title="class in org.apache.openjpa.datacache">DataCacheStoreManager</a></td>
<td class="colLast">
<div class="block">StoreManager proxy that delegates to a data cache when possible.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DefaultCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">DefaultCacheDistributionPolicy</a></td>
<td class="colLast">
<div class="block">A default implementation that selects the cache by the type of the given managed instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DelegatingDataCache.html" title="class in org.apache.openjpa.datacache">DelegatingDataCache</a></td>
<td class="colLast">
<div class="block">Delegating data cache that can also perform exception translation for
use in facades.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DelegatingQueryCache.html" title="class in org.apache.openjpa.datacache">DelegatingQueryCache</a></td>
<td class="colLast">
<div class="block">Delegating query cache that can also perform exception translation for
use in facades.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/ExpirationEvent.html" title="class in org.apache.openjpa.datacache">ExpirationEvent</a></td>
<td class="colLast">
<div class="block">An event indicating the expiration of an object from the data cache,
or an expiration of a result list from the query cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.html" title="class in org.apache.openjpa.datacache">PartitionedDataCache</a></td>
<td class="colLast">
<div class="block">A partitioned data cache maintains a set of partitions that are DataCache themselves.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/QueryCacheStoreQuery.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel"><code>StoreQuery</code></a> implementation that caches the OIDs involved in
the query, and can determine whether or not the query has been dirtied.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/QueryCacheStoreQuery.CachedList.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery.CachedList</a></td>
<td class="colLast">
<div class="block">Result list implementation for a cached query result.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a></td>
<td class="colLast">
<div class="block">This class stores information about a particular invocation of
a query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a></td>
<td class="colLast">
<div class="block">A query result.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/TypeBasedCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">TypeBasedCacheDistributionPolicy</a></td>
<td class="colLast">
<div class="block">A cache distribution policy based on the type of the managed objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/TypesChangedEvent.html" title="class in org.apache.openjpa.datacache">TypesChangedEvent</a></td>
<td class="colLast">
<div class="block">An event indicating that instances of given persistent types have
been modified.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/AbstractQueryCache.EvictPolicy.html" title="enum in org.apache.openjpa.datacache">AbstractQueryCache.EvictPolicy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/datacache/DataCacheMode.html" title="enum in org.apache.openjpa.datacache">DataCacheMode</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.datacache Description">Package org.apache.openjpa.datacache Description</h2>
<div class="block"><p><strong>OpenJPA Data Cache</strong></p>
<p>
OpenJPA's data and query caching frameworks.
</p></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/conf/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/openjpa/ee/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>