blob: 6dcd3c31dce0752b2ba64f3e115242f5515b307b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>PartitionedDataCache (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="PartitionedDataCache (OpenJPA Parent POM 4.1.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.openjpa.datacache</a></div>
<h2 title="Class PartitionedDataCache" class="title">Class PartitionedDataCache</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../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="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">org.apache.openjpa.datacache.AbstractDataCache</a></li>
<li>
<ul class="inheritance">
<li><a href="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><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code>, <code><a href="../event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event">RemoteCommitListener</a></code>, <code><a href="../lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code>, <code><a href="../lib/util/Clearable.html" title="interface in org.apache.openjpa.lib.util">Clearable</a></code>, <code><a href="../lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code>, <code><a href="../lib/util/EventManager.html" title="interface in org.apache.openjpa.lib.util">EventManager</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PartitionedDataCache</span>
extends <a href="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="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="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="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pinaki Poddar</dd>
<dt><span class="seeLabel">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 =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.datacache.ConcurrentDataCache">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.datacache.<a href="ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></h3>
<code><a href="ConcurrentDataCache.html#_lru">_lru</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.datacache.AbstractDataCache">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.datacache.<a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></h3>
<code><a href="AbstractDataCache.html#_evictOnBulkUpdate">_evictOnBulkUpdate</a>, <a href="AbstractDataCache.html#_excludedTypes">_excludedTypes</a>, <a href="AbstractDataCache.html#_includedTypes">_includedTypes</a>, <a href="AbstractDataCache.html#_stats">_stats</a>, <a href="AbstractDataCache.html#conf">conf</a>, <a href="AbstractDataCache.html#log">log</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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="../lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a></h3>
<code><a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#_listeners">_listeners</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.datacache.DataCache">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.datacache.<a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></h3>
<code><a href="DataCache.html#NAME_DEFAULT">NAME_DEFAULT</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">PartitionedDataCache</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endConfiguration()">endConfiguration</a></span>()</code></th>
<td class="colLast">
<div class="block">Invoked upon completion of bean property configuration for this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartition(java.lang.String,boolean)">getPartition</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
boolean&nbsp;create)</code></th>
<td class="colLast">
<div class="block">Gets the named partition.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionNames()">getPartitionNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the name of the configured partitions.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitions()">getPartitions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the individual partition configuration properties.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></span>&#8203;(<a href="DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>&nbsp;mgr)</code></th>
<td class="colLast">
<div class="block">Initialize any resources associated with the given
<a href="DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><code>DataCacheManager</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPartitioned()">isPartitioned</a></span>()</code></th>
<td class="colLast">
<div class="block">Always returns true.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPartitions(java.lang.String)">setPartitions</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parts)</code></th>
<td class="colLast">
<div class="block">Set partitions from a String configuration.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPartitionType(java.lang.String)">setPartitionType</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Sets the type of the partitions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.datacache.ConcurrentDataCache">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.datacache.<a href="ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></h3>
<code><a href="ConcurrentDataCache.html#clearInternal()">clearInternal</a>, <a href="ConcurrentDataCache.html#getCacheMap()">getCacheMap</a>, <a href="ConcurrentDataCache.html#getCacheSize()">getCacheSize</a>, <a href="ConcurrentDataCache.html#getInternal(java.lang.Object)">getInternal</a>, <a href="ConcurrentDataCache.html#getLru()">getLru</a>, <a href="ConcurrentDataCache.html#getSoftReferenceSize()">getSoftReferenceSize</a>, <a href="ConcurrentDataCache.html#newCacheMap()">newCacheMap</a>, <a href="ConcurrentDataCache.html#pinInternal(java.lang.Object)">pinInternal</a>, <a href="ConcurrentDataCache.html#putInternal(java.lang.Object,org.apache.openjpa.datacache.DataCachePCData)">putInternal</a>, <a href="ConcurrentDataCache.html#recacheUpdates()">recacheUpdates</a>, <a href="ConcurrentDataCache.html#removeAllInternal(java.lang.Class,boolean)">removeAllInternal</a>, <a href="ConcurrentDataCache.html#removeInternal(java.lang.Object)">removeInternal</a>, <a href="ConcurrentDataCache.html#setCacheSize(int)">setCacheSize</a>, <a href="ConcurrentDataCache.html#setLru(boolean)">setLru</a>, <a href="ConcurrentDataCache.html#setSoftReferenceSize(int)">setSoftReferenceSize</a>, <a href="ConcurrentDataCache.html#unpinAll(java.lang.Class,boolean)">unpinAll</a>, <a href="ConcurrentDataCache.html#unpinInternal(java.lang.Object)">unpinInternal</a>, <a href="ConcurrentDataCache.html#writeLock()">writeLock</a>, <a href="ConcurrentDataCache.html#writeUnlock()">writeUnlock</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.datacache.AbstractDataCache">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.datacache.<a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></h3>
<code><a href="AbstractDataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</a>, <a href="AbstractDataCache.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</a>, <a href="AbstractDataCache.html#clear()">clear</a>, <a href="AbstractDataCache.html#close()">close</a>, <a href="AbstractDataCache.html#close(boolean)">close</a>, <a href="AbstractDataCache.html#commit(java.util.Collection,java.util.Collection,java.util.Collection,java.util.Collection)">commit</a>, <a href="AbstractDataCache.html#contains(java.lang.Object)">contains</a>, <a href="AbstractDataCache.html#containsAll(java.util.Collection)">containsAll</a>, <a href="AbstractDataCache.html#fireEvent(java.lang.Object,java.lang.Object)">fireEvent</a>, <a href="AbstractDataCache.html#get(java.lang.Object)">get</a>, <a href="AbstractDataCache.html#getAll(java.util.List)">getAll</a>, <a href="AbstractDataCache.html#getEnableStatistics()">getEnableStatistics</a>, <a href="AbstractDataCache.html#getEvictionSchedule()">getEvictionSchedule</a>, <a href="AbstractDataCache.html#getEvictOnBulkUpdate()">getEvictOnBulkUpdate</a>, <a href="AbstractDataCache.html#getExcludedTypes()">getExcludedTypes</a>, <a href="AbstractDataCache.html#getName()">getName</a>, <a href="AbstractDataCache.html#getStatistics()">getStatistics</a>, <a href="AbstractDataCache.html#getTypes()">getTypes</a>, <a href="AbstractDataCache.html#isClosed()">isClosed</a>, <a href="AbstractDataCache.html#keyRemoved(java.lang.Object,boolean)">keyRemoved</a>, <a href="AbstractDataCache.html#pin(java.lang.Object)">pin</a>, <a href="AbstractDataCache.html#pinAll(java.lang.Class,boolean)">pinAll</a>, <a href="AbstractDataCache.html#pinAll(java.util.Collection)">pinAll</a>, <a href="AbstractDataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</a>, <a href="AbstractDataCache.html#putAllInternal(java.util.Collection)">putAllInternal</a>, <a href="AbstractDataCache.html#remove(java.lang.Object)">remove</a>, <a href="AbstractDataCache.html#removeAll(java.lang.Class,boolean)">removeAll</a>, <a href="AbstractDataCache.html#removeAll(java.util.Collection)">removeAll</a>, <a href="AbstractDataCache.html#removeAllInternal(java.util.Collection)">removeAllInternal</a>, <a href="AbstractDataCache.html#removeAllTypeNamesInternal(java.util.Collection)">removeAllTypeNamesInternal</a>, <a href="AbstractDataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</a>, <a href="AbstractDataCache.html#selectCache(org.apache.openjpa.kernel.OpenJPAStateManager)">selectCache</a>, <a href="AbstractDataCache.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</a>, <a href="AbstractDataCache.html#setEnableStatistics(boolean)">setEnableStatistics</a>, <a href="AbstractDataCache.html#setEvictionSchedule(java.lang.String)">setEvictionSchedule</a>, <a href="AbstractDataCache.html#setEvictOnBulkUpdate(boolean)">setEvictOnBulkUpdate</a>, <a href="AbstractDataCache.html#setExcludedTypes(java.lang.String)">setExcludedTypes</a>, <a href="AbstractDataCache.html#setExcludedTypes(java.util.Set)">setExcludedTypes</a>, <a href="AbstractDataCache.html#setName(java.lang.String)">setName</a>, <a href="AbstractDataCache.html#setTypes(java.lang.String)">setTypes</a>, <a href="AbstractDataCache.html#setTypes(java.util.Set)">setTypes</a>, <a href="AbstractDataCache.html#startConfiguration()">startConfiguration</a>, <a href="AbstractDataCache.html#toString()">toString</a>, <a href="AbstractDataCache.html#unpin(java.lang.Object)">unpin</a>, <a href="AbstractDataCache.html#unpinAll(java.util.Collection)">unpinAll</a>, <a href="AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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="../lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</a></h3>
<code><a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#addListener(java.lang.Object)">addListener</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object)">fireEvent</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#getListeners()">getListeners</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#hasListener(java.lang.Object)">hasListener</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#hasListeners()">hasListeners</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#isFailFast()">isFailFast</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#newListenerCollection()">newListenerCollection</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#removeListener(java.lang.Object)">removeListener</a>, <a href="../lib/util/concurrent/AbstractConcurrentEventManager.html#setFailFast(boolean)">setFailFast</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.event.RemoteCommitListener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.event.<a href="../event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event">RemoteCommitListener</a></h3>
<code><a href="../event/RemoteCommitListener.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</a>, <a href="../event/RemoteCommitListener.html#close()">close</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PartitionedDataCache</h4>
<pre>public&nbsp;PartitionedDataCache()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initialize(org.apache.openjpa.datacache.DataCacheManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initialize&#8203;(<a href="DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>&nbsp;mgr)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">DataCache</a></code></span></div>
<div class="block">Initialize any resources associated with the given
<a href="DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><code>DataCacheManager</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="ConcurrentDataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</a></code>&nbsp;in class&nbsp;<code><a href="ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</a></code></dd>
</dl>
</li>
</ul>
<a id="setPartitionType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionType</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPartitionType&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;type)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<div class="block">Sets the type of the partitions.
Each partition is a DataCache itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - the name of the type that implements <a href="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="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if the given type is not resolvable to a loadable type.</dd>
</dl>
</li>
</ul>
<a id="setPartitions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPartitions&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parts)</pre>
<div class="block">Set partitions from a String configuration.</div>
<dl>
<dt><span class="paramLabel">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 id="getPartitions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitions</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;getPartitions()</pre>
<div class="block">Returns the individual partition configuration properties.</div>
</li>
</ul>
<a id="getPartition(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartition</h4>
<pre class="methodSignature">public&nbsp;<a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;getPartition&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
boolean&nbsp;create)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCache.html#getPartition(java.lang.String,boolean)">DataCache</a></code></span></div>
<div class="block">Gets the named partition. Note that a partition itself is another cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCache.html#getPartition(java.lang.String,boolean)">getPartition</a></code>&nbsp;in interface&nbsp;<code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractDataCache.html#getPartition(java.lang.String,boolean)">getPartition</a></code>&nbsp;in class&nbsp;<code><a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></code></dd>
<dt><span class="paramLabel">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="returnLabel">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 id="getPartitionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionNames</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;getPartitionNames()</pre>
<div class="block">Gets the name of the configured partitions.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCache.html#getPartitionNames()">getPartitionNames</a></code>&nbsp;in interface&nbsp;<code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractDataCache.html#getPartitionNames()">getPartitionNames</a></code>&nbsp;in class&nbsp;<code><a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>empty set if no partition exists.</dd>
</dl>
</li>
</ul>
<a id="isPartitioned()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartitioned</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isPartitioned()</pre>
<div class="block">Always returns true.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCache.html#isPartitioned()">isPartitioned</a></code>&nbsp;in interface&nbsp;<code><a href="DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractDataCache.html#isPartitioned()">isPartitioned</a></code>&nbsp;in class&nbsp;<code><a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></code></dd>
</dl>
</li>
</ul>
<a id="endConfiguration()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>endConfiguration</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;endConfiguration()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../lib/conf/Configurable.html#endConfiguration()">Configurable</a></code></span></div>
<div class="block">Invoked upon completion of bean property configuration for this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../lib/conf/Configurable.html#endConfiguration()">endConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractDataCache.html#endConfiguration()">endConfiguration</a></code>&nbsp;in class&nbsp;<code><a href="AbstractDataCache.html" title="class in org.apache.openjpa.datacache">AbstractDataCache</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>