blob: d4a562ddc6b98f334e9795b83d01146e9a0a5f1d [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>PartitionedDataCache (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="PartitionedDataCache (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/PartitionedDataCache.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/ExpirationListener.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/PartitionedDataCache.html" target="_top">Frames</a></li>
<li><a href="PartitionedDataCache.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="#fields_inherited_from_class_org.apache.openjpa.datacache.ConcurrentDataCache">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>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 PartitionedDataCache" class="title">Class PartitionedDataCache</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><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">org.apache.openjpa.datacache.AbstractDataCache</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">org.apache.openjpa.datacache.ConcurrentDataCache</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.datacache.PartitionedDataCache</li>
</ul>
</li>
</ul>
</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/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event">RemoteCommitListener</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>
<hr>
<br>
<pre>public class <span class="strong">PartitionedDataCache</span>
extends <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></pre>
<div class="block">A partitioned data cache maintains a set of partitions that are DataCache themselves.
Each of the partitioned DataCaches can be individually configured.
However, all partitions must be of the same type. By default, this cache uses
<a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a> as its partitions.
<br>
This cache can be configured as a plug-in as follows:
<br>
<code>&lt;property name='openjpa.DataCache"
value="partitioned(name=X, PartitionType=concurrent,Partitions='(name=a,cacheSize=100),
(name=b,cacheSize=200)')</code>
<br>
Notice that the individual partition properties are enclosed parentheses, separated by comma
and finally the whole property string is enclosed in single quote.
Each partition must have a non-empty name that are unique among the partitions.
The <a href="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">policy</a> can return
the name of a partition to distribute the managed instances to be cached in respective partition.
The above configuration will configure a partitioned cache named <code>X</code> with two partitions named
<code>a</code> and <code>b</code> with cache size <code>100</code> and <code>200</code> respectively.
Besides the two partitions, this cache instance itself can store data and referred by its own name
(<code>X</code> in the above example).
<br></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Pinaki Poddar</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.datacache.PartitionedDataCache">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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.datacache.ConcurrentDataCache">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#_lru">_lru</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.datacache.AbstractDataCache">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_evictOnBulkUpdate">_evictOnBulkUpdate</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_excludedTypes">_excludedTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_includedTypes">_includedTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#_stats">_stats</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#conf">conf</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#log">log</a></code></li>
</ul>
<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/PartitionedDataCache.html#PartitionedDataCache()">PartitionedDataCache</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/PartitionedDataCache.html#endConfiguration()">endConfiguration</a></strong>()</code>
<div class="block">Invoked upon completion of bean property configuration for this object.</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/PartitionedDataCache.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/PartitionedDataCache.html#getPartitionNames()">getPartitionNames</a></strong>()</code>
<div class="block">Gets the name of the configured partitions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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/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/PartitionedDataCache.html#getPartitions()">getPartitions</a></strong>()</code>
<div class="block">Returns the individual partition configuration properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.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;mgr)</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="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.html#isPartitioned()">isPartitioned</a></strong>()</code>
<div class="block">Always returns true.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.html#setPartitions(java.lang.String)">setPartitions</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;parts)</code>
<div class="block">Set partitions from a String configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/datacache/PartitionedDataCache.html#setPartitionType(java.lang.String)">setPartitionType</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;type)</code>
<div class="block">Sets the type of the partitions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.datacache.ConcurrentDataCache">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#clearInternal()">clearInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#getCacheMap()">getCacheMap</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#getCacheSize()">getCacheSize</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#getInternal(java.lang.Object)">getInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#getLru()">getLru</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#getSoftReferenceSize()">getSoftReferenceSize</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#newCacheMap()">newCacheMap</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#pinInternal(java.lang.Object)">pinInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#putInternal(java.lang.Object,%20org.apache.openjpa.datacache.DataCachePCData)">putInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#recacheUpdates()">recacheUpdates</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#removeAllInternal(java.lang.Class,%20boolean)">removeAllInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#removeInternal(java.lang.Object)">removeInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#setCacheSize(int)">setCacheSize</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#setLru(boolean)">setLru</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#setSoftReferenceSize(int)">setSoftReferenceSize</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#unpinAll(java.lang.Class,%20boolean)">unpinAll</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#unpinInternal(java.lang.Object)">unpinInternal</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#writeLock()">writeLock</a>, <a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#writeUnlock()">writeUnlock</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.datacache.AbstractDataCache">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.datacache.<a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></h3>
<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#clear()">clear</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#close()">close</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#close(boolean)">close</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#commit(java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection)">commit</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#contains(java.lang.Object)">contains</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#containsAll(java.util.Collection)">containsAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#fireEvent(java.lang.Object,%20java.lang.Object)">fireEvent</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#get(java.lang.Object)">get</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getAll(java.util.List)">getAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getEnableStatistics()">getEnableStatistics</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getEvictionSchedule()">getEvictionSchedule</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getEvictOnBulkUpdate()">getEvictOnBulkUpdate</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getExcludedTypes()">getExcludedTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getName()">getName</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getStatistics()">getStatistics</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getTypes()">getTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#isClosed()">isClosed</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#keyRemoved(java.lang.Object,%20boolean)">keyRemoved</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pin(java.lang.Object)">pin</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinAll(java.lang.Class,%20boolean)">pinAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinAll(java.util.Collection)">pinAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#putAllInternal(java.util.Collection)">putAllInternal</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#remove(java.lang.Object)">remove</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAll(java.lang.Class,%20boolean)">removeAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAll(java.util.Collection)">removeAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllInternal(java.util.Collection)">removeAllInternal</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllTypeNamesInternal(java.util.Collection)">removeAllTypeNamesInternal</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#selectCache(org.apache.openjpa.kernel.OpenJPAStateManager)">selectCache</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEnableStatistics(boolean)">setEnableStatistics</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEvictionSchedule(java.lang.String)">setEvictionSchedule</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setEvictOnBulkUpdate(boolean)">setEvictOnBulkUpdate</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setExcludedTypes(java.util.Set)">setExcludedTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setExcludedTypes(java.lang.String)">setExcludedTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setName(java.lang.String)">setName</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setTypes(java.util.Set)">setTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#setTypes(java.lang.String)">setTypes</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#startConfiguration()">startConfiguration</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#toString()">toString</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpin(java.lang.Object)">unpin</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpinAll(java.util.Collection)">unpinAll</a>, <a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</a></code></li>
</ul>
<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.event.RemoteCommitListener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.event.<a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event">RemoteCommitListener</a></h3>
<code><a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</a>, <a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html#close()">close</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="PartitionedDataCache()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PartitionedDataCache</h4>
<pre>public&nbsp;PartitionedDataCache()</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.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;mgr)</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>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="setPartitionType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionType</h4>
<pre>public&nbsp;void&nbsp;setPartitionType(<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;type)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Sets the type of the partitions.
Each partition is a DataCache itself.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the name of the type that implements <a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a> interface.
Aliases such as <code>"concurrent"</code> is also recognized.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the given type is not resolvable to a loadable type.</dd></dl>
</li>
</ul>
<a name="setPartitions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitions</h4>
<pre>public&nbsp;void&nbsp;setPartitions(<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;parts)</pre>
<div class="block">Set partitions from a String configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</code> - a String of the form <code>(p1, p2, p3)</code> where p1, p2 etc. itself are plug-in strings
for individual Data Cache configuration.</dd></dl>
</li>
</ul>
<a name="getPartitions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitions</h4>
<pre>public&nbsp;<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/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getPartitions()</pre>
<div class="block">Returns the individual partition configuration properties.</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><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getPartition(java.lang.String,%20boolean)">getPartition</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</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">Gets the name of the configured 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><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getPartitionNames()">getPartitionNames</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</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 final&nbsp;boolean&nbsp;isPartitioned()</pre>
<div class="block">Always returns true.</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>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#isPartitioned()">isPartitioned</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></code></dd>
</dl>
</li>
</ul>
<a name="endConfiguration()">
<!-- -->
</a>
<ul class="blockListLast">
<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>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#endConfiguration()">endConfiguration</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/datacache/AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</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/PartitionedDataCache.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/ExpirationListener.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/datacache/PartitionedDataCache.html" target="_top">Frames</a></li>
<li><a href="PartitionedDataCache.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="#fields_inherited_from_class_org.apache.openjpa.datacache.ConcurrentDataCache">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>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>