| <!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>ListVector (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="ListVector (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":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":42,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ListVector.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/complex/LargeListVector.html" title="class in org.apache.arrow.vector.complex"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/vector/complex/MapVector.html" title="class in org.apache.arrow.vector.complex"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/complex/ListVector.html" target="_top">Frames</a></li> |
| <li><a href="ListVector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.complex</div> |
| <h2 title="Class ListVector" class="title">Class ListVector</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">org.apache.arrow.vector.BaseValueVector</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">org.apache.arrow.vector.complex.BaseRepeatedValueVector</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.vector.complex.ListVector</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</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/complex/PromotableVector.html" title="interface in org.apache.arrow.vector.complex">PromotableVector</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/DensityAwareVector.html" title="interface in org.apache.arrow.vector">DensityAwareVector</a>, <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>, <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/arrow/vector/complex/MapVector.html" title="class in org.apache.arrow.vector.complex">MapVector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ListVector</span> |
| extends <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a> |
| implements <a href="../../../../../org/apache/arrow/vector/complex/PromotableVector.html" title="interface in org.apache.arrow.vector.complex">PromotableVector</a></pre> |
| <div class="block">A list vector contains lists of a specific type of elements. Its structure contains 3 elements. |
| <ol> |
| <li>A validity buffer.</li> |
| <li> An offset buffer, that denotes lists boundaries. </li> |
| <li> A child data vector that contains the elements of lists. </li> |
| </ol> |
| The latter two are managed by its superclass.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../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/complex/ListVector.html#field">field</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#lastSet">lastSet</a></span></code> |
| <div class="block">The maximum index that is actually set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListReader.html" title="class in org.apache.arrow.vector.complex.impl">UnionListReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#reader">reader</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#validityAllocationSizeInBytes">validityAllocationSizeInBytes</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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/complex/ListVector.html#validityBuffer">validityBuffer</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.vector.complex.BaseRepeatedValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.arrow.vector.complex.<a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#DATA_VECTOR_NAME">DATA_VECTOR_NAME</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#DEFAULT_DATA_VECTOR">DEFAULT_DATA_VECTOR</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#defaultDataVectorName">defaultDataVectorName</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#OFFSET_WIDTH">OFFSET_WIDTH</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#offsetAllocationSizeInBytes">offsetAllocationSizeInBytes</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#offsetBuffer">offsetBuffer</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#repeatedCallBack">repeatedCallBack</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#valueCount">valueCount</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#vector">vector</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.vector.BaseValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.arrow.vector.<a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#allocator">allocator</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#fieldReader">fieldReader</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#INITIAL_VALUE_ALLOCATION">INITIAL_VALUE_ALLOCATION</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#MAX_ALLOCATION_SIZE">MAX_ALLOCATION_SIZE</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#MAX_ALLOCATION_SIZE_PROPERTY">MAX_ALLOCATION_SIZE_PROPERTY</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.vector.complex.RepeatedValueVector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.arrow.vector.complex.<a href="../../../../../org/apache/arrow/vector/complex/RepeatedValueVector.html" title="interface in org.apache.arrow.vector.complex">RepeatedValueVector</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/complex/RepeatedValueVector.html#DEFAULT_REPEAT_PER_RECORD">DEFAULT_REPEAT_PER_RECORD</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </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/complex/ListVector.html#ListVector-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">ListVector</a></span>(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</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/complex/ListVector.html#ListVector-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.types.pojo.FieldType-org.apache.arrow.vector.util.CallBack-">ListVector</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> name, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/types/pojo/FieldType.html" title="class in org.apache.arrow.vector.types.pojo">FieldType</a> fieldType, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><OUT,IN> OUT</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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><OUT,IN> visitor, |
| IN 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><T extends <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>><br><a href="../../../../../org/apache/arrow/vector/AddOrGetResult.html" title="class in org.apache.arrow.vector">AddOrGetResult</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#addOrGetVector-org.apache.arrow.vector.types.pojo.FieldType-">addOrGetVector</a></span>(<a href="../../../../../org/apache/arrow/vector/types/pojo/FieldType.html" title="class in org.apache.arrow.vector.types.pojo">FieldType</a> fieldType)</code> |
| <div class="block">Initialize the child data vector to field type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#allocateNew--">allocateNew</a></span>()</code> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#allocateNewSafe--"><code>allocateNewSafe()</code></a>.</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/complex/ListVector.html#allocateNewSafe--">allocateNewSafe</a></span>()</code> |
| <div class="block">Allocate memory for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#allocateValidityBuffer-long-">allocateValidityBuffer</a></span>(long size)</code> </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/complex/ListVector.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="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a></span>(int inIndex, |
| int outIndex, |
| <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> 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="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a></span>(int inIndex, |
| int outIndex, |
| <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> from)</code> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html" title="class in org.apache.arrow.vector.complex">ListVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#empty-java.lang.String-org.apache.arrow.memory.BufferAllocator-">empty</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> name, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> </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/complex/ListVector.html#endValue-int-int-">endValue</a></span>(int index, |
| int size)</code> |
| <div class="block">End the current value.</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/complex/ListVector.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><<a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>> buffers, |
| <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffersPtr, |
| long nullValue)</code> |
| <div class="block">Export the buffers of the fields for C Data Interface.</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/complex/ListVector.html#getBuffers-boolean-">getBuffers</a></span>(boolean clear)</code> |
| <div class="block">Return the underlying buffers associated with this vector.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getBufferSize--">getBufferSize</a></span>()</code> |
| <div class="block">Get the size (number of bytes) of underlying buffers used by this |
| vector.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></span>(int 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="i14" 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><<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/complex/ListVector.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="i15" 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/complex/ListVector.html#getDataBuffer--">getDataBuffer</a></span>()</code> |
| <div class="block">Gets the underlying buffer associated with data vector.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="i17" 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/complex/ListVector.html#getDataVector--">getDataVector</a></span>()</code> |
| <div class="block">Get the inner data vector for this list vector.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getDensity--">getDensity</a></span>()</code> |
| <div class="block">Get the density of this ListVector.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getElementEndIndex-int-">getElementEndIndex</a></span>(int index)</code> |
| <div class="block">Get data vector end index with the given list index.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getElementStartIndex-int-">getElementStartIndex</a></span>(int index)</code> |
| <div class="block">Get data vector start index with the given list index.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <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/complex/ListVector.html#getField--">getField</a></span>()</code> |
| <div class="block">Get information about how this field is materialized.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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><<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/complex/ListVector.html#getFieldBuffers--">getFieldBuffers</a></span>()</code> |
| <div class="block">Get the buffers belonging to this vector.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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><<a href="../../../../../org/apache/arrow/vector/BufferBacked.html" title="interface in org.apache.arrow.vector">BufferBacked</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getFieldInnerVectors--">getFieldInnerVectors</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <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="i24" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getLastSet--">getLastSet</a></span>()</code> </td> |
| </tr> |
| <tr id="i25" 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/complex/ListVector.html#getMinorType--">getMinorType</a></span>()</code> </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/complex/ListVector.html#getNullCount--">getNullCount</a></span>()</code> |
| <div class="block">Get the number of elements that are null in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i27" 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><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getObject-int-">getObject</a></span>(int index)</code> |
| <div class="block">Get the element in the list vector at a particular index.</div> |
| </td> |
| </tr> |
| <tr id="i28" 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/complex/ListVector.html#getOffsetBuffer--">getOffsetBuffer</a></span>()</code> |
| <div class="block">Gets the underlying buffer associated with offset vector.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListReader.html" title="class in org.apache.arrow.vector.complex.impl">UnionListReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getReader--">getReader</a></span>()</code> |
| <div class="block">Default implementation to create a reader for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>protected <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/complex/ListVector.html#getReaderImpl--">getReaderImpl</a></span>()</code> |
| <div class="block">Each vector has a different reader that implements the FieldReader interface.</div> |
| </td> |
| </tr> |
| <tr id="i32" 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/complex/ListVector.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> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">To transfer quota responsibility.</div> |
| </td> |
| </tr> |
| <tr id="i33" 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/complex/ListVector.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> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</code> |
| <div class="block">To transfer quota responsibility.</div> |
| </td> |
| </tr> |
| <tr id="i34" 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/complex/ListVector.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> ref, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">To transfer quota responsibility.</div> |
| </td> |
| </tr> |
| <tr id="i35" 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/complex/ListVector.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> ref, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</code> |
| <div class="block">To transfer quota responsibility.</div> |
| </td> |
| </tr> |
| <tr id="i36" 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/complex/ListVector.html#getValidityBuffer--">getValidityBuffer</a></span>()</code> |
| <div class="block">Gets the underlying buffer associated with validity vector.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="i38" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getValueCapacity--">getValueCapacity</a></span>()</code> |
| <div class="block">Get the current value capacity for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListWriter.html" title="class in org.apache.arrow.vector.complex.impl">UnionListWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#getWriter--">getWriter</a></span>()</code> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#hashCode-int-">hashCode</a></span>(int index)</code> |
| <div class="block">Returns hashCode of element in index with the default hasher.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a></span>(int index, |
| <a href="../../../../../org/apache/arrow/memory/util/hash/ArrowBufHasher.html" title="interface in org.apache.arrow.memory.util.hash">ArrowBufHasher</a> hasher)</code> |
| <div class="block">Returns hashCode of element in index with the given hasher.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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><<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>> children)</code> |
| <div class="block">Initializes the child vectors |
| to be later loaded with loadBuffers.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#invalidateReader--">invalidateReader</a></span>()</code> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#isEmpty-int-">isEmpty</a></span>(int index)</code> |
| <div class="block">Check if element at given index is empty list.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#isNull-int-">isNull</a></span>(int index)</code> |
| <div class="block">Check if element at given index is null.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#isSet-int-">isSet</a></span>(int index)</code> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#isNull-int-"><code>isNull(int)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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> 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><<a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>> ownBuffers)</code> |
| <div class="block">Load the buffers of this vector with provided source buffers.</div> |
| </td> |
| </tr> |
| <tr id="i48" 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/complex/ListVector.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> target)</code> |
| <div class="block">Makes a new transfer pair used to transfer underlying buffers.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/UnionVector.html" title="class in org.apache.arrow.vector.complex">UnionVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#promoteToUnion--">promoteToUnion</a></span>()</code> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#reAlloc--">reAlloc</a></span>()</code> |
| <div class="block">Resize the vector to increase the capacity.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#reallocValidityAndOffsetBuffers--">reallocValidityAndOffsetBuffers</a></span>()</code> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int numRecords)</code> |
| <div class="block">Set the initial record capacity.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setInitialCapacity-int-double-">setInitialCapacity</a></span>(int numRecords, |
| double density)</code> |
| <div class="block">Specialized version of setInitialCapacity() for ListVector.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setInitialTotalCapacity-int-int-">setInitialTotalCapacity</a></span>(int numRecords, |
| int totalNumberOfElements)</code> |
| <div class="block">Specialized version of setInitialTotalCapacity() for ListVector.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setLastSet-int-">setLastSet</a></span>(int value)</code> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setNotNull-int-">setNotNull</a></span>(int index)</code> |
| <div class="block">Sets the list at index to be not-null.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setNull-int-">setNull</a></span>(int index)</code> |
| <div class="block">Sets list at index to be null.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#setValueCount-int-">setValueCount</a></span>(int valueCount)</code> |
| <div class="block">Sets the value count for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#startNewValue-int-">startNewValue</a></span>(int index)</code> |
| <div class="block">Start a new value in the list vector.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.complex.BaseRepeatedValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.arrow.vector.complex.<a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#allocateOffsetBuffer-long-">allocateOffsetBuffer</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getInnerValueCount--">getInnerValueCount</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getInnerValueCountAt-int-">getInnerValueCountAt</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getName--">getName</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getOffsetBufferValueCapacity--">getOffsetBufferValueCapacity</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getOffsetVector--">getOffsetVector</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getValueCount--">getValueCount</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#iterator--">iterator</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#reallocOffsetBuffer--">reallocOffsetBuffer</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#replaceDataVector-org.apache.arrow.vector.FieldVector-">replaceDataVector</a>, <a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#size--">size</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.BaseValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.arrow.vector.<a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#checkBufRefs-org.apache.arrow.vector.ValueVector-">checkBufRefs</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#close--">close</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getValidityBufferSizeFromCount-int-">getValidityBufferSizeFromCount</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#releaseBuffer-org.apache.arrow.memory.ArrowBuf-">releaseBuffer</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#toString--">toString</a>, <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#transferBuffer-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-">transferBuffer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.FieldVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.arrow.vector.<a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></h3> |
| <code><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></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.ValueVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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#close--">close</a>, <a href="../../../../../org/apache/arrow/vector/ValueVector.html#getAllocator--">getAllocator</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#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 java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="validityBuffer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validityBuffer</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> validityBuffer</pre> |
| </li> |
| </ul> |
| <a name="reader"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reader</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListReader.html" title="class in org.apache.arrow.vector.complex.impl">UnionListReader</a> reader</pre> |
| </li> |
| </ul> |
| <a name="field"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>field</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field</pre> |
| </li> |
| </ul> |
| <a name="validityAllocationSizeInBytes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validityAllocationSizeInBytes</h4> |
| <pre>protected int validityAllocationSizeInBytes</pre> |
| </li> |
| </ul> |
| <a name="lastSet"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>lastSet</h4> |
| <pre>protected int lastSet</pre> |
| <div class="block">The maximum index that is actually set.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ListVector-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.types.pojo.FieldType-org.apache.arrow.vector.util.CallBack-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ListVector</h4> |
| <pre>public ListVector(<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> name, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/types/pojo/FieldType.html" title="class in org.apache.arrow.vector.types.pojo">FieldType</a> fieldType, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</pre> |
| <div class="block">Constructs a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the instance.</dd> |
| <dd><code>allocator</code> - The allocator to use for allocating/reallocating buffers.</dd> |
| <dd><code>fieldType</code> - The type of this list.</dd> |
| <dd><code>callBack</code> - A schema change callback.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ListVector-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ListVector</h4> |
| <pre>public ListVector(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</pre> |
| <div class="block">Constructs a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>field</code> - The field materialized by this vector.</dd> |
| <dd><code>allocator</code> - The allocator to use for allocating/reallocating buffers.</dd> |
| <dd><code>callBack</code> - A schema change callback.</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="empty-java.lang.String-org.apache.arrow.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>empty</h4> |
| <pre>public static <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html" title="class in org.apache.arrow.vector.complex">ListVector</a> empty(<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> name, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| </li> |
| </ul> |
| <a name="initializeChildrenFromFields-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeChildrenFromFields</h4> |
| <pre>public void 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><<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>> children)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#initializeChildrenFromFields-java.util.List-">FieldVector</a></code></span></div> |
| <div class="block">Initializes the child vectors |
| to be later loaded with loadBuffers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#initializeChildrenFromFields-java.util.List-">initializeChildrenFromFields</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>children</code> - the schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public void setInitialCapacity(int numRecords)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">ValueVector</a></code></span></div> |
| <div class="block">Set the initial record capacity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#setInitialCapacity-int-">setInitialCapacity</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numRecords</code> - the initial record capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public void setInitialCapacity(int numRecords, |
| double density)</pre> |
| <div class="block">Specialized version of setInitialCapacity() for ListVector. This is |
| used by some callers when they want to explicitly control and be |
| conservative about memory allocated for inner data vector. This is |
| very useful when we are working with memory constraints for a query |
| and have a fixed amount of memory reserved for the record batch. In |
| such cases, we are likely to face OOM or related problems when |
| we reserve memory for a record batch with value count x and |
| do setInitialCapacity(x) such that each vector allocates only |
| what is necessary and not the default amount but the multiplier |
| forces the memory requirement to go beyond what was needed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/DensityAwareVector.html#setInitialCapacity-int-double-">setInitialCapacity</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/DensityAwareVector.html" title="interface in org.apache.arrow.vector">DensityAwareVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#setInitialCapacity-int-double-">setInitialCapacity</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numRecords</code> - value count</dd> |
| <dd><code>density</code> - density of ListVector. Density is the average size of |
| list per position in the List vector. For example, a |
| density value of 10 implies each position in the list |
| vector has a list of 10 values. |
| A density value of 0.1 implies out of 10 positions in |
| the list vector, 1 position has a list of size 1 and |
| remaining positions are null (no lists) or empty lists. |
| This helps in tightly controlling the memory we provision |
| for inner data vector.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialTotalCapacity-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialTotalCapacity</h4> |
| <pre>public void setInitialTotalCapacity(int numRecords, |
| int totalNumberOfElements)</pre> |
| <div class="block">Specialized version of setInitialTotalCapacity() for ListVector. This is |
| used by some callers when they want to explicitly control and be |
| conservative about memory allocated for inner data vector. This is |
| very useful when we are working with memory constraints for a query |
| and have a fixed amount of memory reserved for the record batch. In |
| such cases, we are likely to face OOM or related problems when |
| we reserve memory for a record batch with value count x and |
| do setInitialCapacity(x) such that each vector allocates only |
| what is necessary and not the default amount but the multiplier |
| forces the memory requirement to go beyond what was needed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#setInitialTotalCapacity-int-int-">setInitialTotalCapacity</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numRecords</code> - value count</dd> |
| <dd><code>totalNumberOfElements</code> - the total number of elements to to allow |
| for in this vector across all records.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDensity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDensity</h4> |
| <pre>public double getDensity()</pre> |
| <div class="block">Get the density of this ListVector.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>density</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChildrenFromFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildrenFromFields</h4> |
| <pre>public <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><<a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>> getChildrenFromFields()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getChildrenFromFields--">FieldVector</a></code></span></div> |
| <div class="block">The returned list is the same size as the list passed to initializeChildrenFromFields.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getChildrenFromFields--">getChildrenFromFields</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <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>public void loadFieldBuffers(<a href="../../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a> 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><<a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>> ownBuffers)</pre> |
| <div class="block">Load the buffers of this vector with provided source buffers. |
| The caller manages the source buffers and populates them before invoking |
| this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#loadFieldBuffers-org.apache.arrow.vector.ipc.message.ArrowFieldNode-java.util.List-">loadFieldBuffers</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldNode</code> - the fieldNode indicating the value count</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>public <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><<a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>> getFieldBuffers()</pre> |
| <div class="block">Get the buffers belonging to this vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getFieldBuffers--">getFieldBuffers</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the inner buffers.</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>public void 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><<a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>> buffers, |
| <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffersPtr, |
| long 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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#exportCDataBuffers-java.util.List-org.apache.arrow.memory.ArrowBuf-long-">exportCDataBuffers</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| </dl> |
| </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> |
| public <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><<a href="../../../../../org/apache/arrow/vector/BufferBacked.html" title="interface in org.apache.arrow.vector">BufferBacked</a>> getFieldInnerVectors()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getFieldInnerVectors--">getFieldInnerVectors</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <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="getWriter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriter</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListWriter.html" title="class in org.apache.arrow.vector.complex.impl">UnionListWriter</a> getWriter()</pre> |
| </li> |
| </ul> |
| <a name="allocateNew--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew() |
| throws <a href="../../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></pre> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#allocateNewSafe--"><code>allocateNewSafe()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#allocateNew--">allocateNew</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public boolean allocateNewSafe()</pre> |
| <div class="block">Allocate memory for the vector. We internally use a default value count |
| of 4096 to allocate memory for at least these many elements in the |
| vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#allocateNewSafe--">allocateNewSafe</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>false if memory allocation fails, true otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateValidityBuffer-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateValidityBuffer</h4> |
| <pre>protected void allocateValidityBuffer(long size)</pre> |
| </li> |
| </ul> |
| <a name="reAlloc--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reAlloc</h4> |
| <pre>public void reAlloc()</pre> |
| <div class="block">Resize the vector to increase the capacity. The internal behavior is to |
| double the current value capacity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#reAlloc--">reAlloc</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#reAlloc--">reAlloc</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reallocValidityAndOffsetBuffers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reallocValidityAndOffsetBuffers</h4> |
| <pre>protected void reallocValidityAndOffsetBuffers()</pre> |
| </li> |
| </ul> |
| <a name="copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromSafe</h4> |
| <pre>public void copyFromSafe(int inIndex, |
| int outIndex, |
| <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> from)</pre> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inIndex</code> - position to copy from in source vector</dd> |
| <dd><code>outIndex</code> - position to copy to in this vector</dd> |
| <dd><code>from</code> - source vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFrom-int-int-org.apache.arrow.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFrom</h4> |
| <pre>public void copyFrom(int inIndex, |
| int outIndex, |
| <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inIndex</code> - position to copy from in source vector</dd> |
| <dd><code>outIndex</code> - position to copy to in this vector</dd> |
| <dd><code>from</code> - source vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataVector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataVector</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> getDataVector()</pre> |
| <div class="block">Get the inner data vector for this list vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/RepeatedValueVector.html#getDataVector--">getDataVector</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/complex/RepeatedValueVector.html" title="interface in org.apache.arrow.vector.complex">RepeatedValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getDataVector--">getDataVector</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>data vector</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>public <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a> 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> ref, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">ValueVector</a></code></span></div> |
| <div class="block">To transfer quota responsibility.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a> getTransferPair(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">ValueVector</a></code></span></div> |
| <div class="block">To transfer quota responsibility.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a> 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> ref, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">ValueVector</a></code></span></div> |
| <div class="block">To transfer quota responsibility.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><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></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a> getTransferPair(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field, |
| <a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| <a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a> callBack)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><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-">ValueVector</a></code></span></div> |
| <div class="block">To transfer quota responsibility.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><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></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a> makeTransferPair(<a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> target)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">ValueVector</a></code></span></div> |
| <div class="block">Makes a new transfer pair used to transfer underlying buffers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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="getValidityBufferAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidityBufferAddress</h4> |
| <pre>public long getValidityBufferAddress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getValidityBufferAddress--">FieldVector</a></code></span></div> |
| <div class="block">Gets the starting address of the underlying buffer associated with validity vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getValidityBufferAddress--">getValidityBufferAddress</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <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>public long getDataBufferAddress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getDataBufferAddress--">FieldVector</a></code></span></div> |
| <div class="block">Gets the starting address of the underlying buffer associated with data vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getDataBufferAddress--">getDataBufferAddress</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <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>public long getOffsetBufferAddress()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getOffsetBufferAddress--">FieldVector</a></code></span></div> |
| <div class="block">Gets the starting address of the underlying buffer associated with offset vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#getOffsetBufferAddress--">getOffsetBufferAddress</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>buffer address</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValidityBuffer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidityBuffer</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> getValidityBuffer()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">ValueVector</a></code></span></div> |
| <div class="block">Gets the underlying buffer associated with validity vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">getValidityBuffer</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> getDataBuffer()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">ValueVector</a></code></span></div> |
| <div class="block">Gets the underlying buffer associated with data vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">getDataBuffer</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> getOffsetBuffer()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">ValueVector</a></code></span></div> |
| <div class="block">Gets the underlying buffer associated with offset vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">getOffsetBuffer</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">ValueVector</a></code></span></div> |
| <div class="block">Returns hashCode of element in index with the default hasher.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">hashCode</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode(int index, |
| <a href="../../../../../org/apache/arrow/memory/util/hash/ArrowBufHasher.html" title="interface in org.apache.arrow.memory.util.hash">ArrowBufHasher</a> hasher)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">ValueVector</a></code></span></div> |
| <div class="block">Returns hashCode of element in index with the given hasher.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></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>public <OUT,IN> OUT accept(<a href="../../../../../org/apache/arrow/vector/compare/VectorVisitor.html" title="interface in org.apache.arrow.vector.compare">VectorVisitor</a><OUT,IN> visitor, |
| IN value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">ValueVector</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">accept</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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="getReaderImpl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReaderImpl</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a> getReaderImpl()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getReaderImpl--">BaseValueVector</a></code></span></div> |
| <div class="block">Each vector has a different reader that implements the FieldReader interface. Overridden methods must make |
| sure to return the correct concrete reader implementation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getReaderImpl--">getReaderImpl</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns a lambda that initializes a reader when called.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/impl/UnionListReader.html" title="class in org.apache.arrow.vector.complex.impl">UnionListReader</a> getReader()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getReader--">BaseValueVector</a></code></span></div> |
| <div class="block">Default implementation to create a reader for the vector. Depends on the individual vector |
| class' implementation of <a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getReaderImpl--"><code>BaseValueVector.getReaderImpl()</code></a> to initialize the reader appropriately.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html#getReader--">getReader</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Concrete instance of FieldReader by using double-checked locking.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addOrGetVector-org.apache.arrow.vector.types.pojo.FieldType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrGetVector</h4> |
| <pre>public <T extends <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>> <a href="../../../../../org/apache/arrow/vector/AddOrGetResult.html" title="class in org.apache.arrow.vector">AddOrGetResult</a><T> addOrGetVector(<a href="../../../../../org/apache/arrow/vector/types/pojo/FieldType.html" title="class in org.apache.arrow.vector.types.pojo">FieldType</a> fieldType)</pre> |
| <div class="block">Initialize the child data vector to field type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/PromotableVector.html#addOrGetVector-org.apache.arrow.vector.types.pojo.FieldType-">addOrGetVector</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/complex/PromotableVector.html" title="interface in org.apache.arrow.vector.complex">PromotableVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#addOrGetVector-org.apache.arrow.vector.types.pojo.FieldType-">addOrGetVector</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferSize</h4> |
| <pre>public int getBufferSize()</pre> |
| <div class="block">Get the size (number of bytes) of underlying buffers used by this |
| vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getBufferSize--">getBufferSize</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getBufferSize--">getBufferSize</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size of underlying buffers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBufferSizeFor-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferSizeFor</h4> |
| <pre>public int getBufferSizeFor(int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">ValueVector</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <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="getField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> getField()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getField--">ValueVector</a></code></span></div> |
| <div class="block">Get information about how this field is materialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getField--">getField</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <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>public <a href="../../../../../org/apache/arrow/vector/types/Types.MinorType.html" title="enum in org.apache.arrow.vector.types">Types.MinorType</a> getMinorType()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#clear--">ValueVector</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#clear--">clear</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#clear--">clear</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#reset--">ValueVector</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#reset--">reset</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#reset--">reset</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBuffers-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBuffers</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>[] getBuffers(boolean 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getBuffers-boolean-">getBuffers</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getBuffers-boolean-">getBuffers</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <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="promoteToUnion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>promoteToUnion</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/UnionVector.html" title="class in org.apache.arrow.vector.complex">UnionVector</a> promoteToUnion()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/PromotableVector.html#promoteToUnion--">promoteToUnion</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/complex/PromotableVector.html" title="interface in org.apache.arrow.vector.complex">PromotableVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invalidateReader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateReader</h4> |
| <pre>protected void invalidateReader()</pre> |
| </li> |
| </ul> |
| <a name="getObject-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObject</h4> |
| <pre>public <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><?> getObject(int index)</pre> |
| <div class="block">Get the element in the list vector at a particular index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object at given position</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNull-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNull</h4> |
| <pre>public boolean isNull(int index)</pre> |
| <div class="block">Check if element at given index is null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#isNull-int-">isNull</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#isNull-int-">isNull</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if element at given index is null, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEmpty-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty(int index)</pre> |
| <div class="block">Check if element at given index is empty list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#isEmpty-int-">isEmpty</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if element at given index is empty list or NULL, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSet-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSet</h4> |
| <pre>public int isSet(int index)</pre> |
| <div class="block">Same as <a href="../../../../../org/apache/arrow/vector/complex/ListVector.html#isNull-int-"><code>isNull(int)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>1 if element at given index is not null, 0 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNullCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullCount</h4> |
| <pre>public int getNullCount()</pre> |
| <div class="block">Get the number of elements that are null in the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getNullCount--">getNullCount</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of null elements.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueCapacity</h4> |
| <pre>public int getValueCapacity()</pre> |
| <div class="block">Get the current value capacity for the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#getValueCapacity--">getValueCapacity</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of elements that vector can hold.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNotNull-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNotNull</h4> |
| <pre>public void setNotNull(int index)</pre> |
| <div class="block">Sets the list at index to be not-null. Reallocates validity buffer if index |
| is larger than current capacity.</div> |
| </li> |
| </ul> |
| <a name="setNull-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNull</h4> |
| <pre>public void setNull(int index)</pre> |
| <div class="block">Sets list at index to be null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html#setNull-int-">setNull</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position in vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startNewValue-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startNewValue</h4> |
| <pre>public int startNewValue(int index)</pre> |
| <div class="block">Start a new value in the list vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#startNewValue-int-">startNewValue</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the value to start</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endValue-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endValue</h4> |
| <pre>public void endValue(int index, |
| int size)</pre> |
| <div class="block">End the current value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the value to end</dd> |
| <dd><code>size</code> - number of elements in the list that was written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueCount-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueCount</h4> |
| <pre>public void setValueCount(int valueCount)</pre> |
| <div class="block">Sets the value count for the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html#setValueCount-int-">setValueCount</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html#setValueCount-int-">setValueCount</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/complex/BaseRepeatedValueVector.html" title="class in org.apache.arrow.vector.complex">BaseRepeatedValueVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - value count</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLastSet-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLastSet</h4> |
| <pre>public void setLastSet(int value)</pre> |
| </li> |
| </ul> |
| <a name="getLastSet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastSet</h4> |
| <pre>public int getLastSet()</pre> |
| </li> |
| </ul> |
| <a name="getElementStartIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElementStartIndex</h4> |
| <pre>public int getElementStartIndex(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html#getElementStartIndex-int-">BaseListVector</a></code></span></div> |
| <div class="block">Get data vector start index with the given list index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html#getElementStartIndex-int-">getElementStartIndex</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html" title="interface in org.apache.arrow.vector.complex">BaseListVector</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getElementEndIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getElementEndIndex</h4> |
| <pre>public int getElementEndIndex(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html#getElementEndIndex-int-">BaseListVector</a></code></span></div> |
| <div class="block">Get data vector end index with the given list index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html#getElementEndIndex-int-">getElementEndIndex</a></code> in interface <code><a href="../../../../../org/apache/arrow/vector/complex/BaseListVector.html" title="interface in org.apache.arrow.vector.complex">BaseListVector</a></code></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/ListVector.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/complex/LargeListVector.html" title="class in org.apache.arrow.vector.complex"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/vector/complex/MapVector.html" title="class in org.apache.arrow.vector.complex"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/complex/ListVector.html" target="_top">Frames</a></li> |
| <li><a href="ListVector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |