| <!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>BaseLargeVariableWidthVector (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="BaseLargeVariableWidthVector (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":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":42,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":6,"i35":10,"i36":6,"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":9,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BaseLargeVariableWidthVector.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/BaseIntVector.html" title="interface in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/vector/BaseLargeVariableWidthVector.html" target="_top">Frames</a></li> |
| <li><a href="BaseLargeVariableWidthVector.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</div> |
| <h2 title="Class BaseLargeVariableWidthVector" class="title">Class BaseLargeVariableWidthVector</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>org.apache.arrow.vector.BaseLargeVariableWidthVector</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/DensityAwareVector.html" title="interface in org.apache.arrow.vector">DensityAwareVector</a>, <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>, <a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a>, <a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a>, <a href="../../../../org/apache/arrow/vector/VectorDefinitionSetter.html" title="interface in org.apache.arrow.vector">VectorDefinitionSetter</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/arrow/vector/LargeVarBinaryVector.html" title="class in org.apache.arrow.vector">LargeVarBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/LargeVarCharVector.html" title="class in org.apache.arrow.vector">LargeVarCharVector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseLargeVariableWidthVector</span> |
| extends <a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</a> |
| implements <a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></pre> |
| <div class="block">BaseLargeVariableWidthVector is a base class providing functionality for large strings/large bytes types.</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 static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#emptyByteArray">emptyByteArray</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/BaseLargeVariableWidthVector.html#field">field</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#lastSet">lastSet</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#OFFSET_WIDTH">OFFSET_WIDTH</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/BaseLargeVariableWidthVector.html#offsetBuffer">offsetBuffer</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/BaseLargeVariableWidthVector.html#validityBuffer">validityBuffer</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/BaseLargeVariableWidthVector.html#valueBuffer">valueBuffer</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/BaseLargeVariableWidthVector.html#valueCount">valueCount</a></span></code> </td> |
| </tr> |
| </table> |
| <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> |
| </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/BaseLargeVariableWidthVector.html#BaseLargeVariableWidthVector-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">BaseLargeVariableWidthVector</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">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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/BaseLargeVariableWidthVector.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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#allocateNew--">allocateNew</a></span>()</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#allocateNewSafe--"><code>allocateNewSafe()</code></a>.</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/BaseLargeVariableWidthVector.html#allocateNew-int-">allocateNew</a></span>(int valueCount)</code> |
| <div class="block">Allocate a new memory space for this vector.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#allocateNew-long-int-">allocateNew</a></span>(long totalBytes, |
| int valueCount)</code> |
| <div class="block">Allocate memory for the vector to support storing at least the provided number of |
| elements in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#allocateNewSafe--">allocateNewSafe</a></span>()</code> |
| <div class="block">Allocate memory for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#clear--">clear</a></span>()</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#close--"><code>close()</code></a>.</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/BaseLargeVariableWidthVector.html#close--">close</a></span>()</code> |
| <div class="block">Close the vector and release the associated buffers.</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/BaseLargeVariableWidthVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a></span>(int fromIndex, |
| int thisIndex, |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a></span>(int fromIndex, |
| int thisIndex, |
| <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/BaseLargeVariableWidthVector.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="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#fillEmpties-int-">fillEmpties</a></span>(int index)</code> |
| <div class="block">Create holes in the vector upto the given index (exclusive).</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#fillHoles-int-">fillHoles</a></span>(int index)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#get-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.ArrowBuf-int-">get</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> offset, |
| int index)</code> |
| <div class="block">Method used by Json Writer to read a variable width element from |
| the variable width vector and write to Json.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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/BaseLargeVariableWidthVector.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="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getBufferSizeFor-int-">getBufferSizeFor</a></span>(int valueCount)</code> |
| <div class="block">Get the potential buffer size for a particular number of records.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getByteCapacity--">getByteCapacity</a></span>()</code> |
| <div class="block">Get the size (number of bytes) of underlying data buffer.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/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/BaseLargeVariableWidthVector.html#getChildrenFromFields--">getChildrenFromFields</a></span>()</code> |
| <div class="block">Get the inner child vectors.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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/BaseLargeVariableWidthVector.html#getDataBuffer--">getDataBuffer</a></span>()</code> |
| <div class="block">Get the buffer that stores the data for elements in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getDataBufferAddress--">getDataBufferAddress</a></span>()</code> |
| <div class="block">Get the memory address of buffer that stores the data for elements |
| in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getDataPointer-int-">getDataPointer</a></span>(int index)</code> |
| <div class="block">Gets the pointer for the data at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getDataPointer-int-org.apache.arrow.memory.util.ArrowBufPointer-">getDataPointer</a></span>(int index, |
| <a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a> reuse)</code> |
| <div class="block">Gets the pointer for the data at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getDensity--">getDensity</a></span>()</code> |
| <div class="block">Get the density of this ListVector.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getEndOffset-int-">getEndOffset</a></span>(int index)</code> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getField--">getField</a></span>()</code> |
| <div class="block">Get information about how this field is materialized.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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/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/BaseLargeVariableWidthVector.html#getFieldBuffers--">getFieldBuffers</a></span>()</code> |
| <div class="block">Get the buffers belonging to this vector.</div> |
| </td> |
| </tr> |
| <tr id="i26" 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/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/BaseLargeVariableWidthVector.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="i27" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getLastSet--">getLastSet</a></span>()</code> |
| <div class="block">Get the index of last non-null element in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getName--">getName</a></span>()</code> |
| <div class="block">Gets the name of the vector.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i30" 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/BaseLargeVariableWidthVector.html#getOffsetBuffer--">getOffsetBuffer</a></span>()</code> |
| <div class="block">buffer that stores the offsets for elements |
| in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getOffsetBufferAddress--">getOffsetBufferAddress</a></span>()</code> |
| <div class="block">Get the memory address of buffer that stores the offsets for elements |
| in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getStartOffset-int-">getStartOffset</a></span>(int index)</code> |
| <div class="block">Gets the starting offset of a record, given its index.</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/BaseLargeVariableWidthVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a></span>(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">Construct a transfer pair of this vector and another vector of same type.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>abstract <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/BaseLargeVariableWidthVector.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">Construct a transfer pair of this vector and another vector of same type.</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/BaseLargeVariableWidthVector.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">Construct a transfer pair of this vector and another vector of same type.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>abstract <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/BaseLargeVariableWidthVector.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">Construct a transfer pair of this vector and another vector of same type.</div> |
| </td> |
| </tr> |
| <tr id="i37" 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/BaseLargeVariableWidthVector.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">Construct a transfer pair of this vector and another vector of same type.</div> |
| </td> |
| </tr> |
| <tr id="i38" 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/BaseLargeVariableWidthVector.html#getValidityBuffer--">getValidityBuffer</a></span>()</code> |
| <div class="block">Get buffer that manages the validity (NULL or NON-NULL nature) of |
| elements in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getValidityBufferAddress--">getValidityBufferAddress</a></span>()</code> |
| <div class="block">Get the memory address of buffer that manages the validity |
| (NULL or NON-NULL nature) of elements in the vector.</div> |
| </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/BaseLargeVariableWidthVector.html#getValueCapacity--">getValueCapacity</a></span>()</code> |
| <div class="block">Get the current capacity which does not exceed either validity buffer or offset buffer.</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/BaseLargeVariableWidthVector.html#getValueCount--">getValueCount</a></span>()</code> |
| <div class="block">Get the value count of vector.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#getValueLength-int-">getValueLength</a></span>(int index)</code> |
| <div class="block">Get the variable length element at specified index as Text.</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/BaseLargeVariableWidthVector.html#handleSafe-int-int-">handleSafe</a></span>(int index, |
| int dataLength)</code> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i45" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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">Initialize the children in schema for this Field.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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="i48" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#isSafe-int-">isSafe</a></span>(int index)</code> |
| <div class="block">Check if the given index is within the current value capacity |
| of the vector.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#isSet-int-">isSet</a></span>(int index)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#isNull-int-"><code>isNull(int)</code></a>.</div> |
| </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/BaseLargeVariableWidthVector.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="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#reAlloc--">reAlloc</a></span>()</code> |
| <div class="block">Resize the vector to increase the capacity.</div> |
| </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/BaseLargeVariableWidthVector.html#reallocDataBuffer--">reallocDataBuffer</a></span>()</code> |
| <div class="block">Reallocate the data buffer.</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/BaseLargeVariableWidthVector.html#reallocValidityAndOffsetBuffers--">reallocValidityAndOffsetBuffers</a></span>()</code> |
| <div class="block">Reallocate the validity and offset buffers for this vector.</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/BaseLargeVariableWidthVector.html#reset--">reset</a></span>()</code> |
| <div class="block">Reset the vector to initial state.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>static <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/BaseLargeVariableWidthVector.html#set-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-int-int-long-">set</a></span>(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| int valueCount, |
| int index, |
| long value)</code> |
| <div class="block">Method used by Json Reader to explicitly set the offsets of the variable |
| width vector data.</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/BaseLargeVariableWidthVector.html#set-int-byte:A-">set</a></span>(int index, |
| byte[] value)</code> |
| <div class="block">Set the variable length element at the specified index to the supplied |
| byte array.</div> |
| </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/BaseLargeVariableWidthVector.html#set-int-byte:A-int-int-">set</a></span>(int index, |
| byte[] value, |
| int start, |
| int length)</code> |
| <div class="block">Set the variable length element at the specified index to the supplied |
| byte array.</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/BaseLargeVariableWidthVector.html#set-int-java.nio.ByteBuffer-int-int-">set</a></span>(int index, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, |
| int start, |
| int length)</code> |
| <div class="block">Set the variable length element at the specified index to the |
| content in supplied ByteBuffer.</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/BaseLargeVariableWidthVector.html#set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-">set</a></span>(int index, |
| int isSet, |
| long start, |
| long end, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</code> |
| <div class="block">Store the given value at a particular position in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-long-int-org.apache.arrow.memory.ArrowBuf-">set</a></span>(int index, |
| long start, |
| int length, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</code> |
| <div class="block">Store the given value at a particular position in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setBytes-int-byte:A-int-int-">setBytes</a></span>(int index, |
| byte[] value, |
| int start, |
| int length)</code> </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setIndexDefined-int-">setIndexDefined</a></span>(int index)</code> |
| <div class="block">Mark the particular position in the vector as non-null.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setInitialCapacity-int-">setInitialCapacity</a></span>(int valueCount)</code> |
| <div class="block">Sets the desired value capacity for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setInitialCapacity-int-double-">setInitialCapacity</a></span>(int valueCount, |
| double density)</code> |
| <div class="block">Sets the desired value capacity for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setLastSet-int-">setLastSet</a></span>(int value)</code> |
| <div class="block">Set the index of last non-null element in the vector.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setNull-int-">setNull</a></span>(int index)</code> |
| <div class="block">Set the element at the given index to null.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setSafe-int-byte:A-">setSafe</a></span>(int index, |
| byte[] value)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-byte:A-"><code>set(int, byte[])</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setSafe-int-byte:A-int-int-">setSafe</a></span>(int index, |
| byte[] value, |
| int start, |
| int length)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-byte:A-int-int-"><code>set(int, byte[], int, int)</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setSafe-int-java.nio.ByteBuffer-int-int-">setSafe</a></span>(int index, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, |
| int start, |
| int length)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-java.nio.ByteBuffer-int-int-"><code>set(int, ByteBuffer, int, int)</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setSafe-int-int-long-long-org.apache.arrow.memory.ArrowBuf-">setSafe</a></span>(int index, |
| int isSet, |
| long start, |
| long end, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"><code>set(int, int, long, long, ArrowBuf)</code></a> except that it handles the case |
| when index is greater than or equal to current value capacity of the |
| vector.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setSafe-int-long-int-org.apache.arrow.memory.ArrowBuf-">setSafe</a></span>(int index, |
| long start, |
| int length, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</code> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"><code>set(int, int, long, long, ArrowBuf)</code></a> except that it handles the case |
| when index is greater than or equal to current value capacity of the |
| vector.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setValueCount-int-">setValueCount</a></span>(int valueCount)</code> |
| <div class="block">Sets the value count for the vector.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setValueLengthSafe-int-int-">setValueLengthSafe</a></span>(int index, |
| int length)</code> |
| <div class="block">Sets the value length for an element.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#sizeOfValueBuffer--">sizeOfValueBuffer</a></span>()</code> |
| <div class="block">Provide the number of bytes contained in the valueBuffer.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#splitAndTransferTo-int-int-org.apache.arrow.vector.BaseLargeVariableWidthVector-">splitAndTransferTo</a></span>(int startIndex, |
| int length, |
| <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseLargeVariableWidthVector</a> target)</code> |
| <div class="block">Slice this vector at desired index and length and transfer the |
| corresponding data to the target vector.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#transferTo-org.apache.arrow.vector.BaseLargeVariableWidthVector-">transferTo</a></span>(<a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseLargeVariableWidthVector</a> target)</code> |
| <div class="block">Transfer this vector's data to another vector.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#validateScalars--">validateScalars</a></span>()</code> |
| <div class="block">Validate the scalar values held by this vector.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#zeroVector--">zeroVector</a></span>()</code> |
| <div class="block">zero out the vector and the data in associated buffers.</div> |
| </td> |
| </tr> |
| </table> |
| <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#getAllocator--">getAllocator</a>, <a href="../../../../org/apache/arrow/vector/BaseValueVector.html#getReader--">getReader</a>, <a href="../../../../org/apache/arrow/vector/BaseValueVector.html#getReaderImpl--">getReaderImpl</a>, <a href="../../../../org/apache/arrow/vector/BaseValueVector.html#getValidityBufferSizeFromCount-int-">getValidityBufferSizeFromCount</a>, <a href="../../../../org/apache/arrow/vector/BaseValueVector.html#iterator--">iterator</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.VariableWidthFieldVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.arrow.vector.<a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></h3> |
| <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#get-int-">get</a>, <a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#read-int-org.apache.arrow.memory.ReusableBuffer-">read</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#getAllocator--">getAllocator</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#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#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li> |
| </ul> |
| <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> |
| </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="OFFSET_WIDTH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OFFSET_WIDTH</h4> |
| <pre>public static final int OFFSET_WIDTH</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.arrow.vector.BaseLargeVariableWidthVector.OFFSET_WIDTH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emptyByteArray"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emptyByteArray</h4> |
| <pre>protected static final byte[] emptyByteArray</pre> |
| </li> |
| </ul> |
| <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="valueBuffer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueBuffer</h4> |
| <pre>protected <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> valueBuffer</pre> |
| </li> |
| </ul> |
| <a name="offsetBuffer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offsetBuffer</h4> |
| <pre>protected <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> offsetBuffer</pre> |
| </li> |
| </ul> |
| <a name="valueCount"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueCount</h4> |
| <pre>protected int valueCount</pre> |
| </li> |
| </ul> |
| <a name="lastSet"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastSet</h4> |
| <pre>protected int lastSet</pre> |
| </li> |
| </ul> |
| <a name="field"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>field</h4> |
| <pre>protected final <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> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BaseLargeVariableWidthVector-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseLargeVariableWidthVector</h4> |
| <pre>public BaseLargeVariableWidthVector(<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">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 creating/resizing buffers</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="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <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> getName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">ValueVector</a></code></span></div> |
| <div class="block">Gets the name of the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">getName</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">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/BaseValueVector.html#getName--">getName</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>the name of the vector.</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">Get buffer that manages the validity (NULL or NON-NULL nature) of |
| elements in the vector. Consider it as a buffer for internal bit vector |
| data structure.</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">Get the buffer that stores the data for elements in the 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">buffer that stores the offsets for elements |
| in the vector. This operation is not supported for fixed-width vectors.</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="getOffsetBufferAddress--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOffsetBufferAddress</h4> |
| <pre>public long getOffsetBufferAddress()</pre> |
| <div class="block">Get the memory address of buffer that stores the offsets for elements |
| in the 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>starting address of the buffer</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">Get the memory address of buffer that manages the validity |
| (NULL or NON-NULL nature) of elements in the 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>starting address of the buffer</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">Get the memory address of buffer that stores the data for elements |
| in the 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>starting address of the buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public void setInitialCapacity(int valueCount)</pre> |
| <div class="block">Sets the desired value capacity for the vector. This function doesn't |
| allocate any memory for the vector.</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="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - desired number of elements in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialCapacity-int-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialCapacity</h4> |
| <pre>public void setInitialCapacity(int valueCount, |
| double density)</pre> |
| <div class="block">Sets the desired value capacity for the vector. This function doesn't |
| allocate any memory for the vector.</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="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - desired number of elements in the vector</dd> |
| <dd><code>density</code> - average number of bytes per variable width element</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="getValueCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueCapacity</h4> |
| <pre>public int getValueCapacity()</pre> |
| <div class="block">Get the current capacity which does not exceed either validity buffer or offset buffer. |
| Note: Here the `getValueCapacity` has no relationship with the value buffer.</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="returnLabel">Returns:</span></dt> |
| <dd>number of elements that vector can hold.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="zeroVector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>zeroVector</h4> |
| <pre>public void zeroVector()</pre> |
| <div class="block">zero out the vector and the data in associated buffers.</div> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block">Reset the vector to initial state. Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#zeroVector--"><code>zeroVector()</code></a>. |
| Note that this method doesn't release any memory.</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Close the vector and release the associated buffers.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ValueVector.html#close--">close</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#close--">close</a></code> in class <code><a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</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">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#close--"><code>close()</code></a>.</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/BaseValueVector.html#clear--">clear</a></code> in class <code><a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector">BaseValueVector</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="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">Initialize the children in schema for this Field. This operation is a |
| NO-OP for scalar types since they don't have any children.</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> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if children is a non-empty list for scalar types.</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">Get the inner child vectors.</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>list of child vectors for complex types, empty list for scalar vector 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="allocateNew--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew()</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.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> |
| </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. See <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#allocateNew-long-int-"><code>allocateNew(long, int)</code></a> for allocating memory for specific |
| number of 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="returnLabel">Returns:</span></dt> |
| <dd>false if memory allocation fails, true otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateNew-long-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew(long totalBytes, |
| int valueCount)</pre> |
| <div class="block">Allocate memory for the vector to support storing at least the provided number of |
| elements in the vector. This method must be called prior to using the ValueVector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#allocateNew-long-int-">allocateNew</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>totalBytes</code> - desired total memory capacity</dd> |
| <dd><code>valueCount</code> - the desired number of elements in the vector</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> - if memory allocation fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocateNew-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>public void allocateNew(int valueCount)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#allocateNew-int-">VariableWidthVector</a></code></span></div> |
| <div class="block">Allocate a new memory space for this vector. Must be called prior to using the ValueVector. |
| The initial size in bytes is either default (or) reused from previous allocation</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#allocateNew-int-">allocateNew</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - Number of values in the vector.</dd> |
| </dl> |
| </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> |
| </dl> |
| </li> |
| </ul> |
| <a name="reallocDataBuffer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reallocDataBuffer</h4> |
| <pre>public void reallocDataBuffer()</pre> |
| <div class="block">Reallocate the data buffer. Data Buffer stores the actual data for |
| LARGEVARCHAR or LARGEVARBINARY elements in the vector. The behavior is to double |
| the size of buffer.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/util/OversizedAllocationException.html" title="class in org.apache.arrow.vector.util">OversizedAllocationException</a></code> - if the desired new size is more than |
| max allowed</dd> |
| <dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code> - if the internal memory allocation fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reallocValidityAndOffsetBuffers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reallocValidityAndOffsetBuffers</h4> |
| <pre>public void reallocValidityAndOffsetBuffers()</pre> |
| <div class="block">Reallocate the validity and offset buffers for this vector. Validity |
| buffer is used to track the NULL or NON-NULL nature of elements in |
| the vector and offset buffer is used to store the lengths of variable |
| width elements in the vector. |
| |
| <p>Note that data buffer for variable length vectors moves independent |
| of the companion validity and offset buffers. This is in |
| contrast to what we have for fixed width vectors. |
| |
| <p>So even though we may have setup an initial capacity of 1024 |
| elements in the vector, it is quite possible |
| that we need to reAlloc() the data buffer when we are setting |
| the 5th element in the vector simply because previous |
| variable length elements have exhausted the buffer capacity. |
| However, we really don't need to reAlloc() validity and |
| offset buffers until we try to set the 1025th element |
| This is why we do a separate check for safe methods to |
| determine which buffer needs reallocation.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/util/OversizedAllocationException.html" title="class in org.apache.arrow.vector.util">OversizedAllocationException</a></code> - if the desired new size is more than |
| max allowed</dd> |
| <dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code> - if the internal memory allocation fails</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByteCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteCapacity</h4> |
| <pre>public int getByteCapacity()</pre> |
| <div class="block">Get the size (number of bytes) of underlying data buffer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#getByteCapacity--">getByteCapacity</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of bytes in the data buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sizeOfValueBuffer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sizeOfValueBuffer</h4> |
| <pre>public int sizeOfValueBuffer()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#sizeOfValueBuffer--">VariableWidthVector</a></code></span></div> |
| <div class="block">Provide the number of bytes contained in the valueBuffer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html#sizeOfValueBuffer--">sizeOfValueBuffer</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthVector.html" title="interface in org.apache.arrow.vector">VariableWidthVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in valueBuffer.</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="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">Get the potential buffer size for a particular number of records.</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="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - desired number of elements in the vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>estimated size of underlying buffers if the vector holds |
| a given number of elements</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">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="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="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 <code>buffers</code> that is used by this |
| vector instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateScalars--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateScalars</h4> |
| <pre>public void validateScalars()</pre> |
| <div class="block">Validate the scalar values held by this vector.</div> |
| </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">Construct a transfer pair of this vector and another vector of same type.</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> - name of the target vector</dd> |
| <dd><code>allocator</code> - allocator for the target vector</dd> |
| <dd><code>callBack</code> - not used</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TransferPair</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">Construct a transfer pair of this vector and another vector of same type.</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 materialized by this vector</dd> |
| <dd><code>allocator</code> - allocator for the target vector</dd> |
| <dd><code>callBack</code> - not used</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TransferPair</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransferPair-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/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block">Construct a transfer pair of this vector and another vector of same type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/BaseValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</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>allocator</code> - allocator for the target vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TransferPair</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 abstract <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">Construct a transfer pair of this vector and another vector of same type.</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> - name of the target vector</dd> |
| <dd><code>allocator</code> - allocator for the target vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TransferPair</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 abstract <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">Construct a transfer pair of this vector and another vector of same type.</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 materialized by this vector</dd> |
| <dd><code>allocator</code> - allocator for the target vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TransferPair</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transferTo-org.apache.arrow.vector.BaseLargeVariableWidthVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transferTo</h4> |
| <pre>public void transferTo(<a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseLargeVariableWidthVector</a> target)</pre> |
| <div class="block">Transfer this vector's data to another vector. The memory associated |
| with this vector is transferred to the allocator of target vector |
| for accounting and management purposes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - destination vector for transfer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="splitAndTransferTo-int-int-org.apache.arrow.vector.BaseLargeVariableWidthVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitAndTransferTo</h4> |
| <pre>public void splitAndTransferTo(int startIndex, |
| int length, |
| <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector">BaseLargeVariableWidthVector</a> target)</pre> |
| <div class="block">Slice this vector at desired index and length and transfer the |
| corresponding data to the target vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startIndex</code> - start position of the split in source vector.</dd> |
| <dd><code>length</code> - length of the split.</dd> |
| <dd><code>target</code> - destination vector</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="isSafe-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSafe</h4> |
| <pre>public boolean isSafe(int index)</pre> |
| <div class="block">Check if the given index is within the current value capacity |
| of the vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if index is within the current value capacity</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="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</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/BaseLargeVariableWidthVector.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="getValueCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueCount</h4> |
| <pre>public int getValueCount()</pre> |
| <div class="block">Get the value count of vector. This will always be zero unless |
| setValueCount(int) has been called prior to calling this.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCount--">getValueCount</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>valueCount for the vector</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="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - value count</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fillEmpties-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fillEmpties</h4> |
| <pre>public void fillEmpties(int index)</pre> |
| <div class="block">Create holes in the vector upto the given index (exclusive). |
| Holes will be created from the current last set position in |
| the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#fillEmpties-int-">fillEmpties</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - target index</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> |
| <div class="block">Set the index of last non-null element in the vector. |
| It is important to call this method with appropriate value |
| before calling <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#setValueCount-int-"><code>setValueCount(int)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#setLastSet-int-">setLastSet</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - desired index of last non-null element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastSet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastSet</h4> |
| <pre>public int getLastSet()</pre> |
| <div class="block">Get the index of last non-null element in the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#getLastSet--">getLastSet</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>index of the last non-null element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIndexDefined-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndexDefined</h4> |
| <pre>public void setIndexDefined(int index)</pre> |
| <div class="block">Mark the particular position in the vector as non-null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VectorDefinitionSetter.html#setIndexDefined-int-">setIndexDefined</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VectorDefinitionSetter.html" title="interface in org.apache.arrow.vector">VectorDefinitionSetter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueLengthSafe-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueLengthSafe</h4> |
| <pre>public void setValueLengthSafe(int index, |
| int length)</pre> |
| <div class="block">Sets the value length for an element.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#setValueLengthSafe-int-int-">setValueLengthSafe</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>length</code> - length of the element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueLength-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueLength</h4> |
| <pre>public int getValueLength(int index)</pre> |
| <div class="block">Get the variable length element at specified index as Text.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#getValueLength-int-">getValueLength</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of element to get</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>greater than 0 length for non-null element, 0 otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-int-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(int index, |
| byte[] value)</pre> |
| <div class="block">Set the variable length element at the specified index to the supplied |
| byte array. This is same as using <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-byte:A-int-int-"><code>set(int, byte[], int, int)</code></a> |
| with start as 0 and length as value.length</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#set-int-byte:A-">set</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - array of bytes to write</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSafe-int-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSafe</h4> |
| <pre>public void setSafe(int index, |
| byte[] value)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-byte:A-"><code>set(int, byte[])</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#setSafe-int-byte:A-">setSafe</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - array of bytes to write</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-int-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(int index, |
| byte[] value, |
| int start, |
| int length)</pre> |
| <div class="block">Set the variable length element at the specified index to the supplied |
| byte array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#set-int-byte:A-int-int-">set</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - array of bytes to write</dd> |
| <dd><code>start</code> - start index in array of bytes</dd> |
| <dd><code>length</code> - length of data in array of bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSafe-int-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSafe</h4> |
| <pre>public void setSafe(int index, |
| byte[] value, |
| int start, |
| int length)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-byte:A-int-int-"><code>set(int, byte[], int, int)</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#setSafe-int-byte:A-int-int-">setSafe</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - array of bytes to write</dd> |
| <dd><code>start</code> - start index in array of bytes</dd> |
| <dd><code>length</code> - length of data in array of bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-int-java.nio.ByteBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(int index, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, |
| int start, |
| int length)</pre> |
| <div class="block">Set the variable length element at the specified index to the |
| content in supplied ByteBuffer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#set-int-java.nio.ByteBuffer-int-int-">set</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - ByteBuffer with data</dd> |
| <dd><code>start</code> - start index in ByteBuffer</dd> |
| <dd><code>length</code> - length of data in ByteBuffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSafe-int-java.nio.ByteBuffer-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSafe</h4> |
| <pre>public void setSafe(int index, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, |
| int start, |
| int length)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-java.nio.ByteBuffer-int-int-"><code>set(int, ByteBuffer, int, int)</code></a> except that it handles the |
| case where index and length of new element are beyond the existing |
| capacity of the vector.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html#setSafe-int-java.nio.ByteBuffer-int-int-">setSafe</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/VariableWidthFieldVector.html" title="interface in org.apache.arrow.vector">VariableWidthFieldVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the element to set</dd> |
| <dd><code>value</code> - ByteBuffer with data</dd> |
| <dd><code>start</code> - start index in ByteBuffer</dd> |
| <dd><code>length</code> - length of data in ByteBuffer</dd> |
| </dl> |
| </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">Set the element at the given index to 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 of element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(int index, |
| int isSet, |
| long start, |
| long end, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</pre> |
| <div class="block">Store the given value at a particular position in the vector. isSet indicates |
| whether the value is NULL or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the new value</dd> |
| <dd><code>isSet</code> - 0 for NULL value, 1 otherwise</dd> |
| <dd><code>start</code> - start position of data in buffer</dd> |
| <dd><code>end</code> - end position of data in buffer</dd> |
| <dd><code>buffer</code> - data buffer containing the variable width element to be stored |
| in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSafe-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSafe</h4> |
| <pre>public void setSafe(int index, |
| int isSet, |
| long start, |
| long end, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"><code>set(int, int, long, long, ArrowBuf)</code></a> except that it handles the case |
| when index is greater than or equal to current value capacity of the |
| vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the new value</dd> |
| <dd><code>isSet</code> - 0 for NULL value, 1 otherwise</dd> |
| <dd><code>start</code> - start position of data in buffer</dd> |
| <dd><code>end</code> - end position of data in buffer</dd> |
| <dd><code>buffer</code> - data buffer containing the variable width element to be stored |
| in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-int-long-int-org.apache.arrow.memory.ArrowBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(int index, |
| long start, |
| int length, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</pre> |
| <div class="block">Store the given value at a particular position in the vector. isSet indicates |
| whether the value is NULL or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the new value</dd> |
| <dd><code>start</code> - start position of data in buffer</dd> |
| <dd><code>length</code> - length of data in buffer</dd> |
| <dd><code>buffer</code> - data buffer containing the variable width element to be stored |
| in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSafe-int-long-int-org.apache.arrow.memory.ArrowBuf-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSafe</h4> |
| <pre>public void setSafe(int index, |
| long start, |
| int length, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer)</pre> |
| <div class="block">Same as <a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html#set-int-int-long-long-org.apache.arrow.memory.ArrowBuf-"><code>set(int, int, long, long, ArrowBuf)</code></a> except that it handles the case |
| when index is greater than or equal to current value capacity of the |
| vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - position of the new value</dd> |
| <dd><code>start</code> - start position of data in buffer</dd> |
| <dd><code>length</code> - length of data in buffer</dd> |
| <dd><code>buffer</code> - data buffer containing the variable width element to be stored |
| in the vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fillHoles-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fillHoles</h4> |
| <pre>protected final void fillHoles(int index)</pre> |
| </li> |
| </ul> |
| <a name="setBytes-int-byte:A-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre>protected final void setBytes(int index, |
| byte[] value, |
| int start, |
| int length)</pre> |
| </li> |
| </ul> |
| <a name="getStartOffset-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartOffset</h4> |
| <pre>protected final long getStartOffset(int index)</pre> |
| <div class="block">Gets the starting offset of a record, given its index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - index of the record.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the starting offset of the record.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleSafe-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleSafe</h4> |
| <pre>protected final void handleSafe(int index, |
| int dataLength)</pre> |
| </li> |
| </ul> |
| <a name="get-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.ArrowBuf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public static byte[] get(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> data, |
| <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> offset, |
| int index)</pre> |
| <div class="block">Method used by Json Writer to read a variable width element from |
| the variable width vector and write to Json. |
| |
| <p>This method should not be used externally.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - buffer storing the variable width vector elements</dd> |
| <dd><code>offset</code> - buffer storing the offsets of variable width vector elements</dd> |
| <dd><code>index</code> - position of the element in the vector</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>array of bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-org.apache.arrow.memory.ArrowBuf-org.apache.arrow.memory.BufferAllocator-int-int-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public static <a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> set(<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a> buffer, |
| <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator, |
| int valueCount, |
| int index, |
| long value)</pre> |
| <div class="block">Method used by Json Reader to explicitly set the offsets of the variable |
| width vector data. The method takes care of allocating the memory for |
| offsets if the caller hasn't done so. |
| |
| <p>This method should not be used externally.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - ArrowBuf to store offsets for variable width elements</dd> |
| <dd><code>allocator</code> - memory allocator</dd> |
| <dd><code>valueCount</code> - number of elements</dd> |
| <dd><code>index</code> - position of the element</dd> |
| <dd><code>value</code> - offset of the element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>buffer holding the offsets</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 fromIndex, |
| int thisIndex, |
| <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>fromIndex</code> - position to copy from in source vector</dd> |
| <dd><code>thisIndex</code> - position to copy to in this vector</dd> |
| <dd><code>from</code> - source vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromSafe</h4> |
| <pre>public void copyFromSafe(int fromIndex, |
| int thisIndex, |
| <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/BaseLargeVariableWidthVector.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>fromIndex</code> - position to copy from in source vector</dd> |
| <dd><code>thisIndex</code> - position to copy to in this vector</dd> |
| <dd><code>from</code> - source vector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataPointer-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataPointer</h4> |
| <pre>public <a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a> getDataPointer(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-">ElementAddressableVector</a></code></span></div> |
| <div class="block">Gets the pointer for the data at the given index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-">getDataPointer</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - the index for the data.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pointer to the data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataPointer-int-org.apache.arrow.memory.util.ArrowBufPointer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataPointer</h4> |
| <pre>public <a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a> getDataPointer(int index, |
| <a href="../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a> reuse)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-org.apache.arrow.memory.util.ArrowBufPointer-">ElementAddressableVector</a></code></span></div> |
| <div class="block">Gets the pointer for the data at the given index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-org.apache.arrow.memory.util.ArrowBufPointer-">getDataPointer</a></code> in interface <code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - the index for the data.</dd> |
| <dd><code>reuse</code> - the data pointer to fill, this avoids creating a new pointer object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pointer to the data, it should be the same one as the input parameter</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="getEndOffset-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEndOffset</h4> |
| <pre>protected final long getEndOffset(int index)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseLargeVariableWidthVector.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/BaseIntVector.html" title="interface in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/BaseValueVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/arrow/vector/BaseLargeVariableWidthVector.html" target="_top">Frames</a></li> |
| <li><a href="BaseLargeVariableWidthVector.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> |