| <!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>FieldPartitioningPolicy (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="FieldPartitioningPolicy (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/CustomPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/HashPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" target="_top">Frames</a></li> |
| <li><a href="FieldPartitioningPolicy.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 FieldPartitioningPolicy" class="title">Class FieldPartitioningPolicy</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>org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/HashPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">HashPartitioningPolicy</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/RangePartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">RangePartitioningPolicy</a>, <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/ValuePartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">ValuePartitioningPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">FieldPartitioningPolicy</span> |
| extends <a href="../../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></pre> |
| <div class="block">PUBLIC: |
| FieldPartitioningPolicy partitions access to a database cluster by a field value from the object, |
| such as the object's id, location, or tenant. |
| 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.FieldPartitioningPolicy">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"> </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 org.eclipse.persistence.internal.helper.DatabaseField</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#partitionField">partitionField</a></span></code> |
| <div class="block">The column to partition by.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#unionUnpartitionableQueries">unionUnpartitionableQueries</a></span></code> |
| <div class="block">If query does not have the partition field in it, should the query be sent to all databases.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class 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"> </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/FieldPartitioningPolicy.html#FieldPartitioningPolicy--">FieldPartitioningPolicy</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#FieldPartitioningPolicy-java.lang.String-">FieldPartitioningPolicy</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> partitionField)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#FieldPartitioningPolicy-java.lang.String-boolean-">FieldPartitioningPolicy</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> partitionField, |
| boolean unionUnpartitionableQueries)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>protected <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span>(org.eclipse.persistence.internal.sessions.AbstractSession 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> object, |
| <a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</code> |
| <div class="block">INTERNAL: |
| If persist should be partitioned, extra value from object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseField</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#getPartitionField--">getPartitionField</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the database column or query parameter to partition queries by.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/FieldPartitioningPolicy.html#getPartitionFieldName--">getPartitionFieldName</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the database column or query parameter to partition queries by.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#getUnionUnpartitionableQueries--">getUnionUnpartitionableQueries</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return if queries that do not contain the partition field should be sent |
| to every database and have the result unioned.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setPartitionField-org.eclipse.persistence.internal.helper.DatabaseField-">setPartitionField</a></span>(org.eclipse.persistence.internal.helper.DatabaseField partitionField)</code> |
| <div class="block">PUBLIC: |
| Set the database column or query parameter to partition queries by.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setPartitionField-java.lang.String-">setPartitionField</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> partitionField)</code> |
| <div class="block">PUBLIC: |
| Set the database column or query parameter to partition queries by.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html#setUnionUnpartitionableQueries-boolean-">setUnionUnpartitionableQueries</a></span>(boolean unionUnpartitionableQueries)</code> |
| <div class="block">PUBLIC: |
| Set if queries that do not contain the partition field should be sent |
| to every database and have the result unioned.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</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#getConnectionsForQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">getConnectionsForQuery</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#partitionPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-">partitionPersist</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 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="partitionField"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partitionField</h4> |
| <pre>protected org.eclipse.persistence.internal.helper.DatabaseField partitionField</pre> |
| <div class="block">The column to partition by.</div> |
| </li> |
| </ul> |
| <a name="unionUnpartitionableQueries"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>unionUnpartitionableQueries</h4> |
| <pre>protected boolean unionUnpartitionableQueries</pre> |
| <div class="block">If query does not have the partition field in it, should the query be sent to all databases.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FieldPartitioningPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FieldPartitioningPolicy</h4> |
| <pre>public FieldPartitioningPolicy()</pre> |
| </li> |
| </ul> |
| <a name="FieldPartitioningPolicy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FieldPartitioningPolicy</h4> |
| <pre>public FieldPartitioningPolicy(<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> partitionField)</pre> |
| </li> |
| </ul> |
| <a name="FieldPartitioningPolicy-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FieldPartitioningPolicy</h4> |
| <pre>public FieldPartitioningPolicy(<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> partitionField, |
| boolean 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="getPartitionField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionField</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseField getPartitionField()</pre> |
| <div class="block">PUBLIC: |
| Return the database column or query parameter to partition queries by. |
| This is the table column name, not the class attribute name. |
| The column value must be included in the query and should normally be part of the object's Id. |
| This can also be the name of a query parameter. |
| If a query does not contain the field the query will not be partitioned.</div> |
| </li> |
| </ul> |
| <a name="setPartitionField-org.eclipse.persistence.internal.helper.DatabaseField-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitionField</h4> |
| <pre>public void setPartitionField(org.eclipse.persistence.internal.helper.DatabaseField partitionField)</pre> |
| <div class="block">PUBLIC: |
| Set the database column or query parameter to partition queries by. |
| This is the table column name, not the class attribute name. |
| The column value must be included in the query and should normally be part of the object's Id. |
| This can also be the name of a query parameter. |
| If a query does not contain the field the query will not be partitioned.</div> |
| </li> |
| </ul> |
| <a name="getPartitionFieldName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionFieldName</h4> |
| <pre>public <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> getPartitionFieldName()</pre> |
| <div class="block">PUBLIC: |
| Return the database column or query parameter to partition queries by. |
| This is the table column name, not the class attribute name. |
| The column value must be included in the query and should normally be part of the object's Id. |
| This can also be the name of a query parameter. |
| If a query does not contain the field the query will not be partitioned.</div> |
| </li> |
| </ul> |
| <a name="setPartitionField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitionField</h4> |
| <pre>public void setPartitionField(<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> partitionField)</pre> |
| <div class="block">PUBLIC: |
| Set the database column or query parameter to partition queries by. |
| This is the table column name, not the class attribute name. |
| The column value must be included in the query and should normally be part of the object's Id. |
| This can also be the name of a query parameter. |
| If a query does not contain the field the query will not be partitioned.</div> |
| </li> |
| </ul> |
| <a name="getUnionUnpartitionableQueries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnionUnpartitionableQueries</h4> |
| <pre>public boolean getUnionUnpartitionableQueries()</pre> |
| <div class="block">PUBLIC: |
| Return if queries that do not contain the partition field should be sent |
| to every database and have the result unioned.</div> |
| </li> |
| </ul> |
| <a name="setUnionUnpartitionableQueries-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUnionUnpartitionableQueries</h4> |
| <pre>public void setUnionUnpartitionableQueries(boolean unionUnpartitionableQueries)</pre> |
| <div class="block">PUBLIC: |
| Set if queries that do not contain the partition field should be sent |
| to every database and have the result unioned.</div> |
| </li> |
| </ul> |
| <a name="extractPartitionValueForPersist-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Object-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>extractPartitionValueForPersist</h4> |
| <pre>protected <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> extractPartitionValueForPersist(org.eclipse.persistence.internal.sessions.AbstractSession 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> object, |
| <a href="../../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</pre> |
| <div class="block">INTERNAL: |
| If persist should be partitioned, extra value from object.</div> |
| </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/CustomPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/descriptors/partitioning/HashPartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/descriptors/partitioning/FieldPartitioningPolicy.html" target="_top">Frames</a></li> |
| <li><a href="FieldPartitioningPolicy.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
