| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:07 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PagingResultObjectProvider (OpenJPA Parent POM 3.0.0 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <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="PagingResultObjectProvider (OpenJPA Parent POM 3.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/PagingResultObjectProvider.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/jdbc/kernel/OperationOrderUpdateManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html" target="_top">Frames</a></li> |
| <li><a href="PagingResultObjectProvider.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="#fields.inherited.from.class.org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">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>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.jdbc.kernel</div> |
| <h2 title="Class PagingResultObjectProvider" class="title">Class PagingResultObjectProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://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/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.jdbc.kernel.PagingResultObjectProvider</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PagingResultObjectProvider</span> |
| extends <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></pre> |
| <div class="block">Object provider implementation that fetches one page of results at a |
| a time as it scrolls. If the <a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getPagedFields-org.apache.openjpa.jdbc.sql.Select-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-int-long-"><code>getPagedFields(org.apache.openjpa.jdbc.sql.Select, org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, int, long)</code></a> method returns a |
| non-null bit set, this this provider is a good fit for your configuration. |
| The method tests the following conditions: |
| <ul> |
| <li>The eager fetch mode is <code>parallel</code>.</li> |
| <li>The select's result should be treated as a large result set.</li> |
| <li>The mapping being selected has fields that use parallel selects |
| under the current fetch configuration.</li> |
| </ul> |
| To use this provider, select the candidate mapping with eager fetch |
| mode set to <code>join</code>. This provider will take care of performing |
| <code>parallel</code> mode batch selects for each page it reads.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.openjpa.jdbc.kernel.<a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#Z:Z_res">_res</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/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#PagingResultObjectProvider-org.apache.openjpa.jdbc.sql.SelectExecutor-org.apache.openjpa.jdbc.meta.ClassMapping:A-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.util.BitSet:A-long-">PagingResultObjectProvider</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>[] mappings, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a>[] paged, |
| long size)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#PagingResultObjectProvider-org.apache.openjpa.jdbc.sql.SelectExecutor-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.util.BitSet-long-">PagingResultObjectProvider</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a> mapping, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> paged, |
| long size)</code> |
| <div class="block">Constructor.</div> |
| </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#absolute-int-">absolute</a></span>(int pos)</code> |
| <div class="block">Move to the given 0-based position.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getPagedFields-org.apache.openjpa.jdbc.sql.Select-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-int-long-">getPagedFields</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a> mapping, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| int eagerMode, |
| long size)</code> |
| <div class="block">Return a bit set representing batch select fields that will be paged, |
| or null if no fields need paging, which indicates that this provider |
| should not be used.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getPageSize--">getPageSize</a></span>()</code> |
| <div class="block">Return the page size in use.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://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/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getResultObject--">getResultObject</a></span>()</code> |
| <div class="block">Instantiate the current result object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#next--">next</a></span>()</code> |
| <div class="block">Advance the input to the next position.</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/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#open--">open</a></span>()</code> |
| <div class="block">Open the result.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.openjpa.jdbc.kernel.<a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#close--">close</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getFetchConfiguration--">getFetchConfiguration</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getResult--">getResult</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getSelect--">getSelect</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getStore--">getStore</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#handleCheckedException-java.lang.Exception-">handleCheckedException</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#reset--">reset</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#setSize-int-">setSize</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#size--">size</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#supportsRandomAccess--">supportsRandomAccess</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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PagingResultObjectProvider-org.apache.openjpa.jdbc.sql.SelectExecutor-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.util.BitSet-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PagingResultObjectProvider</h4> |
| <pre>public PagingResultObjectProvider(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a> mapping, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> paged, |
| long size)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sel</code> - the select to execute</dd> |
| <dd><code>mapping</code> - the mapping of the result objects</dd> |
| <dd><code>store</code> - the store manager to delegate loading to</dd> |
| <dd><code>fetch</code> - the fetch configuration, or null for default</dd> |
| <dd><code>paged</code> - the bit set returned from <a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getPagedFields-org.apache.openjpa.jdbc.sql.Select-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-int-long-"><code>getPagedFields(org.apache.openjpa.jdbc.sql.Select, org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, int, long)</code></a></dd> |
| <dd><code>size</code> - the known maximum size of the result, or |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no known limit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PagingResultObjectProvider-org.apache.openjpa.jdbc.sql.SelectExecutor-org.apache.openjpa.jdbc.meta.ClassMapping:A-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.util.BitSet:A-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PagingResultObjectProvider</h4> |
| <pre>public PagingResultObjectProvider(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>[] mappings, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a>[] paged, |
| long size)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sel</code> - the select to execute</dd> |
| <dd><code>mappings</code> - the mappings for the independent classes of the |
| result objects</dd> |
| <dd><code>store</code> - the store manager to delegate loading to</dd> |
| <dd><code>fetch</code> - the fetch configuration, or null for default</dd> |
| <dd><code>paged</code> - the bit sets returned from <a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#getPagedFields-org.apache.openjpa.jdbc.sql.Select-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-int-long-"><code>getPagedFields(org.apache.openjpa.jdbc.sql.Select, org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, int, long)</code></a> |
| for each select in the possible union</dd> |
| <dd><code>size</code> - the known maximum size of the result, or |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no known limit</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPagedFields-org.apache.openjpa.jdbc.sql.Select-org.apache.openjpa.jdbc.meta.ClassMapping-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-int-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPagedFields</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> getPagedFields(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a> sel, |
| <a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a> mapping, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a> store, |
| <a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a> fetch, |
| int eagerMode, |
| long size)</pre> |
| <div class="block">Return a bit set representing batch select fields that will be paged, |
| or null if no fields need paging, which indicates that this provider |
| should not be used.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html#PagingResultObjectProvider-org.apache.openjpa.jdbc.sql.SelectExecutor-org.apache.openjpa.jdbc.meta.ClassMapping:A-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.util.BitSet:A-long-"><code>PagingResultObjectProvider(org.apache.openjpa.jdbc.sql.SelectExecutor, org.apache.openjpa.jdbc.meta.ClassMapping[], org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, java.util.BitSet[], long)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPageSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre>public int getPageSize()</pre> |
| <div class="block">Return the page size in use.</div> |
| </li> |
| </ul> |
| <a name="open--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public void open() |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#open--">ResultObjectProvider</a></code></span></div> |
| <div class="block">Open the result. This will be called before |
| <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>ResultObjectProvider.next()</code></a>, <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-"><code>ResultObjectProvider.absolute(int)</code></a>, or <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#size--"><code>ResultObjectProvider.size()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#open--">open</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#open--">open</a></code> in class <code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>public boolean next() |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--">ResultObjectProvider</a></code></span></div> |
| <div class="block">Advance the input to the next position. Return <code>true</code> if |
| there is more data; otherwise <code>false</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--">next</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#next--">next</a></code> in class <code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="absolute-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>absolute</h4> |
| <pre>public boolean absolute(int pos) |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-">ResultObjectProvider</a></code></span></div> |
| <div class="block">Move to the given 0-based position. This method is |
| only called for providers that support random access. |
| Return <code>true</code> if there is data at this position; |
| otherwise <code>false</code>. This may be invoked in place of |
| <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>ResultObjectProvider.next()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-">absolute</a></code> in interface <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#absolute-int-">absolute</a></code> in class <code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getResultObject</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getResultObject() |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#getResultObject--">ResultObjectProvider</a></code></span></div> |
| <div class="block">Instantiate the current result object. This method will only be |
| called after <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>ResultObjectProvider.next()</code></a> or <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-"><code>ResultObjectProvider.absolute(int)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</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="class-use/PagingResultObjectProvider.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/jdbc/kernel/OperationOrderUpdateManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html" target="_top">Frames</a></li> |
| <li><a href="PagingResultObjectProvider.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="#fields.inherited.from.class.org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">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>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–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |