| <!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>RecordIterator (Drill : 1.20.3 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="RecordIterator (Drill : 1.20.3 API)"; |
| } |
| } |
| 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}; |
| 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="class-use/RecordIterator.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/exec/record/RecordBatchSizer.ColumnSize.html" title="class in org.apache.drill.exec.record"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/record/RecordValueAccessor.html" title="class in org.apache.drill.exec.record"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/record/RecordIterator.html" target="_top">Frames</a></li> |
| <li><a href="RecordIterator.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.exec.record</div> |
| <h2 title="Class RecordIterator" class="title">Class RecordIterator</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.exec.record.RecordIterator</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/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?>>, <a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RecordIterator</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/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></pre> |
| <div class="block">RecordIterator iterates over incoming record batches one record at a time. |
| It allows to mark a position during iteration and reset back. |
| RecordIterator will hold onto multiple record batches in order to support resetting beyond record batch boundary.</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/exec/record/RecordIterator.html#RecordIterator-org.apache.drill.exec.record.RecordBatch-org.apache.drill.exec.record.AbstractRecordBatch-org.apache.drill.exec.ops.OperatorContext-int-boolean-org.apache.drill.exec.record.RecordBatchMemoryManager-">RecordIterator</a></span>(<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html" title="interface in org.apache.drill.exec.record">RecordBatch</a> incoming, |
| <a href="../../../../../org/apache/drill/exec/record/AbstractRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractRecordBatch</a><?> outgoing, |
| <a href="../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a> oContext, |
| int inputIndex, |
| boolean enableMarkAndReset, |
| <a href="../../../../../org/apache/drill/exec/record/RecordBatchMemoryManager.html" title="class in org.apache.drill.exec.record">RecordBatchMemoryManager</a> callBack)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#RecordIterator-org.apache.drill.exec.record.RecordBatch-org.apache.drill.exec.record.AbstractRecordBatch-org.apache.drill.exec.ops.OperatorContext-int-org.apache.drill.exec.record.RecordBatchMemoryManager-">RecordIterator</a></span>(<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html" title="interface in org.apache.drill.exec.record">RecordBatch</a> incoming, |
| <a href="../../../../../org/apache/drill/exec/record/AbstractRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractRecordBatch</a><?> outgoing, |
| <a href="../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a> oContext, |
| int inputIndex, |
| <a href="../../../../../org/apache/drill/exec/record/RecordBatchMemoryManager.html" title="class in org.apache.drill.exec.record">RecordBatchMemoryManager</a> callBack)</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="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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.drill.shaded.guava.com.google.common.collect.Range<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>>,<a href="../../../../../org/apache/drill/exec/physical/impl/sort/RecordBatchData.html" title="class in org.apache.drill.exec.physical.impl.sort">RecordBatchData</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#cachedBatches--">cachedBatches</a></span>()</code> </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/exec/record/RecordIterator.html#clear--">clear</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#clearInflightBatches--">clearInflightBatches</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#finished--">finished</a></span>()</code> </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/exec/record/RecordIterator.html#forward-long-">forward</a></span>(long delta)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getCurrentPosition--">getCurrentPosition</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getInnerRecordCount--">getInnerRecordCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getLastOutcome--">getLastOutcome</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getOuterPosition--">getOuterPosition</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getRecordCount--">getRecordCount</a></span>()</code> |
| <div class="block">Get the number of records.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/BatchSchema.html" title="class in org.apache.drill.exec.record">BatchSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getSchema--">getSchema</a></span>()</code> |
| <div class="block">Get the schema of the current RecordBatch.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/selection/SelectionVector2.html" title="class in org.apache.drill.exec.record.selection">SelectionVector2</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getSelectionVector2--">getSelectionVector2</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/selection/SelectionVector4.html" title="class in org.apache.drill.exec.record.selection">SelectionVector4</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getSelectionVector4--">getSelectionVector4</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getTotalRecordCount--">getTotalRecordCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getValueAccessorById-java.lang.Class-int...-">getValueAccessorById</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> clazz, |
| int... ids)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/TypedFieldId.html" title="class in org.apache.drill.exec.record">TypedFieldId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-">getValueVectorId</a></span>(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a> path)</code> |
| <div class="block">Get the value vector type and id for the given schema path.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#iterator--">iterator</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#mark--">mark</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#next--">next</a></span>()</code> |
| <div class="block">Move iterator to next record.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#prepare--">prepare</a></span>()</code> |
| <div class="block">buildSchema calls next() in order to read schema quikcly.</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/apache/drill/exec/record/RecordIterator.html#reset--">reset</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordIterator.html#toString--">toString</a></span>()</code> </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#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.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</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="RecordIterator-org.apache.drill.exec.record.RecordBatch-org.apache.drill.exec.record.AbstractRecordBatch-org.apache.drill.exec.ops.OperatorContext-int-org.apache.drill.exec.record.RecordBatchMemoryManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RecordIterator</h4> |
| <pre>public RecordIterator(<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html" title="interface in org.apache.drill.exec.record">RecordBatch</a> incoming, |
| <a href="../../../../../org/apache/drill/exec/record/AbstractRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractRecordBatch</a><?> outgoing, |
| <a href="../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a> oContext, |
| int inputIndex, |
| <a href="../../../../../org/apache/drill/exec/record/RecordBatchMemoryManager.html" title="class in org.apache.drill.exec.record">RecordBatchMemoryManager</a> callBack)</pre> |
| </li> |
| </ul> |
| <a name="RecordIterator-org.apache.drill.exec.record.RecordBatch-org.apache.drill.exec.record.AbstractRecordBatch-org.apache.drill.exec.ops.OperatorContext-int-boolean-org.apache.drill.exec.record.RecordBatchMemoryManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RecordIterator</h4> |
| <pre>public RecordIterator(<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html" title="interface in org.apache.drill.exec.record">RecordBatch</a> incoming, |
| <a href="../../../../../org/apache/drill/exec/record/AbstractRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractRecordBatch</a><?> outgoing, |
| <a href="../../../../../org/apache/drill/exec/ops/OperatorContext.html" title="interface in org.apache.drill.exec.ops">OperatorContext</a> oContext, |
| int inputIndex, |
| boolean enableMarkAndReset, |
| <a href="../../../../../org/apache/drill/exec/record/RecordBatchMemoryManager.html" title="class in org.apache.drill.exec.record">RecordBatchMemoryManager</a> callBack)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="mark--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mark</h4> |
| <pre>public void mark()</pre> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| </li> |
| </ul> |
| <a name="forward-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forward</h4> |
| <pre>public void forward(long delta)</pre> |
| </li> |
| </ul> |
| <a name="prepare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>public void prepare()</pre> |
| <div class="block">buildSchema calls next() in order to read schema quikcly. |
| Make sure we have fetched next non-empty batch at the end of the prepare. |
| After prepare position of iterator is at 0.</div> |
| </li> |
| </ul> |
| <a name="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a> next()</pre> |
| <div class="block">Move iterator to next record.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Status of current record batch read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finished--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finished</h4> |
| <pre>public boolean finished()</pre> |
| </li> |
| </ul> |
| <a name="getLastOutcome--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastOutcome</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a> getLastOutcome()</pre> |
| </li> |
| </ul> |
| <a name="getTotalRecordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalRecordCount</h4> |
| <pre>public long getTotalRecordCount()</pre> |
| </li> |
| </ul> |
| <a name="getInnerRecordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInnerRecordCount</h4> |
| <pre>public int getInnerRecordCount()</pre> |
| </li> |
| </ul> |
| <a name="getOuterPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOuterPosition</h4> |
| <pre>public long getOuterPosition()</pre> |
| </li> |
| </ul> |
| <a name="getCurrentPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentPosition</h4> |
| <pre>public int getCurrentPosition()</pre> |
| </li> |
| </ul> |
| <a name="cachedBatches--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cachedBatches</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><org.apache.drill.shaded.guava.com.google.common.collect.Range<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>>,<a href="../../../../../org/apache/drill/exec/physical/impl/sort/RecordBatchData.html" title="class in org.apache.drill.exec.physical.impl.sort">RecordBatchData</a>> cachedBatches()</pre> |
| </li> |
| </ul> |
| <a name="getValueAccessorById-java.lang.Class-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueAccessorById</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?> getValueAccessorById(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> clazz, |
| int... ids)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getValueAccessorById-java.lang.Class-int...-">getValueAccessorById</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueVectorId-org.apache.drill.common.expression.SchemaPath-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueVectorId</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/TypedFieldId.html" title="class in org.apache.drill.exec.record">TypedFieldId</a> getValueVectorId(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a> path)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-">VectorAccessible</a></code></span></div> |
| <div class="block">Get the value vector type and id for the given schema path. The TypedFieldId |
| should store a fieldId which is the same as the ordinal position of the field |
| within the Iterator provided this classes implementation of |
| <code>Iterable<ValueVector><code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-">getValueVectorId</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path where the vector should be located.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local field id associated with this vector. If no field matches this |
| path, this will return a null TypedFieldId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/BatchSchema.html" title="class in org.apache.drill.exec.record">BatchSchema</a> getSchema()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSchema--">VectorAccessible</a></code></span></div> |
| <div class="block">Get the schema of the current RecordBatch. This changes if and only if a *_NEW_SCHEMA |
| IterOutcome is provided.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSchema--">getSchema</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>schema of the current batch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRecordCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecordCount</h4> |
| <pre>public int getRecordCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getRecordCount--">VectorAccessible</a></code></span></div> |
| <div class="block">Get the number of records.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getRecordCount--">getRecordCount</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of records</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?>> iterator()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a><?>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSelectionVector2--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectionVector2</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/selection/SelectionVector2.html" title="class in org.apache.drill.exec.record.selection">SelectionVector2</a> getSelectionVector2()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSelectionVector2--">getSelectionVector2</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSelectionVector4--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectionVector4</h4> |
| <pre>public <a href="../../../../../org/apache/drill/exec/record/selection/SelectionVector4.html" title="class in org.apache.drill.exec.record.selection">SelectionVector4</a> getSelectionVector4()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSelectionVector4--">getSelectionVector4</a></code> in interface <code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| </li> |
| </ul> |
| <a name="clearInflightBatches--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearInflightBatches</h4> |
| <pre>public void clearInflightBatches()</pre> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </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> |
| <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/RecordIterator.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/exec/record/RecordBatchSizer.ColumnSize.html" title="class in org.apache.drill.exec.record"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/drill/exec/record/RecordValueAccessor.html" title="class in org.apache.drill.exec.record"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/drill/exec/record/RecordIterator.html" target="_top">Frames</a></li> |
| <li><a href="RecordIterator.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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
