blob: 0e0d4dd01cc81e0b0b6b647a1fcdbd5fcf5925fe [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 (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IteratedSelectObserver (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IteratedSelectObserver (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IteratedSelectObserver.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/util/IteratedSelectObserver.html" target="_top">Frames</a></li>
<li><a href="IteratedSelectObserver.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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.apache.cayenne.access.util</div>
<h2 title="Class IteratedSelectObserver" class="title">Class IteratedSelectObserver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">org.apache.cayenne.access.util.DefaultOperationObserver</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.access.util.IteratedSelectObserver</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/cayenne/access/OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a>, <a href="../../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">IteratedSelectObserver</span>
extends <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></pre>
<div class="block">OperationObserver that is used to track the execution
of SelectQueries with results returned as ResultIterator.</div>
</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="overviewSummary" 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 <a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#resultIterator">resultIterator</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.access.util.DefaultOperationObserver">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.access.util.<a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#globalExceptions">globalExceptions</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#queryExceptions">queryExceptions</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="overviewSummary" 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><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#IteratedSelectObserver()">IteratedSelectObserver</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#getResultIterator()">getResultIterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#isIteratedResult()">isIteratedResult</a></strong>()</code>
<div class="block">Returns <code>false</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#nextRows(org.apache.cayenne.query.Query,%20java.util.List)">nextRows</a></strong>(<a href="../../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;?&gt;&nbsp;dataRows)</code>
<div class="block">Callback method invoked for each processed ResultSet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/access/util/IteratedSelectObserver.html#nextRows(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.ResultIterator)">nextRows</a></strong>(<a href="../../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;q,
<a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a>&nbsp;it)</code>
<div class="block">Closes ResultIterator without reading its data.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.access.util.DefaultOperationObserver">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.access.util.<a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></h3>
<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#getGlobalExceptions()">getGlobalExceptions</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#getQueryExceptions()">getQueryExceptions</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#hasExceptions()">hasExceptions</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextBatchCount(org.apache.cayenne.query.Query,%20int[])">nextBatchCount</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextCount(org.apache.cayenne.query.Query,%20int)">nextCount</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextGeneratedRows(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.ResultIterator)">nextGeneratedRows</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextGlobalException(java.lang.Exception)">nextGlobalException</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextQueryException(org.apache.cayenne.query.Query,%20java.lang.Exception)">nextQueryException</a>, <a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#printExceptions(java.io.PrintWriter)">printExceptions</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="resultIterator">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resultIterator</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a> resultIterator</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IteratedSelectObserver()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IteratedSelectObserver</h4>
<pre>public&nbsp;IteratedSelectObserver()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isIteratedResult()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIteratedResult</h4>
<pre>public&nbsp;boolean&nbsp;isIteratedResult()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#isIteratedResult()">DefaultOperationObserver</a></code></strong></div>
<div class="block">Returns <code>false</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/OperationHints.html#isIteratedResult()">isIteratedResult</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/access/OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#isIteratedResult()">isIteratedResult</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></code></dd>
</dl>
</li>
</ul>
<a name="nextRows(org.apache.cayenne.query.Query, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextRows</h4>
<pre>public&nbsp;void&nbsp;nextRows(<a href="../../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;query,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;?&gt;&nbsp;dataRows)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/OperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20java.util.List)">OperationObserver</a></code></strong></div>
<div class="block">Callback method invoked for each processed ResultSet.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/OperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20java.util.List)">nextRows</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20java.util.List)">nextRows</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></code></dd>
</dl>
</li>
</ul>
<a name="nextRows(org.apache.cayenne.query.Query, org.apache.cayenne.access.ResultIterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextRows</h4>
<pre>public&nbsp;void&nbsp;nextRows(<a href="../../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;q,
<a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a>&nbsp;it)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.ResultIterator)">DefaultOperationObserver</a></code></strong></div>
<div class="block">Closes ResultIterator without reading its data. If you implement a custom subclass,
only call super if closing the iterator is what you need.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/OperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.ResultIterator)">nextRows</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html#nextRows(org.apache.cayenne.query.Query,%20org.apache.cayenne.access.ResultIterator)">nextRows</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util">DefaultOperationObserver</a></code></dd>
</dl>
</li>
</ul>
<a name="getResultIterator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResultIterator</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a>&nbsp;getResultIterator()
throws <a href="../../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IteratedSelectObserver.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/access/util/DefaultOperationObserver.html" title="class in org.apache.cayenne.access.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/util/IteratedSelectObserver.html" target="_top">Frames</a></li>
<li><a href="IteratedSelectObserver.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>