| <!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>AbstractArrayWriter (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="AbstractArrayWriter (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}; |
| 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/AbstractArrayWriter.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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayElementWriterIndex.html" title="class in org.apache.drill.exec.vector.accessor.writer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html" target="_top">Frames</a></li> |
| <li><a href="AbstractArrayWriter.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.vector.accessor.writer</div> |
| <h2 title="Class AbstractArrayWriter" class="title">Class AbstractArrayWriter</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.vector.accessor.writer.AbstractArrayWriter</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/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html" title="interface in org.apache.drill.exec.vector.accessor">WriterPosition</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.BaseArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.BaseArrayWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/dummy/DummyArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer.dummy">DummyArrayWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractArrayWriter</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/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a></pre> |
| <div class="block">Writer for an array-valued column. This writer appends values: once a value |
| is written, it cannot be changed. As a result, writer methods have no item |
| index; each set advances the array to the next position. |
| <p> |
| This class represents the array as a whole. In practice that means building |
| the offset vector. The array is associated with an element object that |
| manages writing to the scalar, array or tuple that is the array element. Note |
| that this representation makes little use of the methods in the "Repeated" |
| vector class: instead it works directly with the offset and element vectors. |
| <p> |
| An array has a one-to-many relationship with its children. Starting an array |
| prepares for writing the first element. Each element must be saved by calling |
| <tt>endValue()</tt>. This is done automatically for scalars (since there is |
| exactly one value per element), but must be done via the client code for |
| arrays of arrays or tuples. Valid state transitions: |
| |
| <table border=1> |
| <tr><th>Public API</th><th>Array Event</th><th>Offset Event</th><th>Element Event</th></tr> |
| <tr><td>startBatch()</td> |
| <td>startWrite()</td> |
| <td>startWrite()</td> |
| <td>startWrite()</td></tr> |
| <tr><td>start() (new row)</td> |
| <td>startRow()</td> |
| <td>startRow()</td> |
| <td>startRow()</td></tr> |
| <tr><td>start() (without save)</td> |
| <td>restartRow()</td> |
| <td>restartRow()</td> |
| <td>restartRow()</td></tr> |
| <tr><td>save() (array)</td> |
| <td>saveValue()</td> |
| <td>saveValue()</td> |
| <td>saveValue()</td></tr> |
| <tr><td>save() (row)</td> |
| <td colspan=3>See subclasses.</td></tr> |
| <tr><td>harvest()</td> |
| <td>endWrite()</td> |
| <td>endWrite()</td> |
| <td>endWrite()</td></tr> |
| </table> |
| |
| Some items to note: |
| <ul> |
| <li>Batch and row events are passed to the element.</li> |
| <li>Each element is saved via a call to <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#save--"><code>ArrayWriter.save()</code></a> on the array. |
| Without this call, the element value is discarded. This is necessary |
| because the array always has an active element: no "startElement" |
| method is necessary. This also means that any unsaved element values |
| can be discarded simply by omitting a call to <tt>save()</tt>.</li> |
| <li>Since elements must be saved individually, the call to |
| <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#saveRow--"><code>WriterEvents.saveRow()</code></a> <i>does not</i> call <tt>saveValue()</tt>. This |
| is an important distinction between an array and a tuple.</li> |
| <li>The offset and element writers are treated equally: the same events |
| are passed to both.</li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayElementWriterIndex.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.ArrayElementWriterIndex</a></span></code> |
| <div class="block">Index into the vector of elements for a repeated vector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.ArrayObjectWriter</a></span></code> |
| <div class="block">Object representation of an array writer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.BaseArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.BaseArrayWriter</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.vector.accessor.writer.WriterEvents"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.drill.exec.vector.accessor.writer.<a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a></h3> |
| <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.ColumnWriterListener.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents.ColumnWriterListener</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.State.html" title="enum in org.apache.drill.exec.vector.accessor.writer">WriterEvents.State</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayElementWriterIndex.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.ArrayElementWriterIndex</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#elementIndex">elementIndex</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractObjectWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#elementObjWriter">elementObjWriter</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#offsetsWriter">offsetsWriter</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriterIndex.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriterIndex</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#outerIndex">outerIndex</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/vector/accessor/writer/AbstractArrayWriter.html#AbstractArrayWriter-org.apache.drill.exec.record.metadata.ColumnMetadata-org.apache.drill.exec.vector.accessor.writer.AbstractObjectWriter-org.apache.drill.exec.vector.accessor.writer.OffsetVectorWriter-">AbstractArrayWriter</a></span>(<a href="../../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> schema, |
| <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractObjectWriter</a> elementObjWriter, |
| <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a> offsetVectorWriter)</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="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#array--">array</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/vector/accessor/writer/AbstractArrayWriter.html#bindListener-org.apache.drill.exec.vector.accessor.writer.WriterEvents.ColumnWriterListener-">bindListener</a></span>(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.ColumnWriterListener.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents.ColumnWriterListener</a> listener)</code> |
| <div class="block">Bind a listener to the underlying vector writer.</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/vector/accessor/writer/AbstractArrayWriter.html#copy-org.apache.drill.exec.vector.accessor.ColumnReader-">copy</a></span>(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a> from)</code> |
| <div class="block">Copy a single value from the given reader, which must be of the |
| same type as this writer.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html" title="interface in org.apache.drill.exec.vector.accessor">DictWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#dict--">dict</a></span>()</code> </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/writer/AbstractArrayWriter.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="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#entry--">entry</a></span>()</code> |
| <div class="block">The object type of the list entry.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/writer/AbstractArrayWriter.html#entryType--">entryType</a></span>()</code> |
| <div class="block">Return a generic object writer for the array entry.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#isProjected--">isProjected</a></span>()</code> |
| <div class="block">Whether this writer is projected (is backed by a materialized vector), |
| or is unprojected (is just a dummy writer.) In most cases, clients can |
| ignore whether the column is projected and just write to the writer.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#lastWriteIndex--">lastWriteIndex</a></span>()</code> |
| <div class="block">Return the last write position in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#nullable--">nullable</a></span>()</code> |
| <div class="block">Whether this writer allows nulls.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#offsetWriter--">offsetWriter</a></span>()</code> |
| <div class="block">Return the writer for the offset vector for this array.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#rowStartIndex--">rowStartIndex</a></span>()</code> |
| <div class="block">Position within the vector of the first value for the current row.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#scalar--">scalar</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#schema--">schema</a></span>()</code> |
| <div class="block">Returns the schema of the column associated with this writer.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#setNull--">setNull</a></span>()</code> |
| <div class="block">Set the current value to null.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#setNull-boolean-">setNull</a></span>(boolean isNull)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#size--">size</a></span>()</code> |
| <div class="block">Number of elements written thus far to the array.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/TupleWriter.html" title="interface in org.apache.drill.exec.vector.accessor">TupleWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#tuple--">tuple</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" 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/writer/AbstractArrayWriter.html#type--">type</a></span>()</code> |
| <div class="block">Return the object (structure) type of this writer.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/VariantWriter.html" title="interface in org.apache.drill.exec.vector.accessor">VariantWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#variant--">variant</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html#writeIndex--">writeIndex</a></span>()</code> |
| <div class="block">Current write index for the writer.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ArrayWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.<a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></h3> |
| <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#save--">save</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ColumnWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.<a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></h3> |
| <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setObject-java.lang.Object-">setObject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.writer.WriterEvents"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.writer.<a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a></h3> |
| <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#bindIndex-org.apache.drill.exec.vector.accessor.ColumnWriterIndex-">bindIndex</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#endArrayValue--">endArrayValue</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#endWrite--">endWrite</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#postRollover--">postRollover</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#preRollover--">preRollover</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#restartRow--">restartRow</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#saveRow--">saveRow</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#startRow--">startRow</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#startWrite--">startWrite</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="elementObjWriter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>elementObjWriter</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractObjectWriter</a> elementObjWriter</pre> |
| </li> |
| </ul> |
| <a name="offsetsWriter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offsetsWriter</h4> |
| <pre>protected final <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a> offsetsWriter</pre> |
| </li> |
| </ul> |
| <a name="outerIndex"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outerIndex</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriterIndex.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriterIndex</a> outerIndex</pre> |
| </li> |
| </ul> |
| <a name="elementIndex"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>elementIndex</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayElementWriterIndex.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter.ArrayElementWriterIndex</a> elementIndex</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractArrayWriter-org.apache.drill.exec.record.metadata.ColumnMetadata-org.apache.drill.exec.vector.accessor.writer.AbstractObjectWriter-org.apache.drill.exec.vector.accessor.writer.OffsetVectorWriter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractArrayWriter</h4> |
| <pre>public AbstractArrayWriter(<a href="../../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> schema, |
| <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractObjectWriter</a> elementObjWriter, |
| <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a> offsetVectorWriter)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="bindListener-org.apache.drill.exec.vector.accessor.writer.WriterEvents.ColumnWriterListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindListener</h4> |
| <pre>public void bindListener(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.ColumnWriterListener.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents.ColumnWriterListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#bindListener-org.apache.drill.exec.vector.accessor.writer.WriterEvents.ColumnWriterListener-">WriterEvents</a></code></span></div> |
| <div class="block">Bind a listener to the underlying vector writer. This listener reports on vector |
| events (overflow, growth), and so is called only when the writer is backed by |
| a vector. The listener is ignored (and never called) for dummy (non-projected) |
| columns. If the column is compound (such as for a nullable or repeated column, |
| or for a map), then the writer is bound to the individual components.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#bindListener-org.apache.drill.exec.vector.accessor.writer.WriterEvents.ColumnWriterListener-">bindListener</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the vector event listener to bind</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a> type()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#type--">ColumnWriter</a></code></span></div> |
| <div class="block">Return the object (structure) type of this writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#type--">type</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>type indicating if this is a scalar, tuple or array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entryType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entryType</h4> |
| <pre>public <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entryType--">ArrayWriter</a></code></span></div> |
| <div class="block">Return a generic object writer for the array entry.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entryType--">entryType</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>generic object reader</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a> schema()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#schema--">ColumnWriter</a></code></span></div> |
| <div class="block">Returns the schema of the column associated with this writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#schema--">schema</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>schema for this writer's column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="entry--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entry</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a> entry()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entry--">ArrayWriter</a></code></span></div> |
| <div class="block">The object type of the list entry. All entries have the same |
| type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#entry--">entry</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the object type of each entry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="scalar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scalar</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarWriter</a> scalar()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#scalar--">scalar</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tuple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tuple</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/TupleWriter.html" title="interface in org.apache.drill.exec.vector.accessor">TupleWriter</a> tuple()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#tuple--">tuple</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="array--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>array</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a> array()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#array--">array</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="variant--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variant</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/VariantWriter.html" title="interface in org.apache.drill.exec.vector.accessor">VariantWriter</a> variant()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#variant--">variant</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dict--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dict</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/DictWriter.html" title="interface in org.apache.drill.exec.vector.accessor">DictWriter</a> dict()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#dict--">dict</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="size--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>public int size()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#size--">ArrayWriter</a></code></span></div> |
| <div class="block">Number of elements written thus far to the array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#size--">size</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nullable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullable</h4> |
| <pre>public boolean nullable()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#nullable--">ColumnWriter</a></code></span></div> |
| <div class="block">Whether this writer allows nulls. This is not as simple as checking |
| for the <a href="../../../../../../../org/apache/drill/common/types/TypeProtos.DataMode.html#OPTIONAL"><code>TypeProtos.DataMode.OPTIONAL</code></a> type in the schema. List entries |
| are nullable, if they are primitive, but not if they are maps or lists. |
| Unions are nullable, regardless of cardinality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#nullable--">nullable</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a call to <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--"><code>ColumnWriter.setNull()</code></a> is supported, false |
| if not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isProjected--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProjected</h4> |
| <pre>public boolean isProjected()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#isProjected--">ColumnWriter</a></code></span></div> |
| <div class="block">Whether this writer is projected (is backed by a materialized vector), |
| or is unprojected (is just a dummy writer.) In most cases, clients can |
| ignore whether the column is projected and just write to the writer. |
| This flag handles those special cases where it is helpful to know if |
| the column is projected or not.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#isProjected--">isProjected</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNull--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNull</h4> |
| <pre>public void setNull()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--">ColumnWriter</a></code></span></div> |
| <div class="block">Set the current value to null. Support depends on the underlying |
| implementation: only nullable types support this operation. |
| |
| throws IllegalStateException if called on a non-nullable value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--">setNull</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rowStartIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowStartIndex</h4> |
| <pre>public int rowStartIndex()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#rowStartIndex--">WriterPosition</a></code></span></div> |
| <div class="block">Position within the vector of the first value for the current row. |
| Note that this is always the first value for the row, even for a |
| writer deeply nested within a hierarchy of arrays. (The first |
| position for the current array is not exposed in this API.)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#rowStartIndex--">rowStartIndex</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html" title="interface in org.apache.drill.exec.vector.accessor">WriterPosition</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the vector offset of the first value for the current |
| row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lastWriteIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastWriteIndex</h4> |
| <pre>public int lastWriteIndex()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#lastWriteIndex--">WriterPosition</a></code></span></div> |
| <div class="block">Return the last write position in the vector. This may be the |
| same as the writer index position (if the vector was written at |
| that point), or an earlier point. In either case, this value |
| points to the last valid value in the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#lastWriteIndex--">lastWriteIndex</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html" title="interface in org.apache.drill.exec.vector.accessor">WriterPosition</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>index of the last valid value in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeIndex</h4> |
| <pre>public int writeIndex()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#writeIndex--">WriterPosition</a></code></span></div> |
| <div class="block">Current write index for the writer. This is the global |
| array location for arrays, same as the row index for top-level |
| columns.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#writeIndex--">writeIndex</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html" title="interface in org.apache.drill.exec.vector.accessor">WriterPosition</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current write index</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNull-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNull</h4> |
| <pre>public void setNull(boolean isNull)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html#setNull-boolean-">setNull</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ArrayWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ArrayWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy-org.apache.drill.exec.vector.accessor.ColumnReader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public void copy(<a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a> from)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#copy-org.apache.drill.exec.vector.accessor.ColumnReader-">ColumnWriter</a></code></span></div> |
| <div class="block">Copy a single value from the given reader, which must be of the |
| same type as this writer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#copy-org.apache.drill.exec.vector.accessor.ColumnReader-">copy</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>from</code> - reader to provide the data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="offsetWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offsetWriter</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a> offsetWriter()</pre> |
| <div class="block">Return the writer for the offset vector for this array. Primarily used |
| to handle overflow; other clients should not attempt to muck about with |
| the offset vector directly.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the writer for the offset vector associated with this array</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>public 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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html#dump-org.apache.drill.exec.vector.accessor.impl.HierarchicalFormatter-">dump</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</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/AbstractArrayWriter.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>Prev Class</li> |
| <li><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.ArrayElementWriterIndex.html" title="class in org.apache.drill.exec.vector.accessor.writer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html" target="_top">Frames</a></li> |
| <li><a href="AbstractArrayWriter.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
