| <!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:58 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>QueryResponse (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="QueryResponse (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/QueryResponse.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/PersistentObject.html" title="class in org.apache.cayenne"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/QueryResponse.html" target="_top">Frames</a></li> |
| <li><a href="QueryResponse.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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</div> |
| <h2 title="Interface QueryResponse" class="title">Interface QueryResponse</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../org/apache/cayenne/util/GenericResponse.html" title="class in org.apache.cayenne.util">GenericResponse</a>, <a href="../../../org/apache/cayenne/util/IncrementalListResponse.html" title="class in org.apache.cayenne.util">IncrementalListResponse</a>, <a href="../../../org/apache/cayenne/util/ListResponse.html" title="class in org.apache.cayenne.util">ListResponse</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">QueryResponse</span></pre> |
| <div class="block">Represents a result of query execution. It potentially contain a mix of update counts |
| and lists of selected values. Provides API somewhat similar to java.util.Iterator or |
| java.sql.ResultSet for scanning through the individual results. |
| <p> |
| An example of iterating through a response: |
| </p> |
| |
| <pre> |
| QueryResponse response = context.performGenericQuery(query); |
| for (response.reset(); response.next();) { |
| if (response.isList()) { |
| List list = response.currentList(); |
| // ... |
| } |
| else { |
| int[] updateCounts = response.currentUpdateCount(); |
| // ... |
| } |
| } |
| </pre> |
| |
| <p> |
| In case the structure of the result is known, and only a single list or an update count |
| is expected, there is a simpler API to access them: |
| </p> |
| |
| <pre> |
| QueryResponse response = context.performGenericQuery(query); |
| List list = response.firstList(); |
| int[] count = response.firstUpdateCount(); |
| </pre></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#currentList()">currentList</a></strong>()</code> |
| <div class="block">Returns a List under the current iterator position.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#currentUpdateCount()">currentUpdateCount</a></strong>()</code> |
| <div class="block">Returns an update count under the current iterator position.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#firstList()">firstList</a></strong>()</code> |
| <div class="block">A utility method for quickly retrieving the first list in the response.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#firstUpdateCount()">firstUpdateCount</a></strong>()</code> |
| <div class="block">A utility method for quickly retrieving the first update count from the response.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#isList()">isList</a></strong>()</code> |
| <div class="block">Returns whether current iteration result is a list or an update count.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#next()">next</a></strong>()</code> |
| <div class="block">Rewinds response iterator to the next result, returning true if it is available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#reset()">reset</a></strong>()</code> |
| <div class="block">Restarts response iterator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/cayenne/QueryResponse.html#size()">size</a></strong>()</code> |
| <div class="block">Returns a number of results in the response.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="size()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>int size()</pre> |
| <div class="block">Returns a number of results in the response.</div> |
| </li> |
| </ul> |
| <a name="isList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isList</h4> |
| <pre>boolean isList()</pre> |
| <div class="block">Returns whether current iteration result is a list or an update count.</div> |
| </li> |
| </ul> |
| <a name="currentList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentList</h4> |
| <pre><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><?> currentList()</pre> |
| <div class="block">Returns a List under the current iterator position. Use <a href="../../../org/apache/cayenne/QueryResponse.html#isList()"><code>isList()</code></a> to check |
| the result type before calling this method.</div> |
| </li> |
| </ul> |
| <a name="currentUpdateCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentUpdateCount</h4> |
| <pre>int[] currentUpdateCount()</pre> |
| <div class="block">Returns an update count under the current iterator position. Returned value is an |
| int[] to accommodate batch queries. For a regular update result, the value will be |
| an int[1]. Use <a href="../../../org/apache/cayenne/QueryResponse.html#isList()"><code>isList()</code></a> to check the result type before calling this |
| method.</div> |
| </li> |
| </ul> |
| <a name="next()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>boolean next()</pre> |
| <div class="block">Rewinds response iterator to the next result, returning true if it is available.</div> |
| </li> |
| </ul> |
| <a name="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Restarts response iterator.</div> |
| </li> |
| </ul> |
| <a name="firstList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>firstList</h4> |
| <pre><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> firstList()</pre> |
| <div class="block">A utility method for quickly retrieving the first list in the response. Returns |
| null if the query has no lists. Note that this method resets current iterator to an |
| undefined state.</div> |
| </li> |
| </ul> |
| <a name="firstUpdateCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>firstUpdateCount</h4> |
| <pre>int[] firstUpdateCount()</pre> |
| <div class="block">A utility method for quickly retrieving the first update count from the response. |
| Note that this method resets current iterator to an undefined state.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QueryResponse.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/PersistentObject.html" title="class in org.apache.cayenne"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/QueryResponse.html" target="_top">Frames</a></li> |
| <li><a href="QueryResponse.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
