blob: e769b52ff42fbfacf4359e8aef28658007d50651 [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>BaseDataValueVector (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="BaseDataValueVector (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":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/BaseDataValueVector.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/AllocationHelper.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/vector/BaseDataValueVector.html" target="_top">Frames</a></li>
<li><a href="BaseDataValueVector.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><a href="#nested.classes.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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</div>
<h2 title="Class BaseDataValueVector" class="title">Class BaseDataValueVector</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><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">org.apache.drill.exec.vector.BaseValueVector</a></li>
<li>
<ul class="inheritance">
<li>org.apache.drill.exec.vector.BaseDataValueVector</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&gt;, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/drill/exec/vector/BigIntVector.html" title="class in org.apache.drill.exec.vector">BigIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/BitVector.html" title="class in org.apache.drill.exec.vector">BitVector</a>, <a href="../../../../../org/apache/drill/exec/vector/DateVector.html" title="class in org.apache.drill.exec.vector">DateVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal18Vector.html" title="class in org.apache.drill.exec.vector">Decimal18Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal28DenseVector.html" title="class in org.apache.drill.exec.vector">Decimal28DenseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal28SparseVector.html" title="class in org.apache.drill.exec.vector">Decimal28SparseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal38DenseVector.html" title="class in org.apache.drill.exec.vector">Decimal38DenseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal38SparseVector.html" title="class in org.apache.drill.exec.vector">Decimal38SparseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Decimal9Vector.html" title="class in org.apache.drill.exec.vector">Decimal9Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/Float4Vector.html" title="class in org.apache.drill.exec.vector">Float4Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/Float8Vector.html" title="class in org.apache.drill.exec.vector">Float8Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/IntervalDayVector.html" title="class in org.apache.drill.exec.vector">IntervalDayVector</a>, <a href="../../../../../org/apache/drill/exec/vector/IntervalVector.html" title="class in org.apache.drill.exec.vector">IntervalVector</a>, <a href="../../../../../org/apache/drill/exec/vector/IntervalYearVector.html" title="class in org.apache.drill.exec.vector">IntervalYearVector</a>, <a href="../../../../../org/apache/drill/exec/vector/IntVector.html" title="class in org.apache.drill.exec.vector">IntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableBigIntVector.html" title="class in org.apache.drill.exec.vector">NullableBigIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableBitVector.html" title="class in org.apache.drill.exec.vector">NullableBitVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDateVector.html" title="class in org.apache.drill.exec.vector">NullableDateVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal18Vector.html" title="class in org.apache.drill.exec.vector">NullableDecimal18Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal28DenseVector.html" title="class in org.apache.drill.exec.vector">NullableDecimal28DenseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal28SparseVector.html" title="class in org.apache.drill.exec.vector">NullableDecimal28SparseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal38DenseVector.html" title="class in org.apache.drill.exec.vector">NullableDecimal38DenseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal38SparseVector.html" title="class in org.apache.drill.exec.vector">NullableDecimal38SparseVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableDecimal9Vector.html" title="class in org.apache.drill.exec.vector">NullableDecimal9Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableFloat4Vector.html" title="class in org.apache.drill.exec.vector">NullableFloat4Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableFloat8Vector.html" title="class in org.apache.drill.exec.vector">NullableFloat8Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableIntervalDayVector.html" title="class in org.apache.drill.exec.vector">NullableIntervalDayVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableIntervalVector.html" title="class in org.apache.drill.exec.vector">NullableIntervalVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableIntervalYearVector.html" title="class in org.apache.drill.exec.vector">NullableIntervalYearVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableIntVector.html" title="class in org.apache.drill.exec.vector">NullableIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableSmallIntVector.html" title="class in org.apache.drill.exec.vector">NullableSmallIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableTimeStampVector.html" title="class in org.apache.drill.exec.vector">NullableTimeStampVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableTimeVector.html" title="class in org.apache.drill.exec.vector">NullableTimeVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableTinyIntVector.html" title="class in org.apache.drill.exec.vector">NullableTinyIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableUInt1Vector.html" title="class in org.apache.drill.exec.vector">NullableUInt1Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableUInt2Vector.html" title="class in org.apache.drill.exec.vector">NullableUInt2Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableUInt4Vector.html" title="class in org.apache.drill.exec.vector">NullableUInt4Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableUInt8Vector.html" title="class in org.apache.drill.exec.vector">NullableUInt8Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableVar16CharVector.html" title="class in org.apache.drill.exec.vector">NullableVar16CharVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableVarBinaryVector.html" title="class in org.apache.drill.exec.vector">NullableVarBinaryVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableVarCharVector.html" title="class in org.apache.drill.exec.vector">NullableVarCharVector</a>, <a href="../../../../../org/apache/drill/exec/vector/NullableVarDecimalVector.html" title="class in org.apache.drill.exec.vector">NullableVarDecimalVector</a>, <a href="../../../../../org/apache/drill/exec/vector/SmallIntVector.html" title="class in org.apache.drill.exec.vector">SmallIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/TimeStampVector.html" title="class in org.apache.drill.exec.vector">TimeStampVector</a>, <a href="../../../../../org/apache/drill/exec/vector/TimeVector.html" title="class in org.apache.drill.exec.vector">TimeVector</a>, <a href="../../../../../org/apache/drill/exec/vector/TinyIntVector.html" title="class in org.apache.drill.exec.vector">TinyIntVector</a>, <a href="../../../../../org/apache/drill/exec/vector/UInt1Vector.html" title="class in org.apache.drill.exec.vector">UInt1Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/UInt2Vector.html" title="class in org.apache.drill.exec.vector">UInt2Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/UInt4Vector.html" title="class in org.apache.drill.exec.vector">UInt4Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/UInt8Vector.html" title="class in org.apache.drill.exec.vector">UInt8Vector</a>, <a href="../../../../../org/apache/drill/exec/vector/UntypedNullVector.html" title="class in org.apache.drill.exec.vector">UntypedNullVector</a>, <a href="../../../../../org/apache/drill/exec/vector/Var16CharVector.html" title="class in org.apache.drill.exec.vector">Var16CharVector</a>, <a href="../../../../../org/apache/drill/exec/vector/VarBinaryVector.html" title="class in org.apache.drill.exec.vector">VarBinaryVector</a>, <a href="../../../../../org/apache/drill/exec/vector/VarCharVector.html" title="class in org.apache.drill.exec.vector">VarCharVector</a>, <a href="../../../../../org/apache/drill/exec/vector/VarDecimalVector.html" title="class in org.apache.drill.exec.vector">VarDecimalVector</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BaseDataValueVector</span>
extends <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.BaseAccessor.html" title="class in org.apache.drill.exec.vector">BaseValueVector.BaseAccessor</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.BaseMutator.html" title="class in org.apache.drill.exec.vector">BaseValueVector.BaseMutator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.vector.ValueVector">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.Accessor.html" title="interface in org.apache.drill.exec.vector">ValueVector.Accessor</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.Mutator.html" title="interface in org.apache.drill.exec.vector">ValueVector.Mutator</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#data">data</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#emptyByteArray">emptyByteArray</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#allocator">allocator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#field">field</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#INITIAL_VALUE_ALLOCATION">INITIAL_VALUE_ALLOCATION</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#MAX_ALLOCATION_SIZE">MAX_ALLOCATION_SIZE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.drill.exec.vector.ValueVector">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#BITS_VECTOR_NAME">BITS_VECTOR_NAME</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MAX_BUFFER_SIZE">MAX_BUFFER_SIZE</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MAX_ROW_COUNT">MAX_ROW_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#MIN_ROW_COUNT">MIN_ROW_COUNT</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#OFFSETS_VECTOR_NAME">OFFSETS_VECTOR_NAME</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#VALUES_VECTOR_NAME">VALUES_VECTOR_NAME</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</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/BaseDataValueVector.html#BaseDataValueVector-org.apache.drill.exec.record.MaterializedField-org.apache.drill.exec.memory.BufferAllocator-">BaseDataValueVector</a></span>(<a href="../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a>&nbsp;field,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator)</code>&nbsp;</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">&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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/BaseDataValueVector.html#clear--">clear</a></span>()</code>
<div class="block">Release the underlying DrillBuf and reset the ValueVector to empty.</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/BaseDataValueVector.html#close--">close</a></span>()</code>
<div class="block">Alternative to clear().</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#collectLedgers-java.util.Set-">collectLedgers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/drill/exec/memory/AllocationManager.BufferLedger.html" title="class in org.apache.drill.exec.memory">AllocationManager.BufferLedger</a>&gt;&nbsp;ledgers)</code>
<div class="block">Add the ledgers underlying the buffers underlying the components of the
vector to the set provided.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">exchange</a></span>(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&nbsp;other)</code>
<div class="block">Exchange state with another value vector of the same type.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getAllocatedSize--">getAllocatedSize</a></span>()</code>
<div class="block">Returns the total size of buffers allocated by this vector.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBuffer--">getBuffer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBuffers-boolean-">getBuffers</a></span>(boolean&nbsp;clear)</code>
<div class="block">Return the underlying buffers associated with this vector.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#getBufferSize--">getBufferSize</a></span>()</code>
<div class="block">Returns the number of bytes that is used by this vector instance.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/vector/BaseDataValueVector.html#reallocRaw-int-">reallocRaw</a></span>(int&nbsp;newAllocationSize)</code>
<div class="block">Core of vector allocation.</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/BaseDataValueVector.html#reset--">reset</a></span>()</code>
<div class="block">This method has a similar effect of allocateNew() without actually clearing and reallocating
the value vector.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#checkBufRefs-org.apache.drill.exec.vector.ValueVector-">checkBufRefs</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#fillBitsVector-org.apache.drill.exec.vector.UInt1Vector-int-">fillBitsVector</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getField--">getField</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getField-java.lang.String-">getField</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getMetadata--">getMetadata</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getMetadataBuilder--">getMetadataBuilder</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#getTransferPair-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#iterator--">iterator</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#toNullable-org.apache.drill.exec.vector.ValueVector-">toNullable</a>, <a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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.ValueVector">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.vector.<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></h3>
<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNew--">allocateNew</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#copyEntry-int-org.apache.drill.exec.vector.ValueVector-int-">copyEntry</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAccessor--">getAccessor</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getMutator--">getMutator</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getPayloadByteCount-int-">getPayloadByteCount</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getReader--">getReader</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.drill.exec.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#load-org.apache.drill.exec.proto.UserBitShared.SerializedField-io.netty.buffer.DrillBuf-">load</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#makeTransferPair-org.apache.drill.exec.vector.ValueVector-">makeTransferPair</a>, <a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="emptyByteArray">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emptyByteArray</h4>
<pre>protected static final&nbsp;byte[] emptyByteArray</pre>
</li>
</ul>
<a name="data">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>data</h4>
<pre>protected&nbsp;<a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a> data</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BaseDataValueVector-org.apache.drill.exec.record.MaterializedField-org.apache.drill.exec.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseDataValueVector</h4>
<pre>public&nbsp;BaseDataValueVector(<a href="../../../../../org/apache/drill/exec/record/MaterializedField.html" title="class in org.apache.drill.exec.record">MaterializedField</a>&nbsp;field,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="reallocRaw-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reallocRaw</h4>
<pre>public abstract&nbsp;<a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>&nbsp;reallocRaw(int&nbsp;newAllocationSize)</pre>
<div class="block">Core of vector allocation. Given a new size (which must be a power of two), allocate
the new buffer, copy the current values, and leave the unused parts garbage-filled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newAllocationSize</code> - new buffer size as a power of two</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new buffer</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#clear--">ValueVector</a></code></span></div>
<div class="block">Release the underlying DrillBuf and reset the ValueVector to empty.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#clear--">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#clear--">clear</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#close--">ValueVector</a></code></span></div>
<div class="block">Alternative to clear(). Allows use as an AutoCloseable in try-with-resources.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html#close--">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector">BaseValueVector</a></code></dd>
</dl>
</li>
</ul>
<a name="getBuffers-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuffers</h4>
<pre>public&nbsp;<a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>[]&nbsp;getBuffers(boolean&nbsp;clear)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBuffers-boolean-">ValueVector</a></code></span></div>
<div class="block">Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for
this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus
external classes shouldn't hold a reference to it (unless they change it).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clear</code> - Whether to clear vector before returning; the buffers will still be refcounted;
but the returned array will be the only reference to them</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The underlying <a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer"><code>buffers</code></a> that is used by this vector instance.</dd>
</dl>
</li>
</ul>
<a name="getBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>public&nbsp;int&nbsp;getBufferSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getBufferSize--">ValueVector</a></code></span></div>
<div class="block">Returns the number of bytes that is used by this vector instance.
This is a bit of a misnomer. Returns the number of bytes used by
data in this instance.</div>
</li>
</ul>
<a name="getAllocatedSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllocatedSize</h4>
<pre>public&nbsp;int&nbsp;getAllocatedSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#getAllocatedSize--">ValueVector</a></code></span></div>
<div class="block">Returns the total size of buffers allocated by this vector. Has
meaning only when vectors are directly allocated and each vector
has its own buffer. Does not have meaning for vectors deserialized
from the network or disk in which multiple vectors share the
same vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>allocated buffer size, in bytes</dd>
</dl>
</li>
</ul>
<a name="getBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuffer</h4>
<pre>public&nbsp;<a href="../../../../../io/netty/buffer/DrillBuf.html" title="class in io.netty.buffer">DrillBuf</a>&nbsp;getBuffer()</pre>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">This method has a similar effect of allocateNew() without actually clearing and reallocating
the value vector. The purpose is to move the value vector to a "mutate" state</div>
</li>
</ul>
<a name="exchange-org.apache.drill.exec.vector.ValueVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exchange</h4>
<pre>public&nbsp;void&nbsp;exchange(<a href="../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#exchange-org.apache.drill.exec.vector.ValueVector-">ValueVector</a></code></span></div>
<div class="block">Exchange state with another value vector of the same type.
Used to implement look-ahead writers.</div>
</li>
</ul>
<a name="collectLedgers-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>collectLedgers</h4>
<pre>public&nbsp;void&nbsp;collectLedgers(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/drill/exec/memory/AllocationManager.BufferLedger.html" title="class in org.apache.drill.exec.memory">AllocationManager.BufferLedger</a>&gt;&nbsp;ledgers)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/drill/exec/vector/ValueVector.html#collectLedgers-java.util.Set-">ValueVector</a></code></span></div>
<div class="block">Add the ledgers underlying the buffers underlying the components of the
vector to the set provided. Used to determine actual memory allocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ledgers</code> - set of ledgers to which to add ledgers for this vector</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/BaseDataValueVector.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/AllocationHelper.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/vector/BaseValueVector.html" title="class in org.apache.drill.exec.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/vector/BaseDataValueVector.html" target="_top">Frames</a></li>
<li><a href="BaseDataValueVector.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><a href="#nested.classes.inherited.from.class.org.apache.drill.exec.vector.BaseValueVector">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>