Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / vector / accessor / ColumnWriter.html
blob: 6241301fd3ec58eca135d0ffdd9c46268bf2024f [file] [log] [blame]
<!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>ColumnWriter (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="ColumnWriter (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/ColumnWriter.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/ColumnReaderIndex.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriterIndex.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ColumnWriter.html" target="_top">Frames</a></li>
<li><a href="ColumnWriter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 ColumnWriter" class="title">Interface ColumnWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</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/DictWriter.html" title="interface in org.apache.drill.exec.vector.accessor">DictWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ObjectWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a>, <a href="../../../../../../org/apache/drill/exec/physical/resultSet/RowSetLoader.html" title="interface in org.apache.drill.exec.physical.resultSet">RowSetLoader</a>, <a href="../../../../../../org/apache/drill/exec/physical/rowSet/RowSetWriter.html" title="interface in org.apache.drill.exec.physical.rowSet">RowSetWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ScalarWriter.html" title="interface in org.apache.drill.exec.vector.accessor">ScalarWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/TupleWriter.html" title="interface in org.apache.drill.exec.vector.accessor">TupleWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/VariantWriter.html" title="interface in org.apache.drill.exec.vector.accessor">VariantWriter</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/AbstractArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractArrayWriter</a>, <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/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/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/AbstractObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractObjectWriter</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/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.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractTupleWriter</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/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/ColumnAccessors.BigIntColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.BigIntColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.DateColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.DateColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Decimal18ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Decimal18ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Decimal28SparseColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Decimal28SparseColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Decimal38SparseColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Decimal38SparseColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Decimal9ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Decimal9ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Float4ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Float4ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Float8ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Float8ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.IntColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.IntColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.IntervalColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.IntervalColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.IntervalDayColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.IntervalDayColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.IntervalYearColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.IntervalYearColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.SmallIntColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.SmallIntColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.TimeColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.TimeColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.TimeStampColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.TimeStampColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.TinyIntColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.TinyIntColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.UInt1ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.UInt1ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.UInt2ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.UInt2ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.UInt4ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.UInt4ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.UInt8ColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.UInt8ColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.Var16CharColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.Var16CharColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.VarBinaryColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.VarBinaryColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.VarCharColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.VarCharColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnAccessors.VarDecimalColumnWriter.html" title="class in org.apache.drill.exec.vector.accessor">ColumnAccessors.VarDecimalColumnWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/DictEntryWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">DictEntryWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/DictEntryWriter.DictEntryObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">DictEntryWriter.DictEntryObjectWriter</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>, <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/DummyDictWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer.dummy">DummyDictWriter</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/ListWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">ListWriterImpl</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/MapWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">MapWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/MapWriter.ArrayMapWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">MapWriter.ArrayMapWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/MapWriter.DummyArrayMapWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">MapWriter.DummyArrayMapWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/MapWriter.DummyMapWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">MapWriter.DummyMapWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/MapWriter.SingleMapWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">MapWriter.SingleMapWriter</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/ObjectArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">ObjectArrayWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/ObjectDictWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">ObjectDictWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/ObjectDictWriter.DictObjectWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">ObjectDictWriter.DictObjectWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/OffsetVectorWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriterImpl</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/RepeatedListWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">RepeatedListWriter</a>, <a href="../../../../../../org/apache/drill/exec/physical/resultSet/impl/RowSetLoaderImpl.html" title="class in org.apache.drill.exec.physical.resultSet.impl">RowSetLoaderImpl</a>, <a href="../../../../../../org/apache/drill/exec/physical/rowSet/RowSetWriterImpl.html" title="class in org.apache.drill.exec.physical.rowSet">RowSetWriterImpl</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/ScalarArrayWriter.html" title="class in org.apache.drill.exec.vector.accessor.writer">ScalarArrayWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/UnionWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">UnionWriterImpl</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 interface <span class="typeNameLabel">ColumnWriter</span></pre>
<div class="block">Generic information about a column writer including:
<ul>
<li>Metadata</li>
<li>Write position information about a writer needed by a vector overflow
implementation. Hides the details of implementation and the writer class
hierarchy, exposing just the required write position information.</li>
<li>Generic methods for writing to the object, primarily used for
testing.</li></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.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>&nbsp;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="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.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="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#nullable--">nullable</a></span>()</code>
<div class="block">Whether this writer allows nulls.</div>
</td>
</tr>
<tr id="i3" 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/ColumnWriter.html#schema--">schema</a></span>()</code>
<div class="block">Returns the schema of the column associated with this writer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--">setNull</a></span>()</code>
<div class="block">Set the current value to null.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.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>&nbsp;value)</code>
<div class="block">Generic technique to write data as a generic Java object.</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/ColumnWriter.html#type--">type</a></span>()</code>
<div class="block">Return the object (structure) type of this writer.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><a href="../../../../../../org/apache/drill/exec/vector/accessor/ObjectType.html" title="enum in org.apache.drill.exec.vector.accessor">ObjectType</a>&nbsp;type()</pre>
<div class="block">Return the object (structure) type of this writer.</div>
<dl>
<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>boolean&nbsp;nullable()</pre>
<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="returnLabel">Returns:</span></dt>
<dd>true if a call to <a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriter.html#setNull--"><code>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>boolean&nbsp;isProjected()</pre>
<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>
</li>
</ul>
<a name="schema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a>&nbsp;schema()</pre>
<div class="block">Returns the schema of the column associated with this writer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>schema for this writer's column</dd>
</dl>
</li>
</ul>
<a name="setNull--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNull</h4>
<pre>void&nbsp;setNull()</pre>
<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>
</li>
</ul>
<a name="copy-org.apache.drill.exec.vector.accessor.ColumnReader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>void&nbsp;copy(<a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnReader.html" title="interface in org.apache.drill.exec.vector.accessor">ColumnReader</a>&nbsp;from)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>from</code> - reader to provide the data</dd>
</dl>
</li>
</ul>
<a name="setObject-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setObject</h4>
<pre>void&nbsp;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>&nbsp;value)</pre>
<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="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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the type of the Java object
cannot be mapped to the type of the underlying vector or
vector structure</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/ColumnWriter.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/ColumnReaderIndex.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/vector/accessor/ColumnWriterIndex.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/ColumnWriter.html" target="_top">Frames</a></li>
<li><a href="ColumnWriter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>