| <!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>FixedWidthVector (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="FixedWidthVector (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/FixedWidthVector.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/FixedSizeBinaryVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/Float2Vector.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/FixedWidthVector.html" target="_top">Frames</a></li> |
| <li><a href="FixedWidthVector.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.arrow.vector</div> |
| <h2 title="Interface FixedWidthVector" class="title">Interface FixedWidthVector</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</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/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/arrow/vector/BaseFixedWidthVector.html" title="class in org.apache.arrow.vector">BaseFixedWidthVector</a>, <a href="../../../../org/apache/arrow/vector/BigIntVector.html" title="class in org.apache.arrow.vector">BigIntVector</a>, <a href="../../../../org/apache/arrow/vector/BitVector.html" title="class in org.apache.arrow.vector">BitVector</a>, <a href="../../../../org/apache/arrow/vector/DateDayVector.html" title="class in org.apache.arrow.vector">DateDayVector</a>, <a href="../../../../org/apache/arrow/vector/DateMilliVector.html" title="class in org.apache.arrow.vector">DateMilliVector</a>, <a href="../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>, <a href="../../../../org/apache/arrow/vector/DecimalVector.html" title="class in org.apache.arrow.vector">DecimalVector</a>, <a href="../../../../org/apache/arrow/vector/DurationVector.html" title="class in org.apache.arrow.vector">DurationVector</a>, <a href="../../../../org/apache/arrow/vector/FixedSizeBinaryVector.html" title="class in org.apache.arrow.vector">FixedSizeBinaryVector</a>, <a href="../../../../org/apache/arrow/vector/Float2Vector.html" title="class in org.apache.arrow.vector">Float2Vector</a>, <a href="../../../../org/apache/arrow/vector/Float4Vector.html" title="class in org.apache.arrow.vector">Float4Vector</a>, <a href="../../../../org/apache/arrow/vector/Float8Vector.html" title="class in org.apache.arrow.vector">Float8Vector</a>, <a href="../../../../org/apache/arrow/vector/IntervalDayVector.html" title="class in org.apache.arrow.vector">IntervalDayVector</a>, <a href="../../../../org/apache/arrow/vector/IntervalMonthDayNanoVector.html" title="class in org.apache.arrow.vector">IntervalMonthDayNanoVector</a>, <a href="../../../../org/apache/arrow/vector/IntervalYearVector.html" title="class in org.apache.arrow.vector">IntervalYearVector</a>, <a href="../../../../org/apache/arrow/vector/IntVector.html" title="class in org.apache.arrow.vector">IntVector</a>, <a href="../../../../org/apache/arrow/vector/SmallIntVector.html" title="class in org.apache.arrow.vector">SmallIntVector</a>, <a href="../../../../org/apache/arrow/vector/TimeMicroVector.html" title="class in org.apache.arrow.vector">TimeMicroVector</a>, <a href="../../../../org/apache/arrow/vector/TimeMilliVector.html" title="class in org.apache.arrow.vector">TimeMilliVector</a>, <a href="../../../../org/apache/arrow/vector/TimeNanoVector.html" title="class in org.apache.arrow.vector">TimeNanoVector</a>, <a href="../../../../org/apache/arrow/vector/TimeSecVector.html" title="class in org.apache.arrow.vector">TimeSecVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMicroTZVector.html" title="class in org.apache.arrow.vector">TimeStampMicroTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMicroVector.html" title="class in org.apache.arrow.vector">TimeStampMicroVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMilliTZVector.html" title="class in org.apache.arrow.vector">TimeStampMilliTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampMilliVector.html" title="class in org.apache.arrow.vector">TimeStampMilliVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampNanoTZVector.html" title="class in org.apache.arrow.vector">TimeStampNanoTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampNanoVector.html" title="class in org.apache.arrow.vector">TimeStampNanoVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampSecTZVector.html" title="class in org.apache.arrow.vector">TimeStampSecTZVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampSecVector.html" title="class in org.apache.arrow.vector">TimeStampSecVector</a>, <a href="../../../../org/apache/arrow/vector/TimeStampVector.html" title="class in org.apache.arrow.vector">TimeStampVector</a>, <a href="../../../../org/apache/arrow/vector/TinyIntVector.html" title="class in org.apache.arrow.vector">TinyIntVector</a>, <a href="../../../../org/apache/arrow/vector/UInt1Vector.html" title="class in org.apache.arrow.vector">UInt1Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt2Vector.html" title="class in org.apache.arrow.vector">UInt2Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt4Vector.html" title="class in org.apache.arrow.vector">UInt4Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt8Vector.html" title="class in org.apache.arrow.vector">UInt8Vector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FixedWidthVector</span> |
| extends <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a></pre> |
| <div class="block">Interface for all fixed width <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector"><code>ElementAddressableVector</code></a> (e.g. integer, fixed size binary, etc).</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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></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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FixedWidthVector.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="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/FixedWidthVector.html#zeroVector--">zeroVector</a></span>()</code> |
| <div class="block">Zero out the underlying buffer backing this vector.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.ElementAddressableVector"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.arrow.vector.<a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a></h3> |
| <code><a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-">getDataPointer</a>, <a href="../../../../org/apache/arrow/vector/ElementAddressableVector.html#getDataPointer-int-org.apache.arrow.memory.util.ArrowBufPointer-">getDataPointer</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#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">accept</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNew--">allocateNew</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#clear--">clear</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#close--">close</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBuffers-boolean-">getBuffers</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSize--">getBufferSize</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">getDataBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getField--">getField</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">getName</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getNullCount--">getNullCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">getOffsetBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">getValidityBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCount--">getValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#isNull-int-">isNull</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reAlloc--">reAlloc</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reset--">reset</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setValueCount-int-">setValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validate--">validate</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validateFull--">validateFull</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="allocateNew-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocateNew</h4> |
| <pre>void allocateNew(int valueCount)</pre> |
| <div class="block">Allocate a new memory space for this vector. Must be called prior to using the ValueVector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valueCount</code> - Number of values in the vector.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="zeroVector--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>zeroVector</h4> |
| <pre>void zeroVector()</pre> |
| <div class="block">Zero out the underlying buffer backing this vector.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FixedWidthVector.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/FixedSizeBinaryVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/arrow/vector/Float2Vector.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/FixedWidthVector.html" target="_top">Frames</a></li> |
| <li><a href="FixedWidthVector.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |