Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / vector / VectorSchemaRoot.html
blob: 390885355558858bedeb14dc3819f4aa6ec367a7 [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>VectorSchemaRoot (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="VectorSchemaRoot (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/VectorSchemaRoot.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/VectorLoaderBenchmark.LoadState.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/VectorUnloader.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/VectorSchemaRoot.html" target="_top">Frames</a></li>
<li><a href="VectorSchemaRoot.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.arrow.vector</div>
<h2 title="Class VectorSchemaRoot" class="title">Class VectorSchemaRoot</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.vector.VectorSchemaRoot</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">VectorSchemaRoot</span>
extends <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>
implements <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></pre>
<div class="block">Holder for a set of vectors to be loaded/unloaded.
A VectorSchemaRoot is a container that can hold batches, batches flow through VectorSchemaRoot
as part of a pipeline. Note this is different from other implementations (i.e. in C++ and Python,
a RecordBatch is a collection of equal-length vector instances and was created each time for a new batch).
The recommended usage for VectorSchemaRoot is creating a single VectorSchemaRoot based on the known
schema and populated data over and over into the same VectorSchemaRoot in a stream of batches rather
than create a new VectorSchemaRoot instance each time (see Flight or ArrowFileWriter for better understanding).
Thus at any one point a VectorSchemaRoot may have data or may have no data (say it was transferred downstream
or not yet populated).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#VectorSchemaRoot-org.apache.arrow.vector.FieldVector-">VectorSchemaRoot</a></span>(<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;parent)</code>
<div class="block">Constructs a new instance containing the children of parent but not the parent itself.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#VectorSchemaRoot-java.lang.Iterable-">VectorSchemaRoot</a></span>(<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/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&gt;&nbsp;vectors)</code>
<div class="block">Constructs new instance containing each of the vectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#VectorSchemaRoot-java.util.List-java.util.List-">VectorSchemaRoot</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;fields,
<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;fieldVectors)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#VectorSchemaRoot-java.util.List-java.util.List-int-">VectorSchemaRoot</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;fields,
<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;fieldVectors,
int&nbsp;rowCount)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#VectorSchemaRoot-org.apache.arrow.vector.types.pojo.Schema-java.util.List-int-">VectorSchemaRoot</a></span>(<a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<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;fieldVectors,
int&nbsp;rowCount)</code>
<div class="block">Constructs a new instance.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#addVector-int-org.apache.arrow.vector.FieldVector-">addVector</a></span>(int&nbsp;index,
<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector)</code>
<div class="block">Add vector to the record batch, producing a new VectorSchemaRoot.</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/VectorSchemaRoot.html#allocateNew--">allocateNew</a></span>()</code>
<div class="block">Do an adaptive allocation of each vector for memory purposes.</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/VectorSchemaRoot.html#approxEquals-org.apache.arrow.vector.VectorSchemaRoot-">approxEquals</a></span>(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other)</code>
<div class="block">Determine if two VectorSchemaRoots are approximately equal using default functions to
calculate difference between float/double values.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#approxEquals-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.compare.VectorValueEqualizer-org.apache.arrow.vector.compare.VectorValueEqualizer-">approxEquals</a></span>(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other,
<a href="../../../../org/apache/arrow/vector/compare/VectorValueEqualizer.html" title="interface in org.apache.arrow.vector.compare">VectorValueEqualizer</a>&lt;<a href="../../../../org/apache/arrow/vector/Float4Vector.html" title="class in org.apache.arrow.vector">Float4Vector</a>&gt;&nbsp;floatDiffFunction,
<a href="../../../../org/apache/arrow/vector/compare/VectorValueEqualizer.html" title="interface in org.apache.arrow.vector.compare">VectorValueEqualizer</a>&lt;<a href="../../../../org/apache/arrow/vector/Float8Vector.html" title="class in org.apache.arrow.vector">Float8Vector</a>&gt;&nbsp;doubleDiffFunction)</code>
<div class="block">Determine if two VectorSchemaRoots are approximately equal using the given functions to
calculate difference between float/double values.</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/VectorSchemaRoot.html#clear--">clear</a></span>()</code>
<div class="block">Release all the memory for each vector held in this root.</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/VectorSchemaRoot.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" 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/VectorSchemaRoot.html#contentToTSVString--">contentToTSVString</a></span>()</code>
<div class="block">Returns a tab separated value of vectors (based on their java object representation).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#create-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.memory.BufferAllocator-">create</a></span>(<a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">Creates a new set of empty vectors corresponding to the given schema.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#equals-org.apache.arrow.vector.VectorSchemaRoot-">equals</a></span>(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other)</code>
<div class="block">Determine if two VectorSchemaRoots are exactly equal.</div>
</td>
</tr>
<tr id="i9" 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/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/VectorSchemaRoot.html#getFieldVectors--">getFieldVectors</a></span>()</code>&nbsp;</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/VectorSchemaRoot.html#getRowCount--">getRowCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#getSchema--">getSchema</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#getVector-org.apache.arrow.vector.types.pojo.Field-">getVector</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)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#getVector-int-">getVector</a></span>(int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#getVector-java.lang.String-">getVector</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;name)</code>
<div class="block">gets a vector by name.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#of-org.apache.arrow.vector.FieldVector...-">of</a></span>(<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>...&nbsp;vectors)</code>
<div class="block">Constructs a new instance from vectors.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#removeVector-int-">removeVector</a></span>(int&nbsp;index)</code>
<div class="block">Remove vector from the record batch, producing a new VectorSchemaRoot.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#setRowCount-int-">setRowCount</a></span>(int&nbsp;rowCount)</code>
<div class="block">Set the row count of all the vectors in this container.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#slice-int-">slice</a></span>(int&nbsp;index)</code>
<div class="block">Slice this root from desired index.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#slice-int-int-">slice</a></span>(int&nbsp;index,
int&nbsp;length)</code>
<div class="block">Slice this root at desired index and length.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html#syncSchema--">syncSchema</a></span>()</code>
<div class="block">Synchronizes the schema from the current vectors.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VectorSchemaRoot-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VectorSchemaRoot</h4>
<pre>public&nbsp;VectorSchemaRoot(<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/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&gt;&nbsp;vectors)</pre>
<div class="block">Constructs new instance containing each of the vectors.</div>
</li>
</ul>
<a name="VectorSchemaRoot-org.apache.arrow.vector.FieldVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VectorSchemaRoot</h4>
<pre>public&nbsp;VectorSchemaRoot(<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;parent)</pre>
<div class="block">Constructs a new instance containing the children of parent but not the parent itself.</div>
</li>
</ul>
<a name="VectorSchemaRoot-java.util.List-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VectorSchemaRoot</h4>
<pre>public&nbsp;VectorSchemaRoot(<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;fields,
<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;fieldVectors)</pre>
<div class="block">Constructs a new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fields</code> - The types of each vector.</dd>
<dd><code>fieldVectors</code> - The data vectors (must be equal in size to <code>fields</code>.</dd>
</dl>
</li>
</ul>
<a name="VectorSchemaRoot-java.util.List-java.util.List-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VectorSchemaRoot</h4>
<pre>public&nbsp;VectorSchemaRoot(<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;fields,
<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;fieldVectors,
int&nbsp;rowCount)</pre>
<div class="block">Constructs a new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fields</code> - The types of each vector.</dd>
<dd><code>fieldVectors</code> - The data vectors (must be equal in size to <code>fields</code>.</dd>
<dd><code>rowCount</code> - The number of rows contained.</dd>
</dl>
</li>
</ul>
<a name="VectorSchemaRoot-org.apache.arrow.vector.types.pojo.Schema-java.util.List-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VectorSchemaRoot</h4>
<pre>public&nbsp;VectorSchemaRoot(<a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<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;fieldVectors,
int&nbsp;rowCount)</pre>
<div class="block">Constructs a new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - The schema for the vectors.</dd>
<dd><code>fieldVectors</code> - The data vectors.</dd>
<dd><code>rowCount</code> - The number of rows</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;create(<a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</pre>
<div class="block">Creates a new set of empty vectors corresponding to the given schema.</div>
</li>
</ul>
<a name="of-org.apache.arrow.vector.FieldVector...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;of(<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>...&nbsp;vectors)</pre>
<div class="block">Constructs a new instance from vectors.</div>
</li>
</ul>
<a name="allocateNew--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocateNew</h4>
<pre>public&nbsp;void&nbsp;allocateNew()</pre>
<div class="block">Do an adaptive allocation of each vector for memory purposes. Sizes will be based on previously
defined initial allocation for each vector (and subsequent size learned).</div>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block">Release all the memory for each vector held in this root. This DOES NOT remove vectors from the container.</div>
</li>
</ul>
<a name="getFieldVectors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldVectors</h4>
<pre>public&nbsp;<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;getFieldVectors()</pre>
</li>
</ul>
<a name="getVector-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVector</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;getVector(<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;name)</pre>
<div class="block">gets a vector by name.
if name occurs multiple times this returns the first inserted entry for name</div>
</li>
</ul>
<a name="getVector-org.apache.arrow.vector.types.pojo.Field-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVector</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;getVector(<a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>&nbsp;field)</pre>
</li>
</ul>
<a name="getVector-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVector</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;getVector(int&nbsp;index)</pre>
</li>
</ul>
<a name="addVector-int-org.apache.arrow.vector.FieldVector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addVector</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;addVector(int&nbsp;index,
<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>&nbsp;vector)</pre>
<div class="block">Add vector to the record batch, producing a new VectorSchemaRoot.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - field index</dd>
<dd><code>vector</code> - vector to be added.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>out VectorSchemaRoot with vector added</dd>
</dl>
</li>
</ul>
<a name="removeVector-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeVector</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;removeVector(int&nbsp;index)</pre>
<div class="block">Remove vector from the record batch, producing a new VectorSchemaRoot.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - field index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>out VectorSchemaRoot with vector removed</dd>
</dl>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;getSchema()</pre>
</li>
</ul>
<a name="getRowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowCount</h4>
<pre>public&nbsp;int&nbsp;getRowCount()</pre>
</li>
</ul>
<a name="setRowCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRowCount</h4>
<pre>public&nbsp;void&nbsp;setRowCount(int&nbsp;rowCount)</pre>
<div class="block">Set the row count of all the vectors in this container. Also sets the value
count for each root level contained FieldVector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowCount</code> - Number of records.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<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>
</dl>
</li>
</ul>
<a name="contentToTSVString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentToTSVString</h4>
<pre>public&nbsp;<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;contentToTSVString()</pre>
<div class="block">Returns a tab separated value of vectors (based on their java object representation).</div>
</li>
</ul>
<a name="syncSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>syncSchema</h4>
<pre>public&nbsp;boolean&nbsp;syncSchema()</pre>
<div class="block">Synchronizes the schema from the current vectors.
In some cases, the schema and the actual vector structure may be different.
This can be caused by a promoted writer (For details, please see
<a href="../../../../org/apache/arrow/vector/complex/impl/PromotableWriter.html" title="class in org.apache.arrow.vector.complex.impl"><code>PromotableWriter</code></a>).
For example, when writing different types of data to a <a href="../../../../org/apache/arrow/vector/complex/ListVector.html" title="class in org.apache.arrow.vector.complex"><code>ListVector</code></a>
may lead to such a case.
When this happens, this method should be called to bring the schema and vector structure in a synchronized state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the schema is updated, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="slice-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;slice(int&nbsp;index)</pre>
<div class="block">Slice this root from desired index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - start position of the slice</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sliced root</dd>
</dl>
</li>
</ul>
<a name="slice-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;slice(int&nbsp;index,
int&nbsp;length)</pre>
<div class="block">Slice this root at desired index and length.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - start position of the slice</dd>
<dd><code>length</code> - length of the slice</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sliced root</dd>
</dl>
</li>
</ul>
<a name="equals-org.apache.arrow.vector.VectorSchemaRoot-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other)</pre>
<div class="block">Determine if two VectorSchemaRoots are exactly equal.</div>
</li>
</ul>
<a name="approxEquals-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.compare.VectorValueEqualizer-org.apache.arrow.vector.compare.VectorValueEqualizer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>approxEquals</h4>
<pre>public&nbsp;boolean&nbsp;approxEquals(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other,
<a href="../../../../org/apache/arrow/vector/compare/VectorValueEqualizer.html" title="interface in org.apache.arrow.vector.compare">VectorValueEqualizer</a>&lt;<a href="../../../../org/apache/arrow/vector/Float4Vector.html" title="class in org.apache.arrow.vector">Float4Vector</a>&gt;&nbsp;floatDiffFunction,
<a href="../../../../org/apache/arrow/vector/compare/VectorValueEqualizer.html" title="interface in org.apache.arrow.vector.compare">VectorValueEqualizer</a>&lt;<a href="../../../../org/apache/arrow/vector/Float8Vector.html" title="class in org.apache.arrow.vector">Float8Vector</a>&gt;&nbsp;doubleDiffFunction)</pre>
<div class="block">Determine if two VectorSchemaRoots are approximately equal using the given functions to
calculate difference between float/double values.
Note that approx equals are in regards to floating point values, other values are comparing
to exactly equals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>floatDiffFunction</code> - function to calculate difference between float values.</dd>
<dd><code>doubleDiffFunction</code> - function to calculate difference between double values.</dd>
</dl>
</li>
</ul>
<a name="approxEquals-org.apache.arrow.vector.VectorSchemaRoot-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>approxEquals</h4>
<pre>public&nbsp;boolean&nbsp;approxEquals(<a href="../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a>&nbsp;other)</pre>
<div class="block">Determine if two VectorSchemaRoots are approximately equal using default functions to
calculate difference between float/double values.</div>
</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/VectorSchemaRoot.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/VectorLoaderBenchmark.LoadState.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/VectorUnloader.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/VectorSchemaRoot.html" target="_top">Frames</a></li>
<li><a href="VectorSchemaRoot.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>