Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / datacache / DataCacheManagerImpl.html
blob: eac8198e450b58d2cf500a5b6c587777bc28dbaa [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:28 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataCacheManagerImpl (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataCacheManagerImpl (OpenJPA Parent POM 2.4.2 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><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/DataCacheManagerImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/DataCacheMode.html" title="enum 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/DataCacheManagerImpl.html" target="_top">Frames</a></li>
<li><a href="DataCacheManagerImpl.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>Field&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>Field&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 DataCacheManagerImpl" class="title">Class DataCacheManagerImpl</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>org.apache.openjpa.datacache.DataCacheManagerImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DataCacheManagerImpl</span>
extends <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>
implements <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a>, <a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></pre>
<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. This implementation also determines whether a
managed type is eligible to cache.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White, Patrick Linskey, Pinaki Poddar</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&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/DataCacheManagerImpl.html#DataCacheManagerImpl()">DataCacheManagerImpl</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/DataCacheManagerImpl.html#close()">close</a></strong>()</code>
<div class="block">Close all caches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getClearableScheduler()">getClearableScheduler</a></strong>()</code>
<div class="block">Return the runnable which schedules evictions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getDataCache(java.lang.String)">getDataCache</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">Return the named data cache, or null if it does not exist.</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/DataCacheManagerImpl.html#getDataCache(java.lang.String,%20boolean)">getDataCache</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">Returns the named cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getDistributionPolicy()">getDistributionPolicy</a></strong>()</code>
<div class="block">Gets the instance-based cache distribution policy, if configured.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getPCDataGenerator()">getPCDataGenerator</a></strong>()</code>
<div class="block">Return the PCData generator if configured.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getSystemDataCache()">getSystemDataCache</a></strong>()</code>
<div class="block">Return the system-wide data cache, or null if caching is not enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#getSystemQueryCache()">getSystemQueryCache</a></strong>()</code>
<div class="block">Return the system query cache, or null if not configured.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#initialize(org.apache.openjpa.conf.OpenJPAConfiguration,%20org.apache.openjpa.lib.conf.ObjectValue,%20org.apache.openjpa.lib.conf.ObjectValue)">initialize</a></strong>(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a>&nbsp;conf,
<a href="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</a>&nbsp;dataCache,
<a href="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</a>&nbsp;queryCache)</code>
<div class="block">Initialize the manager, supplying the cache configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#isCachable(org.apache.openjpa.meta.ClassMetaData)">isCachable</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta)</code>
<div class="block">Affirms if the given type is eligible for cache.</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#listKnownTypes()">listKnownTypes</a></strong>()</code>
<div class="block">Returns the names of classes that are known to the cache and whether or not they are currently being cached.</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/DataCacheManagerImpl.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>
<div class="block">Select cache for the given managed instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#setTypes(java.util.Set,%20java.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;includedTypes,
<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;excludedTypes)</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/DataCacheManagerImpl.html#startCaching(java.lang.String)">startCaching</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;cls)</code>
<div class="block">Start caching the type matching the provided class name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html#stopCaching(java.lang.String)">stopCaching</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;cls)</code>
<div class="block">Stop caching the type matching the provided class name.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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#toString()" title="class or interface in java.lang">toString</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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataCacheManagerImpl()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataCacheManagerImpl</h4>
<pre>public&nbsp;DataCacheManagerImpl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initialize(org.apache.openjpa.conf.OpenJPAConfiguration, org.apache.openjpa.lib.conf.ObjectValue, org.apache.openjpa.lib.conf.ObjectValue)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a>&nbsp;conf,
<a href="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</a>&nbsp;dataCache,
<a href="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</a>&nbsp;queryCache)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#initialize(org.apache.openjpa.conf.OpenJPAConfiguration,%20org.apache.openjpa.lib.conf.ObjectValue,%20org.apache.openjpa.lib.conf.ObjectValue)">DataCacheManager</a></code></strong></div>
<div class="block">Initialize the manager, supplying the cache configuration.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#initialize(org.apache.openjpa.conf.OpenJPAConfiguration,%20org.apache.openjpa.lib.conf.ObjectValue,%20org.apache.openjpa.lib.conf.ObjectValue)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getSystemDataCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemDataCache</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;getSystemDataCache()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemDataCache()">DataCacheManager</a></code></strong></div>
<div class="block">Return the system-wide data cache, or null if caching is not enabled.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemDataCache()">getSystemDataCache</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getDataCache(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataCache</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;getDataCache(<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/DataCacheManager.html#getDataCache(java.lang.String)">DataCacheManager</a></code></strong></div>
<div class="block">Return the named data cache, or null if it does not exist.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDataCache(java.lang.String)">getDataCache</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getDataCache(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataCache</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;getDataCache(<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">Returns the named cache.
If the given name is name or the name of the cache plugin then returns the main cache.
Otherwise, <a href="../../../../org/apache/openjpa/datacache/DataCache.html#getPartition(java.lang.String,%20boolean)">delegates</a> to the main cache
to obtain a partition.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDataCache(java.lang.String,%20boolean)">getDataCache</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
<dd><code>create</code> - if true, the cache will be created if it does
not already exist</dd></dl>
</li>
</ul>
<a name="getSystemQueryCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemQueryCache</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a>&nbsp;getSystemQueryCache()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemQueryCache()">DataCacheManager</a></code></strong></div>
<div class="block">Return the system query cache, or null if not configured.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemQueryCache()">getSystemQueryCache</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getPCDataGenerator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPCDataGenerator</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</a>&nbsp;getPCDataGenerator()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getPCDataGenerator()">DataCacheManager</a></code></strong></div>
<div class="block">Return the PCData generator if configured.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getPCDataGenerator()">getPCDataGenerator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="getClearableScheduler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClearableScheduler</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/ClearableScheduler.html" title="class in org.apache.openjpa.datacache">ClearableScheduler</a>&nbsp;getClearableScheduler()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getClearableScheduler()">DataCacheManager</a></code></strong></div>
<div class="block">Return the runnable which schedules evictions.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getClearableScheduler()">getClearableScheduler</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</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/DataCacheManager.html#close()">DataCacheManager</a></code></strong></div>
<div class="block">Close all caches.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</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="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>
<div class="block">Select cache for the given managed instance.
If type based verification affirms the type to be cached then the instance based policy
is called to determine the target cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#selectCache(org.apache.openjpa.kernel.OpenJPAStateManager)">selectCache</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sm</code> - the managed proxy instance</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cache that will store the state of the given managed instance.</dd></dl>
</li>
</ul>
<a name="getDistributionPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistributionPolicy</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">CacheDistributionPolicy</a>&nbsp;getDistributionPolicy()</pre>
<div class="block">Gets the instance-based cache distribution policy, if configured.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDistributionPolicy()">getDistributionPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="isCachable(org.apache.openjpa.meta.ClassMetaData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCachable</h4>
<pre>public&nbsp;boolean&nbsp;isCachable(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta)</pre>
<div class="block">Affirms if the given type is eligible for cache.</div>
</li>
</ul>
<a name="setTypes(java.util.Set, 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;includedTypes,
<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;excludedTypes)</pre>
</li>
</ul>
<a name="startCaching(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startCaching</h4>
<pre>public&nbsp;void&nbsp;startCaching(<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;cls)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#startCaching(java.lang.String)">DataCacheManager</a></code></strong></div>
<div class="block">Start caching the type matching the provided class name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#startCaching(java.lang.String)">startCaching</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="stopCaching(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopCaching</h4>
<pre>public&nbsp;void&nbsp;stopCaching(<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;cls)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#stopCaching(java.lang.String)">DataCacheManager</a></code></strong></div>
<div class="block">Stop caching the type matching the provided class name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#stopCaching(java.lang.String)">stopCaching</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
<a name="listKnownTypes()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>listKnownTypes</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/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;listKnownTypes()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#listKnownTypes()">DataCacheManager</a></code></strong></div>
<div class="block">Returns the names of classes that are known to the cache and whether or not they are currently being cached.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html#listKnownTypes()">listKnownTypes</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataCacheManagerImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/DataCacheMode.html" title="enum 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/DataCacheManagerImpl.html" target="_top">Frames</a></li>
<li><a href="DataCacheManagerImpl.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>Field&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>Field&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;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>