Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / vector / FieldVector.html
blob: 74ae69ea8c4818de561a963d47d2ce8ebd8fd0cb [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>FieldVector (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="FieldVector (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated 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/FieldVector.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/ExtensionTypeVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/FixedSizeBinaryVector.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/FieldVector.html" target="_top">Frames</a></li>
<li><a href="FieldVector.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 FieldVector" class="title">Interface FieldVector</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;, <a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></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/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><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/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/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">FieldVector</span>
extends <a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></pre>
<div class="block">A vector corresponding to a Field in the schema.
It has inner vectors backed by buffers (validity, offsets, data, ...)</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#exportBuffer-org.apache.arrow.memory.ArrowBuf-java.util.List-org.apache.arrow.memory.ArrowBuf-long-boolean-">exportBuffer</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;buffers,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffersPtr,
long&nbsp;nullValue,
boolean&nbsp;retain)</code>
<div class="block">Export a given buffer and its memory address into a list of buffers and a pointer to the list of buffers.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#exportCDataBuffers-java.util.List-org.apache.arrow.memory.ArrowBuf-long-">exportCDataBuffers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;buffers,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffersPtr,
long&nbsp;nullValue)</code>
<div class="block">Export the buffers of the fields for C Data Interface.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getChildrenFromFields--">getChildrenFromFields</a></span>()</code>
<div class="block">The returned list is the same size as the list passed to initializeChildrenFromFields.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getDataBufferAddress--">getDataBufferAddress</a></span>()</code>
<div class="block">Gets the starting address of the underlying buffer associated with data vector.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getFieldBuffers--">getFieldBuffers</a></span>()</code>
<div class="block">Get the buffers of the fields, (same size as getFieldVectors() since it is their content).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/BufferBacked.html" title="interface in org.apache.arrow.vector">BufferBacked</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getFieldInnerVectors--">getFieldInnerVectors</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">This API will be removed as the current implementations no longer support inner vectors.</span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getOffsetBufferAddress--">getOffsetBufferAddress</a></span>()</code>
<div class="block">Gets the starting address of the underlying buffer associated with offset vector.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#getValidityBufferAddress--">getValidityBufferAddress</a></span>()</code>
<div class="block">Gets the starting address of the underlying buffer associated with validity vector.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#initializeChildrenFromFields-java.util.List-">initializeChildrenFromFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&gt;&nbsp;children)</code>
<div class="block">Initializes the child vectors
to be later loaded with loadBuffers.</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/arrow/vector/FieldVector.html#loadFieldBuffers-org.apache.arrow.vector.ipc.message.ArrowFieldNode-java.util.List-">loadFieldBuffers</a></span>(<a href="../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>&nbsp;fieldNode,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;ownBuffers)</code>
<div class="block">Loads data in the vectors.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FieldVector.html#setNull-int-">setNull</a></span>(int&nbsp;index)</code>
<div class="block">Set the element at the given index to null.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.ValueVector">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.arrow.vector.<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></h3>
<code><a href="../../../../org/apache/arrow/vector/ValueVector.html#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">accept</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNew--">allocateNew</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#clear--">clear</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#close--">close</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBuffers-boolean-">getBuffers</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSize--">getBufferSize</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">getDataBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getField--">getField</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">getName</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getNullCount--">getNullCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">getOffsetBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <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>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <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>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">getValidityBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCount--">getValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#isNull-int-">isNull</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reAlloc--">reAlloc</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reset--">reset</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setValueCount-int-">setValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validate--">validate</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validateFull--">validateFull</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#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="initializeChildrenFromFields-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeChildrenFromFields</h4>
<pre>void&nbsp;initializeChildrenFromFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&gt;&nbsp;children)</pre>
<div class="block">Initializes the child vectors
to be later loaded with loadBuffers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>children</code> - the schema</dd>
</dl>
</li>
</ul>
<a name="getChildrenFromFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildrenFromFields</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&gt;&nbsp;getChildrenFromFields()</pre>
<div class="block">The returned list is the same size as the list passed to initializeChildrenFromFields.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the children according to schema (empty for primitive types)</dd>
</dl>
</li>
</ul>
<a name="loadFieldBuffers-org.apache.arrow.vector.ipc.message.ArrowFieldNode-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadFieldBuffers</h4>
<pre>void&nbsp;loadFieldBuffers(<a href="../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>&nbsp;fieldNode,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;ownBuffers)</pre>
<div class="block">Loads data in the vectors.
(ownBuffers must be the same size as getFieldVectors())</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldNode</code> - the fieldNode</dd>
<dd><code>ownBuffers</code> - the buffers for this Field (own buffers only, children not included)</dd>
</dl>
</li>
</ul>
<a name="getFieldBuffers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldBuffers</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;getFieldBuffers()</pre>
<div class="block">Get the buffers of the fields, (same size as getFieldVectors() since it is their content).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the buffers containing the data for this vector (ready for reading)</dd>
</dl>
</li>
</ul>
<a name="exportBuffer-org.apache.arrow.memory.ArrowBuf-java.util.List-org.apache.arrow.memory.ArrowBuf-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportBuffer</h4>
<pre>default&nbsp;void&nbsp;exportBuffer(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;buffers,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffersPtr,
long&nbsp;nullValue,
boolean&nbsp;retain)</pre>
<div class="block">Export a given buffer and its memory address into a list of buffers and a pointer to the list of buffers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - the buffer to export</dd>
<dd><code>buffers</code> - the list of buffers</dd>
<dd><code>buffersPtr</code> - the pointer to the list of buffers</dd>
<dd><code>nullValue</code> - the null value to use for null buffer</dd>
<dd><code>retain</code> - whether to retain the buffer when exporting</dd>
</dl>
</li>
</ul>
<a name="exportCDataBuffers-java.util.List-org.apache.arrow.memory.ArrowBuf-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exportCDataBuffers</h4>
<pre>default&nbsp;void&nbsp;exportCDataBuffers(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&gt;&nbsp;buffers,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;buffersPtr,
long&nbsp;nullValue)</pre>
<div class="block">Export the buffers of the fields for C Data Interface. This method traverse the buffers and
export buffer and buffer's memory address into a list of buffers and a pointer to the list of buffers.
By default, when exporting a buffer, it will increase ref count for exported buffer that counts
the usage at imported side.</div>
</li>
</ul>
<a name="getFieldInnerVectors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldInnerVectors</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/arrow/vector/BufferBacked.html" title="interface in org.apache.arrow.vector">BufferBacked</a>&gt;&nbsp;getFieldInnerVectors()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This API will be removed as the current implementations no longer support inner vectors.</span></div>
<div class="block">Get the inner vectors.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the inner vectors for this field as defined by the TypeLayout</dd>
</dl>
</li>
</ul>
<a name="getValidityBufferAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidityBufferAddress</h4>
<pre>long&nbsp;getValidityBufferAddress()</pre>
<div class="block">Gets the starting address of the underlying buffer associated with validity vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer address</dd>
</dl>
</li>
</ul>
<a name="getDataBufferAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataBufferAddress</h4>
<pre>long&nbsp;getDataBufferAddress()</pre>
<div class="block">Gets the starting address of the underlying buffer associated with data vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer address</dd>
</dl>
</li>
</ul>
<a name="getOffsetBufferAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffsetBufferAddress</h4>
<pre>long&nbsp;getOffsetBufferAddress()</pre>
<div class="block">Gets the starting address of the underlying buffer associated with offset vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>buffer address</dd>
</dl>
</li>
</ul>
<a name="setNull-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setNull</h4>
<pre>void&nbsp;setNull(int&nbsp;index)</pre>
<div class="block">Set the element at the given index to null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the value to change</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/FieldVector.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/ExtensionTypeVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/FixedSizeBinaryVector.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/FieldVector.html" target="_top">Frames</a></li>
<li><a href="FieldVector.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>