| <!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>ArrayReader (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="ArrayReader (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ArrayReader.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/vector/accessor/AbstractSqlAccessor.html" title="class in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ArrayReader.html" target="_top">Frames</a></li> |
| <li><a href="ArrayReader.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.drill.exec.vector.accessor</div> |
| <h2 title="Interface ArrayReader" class="title">Interface ArrayReader</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/DictReader.html" title="interface in org.apache.drill.exec.vector.accessor">DictReader</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/reader/ArrayReaderImpl.html" title="class in org.apache.drill.exec.vector.accessor.reader">ArrayReaderImpl</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/reader/DictReaderImpl.html" title="class in org.apache.drill.exec.vector.accessor.reader">DictReaderImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ArrayReader</span> |
| extends <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a></pre> |
| <div class="block">Generic array reader. An array is one of the following: |
| <ul> |
| <li>Array of scalars. Read the values using <code>#elements()</code>, which provides |
| an array-like access to the scalars.</li> |
| <li>A repeated map. Use <code>#tuple(int)</code> to get a tuple reader for a |
| specific array element. Use <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#size--"><code>size()</code></a> to learn the number of maps in |
| the array.</li> |
| <li>List of lists. Use the <code>#array(int)</code> method to get the nested list |
| at a given index. Use <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#size--"><code>size()</code></a> to learn the number of maps in |
| the array.</li> |
| </ul> |
| <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor"><code>ArrayWriter</code></a></div> |
| </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="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></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="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#array--">array</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectReader.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#entry--">entry</a></span>()</code> |
| <div class="block">Return the generic object reader for the array element.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#entryType--">entryType</a></span>()</code> |
| <div class="block">The object type of the list entry.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#next--">next</a></span>()</code> |
| <div class="block">Move forward one position.</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/exec/vector/accessor/ArrayReader.html#rewind--">rewind</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarReader.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#scalar--">scalar</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#setPosn-int-">setPosn</a></span>(int index)</code> |
| <div class="block">Set the array reader to read a given array entry.</div> |
| </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/vector/accessor/ArrayReader.html#size--">size</a></span>()</code> |
| <div class="block">Number of elements in the array.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/TupleReader.html" title="interface in org.apache.drill.exec.vector.accessor">TupleReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#tuple--">tuple</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/VariantReader.html" title="interface in org.apache.drill.exec.vector.accessor">VariantReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#variant--">variant</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ColumnReader"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.<a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html#getAsString--">getAsString</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html#getObject--">getObject</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html#isNull--">isNull</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html#schema--">schema</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html#type--">type</a></code></li> |
| </ul> |
| </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">Number of elements in the array.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entryType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entryType</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a> entryType()</pre> |
| <div class="block">The object type of the list entry. All entries have the same |
| type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object type of each entry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entry--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entry</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectReader.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectReader</a> entry()</pre> |
| <div class="block">Return the generic object reader for the array element. This |
| version <i>does not</i> position the reader, the client must |
| call <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#setPosn-int-"><code>setPosn(int)</code></a> to set the position. This form allows |
| up-front setup of the readers when convenient for the caller.</div> |
| </li> |
| </ul> |
| <a name="scalar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scalar</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarReader.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarReader</a> scalar()</pre> |
| </li> |
| </ul> |
| <a name="tuple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tuple</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/TupleReader.html" title="interface in org.apache.drill.exec.vector.accessor">TupleReader</a> tuple()</pre> |
| </li> |
| </ul> |
| <a name="array--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>array</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayReader</a> array()</pre> |
| </li> |
| </ul> |
| <a name="variant--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variant</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/VariantReader.html" title="interface in org.apache.drill.exec.vector.accessor">VariantReader</a> variant()</pre> |
| </li> |
| </ul> |
| <a name="setPosn-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPosn</h4> |
| <pre>void setPosn(int index)</pre> |
| <div class="block">Set the array reader to read a given array entry. Not used for |
| scalars, only for maps and arrays when using the non-indexed |
| methods <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#entry--"><code>entry()</code></a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#tuple--"><code>tuple()</code></a> and <a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayReader.html#array--"><code>array()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="rewind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewind</h4> |
| <pre>void rewind()</pre> |
| </li> |
| </ul> |
| <a name="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>boolean next()</pre> |
| <div class="block">Move forward one position.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if another position is available, false if |
| the end of the array is reached</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/ArrayReader.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/vector/accessor/AbstractSqlAccessor.html" title="class in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ArrayReader.html" target="_top">Frames</a></li> |
| <li><a href="ArrayReader.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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |