Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / dc14875ef3f6d97d98bc0960309679ca74c81989 / . / api / 3.0 / org / eclipse / persistence / queries / CursoredStream.html
blob: 4d4b5dd4249d635128f2a1e06057359b8eae893c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_222) on Tue Dec 08 12:28:31 UTC 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CursoredStream (EclipseLink 3.0.0, API Reference)</title>
<meta name="date" content="2020-12-08">
<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="CursoredStream (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/queries/CursoredStreamPolicy.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/CursoredStream.html" target="_top">Frames</a></li>
<li><a href="CursoredStream.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 CursoredStream" class="title">Class CursoredStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">org.eclipse.persistence.queries.Cursor</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.queries.CursoredStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CursoredStream</span>
extends <a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></pre>
<div class="block"><p><b>Purpose</b>:
Stream class which is used to deal with large collections returned
from TOPLink queries more efficiently.
<p><b>Responsibilities</b>:
Wraps a database result set cursor to provide a stream on the resulting selected objects.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.eclipse.persistence.queries.CursoredStream">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Yvon Lavoie</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>TOPLink/Java 1.0</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#marker">marker</a></span></code>
<div class="block">Marker for backing up.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.queries.Cursor">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#executionSession">executionSession</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#fields">fields</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#initiallyConformingIndex">initiallyConformingIndex</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#nextRow">nextRow</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#objectCollection">objectCollection</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#policy">policy</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#position">position</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#query">query</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#resultSet">resultSet</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#selectionCriteriaClone">selectionCriteriaClone</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#session">session</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#size">size</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#statement">statement</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#translationRow">translationRow</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#CursoredStream--">CursoredStream</a></span>()</code>
<div class="block">INTERNAL:
Initialize the state of the stream</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#CursoredStream-org.eclipse.persistence.internal.databaseaccess.DatabaseCall-org.eclipse.persistence.queries.CursoredStreamPolicy-">CursoredStream</a></span>(org.eclipse.persistence.internal.databaseaccess.DatabaseCall&nbsp;call,
<a href="../../../../org/eclipse/persistence/queries/CursoredStreamPolicy.html" title="class in org.eclipse.persistence.queries">CursoredStreamPolicy</a>&nbsp;policy)</code>
<div class="block">INTERNAL:
Initialize the state of the stream</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="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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#atEnd--">atEnd</a></span>()</code>
<div class="block">PUBLIC:
Return whether the cursored stream is at its end.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#available--">available</a></span>()</code>
<div class="block">PUBLIC:
Returns the number of objects that can be read from this input without blocking.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/CursoredStream.html#buildCountDistinctExpression-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-">buildCountDistinctExpression</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>&nbsp;includeFields,
<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder)</code>
<div class="block">INTERNAL:
Must build the count on the primary key fields, not * as * is not allowed if there was a distinct.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#clear--">clear</a></span>()</code>
<div class="block">PUBLIC:
Release all objects read in so far.</div>
</td>
</tr>
<tr id="i4" 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/CursoredStream.html#copy-int-int-">copy</a></span>(int&nbsp;startIndex,
int&nbsp;endIndex)</code>
<div class="block">INTERNAL:
Answer a list of the elements of the receiver's collection from startIndex to endIndex.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.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>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#getInitialReadSize--">getInitialReadSize</a></span>()</code>
<div class="block">INTERNAL:
Return the threshold for the stream.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#getMarker--">getMarker</a></span>()</code>
<div class="block">INTERNAL:
Return the marker used for mark() &amp; reset() operations.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#getPageSize--">getPageSize</a></span>()</code>
<div class="block">INTERNAL:
Return the page size for the stream.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.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="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#hasMoreElements--">hasMoreElements</a></span>()</code>
<div class="block">PUBLIC:
Return whether the cursored stream has any more elements.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#hasNext--">hasNext</a></span>()</code>
<div class="block">PUBLIC:
Return whether the cursored stream has any more elements.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#mark-int-">mark</a></span>(int&nbsp;readAheadLimit)</code>
<div class="block">PUBLIC:
Mark the present position in the stream.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#markSupported--">markSupported</a></span>()</code>
<div class="block">PUBLIC:
Tests if this input stream supports the <code>mark</code>
and <code>reset</code> methods.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#next--">next</a></span>()</code>
<div class="block">PUBLIC:
Return the next object from the collection, if beyond the read limit read from the cursor.</div>
</td>
</tr>
<tr id="i15" 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/CursoredStream.html#next-int-">next</a></span>(int&nbsp;numberOfElements)</code>
<div class="block">PUBLIC:
Return a Vector of at most numberOfElements of the next objects from the collection.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#nextElement--">nextElement</a></span>()</code>
<div class="block">PUBLIC:
Return the next object from the collection, if beyond the read limit read from the cursor.</div>
</td>
</tr>
<tr id="i17" 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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#nextElements-int-">nextElements</a></span>(int&nbsp;numberOfElements)</code>
<div class="block">PUBLIC:
Return a Vector of at most numberOfElements of the next objects from the collection.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#peek--">peek</a></span>()</code>
<div class="block">PUBLIC:
Return the next object in the stream, without incrementing the stream's position.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><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></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#read--">read</a></span>()</code>
<div class="block">PUBLIC:
This method differs slightly from conventional read() operation on a Java stream.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<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/CursoredStream.html#read-int-">read</a></span>(int&nbsp;number)</code>
<div class="block">PUBLIC:
This method differs slightly from conventional read() operation on a Java stream.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#releasePrevious--">releasePrevious</a></span>()</code>
<div class="block">PUBLIC:
Release all objects read in so far.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#reset--">reset</a></span>()</code>
<div class="block">PUBLIC:
Repositions this stream to the position at the time the
mark method was last called on this stream.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<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/CursoredStream.html#retrieveNextObject--">retrieveNextObject</a></span>()</code>
<div class="block">INTERNAL:
Read the next row from the result set.</div>
</td>
</tr>
<tr id="i24" 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/CursoredStream.html#retrieveNextPage--">retrieveNextPage</a></span>()</code>
<div class="block">INTERNAL:
Retrieve and add the next page size of rows to the vector.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#setLimits--">setLimits</a></span>()</code>
<div class="block">INTERNAL:
Initialize the stream size and position</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/CursoredStream.html#setMarker-int-">setMarker</a></span>(int&nbsp;value)</code>
<div class="block">INTERNAL:
Set the marker used for mark() &amp; reset() operations</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.queries.Cursor">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#buildAndRegisterObject-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildAndRegisterObject</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#close--">close</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#finalize--">finalize</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getAccessor--">getAccessor</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getExecutionSession--">getExecutionSession</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getFields--">getFields</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getInitiallyConformingIndex--">getInitiallyConformingIndex</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getObjectCollection--">getObjectCollection</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPolicy--">getPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getQuery--">getQuery</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getResultSet--">getResultSet</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getSelectionCriteriaClone--">getSelectionCriteriaClone</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getSession--">getSession</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getStatement--">getStatement</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#getTranslationRow--">getTranslationRow</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#isClosed--">isClosed</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#remove--">remove</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setExecutionSession</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setFields-java.util.Vector-">setFields</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setInitiallyConformingIndex-java.util.Map-">setInitiallyConformingIndex</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setObjectCollection-java.util.List-">setObjectCollection</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setPolicy-org.eclipse.persistence.queries.CursorPolicy-">setPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setPosition-int-">setPosition</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setResultSet-java.sql.ResultSet-">setResultSet</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSelectionCriteriaClone-org.eclipse.persistence.expressions.Expression-">setSelectionCriteriaClone</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setSize-int-">setSize</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setTranslationRow</a>, <a href="../../../../org/eclipse/persistence/queries/Cursor.html#size--">size</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#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.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></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="marker">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>marker</h4>
<pre>protected&nbsp;int marker</pre>
<div class="block">Marker for backing up.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CursoredStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CursoredStream</h4>
<pre>public&nbsp;CursoredStream()</pre>
<div class="block">INTERNAL:
Initialize the state of the stream</div>
</li>
</ul>
<a name="CursoredStream-org.eclipse.persistence.internal.databaseaccess.DatabaseCall-org.eclipse.persistence.queries.CursoredStreamPolicy-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CursoredStream</h4>
<pre>public&nbsp;CursoredStream(org.eclipse.persistence.internal.databaseaccess.DatabaseCall&nbsp;call,
<a href="../../../../org/eclipse/persistence/queries/CursoredStreamPolicy.html" title="class in org.eclipse.persistence.queries">CursoredStreamPolicy</a>&nbsp;policy)</pre>
<div class="block">INTERNAL:
Initialize the state of the stream</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="atEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>atEnd</h4>
<pre>public&nbsp;boolean&nbsp;atEnd()
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">PUBLIC:
Return whether the cursored stream is at its end.</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="available--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre>public&nbsp;int&nbsp;available()
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">PUBLIC:
Returns the number of objects that can be read from this input without blocking.</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="buildCountDistinctExpression-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCountDistinctExpression</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;buildCountDistinctExpression(<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>&nbsp;includeFields,
<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder)</pre>
<div class="block">INTERNAL:
Must build the count on the primary key fields, not * as * is not allowed if there was a distinct.
This require a manually defined operator.
added for CR 2900</div>
</li>
</ul>
<a name="copy-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</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;&nbsp;copy(int&nbsp;startIndex,
int&nbsp;endIndex)
throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
<div class="block">INTERNAL:
Answer a list of the elements of the receiver's collection from startIndex to endIndex.</div>
<dl>
<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="getCursorSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCursorSize</h4>
<pre>protected&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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getCursorSize--">getCursorSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</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>
<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="getInitialReadSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialReadSize</h4>
<pre>protected&nbsp;int&nbsp;getInitialReadSize()</pre>
<div class="block">INTERNAL:
Return the threshold for the stream.</div>
</li>
</ul>
<a name="getMarker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMarker</h4>
<pre>protected&nbsp;int&nbsp;getMarker()</pre>
<div class="block">INTERNAL:
Return the marker used for mark() &amp; reset() operations.</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 page size for the stream.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPageSize--">getPageSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></code></dd>
</dl>
</li>
</ul>
<a name="getPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>public&nbsp;int&nbsp;getPosition()</pre>
<div class="block">INTERNAL:
Return the position of the stream inside the object collection</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#getPosition--">getPosition</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></code></dd>
</dl>
</li>
</ul>
<a name="hasMoreElements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMoreElements</h4>
<pre>public&nbsp;boolean&nbsp;hasMoreElements()</pre>
<div class="block">PUBLIC:
Return whether the cursored stream has any more elements.</div>
</li>
</ul>
<a name="hasNext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public&nbsp;boolean&nbsp;hasNext()</pre>
<div class="block">PUBLIC:
Return whether the cursored stream has any more elements.</div>
</li>
</ul>
<a name="mark-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mark</h4>
<pre>public&nbsp;void&nbsp;mark(int&nbsp;readAheadLimit)</pre>
<div class="block">PUBLIC:
Mark the present position in the stream.
Subsequent calls to reset() will attempt to reposition the stream to this point.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readAheadLimit</code> - Limit on the number of characters that may be
read while still preserving the mark. Because
the stream's input comes from the database, there
is no actual limit, so this argument is ignored.</dd>
</dl>
</li>
</ul>
<a name="markSupported--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markSupported</h4>
<pre>public&nbsp;boolean&nbsp;markSupported()</pre>
<div class="block">PUBLIC:
Tests if this input stream supports the <code>mark</code>
and <code>reset</code> methods. The <code>markSupported</code>
method of <code>InputStream</code> returns <code>false</code>.</div>
</li>
</ul>
<a name="nextElement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextElement</h4>
<pre>public&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;nextElement()</pre>
<div class="block">PUBLIC:
Return the next object from the collection, if beyond the read limit read from the cursor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next object in stream</dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public&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;next()</pre>
<div class="block">PUBLIC:
Return the next object from the collection, if beyond the read limit read from the cursor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next object in stream</dd>
</dl>
</li>
</ul>
<a name="nextElements-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextElements</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>&nbsp;nextElements(int&nbsp;numberOfElements)</pre>
<div class="block">PUBLIC:
Return a Vector of at most numberOfElements of the next objects from the collection. If there
aren't that many objects left to read, just return what is available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next objects in stream</dd>
</dl>
</li>
</ul>
<a name="next-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</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;next(int&nbsp;numberOfElements)</pre>
<div class="block">PUBLIC:
Return a Vector of at most numberOfElements of the next objects from the collection. If there
aren't that many objects left to read, just return what is available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next objects in stream</dd>
</dl>
</li>
</ul>
<a name="peek--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre>public&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;peek()
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">PUBLIC:
Return the next object in the stream, without incrementing the stream's position.</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="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public&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;read()
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">PUBLIC:
This method differs slightly from conventional read() operation on a Java stream. This
method return the next object in the collection rather than specifying the number of
bytes to be read in.
Return the next object from the collection, if beyond the read limit read from the cursor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>- next object in stream</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> - if read pass end of stream</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="read-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</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;read(int&nbsp;number)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">PUBLIC:
This method differs slightly from conventional read() operation on a Java stream. This
method returns the next number of objects in the collection in a vector.
Return the next object from the collection, if beyond the read limit read from the cursor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - - number of objects to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>- vector containing next number of objects</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> - if read pass end of stream</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#clear--">clear</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</a></code></dd>
</dl>
</li>
</ul>
<a name="releasePrevious--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releasePrevious</h4>
<pre>public&nbsp;void&nbsp;releasePrevious()</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>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">PUBLIC:
Repositions this stream to the position at the time the
mark method was last called on this stream.</div>
</li>
</ul>
<a name="retrieveNextObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveNextObject</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;retrieveNextObject()
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#retrieveNextObject--">Cursor</a></code></span></div>
<div class="block">INTERNAL:
Read the next row from the result set.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/Cursor.html#retrieveNextObject--">retrieveNextObject</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries">Cursor</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="retrieveNextPage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveNextPage</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;retrieveNextPage()
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Retrieve and add the next page size of rows to the vector.
Return the last object, or null if at end.</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="setLimits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLimits</h4>
<pre>protected&nbsp;void&nbsp;setLimits()</pre>
<div class="block">INTERNAL:
Initialize the stream size and position</div>
</li>
</ul>
<a name="setMarker-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMarker</h4>
<pre>protected&nbsp;void&nbsp;setMarker(int&nbsp;value)</pre>
<div class="block">INTERNAL:
Set the marker used for mark() &amp; reset() operations</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.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/queries/Cursor.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/queries/CursoredStreamPolicy.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/CursoredStream.html" target="_top">Frames</a></li>
<li><a href="CursoredStream.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;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>