| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.openjpa.datacache (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.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 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.openjpa.datacache</h1> |
| </div> |
| <div class="contentContainer"> |
| <section><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block"><p><strong>OpenJPA Data Cache</strong></p> |
| |
| <p> |
| OpenJPA's data and query caching frameworks. |
| </p></div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="CacheStatistics.html" title="interface in org.apache.openjpa.datacache">CacheStatistics</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="CacheStatisticsSPI.html" title="interface in org.apache.openjpa.datacache">CacheStatisticsSPI</a></th> |
| <td class="colLast"> |
| <div class="block">The provider extensions to the CacheStatistics interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></th> |
| <td class="colLast"> |
| <div class="block">Manages the system's data and query caches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</a></th> |
| <td class="colLast"> |
| <div class="block">Specialized <a href="../kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a> implementation for data caching.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataCachePCDataGenerator.Timed.html" title="interface in org.apache.openjpa.datacache">DataCachePCDataGenerator.Timed</a></th> |
| <td class="colLast"> |
| <div class="block">Simple interface to give access to expiration time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</a></th> |
| <td class="colLast"> |
| <div class="block">An entity that wishes to be notified when cache keys expire.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="TypesChangedListener.html" title="interface in org.apache.openjpa.datacache">TypesChangedListener</a></th> |
| <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"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></th> |
| <td class="colLast"> |
| <div class="block">Abstract <a href="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"> |
| <th class="colFirst" scope="row"><a href="AbstractQueryCache.html" title="class in org.apache.openjpa.datacache">AbstractQueryCache</a></th> |
| <td class="colLast"> |
| <div class="block">Abstract <a href="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"> |
| <th class="colFirst" scope="row"><a href="AbstractQueryCache.Default.html" title="class in org.apache.openjpa.datacache">AbstractQueryCache.Default</a><T></th> |
| <td class="colLast"> |
| <div class="block">A default implementation of query statistics for the Query result cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CacheStatisticsImpl.html" title="class in org.apache.openjpa.datacache">CacheStatisticsImpl</a></th> |
| <td class="colLast"> |
| <div class="block">The default CacheStatistics(SPI) implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a></th> |
| <td class="colLast"> |
| <div class="block">Cron-style clearable eviction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="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"> |
| <th class="colFirst" scope="row"><a href="ConcurrentQueryCache.html" title="class in org.apache.openjpa.datacache">ConcurrentQueryCache</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="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"> |
| <th class="colFirst" scope="row"><a href="DataCacheManagerImpl.html" title="class in org.apache.openjpa.datacache">DataCacheManagerImpl</a></th> |
| <td class="colLast"> |
| <div class="block">Default data cache manager provides handle to utilities <a href="../enhance/PCDataGenerator.html" title="class in org.apache.openjpa.enhance">PCDataGenerator</a>, <a href="ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a> |
| and <a href="CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a> for the cache operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="../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"> |
| <th class="colFirst" scope="row"><a href="DataCachePCDataImpl.html" title="class in org.apache.openjpa.datacache">DataCachePCDataImpl</a></th> |
| <td class="colLast"> |
| <div class="block">Specialized <a href="../kernel/PCData.html" title="interface in org.apache.openjpa.kernel"><code>PCData</code></a> implementation for data caching.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataCacheStoreManager.html" title="class in org.apache.openjpa.datacache">DataCacheStoreManager</a></th> |
| <td class="colLast"> |
| <div class="block">StoreManager proxy that delegates to a data cache when possible.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">DefaultCacheDistributionPolicy</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="DelegatingDataCache.html" title="class in org.apache.openjpa.datacache">DelegatingDataCache</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="DelegatingQueryCache.html" title="class in org.apache.openjpa.datacache">DelegatingQueryCache</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="ExpirationEvent.html" title="class in org.apache.openjpa.datacache">ExpirationEvent</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="PartitionedDataCache.html" title="class in org.apache.openjpa.datacache">PartitionedDataCache</a></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="QueryCacheStoreQuery.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery</a></th> |
| <td class="colLast"> |
| <div class="block">A <a href="../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"> |
| <th class="colFirst" scope="row"><a href="QueryCacheStoreQuery.CachedList.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery.CachedList</a></th> |
| <td class="colLast"> |
| <div class="block">Result list implementation for a cached query result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QueryKey.html" title="class in org.apache.openjpa.datacache">QueryKey</a></th> |
| <td class="colLast"> |
| <div class="block">This class stores information about a particular invocation of |
| a query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="QueryResult.html" title="class in org.apache.openjpa.datacache">QueryResult</a></th> |
| <td class="colLast"> |
| <div class="block">A query result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="TypeBasedCacheDistributionPolicy.html" title="class in org.apache.openjpa.datacache">TypeBasedCacheDistributionPolicy</a></th> |
| <td class="colLast"> |
| <div class="block">A cache distribution policy based on the type of the managed objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TypesChangedEvent.html" title="class in org.apache.openjpa.datacache">TypesChangedEvent</a></th> |
| <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"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractQueryCache.EvictPolicy.html" title="enum in org.apache.openjpa.datacache">AbstractQueryCache.EvictPolicy</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataCacheMode.html" title="enum in org.apache.openjpa.datacache">DataCacheMode</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
