blob: 429cfd21f7800ad3f8303e7692633cf94f815568 [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 (1.8.0_252) on Fri Jul 16 09:39:12 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ValuePartitioningPolicy (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ValuePartitioningPolicy (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/UnionPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html" target="_top">Frames</a></li>
<li><a href="ValuePartitioningPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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><a href="#field.detail">Field</a>&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.eclipse.persistence.descriptors.partitioning</div>
<h2 title="Class ValuePartitioningPolicy" class="title">Class ValuePartitioningPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.descriptors.partitioning.ValuePartitioningPolicy</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="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ValuePartitioningPolicy</span>
extends <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">FieldPartitioningPolicy</a></pre>
<div class="block">PUBLIC:
ValuePartitioningPolicy partitions access to a database cluster by a field value from the object,
such as the object's location, or tenant.
Each value is assigned a specific server.
All write or read request for object's with that value are sent to the server.
If a query does not include the field as a parameter, then it can either be sent
to all server's and unioned, or left to the sesion's default behavior.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.descriptors.partitioning.ValuePartitioningPolicy">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>James Sutherland</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EclipseLink 2.2</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#defaultConnectionPool">defaultConnectionPool</a></span></code>
<div class="block">The default connection pool is used for any unmapped values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#orderedPartitions">orderedPartitions</a></span></code>
<div class="block">Use to track order for compute UCP index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#partitionNames">partitionNames</a></span></code>
<div class="block">Store the value partitions by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#partitions">partitions</a></span></code>
<div class="block">Store the value partitions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#partitionValueType">partitionValueType</a></span></code>
<div class="block">The type of the partition values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#partitionValueTypeName">partitionValueTypeName</a></span></code>
<div class="block">The type name of the partition value names.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.descriptors.partitioning.<a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">FieldPartitioningPolicy</a></h3>
<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#partitionField">partitionField</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#unionUnpartitionableQueries">unionUnpartitionableQueries</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.descriptors.partitioning.<a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></h3>
<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#name">name</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#ValuePartitioningPolicy--">ValuePartitioningPolicy</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#ValuePartitioningPolicy-java.lang.String-">ValuePartitioningPolicy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionField)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#ValuePartitioningPolicy-java.lang.String-boolean-">ValuePartitioningPolicy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionField,
boolean&nbsp;unionUnpartitionableQueries)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#addPartition-java.lang.Object-java.lang.String-">addPartition</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionPool)</code>
<div class="block">PUBLIC:
Add the value partition.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#addPartitionName-java.lang.String-java.lang.String-">addPartitionName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;valueName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionPool)</code>
<div class="block">INTERNAL:
Add partition values by name (will be initialized at runtime with the
real class loader).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</code>
<div class="block">INTERNAL:
Convert all the class-name-based settings to actual class-based settings.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#getConnectionsForQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">getConnectionsForQuery</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="../../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;arguments)</code>
<div class="block">INTERNAL:
Get a connection from one of the pools in a round robin rotation fashion.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#getDefaultConnectionPool--">getDefaultConnectionPool</a></span>()</code>
<div class="block">PUBLIC:
Return the default connection pool used for any unmapped values.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#getOrderedPartitions--">getOrderedPartitions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#getPartitions--">getPartitions</a></span>()</code>
<div class="block">PUBLIC:
Return the value partitions.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#partitionPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-">partitionPersist</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor)</code>
<div class="block">INTERNAL:
Allow for the persist call to assign the partition.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#setDefaultConnectionPool-java.lang.String-">setDefaultConnectionPool</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultConnectionPool)</code>
<div class="block">PUBLIC:
Set the default connection pool used for any unmapped values.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#setOrderedPartitions-java.util.List-">setOrderedPartitions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;orderedPartitions)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#setPartitions-java.util.Map-">setPartitions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;partitions)</code>
<div class="block">PUBLIC:
Set the value partitions.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html#setPartitionValueTypeName-java.lang.String-">setPartitionValueTypeName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionValueTypeName)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.descriptors.partitioning.<a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">FieldPartitioningPolicy</a></h3>
<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#extractPartitionValueForPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-">extractPartitionValueForPersist</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#getPartitionField--">getPartitionField</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#getPartitionFieldName--">getPartitionFieldName</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#getUnionUnpartitionableQueries--">getUnionUnpartitionableQueries</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setPartitionField-org.eclipse.persistence.internal.helper.DatabaseField-">setPartitionField</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setPartitionField-java.lang.String-">setPartitionField</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setUnionUnpartitionableQueries-boolean-">setUnionUnpartitionableQueries</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.descriptors.partitioning.<a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></h3>
<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#acquireAccessor-java.lang.String-org.eclipse.persistence.sessions.server.ServerSession-org.eclipse.persistence.queries.DatabaseQuery-boolean-">acquireAccessor</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#getAccessor-java.lang.String-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.DatabaseQuery-boolean-">getAccessor</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#getName--">getName</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#setName-java.lang.String-">setName</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="partitions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitions</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; partitions</pre>
<div class="block">Store the value partitions. Each partition maps a value to a connectionPool.</div>
</li>
</ul>
<a name="partitionNames">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitionNames</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; partitionNames</pre>
<div class="block">Store the value partitions by name. Initialized at runtime.</div>
</li>
</ul>
<a name="partitionValueTypeName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitionValueTypeName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> partitionValueTypeName</pre>
<div class="block">The type name of the partition value names. Initialized at runtime</div>
</li>
</ul>
<a name="partitionValueType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitionValueType</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> partitionValueType</pre>
<div class="block">The type of the partition values. Initialized from the type name at runtime.</div>
</li>
</ul>
<a name="orderedPartitions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderedPartitions</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt; orderedPartitions</pre>
<div class="block">Use to track order for compute UCP index.</div>
</li>
</ul>
<a name="defaultConnectionPool">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultConnectionPool</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> defaultConnectionPool</pre>
<div class="block">The default connection pool is used for any unmapped values.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ValuePartitioningPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ValuePartitioningPolicy</h4>
<pre>public&nbsp;ValuePartitioningPolicy()</pre>
</li>
</ul>
<a name="ValuePartitioningPolicy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ValuePartitioningPolicy</h4>
<pre>public&nbsp;ValuePartitioningPolicy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionField)</pre>
</li>
</ul>
<a name="ValuePartitioningPolicy-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ValuePartitioningPolicy</h4>
<pre>public&nbsp;ValuePartitioningPolicy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionField,
boolean&nbsp;unionUnpartitionableQueries)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="convertClassNamesToClasses-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertClassNamesToClasses</h4>
<pre>public&nbsp;void&nbsp;convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;classLoader)</pre>
<div class="block">INTERNAL:
Convert all the class-name-based settings to actual class-based settings.
This method is used when converting a project that has been built with
class names to a project with classes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="setPartitionValueTypeName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionValueTypeName</h4>
<pre>public&nbsp;void&nbsp;setPartitionValueTypeName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;partitionValueTypeName)</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="getOrderedPartitions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderedPartitions</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getOrderedPartitions()</pre>
</li>
</ul>
<a name="setOrderedPartitions-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrderedPartitions</h4>
<pre>public&nbsp;void&nbsp;setOrderedPartitions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;orderedPartitions)</pre>
</li>
</ul>
<a name="getDefaultConnectionPool--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultConnectionPool</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDefaultConnectionPool()</pre>
<div class="block">PUBLIC:
Return the default connection pool used for any unmapped values.</div>
</li>
</ul>
<a name="setDefaultConnectionPool-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultConnectionPool</h4>
<pre>public&nbsp;void&nbsp;setDefaultConnectionPool(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultConnectionPool)</pre>
<div class="block">PUBLIC:
Set the default connection pool used for any unmapped values.</div>
</li>
</ul>
<a name="getPartitions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitions</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/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">PUBLIC:
Return the value partitions.
Each partition maps a value to a connectionPool.</div>
</li>
</ul>
<a name="setPartitions-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitions</h4>
<pre>public&nbsp;void&nbsp;setPartitions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;partitions)</pre>
<div class="block">PUBLIC:
Set the value partitions.
Each partition maps a value to a connectionPool.</div>
</li>
</ul>
<a name="addPartition-java.lang.Object-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPartition</h4>
<pre>public&nbsp;void&nbsp;addPartition(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionPool)</pre>
<div class="block">PUBLIC:
Add the value partition.</div>
</li>
</ul>
<a name="addPartitionName-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPartitionName</h4>
<pre>public&nbsp;void&nbsp;addPartitionName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;valueName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connectionPool)</pre>
<div class="block">INTERNAL:
Add partition values by name (will be initialized at runtime with the
real class loader).</div>
</li>
</ul>
<a name="getConnectionsForQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionsForQuery</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;&nbsp;getConnectionsForQuery(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="../../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;arguments)</pre>
<div class="block">INTERNAL:
Get a connection from one of the pools in a round robin rotation fashion.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#getConnectionsForQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">getConnectionsForQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="partitionPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>partitionPersist</h4>
<pre>public&nbsp;void&nbsp;partitionPersist(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object,
<a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&nbsp;descriptor)</pre>
<div class="block">INTERNAL:
Allow for the persist call to assign the partition.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html#partitionPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-">partitionPersist</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/UnionPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html" target="_top">Frames</a></li>
<li><a href="ValuePartitioningPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<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><a href="#field.detail">Field</a>&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; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>