Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / vector / accessor / WriterPosition.html
blob: 4c97a299c71b77de3f1f092252afee932d5a3a75 [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>WriterPosition (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="WriterPosition (Drill : 1.20.3 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/WriterPosition.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/VariantWriter.VariantWriterListener.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/WriterPosition.html" target="_top">Frames</a></li>
<li><a href="WriterPosition.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 WriterPosition" class="title">Interface WriterPosition</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/writer/OffsetVectorWriter.html" title="interface in org.apache.drill.exec.vector.accessor.writer">OffsetVectorWriter</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/UnionWriterImpl.UnionShim.html" title="interface in org.apache.drill.exec.vector.accessor.writer">UnionWriterImpl.UnionShim</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/WriterEvents.html" title="interface in org.apache.drill.exec.vector.accessor.writer">WriterEvents</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.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/AbstractScalarWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">AbstractScalarWriterImpl</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/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/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/EmptyListShim.html" title="class in org.apache.drill.exec.vector.accessor.writer">EmptyListShim</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/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/SimpleListShim.html" title="class in org.apache.drill.exec.vector.accessor.writer">SimpleListShim</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/UnionVectorShim.html" title="class in org.apache.drill.exec.vector.accessor.writer">UnionVectorShim</a>, <a href="../../../../../../org/apache/drill/exec/vector/accessor/writer/UnionWriterImpl.html" title="class in org.apache.drill.exec.vector.accessor.writer">UnionWriterImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WriterPosition</span></pre>
<div class="block">Position information about a writer used during vector overflow.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#lastWriteIndex--">lastWriteIndex</a></span>()</code>
<div class="block">Return the last write position in the vector.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.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="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/vector/accessor/WriterPosition.html#writeIndex--">writeIndex</a></span>()</code>
<div class="block">Current write index for the 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="rowStartIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rowStartIndex</h4>
<pre>int&nbsp;rowStartIndex()</pre>
<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="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>int&nbsp;lastWriteIndex()</pre>
<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="returnLabel">Returns:</span></dt>
<dd>index of the last valid value in the vector</dd>
</dl>
</li>
</ul>
<a name="writeIndex--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>writeIndex</h4>
<pre>int&nbsp;writeIndex()</pre>
<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="returnLabel">Returns:</span></dt>
<dd>current write index</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/WriterPosition.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/VariantWriter.VariantWriterListener.html" title="interface in org.apache.drill.exec.vector.accessor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/vector/accessor/WriterPosition.html" target="_top">Frames</a></li>
<li><a href="WriterPosition.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>