| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SingleRowListener (Drill : 1.20.0 API)</title> |
| <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="SingleRowListener (Drill : 1.20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10,"i8":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="class-use/SingleRowListener.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/drill/PlanTestBase.html" title="class in org.apache.drill"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/drill/TestAggNullable.html" title="class in org.apache.drill"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/drill/SingleRowListener.html" target="_top">Frames</a></li> |
| <li><a href="SingleRowListener.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill</div> |
| <h2 title="Class SingleRowListener" class="title">Class SingleRowListener</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.apache.drill.SingleRowListener</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">SingleRowListener</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="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></pre> |
| <div class="block">Result listener that is set up to receive a single row. Useful for queries |
| such with a count(*) or limit 1. The abstract method <a href="../../../org/apache/drill/SingleRowListener.html#rowArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-"><code>rowArrived(QueryDataBatch)</code></a> provides |
| the means for a derived class to get the expected record's data.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#SingleRowListener--">SingleRowListener</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#cleanup--">cleanup</a></span>()</code> |
| <div class="block">Clean up any resources used.</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/apache/drill/SingleRowListener.html#dataArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-org.apache.drill.exec.rpc.ConnectionThrottle-">dataArrived</a></span>(<a href="../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a> result, |
| <a href="../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a> throttle)</code> |
| <div class="block">A <code>QueryData</code> message was received</div> |
| </td> |
| </tr> |
| <tr id="i2" 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><<a href="../../../org/apache/drill/exec/proto/UserBitShared.DrillPBError.html" title="class in org.apache.drill.exec.proto">UserBitShared.DrillPBError</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#getErrorList--">getErrorList</a></span>()</code> |
| <div class="block">Get an immutable copy of the list of all errors received so far.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.QueryState.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryResult.QueryState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#getQueryState--">getQueryState</a></span>()</code> |
| <div class="block">Get the last known QueryState.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#queryCompleted-org.apache.drill.exec.proto.UserBitShared.QueryResult.QueryState-">queryCompleted</a></span>(<a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.QueryState.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryResult.QueryState</a> state)</code> |
| <div class="block">The query has completed (successful completion or cancellation).</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#queryIdArrived-org.apache.drill.exec.proto.UserBitShared.QueryId-">queryIdArrived</a></span>(<a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a> queryId)</code> |
| <div class="block">QueryId is available.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#rowArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-">rowArrived</a></span>(<a href="../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a> queryDataBatch)</code> |
| <div class="block">A record has arrived and is ready for access.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#submissionFailed-org.apache.drill.common.exceptions.UserException-">submissionFailed</a></span>(<a href="../../../org/apache/drill/common/exceptions/UserException.html" title="class in org.apache.drill.common.exceptions">UserException</a> ex)</code> |
| <div class="block">The query has failed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/drill/SingleRowListener.html#waitForCompletion--">waitForCompletion</a></span>()</code> |
| <div class="block">Wait for the completion of this query; receiving a record or an error will both cause the |
| query to be considered complete</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 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#finalize--" title="class or interface in java.lang">finalize</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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SingleRowListener--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SingleRowListener</h4> |
| <pre>public SingleRowListener()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="queryIdArrived-org.apache.drill.exec.proto.UserBitShared.QueryId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryIdArrived</h4> |
| <pre>public void queryIdArrived(<a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a> queryId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#queryIdArrived-org.apache.drill.exec.proto.UserBitShared.QueryId-">UserResultsListener</a></code></span></div> |
| <div class="block">QueryId is available. Called when a query is successfully submitted to the |
| server.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#queryIdArrived-org.apache.drill.exec.proto.UserBitShared.QueryId-">queryIdArrived</a></code> in interface <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryId</code> - sent by the server along <code>Acks.OK</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submissionFailed-org.apache.drill.common.exceptions.UserException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submissionFailed</h4> |
| <pre>public void submissionFailed(<a href="../../../org/apache/drill/common/exceptions/UserException.html" title="class in org.apache.drill.common.exceptions">UserException</a> ex)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#submissionFailed-org.apache.drill.common.exceptions.UserException-">UserResultsListener</a></code></span></div> |
| <div class="block">The query has failed. Most likely called when the server returns a FAILED |
| query state. Can also be called if |
| <a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#dataArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-org.apache.drill.exec.rpc.ConnectionThrottle-"><code>dataArrived()</code></a> |
| throws an exception</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#submissionFailed-org.apache.drill.common.exceptions.UserException-">submissionFailed</a></code> in interface <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ex</code> - exception describing the cause of the failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="queryCompleted-org.apache.drill.exec.proto.UserBitShared.QueryResult.QueryState-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryCompleted</h4> |
| <pre>public void queryCompleted(<a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.QueryState.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryResult.QueryState</a> state)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#queryCompleted-org.apache.drill.exec.proto.UserBitShared.QueryResult.QueryState-">UserResultsListener</a></code></span></div> |
| <div class="block">The query has completed (successful completion or cancellation). The |
| listener will not receive any other data or result message. Called when the |
| server returns a terminal-non failing- state (COMPLETED or CANCELLED)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#queryCompleted-org.apache.drill.exec.proto.UserBitShared.QueryResult.QueryState-">queryCompleted</a></code> in interface <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dataArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-org.apache.drill.exec.rpc.ConnectionThrottle-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataArrived</h4> |
| <pre>public void dataArrived(<a href="../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a> result, |
| <a href="../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a> throttle)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#dataArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-org.apache.drill.exec.rpc.ConnectionThrottle-">UserResultsListener</a></code></span></div> |
| <div class="block">A <code>QueryData</code> message was received</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html#dataArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-org.apache.drill.exec.rpc.ConnectionThrottle-">dataArrived</a></code> in interface <code><a href="../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - data batch received</dd> |
| <dd><code>throttle</code> - connection throttle</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryState</h4> |
| <pre>public <a href="../../../org/apache/drill/exec/proto/UserBitShared.QueryResult.QueryState.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryResult.QueryState</a> getQueryState()</pre> |
| <div class="block">Get the last known QueryState.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the query state; may be null if no query state has been received</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getErrorList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getErrorList</h4> |
| <pre>public <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><<a href="../../../org/apache/drill/exec/proto/UserBitShared.DrillPBError.html" title="class in org.apache.drill.exec.proto">UserBitShared.DrillPBError</a>> getErrorList()</pre> |
| <div class="block">Get an immutable copy of the list of all errors received so far.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of errors received</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rowArrived-org.apache.drill.exec.rpc.user.QueryDataBatch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowArrived</h4> |
| <pre>protected abstract void rowArrived(<a href="../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a> queryDataBatch)</pre> |
| <div class="block">A record has arrived and is ready for access. |
| |
| <p>Derived classes provide whatever implementation they require here to access |
| the record's data.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryDataBatch</code> - result batch holding the row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForCompletion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForCompletion</h4> |
| <pre>public void waitForCompletion() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Wait for the completion of this query; receiving a record or an error will both cause the |
| query to be considered complete</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there was any kind of problem</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cleanup--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre>public void cleanup()</pre> |
| <div class="block">Clean up any resources used. |
| |
| <p>Derived classes may use this to free things like allocators or files that were used to |
| record data received in resultArrived().</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="class-use/SingleRowListener.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/drill/PlanTestBase.html" title="class in org.apache.drill"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/drill/TestAggNullable.html" title="class in org.apache.drill"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/drill/SingleRowListener.html" target="_top">Frames</a></li> |
| <li><a href="SingleRowListener.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
