| <!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>ScalarWriter (Drill : 1.20.0 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="ScalarWriter (Drill : 1.20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ScalarWriter.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/ScalarReader.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/vector/accessor/SqlAccessor.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ScalarWriter.html" target="_top">Frames</a></li> |
| <li><a href="ScalarWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.drill.exec.vector.accessor</div> |
| <h2 title="Interface ScalarWriter" class="title">Interface ScalarWriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ValueWriter</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractFixedWidthWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractFixedWidthWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractFixedWidthWriter.BaseFixedWidthWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractFixedWidthWriter.BaseFixedWidthWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractFixedWidthWriter.BaseIntWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractFixedWidthWriter.BaseIntWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractScalarWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractScalarWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractScalarWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractScalarWriterImpl</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/BaseScalarWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">BaseScalarWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/BaseVarWidthWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">BaseVarWidthWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/BitColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">BitColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/dummy/DummyArrayWriter.DummyOffsetVectorWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer.dummy">DummyArrayWriter.DummyOffsetVectorWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/dummy/DummyScalarWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer.dummy">DummyScalarWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/NullableScalarWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">NullableScalarWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriterImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ScalarWriter</span> |
| extends <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/ValueWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ValueWriter</a></pre> |
| <div class="block">Represents a scalar value: a required column, a nullable column, |
| or one element within an array of scalars. |
| <p> |
| Vector values are mapped to |
| their "natural" representations: the representation closest |
| to the actual vector value. For date and time values, this |
| generally means a numeric value. Applications can then map |
| this value to Java objects as desired. Decimal types all |
| map to BigDecimal as that is the only way in Java to |
| represent large decimal values. |
| <p> |
| In general, a column maps to just one value. However, derived |
| classes may choose to provide type conversions if convenient. |
| An exception is thrown if a call is made to a method that |
| is not supported by the column type. |
| <p> |
| <a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarReader.html" title="interface in org.apache.drill.exec.vector.accessor"><code>ScalarReader</code></a> |
| <code>ScalarElementReader</code></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html#extendedType--">extendedType</a></span>()</code> |
| <div class="block">The extended type of the value, describes the secondary type |
| for DATE, TIME and TIMESTAMP for which the value type is |
| int or long.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html#setDefaultValue-java.lang.Object-">setDefaultValue</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">Set the default value to be used to fill empties for this writer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html#valueType--">valueType</a></span>()</code> |
| <div class="block">Describe the type of the value.</div> |
| </td> |
| </tr> |
| </table> |
| <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#copy-org.apache.drill.exec.vector.accessor.ColumnReader-">copy</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#isProjected--">isProjected</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#nullable--">nullable</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#schema--">schema</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--">setNull</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setObject-java.lang.Object-">setObject</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#type--">type</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.accessor.ValueWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.drill.exec.vector.accessor.<a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ValueWriter</a></h3> |
| <code><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#appendBytes-byte:A-int-">appendBytes</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setBoolean-boolean-">setBoolean</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setBytes-byte:A-int-">setBytes</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setDate-java.time.LocalDate-">setDate</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setDecimal-java.math.BigDecimal-">setDecimal</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setDouble-double-">setDouble</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setFloat-float-">setFloat</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setInt-int-">setInt</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setLong-long-">setLong</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setNull--">setNull</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setPeriod-org.joda.time.Period-">setPeriod</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setString-java.lang.String-">setString</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setTime-java.time.LocalTime-">setTime</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setTimestamp-java.time.Instant-">setTimestamp</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setValue-java.lang.Object-">setValue</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="valueType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueType</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a> valueType()</pre> |
| <div class="block">Describe the type of the value. This is a compression of the |
| value vector type: it describes which method will return the |
| vector value.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value type which indicates which get method |
| is valid for the column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extendedType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extendedType</h4> |
| <pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueType.html" title="enum in org.apache.drill.exec.vector.accessor">ValueType</a> extendedType()</pre> |
| <div class="block">The extended type of the value, describes the secondary type |
| for DATE, TIME and TIMESTAMP for which the value type is |
| int or long.</div> |
| </li> |
| </ul> |
| <a name="setDefaultValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setDefaultValue</h4> |
| <pre>void setDefaultValue(<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">Set the default value to be used to fill empties for this writer. |
| Only valid for required writers: null writers set this is-set bit |
| to 0 and set the data value to 0.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value to set. Cannot be null. The type of the value |
| must match that legal for <a href="../../../../../../org/apache/drill/exec/vector/accessor/ValueWriter.html#setValue-java.lang.Object-"><code>ValueWriter.setValue(Object)</code></a></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/ScalarWriter.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/ScalarReader.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/vector/accessor/SqlAccessor.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ScalarWriter.html" target="_top">Frames</a></li> |
| <li><a href="ScalarWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |