| <!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>AbstractObjectWriter (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="AbstractObjectWriter (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractObjectWriter.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/writer/AbstractFixedWidthWriter.BaseIntWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractScalarWriter.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/AbstractObjectWriter.html" target="_top">Frames</a></li> |
| <li><a href="AbstractObjectWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill.exec.vector.accessor.writer</div> |
| <h2 title="Class AbstractObjectWriter" class="title">Class AbstractObjectWriter</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.AbstractObjectWriter</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/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><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>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractScalarWriterImpl.ScalarObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractScalarWriterImpl.ScalarObjectWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractTupleWriter.TupleObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractTupleWriter.TupleObjectWriter</a>, <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/UnionWriterImpl.VariantObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">UnionWriterImpl.VariantObjectWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractObjectWriter</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/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></pre> |
| <div class="block">Abstract base class for the object layer in writers. This class acts |
| as the glue between a column and the data type of that column, per the |
| JSON model which Drill uses. This base class provides stubs for most |
| methods so that type-specific subclasses can simply fill in the bits |
| needed for that particular class.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html#AbstractObjectWriter--">AbstractObjectWriter</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><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/AbstractObjectWriter.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/AbstractObjectWriter.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="i2" class="altColor"> |
| <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/AbstractObjectWriter.html#dict--">dict</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.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="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html#events--">events</a></span>()</code> |
| <div class="block">The internal state behind this writer.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/AbstractObjectWriter.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="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html#nullable--">nullable</a></span>()</code> |
| <div class="block">Whether this writer allows nulls.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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/AbstractObjectWriter.html#scalar--">scalar</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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/AbstractObjectWriter.html#schema--">schema</a></span>()</code> |
| <div class="block">Returns the schema of the column associated with this writer.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/AbstractObjectWriter.html#setNull--">setNull</a></span>()</code> |
| <div class="block">Set the current value to null.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/AbstractObjectWriter.html#setObject-java.lang.Object-">setObject</a></span>(<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> value)</code> |
| <div class="block">Generic technique to write data as a generic Java object.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractObjectWriter.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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/AbstractObjectWriter.html#tuple--">tuple</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <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/AbstractObjectWriter.html#type--">type</a></span>()</code> |
| <div class="block">Return the object (structure) type of this writer.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <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/AbstractObjectWriter.html#variant--">variant</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ObjectWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.<a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></h3> |
| <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html#writer--">writer</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractObjectWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractObjectWriter</h4> |
| <pre>public AbstractObjectWriter()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <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/ObjectWriter.html#scalar--">scalar</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</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/ObjectWriter.html#tuple--">tuple</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</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/ObjectWriter.html#array--">array</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</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/ObjectWriter.html#variant--">variant</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</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/ObjectWriter.html#dict--">dict</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="events--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>events</h4> |
| <pre>public abstract <a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</a> events()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html#events--">ObjectWriter</a></code></span></div> |
| <div class="block">The internal state behind this writer. To be used only by the |
| implementation, not by the client.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html#events--">events</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a></code></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="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="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="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="setObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObject</h4> |
| <pre>public void setObject(<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> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setObject-java.lang.Object-">ColumnWriter</a></code></span></div> |
| <div class="block">Generic technique to write data as a generic Java object. The |
| type of the object must match the target writer. |
| Primarily for testing. |
| <ul> |
| <li>Scalar: The type of the Java object must match the type of |
| the target vector. <tt>String</tt> or <tt>byte[]</tt> can be |
| used for Varchar vectors.</li> |
| <li>Array: Write the array given an array of values. The object |
| must be a Java array. The type of the array must match the type of |
| element in the repeated vector. That is, if the vector is |
| a <tt>Repeated Int</tt>, provide an <tt>int[]</tt> array.</tt></li> |
| <li>Tuple (map or row): The Java object must be an array of objects |
| in which the members of the array have a 1:1 correspondence with the |
| members of the tuple in the order defined by the writer metadata. |
| That is, if the map is (Int, Varchar), provide a <tt>Object[]</tt> |
| array like this: <tt>{10, "fred"}</tt>.</li> |
| <li>Union: Uses the Java object type to determine the type of the |
| backing vector. Creates a vector |
| of the required type if needed.</li></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setObject-java.lang.Object-">setObject</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>value</code> - value to write to the vector. The Java type of the |
| object indicates the Drill storage type</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="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="dump-org.apache.drill.exec.vector.accessor.impl.HierarchicalFormatter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre>public abstract 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> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractObjectWriter.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/writer/AbstractFixedWidthWriter.BaseIntWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractScalarWriter.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/AbstractObjectWriter.html" target="_top">Frames</a></li> |
| <li><a href="AbstractObjectWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
