| <!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>VectorState (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="VectorState (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}; |
| 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/VectorState.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/physical/resultSet/impl/UnionState.UnionVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/impl/VectorState.html" target="_top">Frames</a></li> |
| <li><a href="VectorState.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.physical.resultSet.impl</div> |
| <h2 title="Interface VectorState" class="title">Interface VectorState</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/drill/exec/physical/resultSet/impl/ListState.ListVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ListState.ListVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/NullableVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">NullableVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/NullVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">NullVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/NullVectorState.UnmanagedVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">NullVectorState.UnmanagedVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/RepeatedListState.RepeatedListVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">RepeatedListState.RepeatedListVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/RepeatedVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">RepeatedVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.FixedWidthVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState.FixedWidthVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.IsSetVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState.IsSetVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.OffsetVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState.OffsetVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.SimpleVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState.SimpleVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/SingleVectorState.VariableWidthVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">SingleVectorState.VariableWidthVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/TupleState.DictArrayVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">TupleState.DictArrayVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/TupleState.DictVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">TupleState.DictVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/TupleState.MapVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">TupleState.MapVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/TupleState.SingleDictVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">TupleState.SingleDictVectorState</a>, <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/UnionState.UnionVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl">UnionState.UnionVectorState</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">VectorState</span></pre> |
| <div class="block">Handles batch and overflow operation for a (possibly compound) vector. |
| <p> |
| The data model is the following: |
| <ul> |
| <li>Column model<ul> |
| <li>Value vector itself</li> |
| <li>Column writer</li> |
| <li>Column schema</li> |
| <li>Column coordinator (this class)</li> |
| </ul></li></ul> |
| The vector state coordinates events between the result set loader |
| on the one side and the vectors, writers and schema on the other. |
| For example: |
| <pre><code> |
| Result Set Vector |
| Loader <--> State <--> Vectors |
| </code></pre> |
| Events from the row set loader deal with allocation, roll-over, |
| harvesting completed batches and so on. Events from the writer, |
| via the tuple model deal with adding columns and column |
| overflow.</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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/VectorState.html#allocate-int-">allocate</a></span>(int cardinality)</code> |
| <div class="block">Allocate a new vector with the number of elements given.</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/exec/physical/resultSet/impl/VectorState.html#close--">close</a></span>()</code> |
| <div class="block">Clear the vector(s) associated with this state.</div> |
| </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/physical/resultSet/impl/VectorState.html#dump-org.apache.drill.exec.vector.accessor.impl.HierarchicalFormatter-">dump</a></span>(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/impl/HierarchicalFormatter.html" title="interface in org.apache.drill.exec.vector.accessor.impl">HierarchicalFormatter</a> format)</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/physical/resultSet/impl/VectorState.html#harvestWithLookAhead--">harvestWithLookAhead</a></span>()</code> |
| <div class="block">A batch is being harvested after an overflow.</div> |
| </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/physical/resultSet/impl/VectorState.html#isProjected--">isProjected</a></span>()</code> |
| <div class="block">Report whether this column is projected (has materialized vectors), |
| or is unprojected (has no materialized backing.)</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/exec/physical/resultSet/impl/VectorState.html#rollover-int-">rollover</a></span>(int cardinality)</code> |
| <div class="block">A vector has overflowed.</div> |
| </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/physical/resultSet/impl/VectorState.html#startBatchWithLookAhead--">startBatchWithLookAhead</a></span>()</code> |
| <div class="block">A new batch is starting while an look-ahead vector exists.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="../../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/VectorState.html#vector--">vector</a></span>()</code> |
| <div class="block">Underlying vector: the one presented to the consumer of the |
| result set loader.</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="allocate-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre>int allocate(int cardinality)</pre> |
| <div class="block">Allocate a new vector with the number of elements given. If the vector |
| is an array, then the cardinality given is the number of arrays.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cardinality</code> - number of elements desired in the allocated |
| vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes allocated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollover-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollover</h4> |
| <pre>void rollover(int cardinality)</pre> |
| <div class="block">A vector has overflowed. Create a new look-ahead vector of the given |
| cardinality, then copy the overflow values from the main vector to the |
| look-ahead vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cardinality</code> - the number of elements in the new vector. If this |
| vector is an array, then this is the number of arrays</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="harvestWithLookAhead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>harvestWithLookAhead</h4> |
| <pre>void harvestWithLookAhead()</pre> |
| <div class="block">A batch is being harvested after an overflow. Put the full batch |
| back into the main vector so it can be harvested.</div> |
| </li> |
| </ul> |
| <a name="startBatchWithLookAhead--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startBatchWithLookAhead</h4> |
| <pre>void startBatchWithLookAhead()</pre> |
| <div class="block">A new batch is starting while an look-ahead vector exists. Move |
| the look-ahead buffers into the main vector to prepare for writing |
| the rest of the batch.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Clear the vector(s) associated with this state.</div> |
| </li> |
| </ul> |
| <a name="vector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vector</h4> |
| <pre><T extends <a href="../../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>> T vector()</pre> |
| <div class="block">Underlying vector: the one presented to the consumer of the |
| result set loader.</div> |
| </li> |
| </ul> |
| <a name="isProjected--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProjected</h4> |
| <pre>boolean isProjected()</pre> |
| <div class="block">Report whether this column is projected (has materialized vectors), |
| or is unprojected (has no materialized backing.)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the column is projected to the output, false if |
| not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dump-org.apache.drill.exec.vector.accessor.impl.HierarchicalFormatter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre>void dump(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/impl/HierarchicalFormatter.html" title="interface in org.apache.drill.exec.vector.accessor.impl">HierarchicalFormatter</a> format)</pre> |
| </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/VectorState.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/physical/resultSet/impl/UnionState.UnionVectorState.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/impl/VectorState.html" target="_top">Frames</a></li> |
| <li><a href="VectorState.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> |
