api/3.0/org/eclipse/persistence/queries/Cursor.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!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:07 UTC 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Cursor (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="Cursor (EclipseLink 3.0.2, API Reference)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":6,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":6,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/queries/ConstructorResult.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/queries/Cursor.html" target="_top">Frames</a></li>
 <li><a href="Cursor.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.queries</div>
 <h2 title="Class Cursor" class="title">Class Cursor</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>org.eclipse.persistence.queries.Cursor</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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html" title="class in org.eclipse.persistence.queries">CursoredStream</a>, <a href="../../../../org/eclipse/persistence/queries/ScrollableCursor.html" title="class in org.eclipse.persistence.queries">ScrollableCursor</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public abstract class <span class="typeNameLabel">Cursor</span>
 extends <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>
 implements <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>, <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></pre>
 <div class="block"><p><b>Purpose</b>:
  Abstract class for CursoredStream and ScrolableCursor</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../serialized-form.html#org.eclipse.persistence.queries.Cursor">Serialized Form</a></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 org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#executionSession">executionSession</a></span></code>
 <div class="block">The root session that executed the call for the query.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#fields">fields</a></span></code>
 <div class="block">The fields expected in the result set.</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/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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#initiallyConformingIndex">initiallyConformingIndex</a></span></code>
 <div class="block">Conforming instances found in memory when building the result.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#nextRow">nextRow</a></span></code>
 <div class="block">Store the next row, for 1-m joining.</div>
 </td>
 </tr>
 <tr class="altColor">
 <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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#objectCollection">objectCollection</a></span></code>
 <div class="block">Internal collection of objects.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#policy">policy</a></span></code>
 <div class="block">Query policy that initialize the stream.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#position">position</a></span></code>
 <div class="block">Current position in the objectCollection of the stream.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#query">query</a></span></code>
 <div class="block">Read query that initialize the stream.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#resultSet">resultSet</a></span></code>
 <div class="block">The result set (cursor) that holds the handle to the database that the results are read from.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#selectionCriteriaClone">selectionCriteriaClone</a></span></code>
 <div class="block">SelectionCriteria &amp; translation row ready for incremental conforming.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#session">session</a></span></code>
 <div class="block">The session that executed the query for the stream.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#size">size</a></span></code>
 <div class="block">Cached size of the stream.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true" title="class or interface in java.sql">Statement</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#statement">statement</a></span></code>
 <div class="block">The preparedStatement that holds the handle to the database that the results are read from.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#translationRow">translationRow</a></span></code>&nbsp;</td>
 </tr>
 </table>
 </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/queries/Cursor.html#Cursor--">Cursor</a></span>()</code>
 <div class="block">INTERNAL:
  Default constructor.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#Cursor-org.eclipse.persistence.internal.databaseaccess.DatabaseCall-org.eclipse.persistence.queries.CursorPolicy-">Cursor</a></span>(org.eclipse.persistence.internal.databaseaccess.DatabaseCall&nbsp;call,
       <a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a>&nbsp;policy)</code>
 <div class="block">INTERNAL:</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>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/queries/Cursor.html#buildAndRegisterObject-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildAndRegisterObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</code>
 <div class="block">INTERNAL:
  builds and registers an object from a row for cursors.</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/queries/Cursor.html#clear--">clear</a></span>()</code>
 <div class="block">PUBLIC:
  Release all objects read in so far.</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/queries/Cursor.html#close--">close</a></span>()</code>
 <div class="block">PUBLIC:
  Closes the stream.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#finalize--">finalize</a></span>()</code>
 <div class="block">Close in case not closed.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getAccessor--">getAccessor</a></span>()</code>
 <div class="block">INTERNAL:
  Return the accessor associated with the cursor.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>protected abstract int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getCursorSize--">getCursorSize</a></span>()</code>
 <div class="block">INTERNAL:
  Retrieve the size of the open cursor by executing a count on the same query as the cursor.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getExecutionSession--">getExecutionSession</a></span>()</code>
 <div class="block">INTERNAL:
  Returns the session the underlying call was executed on.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getFields--">getFields</a></span>()</code>
 <div class="block">INTERNAL:
  Return the fields for the stream.</div>
 </td>
 </tr>
 <tr id="i8" 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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getInitiallyConformingIndex--">getInitiallyConformingIndex</a></span>()</code>
 <div class="block">INTERNAL:
  Conforming instances found in memory when building the result.</div>
 </td>
 </tr>
 <tr id="i9" 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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getObjectCollection--">getObjectCollection</a></span>()</code>
 <div class="block">INTERNAL:
  Return the internal object collection that stores the objects.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPageSize--">getPageSize</a></span>()</code>
 <div class="block">INTERNAL:
  Return the number of items to be faulted in for the stream.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPolicy--">getPolicy</a></span>()</code>
 <div class="block">INTERNAL:
  Return the cursor policy.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>abstract int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPosition--">getPosition</a></span>()</code>
 <div class="block">INTERNAL:
  Return the position of the stream inside the object collection.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getQuery--">getQuery</a></span>()</code>
 <div class="block">INTERNAL:
  Return the query associated with the stream.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getResultSet--">getResultSet</a></span>()</code>
 <div class="block">INTERNAL:
  Return the result set (cursor).</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getSelectionCriteriaClone--">getSelectionCriteriaClone</a></span>()</code>
 <div class="block">INTERNAL:
  The clone of the selection criteria is needed for in-memory conforming
  each object read from the Cursor.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getSession--">getSession</a></span>()</code>
 <div class="block">INTERNAL:
  Return the handle to the session</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true" title="class or interface in java.sql">Statement</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getStatement--">getStatement</a></span>()</code>
 <div class="block">INTERNAL:
  Return the Statement.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getTranslationRow--">getTranslationRow</a></span>()</code>
 <div class="block">INTERNAL:
  Gets the translation row the query was executed with, used for incremental
  conforming.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#isClosed--">isClosed</a></span>()</code>
 <div class="block">PUBLIC:
  Return if the stream is closed.</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#remove--">remove</a></span>()</code>
 <div class="block">PUBLIC:
  Remove is not support with cursors.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code>protected abstract <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/queries/Cursor.html#retrieveNextObject--">retrieveNextObject</a></span>()</code>
 <div class="block">INTERNAL:
  Read the next row from the result set.</div>
 </td>
 </tr>
 <tr id="i22" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setExecutionSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</code>
 <div class="block">INTERNAL:
  Sets the session the underlying call was executed on.</div>
 </td>
 </tr>
 <tr id="i23" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setFields-java.util.Vector-">setFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;&nbsp;fields)</code>
 <div class="block">INTERNAL:
  Set the fields for the stream.</div>
 </td>
 </tr>
 <tr id="i24" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setInitiallyConformingIndex-java.util.Map-">setInitiallyConformingIndex</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;index)</code>
 <div class="block">INTERNAL:
  Conforming instances found in memory when building the result.</div>
 </td>
 </tr>
 <tr id="i25" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setObjectCollection-java.util.List-">setObjectCollection</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;collection)</code>
 <div class="block">INTERNAL:
  Set the internal object collection</div>
 </td>
 </tr>
 <tr id="i26" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setPolicy-org.eclipse.persistence.queries.CursorPolicy-">setPolicy</a></span>(<a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a>&nbsp;policy)</code>
 <div class="block">INTERNAL:
  Set the cursor policy.</div>
 </td>
 </tr>
 <tr id="i27" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setPosition-int-">setPosition</a></span>(int&nbsp;value)</code>
 <div class="block">INTERNAL:
  Set the current position of the stream</div>
 </td>
 </tr>
 <tr id="i28" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setResultSet-java.sql.ResultSet-">setResultSet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a>&nbsp;result)</code>
 <div class="block">INTERNAL:
  Set the result set (cursor)</div>
 </td>
 </tr>
 <tr id="i29" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSelectionCriteriaClone-org.eclipse.persistence.expressions.Expression-">setSelectionCriteriaClone</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;expression)</code>
 <div class="block">INTERNAL:
  The clone of the selection criteria is needed for in-memory conforming
  each object read from the Cursor.</div>
 </td>
 </tr>
 <tr id="i30" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;databaseSession)</code>
 <div class="block">INTERNAL:
  Set the session handle</div>
 </td>
 </tr>
 <tr id="i31" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSize-int-">setSize</a></span>(int&nbsp;size)</code>
 <div class="block">INTERNAL:
  Set the cache size</div>
 </td>
 </tr>
 <tr id="i32" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setTranslationRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</code>
 <div class="block">INTERNAL:
  Sets the translation row this query was executed with.</div>
 </td>
 </tr>
 <tr id="i33" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Cursor.html#size--">size</a></span>()</code>
 <div class="block">PUBLIC:
  Retrieve the size of the open cursor by executing a count on the same query as the cursor.</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&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#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>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.util.Enumeration">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true#hasMoreElements--" title="class or interface in java.util">hasMoreElements</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html?is-external=true#nextElement--" title="class or interface in java.util">nextElement</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#forEachRemaining-java.util.function.Consumer-" title="class or interface in java.util">forEachRemaining</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#hasNext--" title="class or interface in java.util">hasNext</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#next--" title="class or interface in java.util">next</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="statement">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>statement</h4>
 <pre>protected transient&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true" title="class or interface in java.sql">Statement</a> statement</pre>
 <div class="block">The preparedStatement that holds the handle to the database that the results are read from.</div>
 </li>
 </ul>
 <a name="resultSet">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>resultSet</h4>
 <pre>protected transient&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet</pre>
 <div class="block">The result set (cursor) that holds the handle to the database that the results are read from.</div>
 </li>
 </ul>
 <a name="session">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>session</h4>
 <pre>protected transient&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession session</pre>
 <div class="block">The session that executed the query for the stream.</div>
 </li>
 </ul>
 <a name="executionSession">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>executionSession</h4>
 <pre>protected transient&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession executionSession</pre>
 <div class="block">The root session that executed the call for the query.  Knows the database platform.</div>
 </li>
 </ul>
 <a name="fields">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fields</h4>
 <pre>protected transient&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt; fields</pre>
 <div class="block">The fields expected in the result set.</div>
 </li>
 </ul>
 <a name="size">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>size</h4>
 <pre>protected&nbsp;int size</pre>
 <div class="block">Cached size of the stream.</div>
 </li>
 </ul>
 <a name="query">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>query</h4>
 <pre>public transient&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a> query</pre>
 <div class="block">Read query that initialize the stream.</div>
 </li>
 </ul>
 <a name="policy">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>policy</h4>
 <pre>public transient&nbsp;<a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a> policy</pre>
 <div class="block">Query policy that initialize the stream.</div>
 </li>
 </ul>
 <a name="objectCollection">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>objectCollection</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt; objectCollection</pre>
 <div class="block">Internal collection of objects.</div>
 </li>
 </ul>
 <a name="initiallyConformingIndex">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>initiallyConformingIndex</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt; initiallyConformingIndex</pre>
 <div class="block">Conforming instances found in memory when building the result.</div>
 </li>
 </ul>
 <a name="selectionCriteriaClone">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>selectionCriteriaClone</h4>
 <pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> selectionCriteriaClone</pre>
 <div class="block">SelectionCriteria &amp; translation row ready for incremental conforming.</div>
 </li>
 </ul>
 <a name="translationRow">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>translationRow</h4>
 <pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord translationRow</pre>
 </li>
 </ul>
 <a name="nextRow">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>nextRow</h4>
 <pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord nextRow</pre>
 <div class="block">Store the next row, for 1-m joining.</div>
 </li>
 </ul>
 <a name="position">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>position</h4>
 <pre>protected&nbsp;int position</pre>
 <div class="block">Current position in the objectCollection of the stream.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="Cursor--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>Cursor</h4>
 <pre>public&nbsp;Cursor()</pre>
 <div class="block">INTERNAL:
  Default constructor.</div>
 </li>
 </ul>
 <a name="Cursor-org.eclipse.persistence.internal.databaseaccess.DatabaseCall-org.eclipse.persistence.queries.CursorPolicy-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>Cursor</h4>
 <pre>public&nbsp;Cursor(org.eclipse.persistence.internal.databaseaccess.DatabaseCall&nbsp;call,
               <a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a>&nbsp;policy)</pre>
 <div class="block">INTERNAL:</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="close--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre>public&nbsp;void&nbsp;close()
            throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
 <div class="block">PUBLIC:
  Closes the stream.
  This should be performed whenever the user has finished with the stream.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="finalize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>finalize</h4>
 <pre>protected&nbsp;void&nbsp;finalize()
                  throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
 <div class="block">Close in case not closed.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><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></code>&nbsp;in class&nbsp;<code><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></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="getAccessor--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAccessor</h4>
 <pre>public&nbsp;org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor&nbsp;getAccessor()</pre>
 <div class="block">INTERNAL:
  Return the accessor associated with the cursor.</div>
 </li>
 </ul>
 <a name="getCursorSize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCursorSize</h4>
 <pre>protected abstract&nbsp;int&nbsp;getCursorSize()
                               throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a>,
                                      <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
 <div class="block">INTERNAL:
  Retrieve the size of the open cursor by executing a count on the same query as the cursor.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="getFields--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFields</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;&nbsp;getFields()</pre>
 <div class="block">INTERNAL:
  Return the fields for the stream.</div>
 </li>
 </ul>
 <a name="getInitiallyConformingIndex--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getInitiallyConformingIndex</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getInitiallyConformingIndex()</pre>
 <div class="block">INTERNAL:
  Conforming instances found in memory when building the result.
  These objects are returned first by the cursor, and a fast lookup
  is needed to make sure the same objects appearing in the cursor are
  filtered out.</div>
 </li>
 </ul>
 <a name="getObjectCollection--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getObjectCollection</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getObjectCollection()</pre>
 <div class="block">INTERNAL:
  Return the internal object collection that stores the objects.</div>
 </li>
 </ul>
 <a name="getPageSize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPageSize</h4>
 <pre>public&nbsp;int&nbsp;getPageSize()</pre>
 <div class="block">INTERNAL:
  Return the number of items to be faulted in for the stream.</div>
 </li>
 </ul>
 <a name="getPolicy--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPolicy</h4>
 <pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a>&nbsp;getPolicy()</pre>
 <div class="block">INTERNAL:
  Return the cursor policy.</div>
 </li>
 </ul>
 <a name="getPosition--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPosition</h4>
 <pre>public abstract&nbsp;int&nbsp;getPosition()</pre>
 <div class="block">INTERNAL:
  Return the position of the stream inside the object collection.</div>
 </li>
 </ul>
 <a name="getQuery--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuery</h4>
 <pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a>&nbsp;getQuery()</pre>
 <div class="block">INTERNAL:
  Return the query associated with the stream.</div>
 </li>
 </ul>
 <a name="getResultSet--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getResultSet</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a>&nbsp;getResultSet()</pre>
 <div class="block">INTERNAL:
  Return the result set (cursor).</div>
 </li>
 </ul>
 <a name="getSelectionCriteriaClone--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSelectionCriteriaClone</h4>
 <pre>public&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;getSelectionCriteriaClone()</pre>
 <div class="block">INTERNAL:
  The clone of the selection criteria is needed for in-memory conforming
  each object read from the Cursor.</div>
 </li>
 </ul>
 <a name="getSession--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSession</h4>
 <pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getSession()</pre>
 <div class="block">INTERNAL:
  Return the handle to the session</div>
 </li>
 </ul>
 <a name="getExecutionSession--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecutionSession</h4>
 <pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getExecutionSession()</pre>
 <div class="block">INTERNAL:
  Returns the session the underlying call was executed on.  This root
  session knows the database platform.</div>
 </li>
 </ul>
 <a name="getStatement--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getStatement</h4>
 <pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true" title="class or interface in java.sql">Statement</a>&nbsp;getStatement()</pre>
 <div class="block">INTERNAL:
  Return the Statement.</div>
 </li>
 </ul>
 <a name="getTranslationRow--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTranslationRow</h4>
 <pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;getTranslationRow()</pre>
 <div class="block">INTERNAL:
  Gets the translation row the query was executed with, used for incremental
  conforming.</div>
 </li>
 </ul>
 <a name="isClosed--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isClosed</h4>
 <pre>public&nbsp;boolean&nbsp;isClosed()</pre>
 <div class="block">PUBLIC:
  Return if the stream is closed.</div>
 </li>
 </ul>
 <a name="buildAndRegisterObject-org.eclipse.persistence.internal.sessions.AbstractRecord-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>buildAndRegisterObject</h4>
 <pre>protected&nbsp;<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;buildAndRegisterObject(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</pre>
 <div class="block">INTERNAL:
  builds and registers an object from a row for cursors.
  Behavior is different from the query version in that refreshing is not
  supported.</div>
 </li>
 </ul>
 <a name="retrieveNextObject--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>retrieveNextObject</h4>
 <pre>protected abstract&nbsp;<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;retrieveNextObject()
                                       throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
 <div class="block">INTERNAL:
  Read the next row from the result set.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="setFields-java.util.Vector-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setFields</h4>
 <pre>protected&nbsp;void&nbsp;setFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&lt;org.eclipse.persistence.internal.helper.DatabaseField&gt;&nbsp;fields)</pre>
 <div class="block">INTERNAL:
  Set the fields for the stream.</div>
 </li>
 </ul>
 <a name="setInitiallyConformingIndex-java.util.Map-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setInitiallyConformingIndex</h4>
 <pre>public&nbsp;void&nbsp;setInitiallyConformingIndex(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;index)</pre>
 <div class="block">INTERNAL:
  Conforming instances found in memory when building the result.
  These objects are returned first by the cursor, and a fast lookup
  is needed to make sure the same objects appearing in the cursor are
  filtered out.</div>
 </li>
 </ul>
 <a name="setObjectCollection-java.util.List-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setObjectCollection</h4>
 <pre>public&nbsp;void&nbsp;setObjectCollection(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;collection)</pre>
 <div class="block">INTERNAL:
  Set the internal object collection</div>
 </li>
 </ul>
 <a name="setPolicy-org.eclipse.persistence.queries.CursorPolicy-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPolicy</h4>
 <pre>public&nbsp;void&nbsp;setPolicy(<a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries">CursorPolicy</a>&nbsp;policy)</pre>
 <div class="block">INTERNAL:
  Set the cursor policy.</div>
 </li>
 </ul>
 <a name="setPosition-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPosition</h4>
 <pre>protected&nbsp;void&nbsp;setPosition(int&nbsp;value)</pre>
 <div class="block">INTERNAL:
  Set the current position of the stream</div>
 </li>
 </ul>
 <a name="setResultSet-java.sql.ResultSet-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setResultSet</h4>
 <pre>protected&nbsp;void&nbsp;setResultSet(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a>&nbsp;result)</pre>
 <div class="block">INTERNAL:
  Set the result set (cursor)</div>
 </li>
 </ul>
 <a name="setSelectionCriteriaClone-org.eclipse.persistence.expressions.Expression-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSelectionCriteriaClone</h4>
 <pre>public&nbsp;void&nbsp;setSelectionCriteriaClone(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;expression)</pre>
 <div class="block">INTERNAL:
  The clone of the selection criteria is needed for in-memory conforming
  each object read from the Cursor.</div>
 </li>
 </ul>
 <a name="setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSession</h4>
 <pre>public&nbsp;void&nbsp;setSession(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;databaseSession)</pre>
 <div class="block">INTERNAL:
  Set the session handle</div>
 </li>
 </ul>
 <a name="setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setExecutionSession</h4>
 <pre>protected&nbsp;void&nbsp;setExecutionSession(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;executionSession)</pre>
 <div class="block">INTERNAL:
  Sets the session the underlying call was executed on.  This root
  session knows the database platform.</div>
 </li>
 </ul>
 <a name="setSize-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSize</h4>
 <pre>public&nbsp;void&nbsp;setSize(int&nbsp;size)</pre>
 <div class="block">INTERNAL:
  Set the cache size</div>
 </li>
 </ul>
 <a name="setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setTranslationRow</h4>
 <pre>public&nbsp;void&nbsp;setTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</pre>
 <div class="block">INTERNAL:
  Sets the translation row this query was executed with.  Used for
  incremental conforming.</div>
 </li>
 </ul>
 <a name="size--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>size</h4>
 <pre>public&nbsp;int&nbsp;size()
          throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
 <div class="block">PUBLIC:
  Retrieve the size of the open cursor by executing a count on the same query as the cursor.

  If this cursor is conforming size() can only be an estimate.  cursor size
  plus number of conforming instances found in memory will be returned.  The
  union (actual result) may be smaller than this.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="remove--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>remove</h4>
 <pre>public&nbsp;void&nbsp;remove()
             throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
 <div class="block">PUBLIC:
  Remove is not support with cursors.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#remove--" title="class or interface in java.util">remove</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="clear--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>clear</h4>
 <pre>public&nbsp;void&nbsp;clear()</pre>
 <div class="block">PUBLIC:
  Release all objects read in so far.
  This should be performed when reading in a large collection of
  objects in order to preserve memory.</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/queries/ConstructorResult.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/eclipse/persistence/queries/Cursor.html" target="_top">Frames</a></li>
 <li><a href="Cursor.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>