| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:50 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SliceImplHelper (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SliceImplHelper (OpenJPA Parent POM 2.4.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SliceImplHelper.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/slice/Slice.Status.html" title="enum in org.apache.openjpa.slice"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/slice/SliceImplHelper.html" target="_top">Frames</a></li> |
| <li><a href="SliceImplHelper.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>Field | </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>Field | </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.apache.openjpa.slice</div> |
| <h2 title="Class SliceImplHelper" class="title">Class SliceImplHelper</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.slice.SliceImplHelper</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SliceImplHelper</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Utility methods to determine the target slices for a persistence capable |
| instance by calling back to user-specified distribution policy.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Pinaki Poddar</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#SliceImplHelper()">SliceImplHelper</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#getSliceInfo(org.apache.openjpa.kernel.OpenJPAStateManager)">getSliceInfo</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</code> |
| <div class="block">Gets the assigned slice information, if any, from the given StateManager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#getSlicesByPolicy(java.lang.Object,%20org.apache.openjpa.slice.DistributedConfiguration,%20java.lang.Object)">getSlicesByPolicy</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pc, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> ctx)</code> |
| <div class="block">Gets the target slices by calling user-specified <a href="../../../../org/apache/openjpa/slice/DistributionPolicy.html" title="interface in org.apache.openjpa.slice"><code>DistributionPolicy</code></a> or <a href="../../../../org/apache/openjpa/slice/ReplicationPolicy.html" title="interface in org.apache.openjpa.slice"><code>ReplicationPolicy</code></a> |
| depending on whether the given instance is <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html#isReplicated(java.lang.Class)"><code>replicated</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#getSlicesByPolicy(org.apache.openjpa.kernel.OpenJPAStateManager,%20org.apache.openjpa.slice.DistributedConfiguration,%20java.lang.Object)">getSlicesByPolicy</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> ctx)</code> |
| <div class="block">Gets the target slices for the given StateManager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#isReplicated(java.lang.Object,%20org.apache.openjpa.slice.DistributedConfiguration)">isReplicated</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pc, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf)</code> |
| <div class="block">Affirms if the given instance be replicated to multiple slices.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/slice/SliceImplHelper.html#isSliceAssigned(org.apache.openjpa.kernel.OpenJPAStateManager)">isSliceAssigned</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</code> |
| <div class="block">Affirms if the given StateManager has an assigned slice.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SliceImplHelper()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SliceImplHelper</h4> |
| <pre>public SliceImplHelper()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSlicesByPolicy(java.lang.Object, org.apache.openjpa.slice.DistributedConfiguration, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSlicesByPolicy</h4> |
| <pre>public static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a> getSlicesByPolicy(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pc, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> ctx)</pre> |
| <div class="block">Gets the target slices by calling user-specified <a href="../../../../org/apache/openjpa/slice/DistributionPolicy.html" title="interface in org.apache.openjpa.slice"><code>DistributionPolicy</code></a> or <a href="../../../../org/apache/openjpa/slice/ReplicationPolicy.html" title="interface in org.apache.openjpa.slice"><code>ReplicationPolicy</code></a> |
| depending on whether the given instance is <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html#isReplicated(java.lang.Class)"><code>replicated</code></a>. |
| The policy is invoked when an instance enters the managed life cycle. However, if the instance |
| being persisted is distributed to a target slice that is <em>not</em> determinable by its own basic attributes, |
| but on its associated instance then those association may not have been initialized at the point of entry. |
| In such case, the policy may return null. However, when a target slice may not be determinable at the |
| entry to managed life cycle, a target slice must be determinable by the time an instance is flushed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pc</code> - the managed instance whose target slice is to be determined.</dd><dd><code>conf</code> - to supply the distribution policy</dd><dd><code>ctx</code> - the (opaque) context of invocation. No semantics is currently associated.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>information about the target slice for the given instance. Can be null if the policy |
| can not determine the target slice(s) based on the current state of the instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSlicesByPolicy(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.slice.DistributedConfiguration, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSlicesByPolicy</h4> |
| <pre>public static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a> getSlicesByPolicy(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> ctx)</pre> |
| <div class="block">Gets the target slices for the given StateManager.</div> |
| </li> |
| </ul> |
| <a name="isReplicated(java.lang.Object, org.apache.openjpa.slice.DistributedConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReplicated</h4> |
| <pre>public static boolean isReplicated(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pc, |
| <a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html" title="interface in org.apache.openjpa.slice">DistributedConfiguration</a> conf)</pre> |
| <div class="block">Affirms if the given instance be replicated to multiple slices.</div> |
| </li> |
| </ul> |
| <a name="isSliceAssigned(org.apache.openjpa.kernel.OpenJPAStateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSliceAssigned</h4> |
| <pre>public static boolean isSliceAssigned(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</pre> |
| <div class="block">Affirms if the given StateManager has an assigned slice.</div> |
| </li> |
| </ul> |
| <a name="getSliceInfo(org.apache.openjpa.kernel.OpenJPAStateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSliceInfo</h4> |
| <pre>public static <a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice">SliceInfo</a> getSliceInfo(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</pre> |
| <div class="block">Gets the assigned slice information, if any, from the given StateManager.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SliceImplHelper.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/slice/Slice.Status.html" title="enum in org.apache.openjpa.slice"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/slice/SliceInfo.html" title="class in org.apache.openjpa.slice"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/slice/SliceImplHelper.html" target="_top">Frames</a></li> |
| <li><a href="SliceImplHelper.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>Field | </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>Field | </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 © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
