Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / vector / ValueVector.html
blob: b4adcabf11ff4af736121fbbc6c5fb888adccffb [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>ValueVector (Apache Arrow Java Root POM 17.0.0-SNAPSHOT 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="ValueVector (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":18,"i36":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/ValueVector.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/arrow/vector/UInt8Vector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/VarBinaryVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/vector/ValueVector.html" target="_top">Frames</a></li>
<li><a href="ValueVector.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.arrow.vector</div>
<h2 title="Interface ValueVector" class="title">Interface ValueVector</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><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/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/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&gt;</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/arrow/vector/BaseIntVector.html" title="interface in org.apache.arrow.vector">BaseIntVector</a>, <a href="../../../../org/apache/arrow/vector/complex/BaseListVector.html" title="interface in org.apache.arrow.vector.complex">BaseListVector</a>, <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>, <a href="../../../../org/apache/arrow/vector/FixedWidthVector.html" title="interface in org.apache.arrow.vector">FixedWidthVector</a>, <a href="../../../../org/apache/arrow/vector/FloatingPointVector.html" title="interface in org.apache.arrow.vector">FloatingPointVector</a>, <a href="../../../../org/apache/arrow/vector/complex/RepeatedValueVector.html" title="interface in org.apache.arrow.vector.complex">RepeatedValueVector</a>, <a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a>, <a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/arrow/vector/complex/AbstractContainerVector.html" title="class in org.apache.arrow.vector.complex">AbstractContainerVector</a>, <a href="../../../../org/apache/arrow/vector/complex/AbstractStructVector.html" title="class in org.apache.arrow.vector.complex">AbstractStructVector</a>, <a href="../../../../org/apache/arrow/vector/BaseFixedWidthVector.html" title="class in org.apache.arrow.vector">BaseFixedWidthVector</a>, <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseLargeVariableWidthVector</a>, <a href="../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a>, <a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a>, <a href="../../../../org/apache/arrow/vector/BaseVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseVariableWidthVector</a>, <a href="../../../../org/apache/arrow/vector/BaseVariableWidthViewVector.html" title="class in org.apache.arrow.vector">BaseVariableWidthViewVector</a>, <a href="../../../../org/apache/arrow/vector/BigIntVector.html" title="class in org.apache.arrow.vector">BigIntVector</a>, <a href="../../../../org/apache/arrow/vector/BitVector.html" title="class in org.apache.arrow.vector">BitVector</a>, <a href="../../../../org/apache/arrow/vector/DateDayVector.html" title="class in org.apache.arrow.vector">DateDayVector</a>, <a href="../../../../org/apache/arrow/vector/DateMilliVector.html" title="class in org.apache.arrow.vector">DateMilliVector</a>, <a href="../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>, <a href="../../../../org/apache/arrow/vector/DecimalVector.html" title="class in org.apache.arrow.vector">DecimalVector</a>, <a href="../../../../org/apache/arrow/vector/complex/DenseUnionVector.html" title="class in org.apache.arrow.vector.complex">DenseUnionVector</a>, <a href="../../../../org/apache/arrow/vector/DurationVector.html" title="class in org.apache.arrow.vector">DurationVector</a>, <a href="../../../../org/apache/arrow/vector/ExtensionTypeVector.html" title="class in org.apache.arrow.vector">ExtensionTypeVector</a>, <a href="../../../../org/apache/arrow/vector/FixedSizeBinaryVector.html" title="class in org.apache.arrow.vector">FixedSizeBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/complex/FixedSizeListVector.html" title="class in org.apache.arrow.vector.complex">FixedSizeListVector</a>, <a href="../../../../org/apache/arrow/vector/Float2Vector.html" title="class in org.apache.arrow.vector">Float2Vector</a>, <a href="../../../../org/apache/arrow/vector/Float4Vector.html" title="class in org.apache.arrow.vector">Float4Vector</a>, <a href="../../../../org/apache/arrow/vector/Float8Vector.html" title="class in org.apache.arrow.vector">Float8Vector</a>, <a href="../../../../org/apache/arrow/vector/IntervalDayVector.html" title="class in org.apache.arrow.vector">IntervalDayVector</a>, <a href="../../../../org/apache/arrow/vector/IntervalMonthDayNanoVector.html" title="class in org.apache.arrow.vector">IntervalMonthDayNanoVector</a>, <a href="../../../../org/apache/arrow/vector/IntervalYearVector.html" title="class in org.apache.arrow.vector">IntervalYearVector</a>, <a href="../../../../org/apache/arrow/vector/IntVector.html" title="class in org.apache.arrow.vector">IntVector</a>, <a href="../../../../org/apache/arrow/vector/complex/LargeListVector.html" title="class in org.apache.arrow.vector.complex">LargeListVector</a>, <a href="../../../../org/apache/arrow/vector/LargeVarBinaryVector.html" title="class in org.apache.arrow.vector">LargeVarBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/LargeVarCharVector.html" title="class in org.apache.arrow.vector">LargeVarCharVector</a>, <a href="../../../../org/apache/arrow/vector/complex/ListVector.html" title="class in org.apache.arrow.vector.complex">ListVector</a>, <a href="../../../../org/apache/arrow/vector/complex/MapVector.html" title="class in org.apache.arrow.vector.complex">MapVector</a>, <a href="../../../../org/apache/arrow/vector/complex/NonNullableStructVector.html" title="class in org.apache.arrow.vector.complex">NonNullableStructVector</a>, <a href="../../../../org/apache/arrow/vector/NullVector.html" title="class in org.apache.arrow.vector">NullVector</a>, <a href="../../../../org/apache/arrow/vector/SmallIntVector.html" title="class in org.apache.arrow.vector">SmallIntVector</a>, <a href="../../../../org/apache/arrow/vector/complex/StructVector.html" title="class in org.apache.arrow.vector.complex">StructVector</a>, <a href="../../../../org/apache/arrow/vector/TimeMicroVector.html" title="class in org.apache.arrow.vector">TimeMicroVector</a>, <a href="../../../../org/apache/arrow/vector/TimeMilliVector.html" title="class in org.apache.arrow.vector">TimeMilliVector</a>, <a href="../../../../org/apache/arrow/vector/TimeNanoVector.html" title="class in org.apache.arrow.vector">TimeNanoVector</a>, <a href="../../../../org/apache/arrow/vector/TimeSecVector.html" title="class in org.apache.arrow.vector">TimeSecVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMicroTZVector.html" title="class in org.apache.arrow.vector">TimeStampMicroTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMicroVector.html" title="class in org.apache.arrow.vector">TimeStampMicroVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMilliTZVector.html" title="class in org.apache.arrow.vector">TimeStampMilliTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMilliVector.html" title="class in org.apache.arrow.vector">TimeStampMilliVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampNanoTZVector.html" title="class in org.apache.arrow.vector">TimeStampNanoTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampNanoVector.html" title="class in org.apache.arrow.vector">TimeStampNanoVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampSecTZVector.html" title="class in org.apache.arrow.vector">TimeStampSecTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampSecVector.html" title="class in org.apache.arrow.vector">TimeStampSecVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampVector.html" title="class in org.apache.arrow.vector">TimeStampVector</a>, <a href="../../../../org/apache/arrow/vector/TinyIntVector.html" title="class in org.apache.arrow.vector">TinyIntVector</a>, <a href="../../../../org/apache/arrow/vector/UInt1Vector.html" title="class in org.apache.arrow.vector">UInt1Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt2Vector.html" title="class in org.apache.arrow.vector">UInt2Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt4Vector.html" title="class in org.apache.arrow.vector">UInt4Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt8Vector.html" title="class in org.apache.arrow.vector">UInt8Vector</a>, <a href="../../../../org/apache/arrow/vector/complex/UnionVector.html" title="class in org.apache.arrow.vector.complex">UnionVector</a>, <a href="../../../../org/apache/arrow/vector/VarBinaryVector.html" title="class in org.apache.arrow.vector">VarBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/VarCharVector.html" title="class in org.apache.arrow.vector">VarCharVector</a>, <a href="../../../../org/apache/arrow/vector/ViewVarBinaryVector.html" title="class in org.apache.arrow.vector">ViewVarBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/ViewVarCharVector.html" title="class in org.apache.arrow.vector">ViewVarCharVector</a>, <a href="../../../../org/apache/arrow/vector/ZeroVector.html" title="class in org.apache.arrow.vector">ZeroVector</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ValueVector</span>
extends <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/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&gt;</pre>
<div class="block">An abstraction that is used to store a sequence of values in an individual column.
<p>A <a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector"><code>value vector</code></a> stores underlying data in-memory in a columnar fashion that is compact and
efficient. The column whose data is stored, is referred by <a href="../../../../org/apache/arrow/vector/ValueVector.html#getField--"><code>getField()</code></a>.
<p>It is important that vector is allocated before attempting to read or write.
<p>There are a few "rules" around vectors:
<ul>
<li>values need to be written in order (e.g. index 0, 1, 2, 5)</li>
<li>null vectors start with all values as null before writing anything</li>
<li>for variable width types, the offset vector should be all zeros before writing</li>
<li>you must call setValueCount before a vector can be read</li>
<li>you should never write to a vector once it has been read.</li>
</ul>
<p>Please note that the current implementation doesn't enforce those rules, hence we may find few places that
deviate from these rules (e.g. offset vectors in Variable Length and Repeated vector)
<p>This interface "should" strive to guarantee this order of operation:
<blockquote>
allocate &gt; mutate &gt; setvaluecount &gt; access &gt; clear (or allocate to start the process over).
</blockquote></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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>&lt;OUT,IN&gt;&nbsp;OUT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">accept</a></span>(<a href="../../../../org/apache/arrow/vector/compare/VectorVisitor.html" title="interface in org.apache.arrow.vector.compare">VectorVisitor</a>&lt;OUT,IN&gt;&nbsp;visitor,
IN&nbsp;value)</code>
<div class="block">Accept a generic <a href="../../../../org/apache/arrow/vector/compare/VectorVisitor.html" title="interface in org.apache.arrow.vector.compare"><code>VectorVisitor</code></a> and return the result.</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/arrow/vector/ValueVector.html#allocateNew--">allocateNew</a></span>()</code>
<div class="block">Allocate new buffers.</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/arrow/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a></span>()</code>
<div class="block">Allocates new buffers.</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/arrow/vector/ValueVector.html#clear--">clear</a></span>()</code>
<div class="block">Release any owned ArrowBuf and reset the ValueVector to the initial state.</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/arrow/vector/ValueVector.html#close--">close</a></span>()</code>
<div class="block">Alternative to clear().</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/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a></span>(int&nbsp;fromIndex,
int&nbsp;thisIndex,
<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;from)</code>
<div class="block">Copy a cell value from a particular index in source vector to a particular
position in this vector.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a></span>(int&nbsp;fromIndex,
int&nbsp;thisIndex,
<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;from)</code>
<div class="block">Same as <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-"><code>copyFrom(int, int, ValueVector)</code></a> except that
it handles the case when the capacity of the vector needs to be expanded
before copy.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getAllocator--">getAllocator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.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="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSize--">getBufferSize</a></span>()</code>
<div class="block">Get the number of bytes used by this vector.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></span>(int&nbsp;valueCount)</code>
<div class="block">Returns the number of bytes that is used by this vector if it holds the given number
of values.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">getDataBuffer</a></span>()</code>
<div class="block">Gets the underlying buffer associated with data vector.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getField--">getField</a></span>()</code>
<div class="block">Get information about how this field is materialized.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/types/Types.MinorType.html" title="enum in org.apache.arrow.vector.types">Types.MinorType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">getName</a></span>()</code>
<div class="block">Gets the name of the vector.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getNullCount--">getNullCount</a></span>()</code>
<div class="block">Returns number of null elements in the vector.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a></span>(int&nbsp;index)</code>
<div class="block">Get friendly type object from the vector.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">getOffsetBuffer</a></span>()</code>
<div class="block">Gets the underlying buffer associated with offset vector.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a></span>()</code>
<div class="block">Get a reader for this vector.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></span>(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">To transfer quota responsibility.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></span>(<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;field,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">To transfer quota responsibility.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a></span>(<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;field,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator,
<a href="../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a>&nbsp;callBack)</code>
<div class="block">To transfer quota responsibility.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">To transfer quota responsibility.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator,
<a href="../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a>&nbsp;callBack)</code>
<div class="block">To transfer quota responsibility.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">getValidityBuffer</a></span>()</code>
<div class="block">Gets the underlying buffer associated with validity vector.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a></span>()</code>
<div class="block">Returns the maximum number of values that can be stored in this vector instance.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCount--">getValueCount</a></span>()</code>
<div class="block">Gets the number of values.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">hashCode</a></span>(int&nbsp;index)</code>
<div class="block">Returns hashCode of element in index with the default hasher.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a></span>(int&nbsp;index,
<a href="../../../../org/apache/arrow/memory/util/hash/ArrowBufHasher.html" title="interface in org.apache.arrow.memory.util.hash">ArrowBufHasher</a>&nbsp;hasher)</code>
<div class="block">Returns hashCode of element in index with the given hasher.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#isNull-int-">isNull</a></span>(int&nbsp;index)</code>
<div class="block">Check whether an element in the vector is null.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a></span>(<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;target)</code>
<div class="block">Makes a new transfer pair used to transfer underlying buffers.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#reAlloc--">reAlloc</a></span>()</code>
<div class="block">Allocate new buffer with double capacity, and copy data into the new buffer.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#reset--">reset</a></span>()</code>
<div class="block">Reset the ValueVector to the initial state without releasing any owned ArrowBuf.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int&nbsp;numRecords)</code>
<div class="block">Set the initial record capacity.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#setValueCount-int-">setValueCount</a></span>(int&nbsp;valueCount)</code>
<div class="block">Set number of values in the vector.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#validate--">validate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/ValueVector.html#validateFull--">validateFull</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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#iterator--" title="class or interface in java.lang">iterator</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="allocateNew--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocateNew</h4>
<pre>void&nbsp;allocateNew()
throws <a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></pre>
<div class="block">Allocate new buffers. ValueVector implements logic to determine how much to allocate.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code> - Thrown if no memory can be allocated.</dd>
</dl>
</li>
</ul>
<a name="allocateNewSafe--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocateNewSafe</h4>
<pre>boolean&nbsp;allocateNewSafe()</pre>
<div class="block">Allocates new buffers. ValueVector implements logic to determine how much to allocate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns true if allocation was successful.</dd>
</dl>
</li>
</ul>
<a name="reAlloc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reAlloc</h4>
<pre>void&nbsp;reAlloc()</pre>
<div class="block">Allocate new buffer with double capacity, and copy data into the new buffer.
Replace vector's buffer with new buffer, and release old one</div>
</li>
</ul>
<a name="getAllocator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllocator</h4>
<pre><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;getAllocator()</pre>
</li>
</ul>
<a name="setInitialCapacity-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialCapacity</h4>
<pre>void&nbsp;setInitialCapacity(int&nbsp;numRecords)</pre>
<div class="block">Set the initial record capacity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numRecords</code> - the initial record capacity.</dd>
</dl>
</li>
</ul>
<a name="getValueCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueCapacity</h4>
<pre>int&nbsp;getValueCapacity()</pre>
<div class="block">Returns the maximum number of values that can be stored in this vector instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of values that can be stored in this vector instance.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()</pre>
<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/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="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>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()</pre>
<div class="block">Release any owned ArrowBuf and reset the ValueVector to the initial state. If the
vector has any child vectors, they will also be cleared.</div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>void&nbsp;reset()</pre>
<div class="block">Reset the ValueVector to the initial state without releasing any owned ArrowBuf.
Buffer capacities will remain unchanged and any previous data will be zeroed out.
This includes buffers for data, validity, offset, etc. If the vector has any
child vectors, they will also be reset.</div>
</li>
</ul>
<a name="getField--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getField</h4>
<pre><a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;getField()</pre>
<div class="block">Get information about how this field is materialized.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the field corresponding to this vector</dd>
</dl>
</li>
</ul>
<a name="getMinorType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinorType</h4>
<pre><a href="../../../../org/apache/arrow/vector/types/Types.MinorType.html" title="enum in org.apache.arrow.vector.types">Types.MinorType</a>&nbsp;getMinorType()</pre>
</li>
</ul>
<a name="getTransferPair-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;getTransferPair(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</pre>
<div class="block">To transfer quota responsibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allocator</code> - the target allocator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a>, creating a new target vector of
the same type.</dd>
</dl>
</li>
</ul>
<a name="getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;getTransferPair(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</pre>
<div class="block">To transfer quota responsibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ref</code> - the name of the vector</dd>
<dd><code>allocator</code> - the target allocator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a>, creating a new target vector of
the same type.</dd>
</dl>
</li>
</ul>
<a name="getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;getTransferPair(<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;field,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</pre>
<div class="block">To transfer quota responsibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - the Field object used by the target vector</dd>
<dd><code>allocator</code> - the target allocator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a>, creating a new target vector of
the same type.</dd>
</dl>
</li>
</ul>
<a name="getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;getTransferPair(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator,
<a href="../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a>&nbsp;callBack)</pre>
<div class="block">To transfer quota responsibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ref</code> - the name of the vector</dd>
<dd><code>allocator</code> - the target allocator</dd>
<dd><code>callBack</code> - A schema change callback.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a>, creating a new target vector of
the same type.</dd>
</dl>
</li>
</ul>
<a name="getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;getTransferPair(<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;field,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator,
<a href="../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a>&nbsp;callBack)</pre>
<div class="block">To transfer quota responsibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - the Field object used by the target vector</dd>
<dd><code>allocator</code> - the target allocator</dd>
<dd><code>callBack</code> - A schema change callback.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a>, creating a new target vector of
the same type.</dd>
</dl>
</li>
</ul>
<a name="makeTransferPair-org.apache.arrow.vector.ValueVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeTransferPair</h4>
<pre><a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a>&nbsp;makeTransferPair(<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;target)</pre>
<div class="block">Makes a new transfer pair used to transfer underlying buffers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - the target for the transfer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>transfer pair</code></a> that is used to transfer underlying
buffers into the target vector.</dd>
</dl>
</li>
</ul>
<a name="getReader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReader</h4>
<pre><a href="../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a>&nbsp;getReader()</pre>
<div class="block">Get a reader for this vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader"><code>field reader</code></a> that supports reading values
from this vector.</dd>
</dl>
</li>
</ul>
<a name="getBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>int&nbsp;getBufferSize()</pre>
<div class="block">Get the number of bytes used by this vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes that is used by this vector instance.</dd>
</dl>
</li>
</ul>
<a name="getBufferSizeFor-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSizeFor</h4>
<pre>int&nbsp;getBufferSizeFor(int&nbsp;valueCount)</pre>
<div class="block">Returns the number of bytes that is used by this vector if it holds the given number
of values. The result will be the same as if setValueCount() were called, followed
by calling getBufferSize(), but without any of the closing side-effects that setValueCount()
implies wrt finishing off the population of a vector. Some operations might wish to use
this to determine how much memory has been used by a vector so far, even though it is
not finished being populated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>valueCount</code> - the number of values to assume this vector contains</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the buffer size if this vector is holding valueCount values</dd>
</dl>
</li>
</ul>
<a name="getBuffers-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuffers</h4>
<pre><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>[]&nbsp;getBuffers(boolean&nbsp;clear)</pre>
<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="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory"><code>buffers</code></a> that is used by this vector instance.</dd>
</dl>
</li>
</ul>
<a name="getValidityBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidityBuffer</h4>
<pre><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;getValidityBuffer()</pre>
<div class="block">Gets the underlying buffer associated with validity vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer</dd>
</dl>
</li>
</ul>
<a name="getDataBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataBuffer</h4>
<pre><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;getDataBuffer()</pre>
<div class="block">Gets the underlying buffer associated with data vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer</dd>
</dl>
</li>
</ul>
<a name="getOffsetBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffsetBuffer</h4>
<pre><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;getOffsetBuffer()</pre>
<div class="block">Gets the underlying buffer associated with offset vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer</dd>
</dl>
</li>
</ul>
<a name="getValueCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueCount</h4>
<pre>int&nbsp;getValueCount()</pre>
<div class="block">Gets the number of values.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of values in the vector</dd>
</dl>
</li>
</ul>
<a name="setValueCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValueCount</h4>
<pre>void&nbsp;setValueCount(int&nbsp;valueCount)</pre>
<div class="block">Set number of values in the vector.</div>
</li>
</ul>
<a name="getObject-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre><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;getObject(int&nbsp;index)</pre>
<div class="block">Get friendly type object from the vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index of object to get</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>friendly type object</dd>
</dl>
</li>
</ul>
<a name="getNullCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNullCount</h4>
<pre>int&nbsp;getNullCount()</pre>
<div class="block">Returns number of null elements in the vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of null elements</dd>
</dl>
</li>
</ul>
<a name="isNull-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNull</h4>
<pre>boolean&nbsp;isNull(int&nbsp;index)</pre>
<div class="block">Check whether an element in the vector is null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index to check for null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if element is null</dd>
</dl>
</li>
</ul>
<a name="hashCode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int&nbsp;hashCode(int&nbsp;index)</pre>
<div class="block">Returns hashCode of element in index with the default hasher.</div>
</li>
</ul>
<a name="hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int&nbsp;hashCode(int&nbsp;index,
<a href="../../../../org/apache/arrow/memory/util/hash/ArrowBufHasher.html" title="interface in org.apache.arrow.memory.util.hash">ArrowBufHasher</a>&nbsp;hasher)</pre>
<div class="block">Returns hashCode of element in index with the given hasher.</div>
</li>
</ul>
<a name="copyFrom-int-int-org.apache.arrow.vector.ValueVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyFrom</h4>
<pre>void&nbsp;copyFrom(int&nbsp;fromIndex,
int&nbsp;thisIndex,
<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;from)</pre>
<div class="block">Copy a cell value from a particular index in source vector to a particular
position in this vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromIndex</code> - position to copy from in source vector</dd>
<dd><code>thisIndex</code> - position to copy to in this vector</dd>
<dd><code>from</code> - source vector</dd>
</dl>
</li>
</ul>
<a name="copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyFromSafe</h4>
<pre>void&nbsp;copyFromSafe(int&nbsp;fromIndex,
int&nbsp;thisIndex,
<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&nbsp;from)</pre>
<div class="block">Same as <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-"><code>copyFrom(int, int, ValueVector)</code></a> except that
it handles the case when the capacity of the vector needs to be expanded
before copy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromIndex</code> - position to copy from in source vector</dd>
<dd><code>thisIndex</code> - position to copy to in this vector</dd>
<dd><code>from</code> - source vector</dd>
</dl>
</li>
</ul>
<a name="accept-org.apache.arrow.vector.compare.VectorVisitor-java.lang.Object-">
<!-- -->
</a><a name="accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>&lt;OUT,IN&gt;&nbsp;OUT&nbsp;accept(<a href="../../../../org/apache/arrow/vector/compare/VectorVisitor.html" title="interface in org.apache.arrow.vector.compare">VectorVisitor</a>&lt;OUT,IN&gt;&nbsp;visitor,
IN&nbsp;value)</pre>
<div class="block">Accept a generic <a href="../../../../org/apache/arrow/vector/compare/VectorVisitor.html" title="interface in org.apache.arrow.vector.compare"><code>VectorVisitor</code></a> and return the result.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>OUT</code> - the output result type.</dd>
<dd><code>IN</code> - the input data together with visitor.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Gets the name of the vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the vector.</dd>
</dl>
</li>
</ul>
<a name="validate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>default&nbsp;void&nbsp;validate()</pre>
</li>
</ul>
<a name="validateFull--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateFull</h4>
<pre>default&nbsp;void&nbsp;validateFull()</pre>
</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/ValueVector.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/arrow/vector/UInt8Vector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/VarBinaryVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/vector/ValueVector.html" target="_top">Frames</a></li>
<li><a href="ValueVector.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; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>