blob: d1ea8b3a32f725db41a37c3a92b30341ccc1058a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.arrow.vector.util (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="org.apache.arrow.vector.util (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/types/pojo/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/vector/util/jmh_generated/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/vector/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.arrow.vector.util</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util">CallBack</a></td>
<td class="colLast">
<div class="block">Generic callback interface to be notified of events on value vectors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/MapWithOrdinal.html" title="interface in org.apache.arrow.vector.util">MapWithOrdinal</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">An implementation of a map that supports constant time look-up by a generic key or an ordinal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util">TransferPair</a></td>
<td class="colLast">
<div class="block">Interface for copying values between a pair of two vectors of the same type.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/ByteArrayReadableSeekableByteChannel.html" title="class in org.apache.arrow.vector.util">ByteArrayReadableSeekableByteChannel</a></td>
<td class="colLast">
<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/SeekableByteChannel.html?is-external=true" title="class or interface in java.nio.channels"><code>SeekableByteChannel</code></a> backed by a byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html" title="class in org.apache.arrow.vector.util">DataSizeRoundingUtil</a></td>
<td class="colLast">
<div class="block">Utilities for rounding data size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/DateUtility.html" title="class in org.apache.arrow.vector.util">DateUtility</a></td>
<td class="colLast">
<div class="block">Utility class for Date, DateTime, TimeStamp, Interval data types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/DecimalUtility.html" title="class in org.apache.arrow.vector.util">DecimalUtility</a></td>
<td class="colLast">
<div class="block">Utility methods for configurable precision Decimal values (e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/DictionaryUtility.html" title="class in org.apache.arrow.vector.util">DictionaryUtility</a></td>
<td class="colLast">
<div class="block">Utility methods for working with Dictionaries used in Dictionary encodings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/ElementAddressableVectorIterator.html" title="class in org.apache.arrow.vector.util">ElementAddressableVectorIterator</a>&lt;T extends <a href="../../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector">ElementAddressableVector</a>&gt;</td>
<td class="colLast">
<div class="block">Iterator for traversing elements of a <a href="../../../../../org/apache/arrow/vector/ElementAddressableVector.html" title="interface in org.apache.arrow.vector"><code>ElementAddressableVector</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/JsonStringArrayList.html" title="class in org.apache.arrow.vector.util">JsonStringArrayList</a>&lt;E&gt;</td>
<td class="colLast">
<div class="block">Extension of <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util"><code>ArrayList</code></a> that <a href="../../../../../org/apache/arrow/vector/util/JsonStringArrayList.html#toString--"><code>JsonStringArrayList.toString()</code></a> method returns the serialized JSON
version of its members (or throws an exception if they can't be converted to JSON).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/JsonStringHashMap.html" title="class in org.apache.arrow.vector.util">JsonStringHashMap</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Simple class that extends the regular java.util.HashMap but overrides the
toString() method of the HashMap class to produce a JSON string instead</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/MapWithOrdinalImpl.html" title="class in org.apache.arrow.vector.util">MapWithOrdinalImpl</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">An implementation of map that supports constant time look-up by a generic key or an ordinal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/MultiMapWithOrdinal.html" title="class in org.apache.arrow.vector.util">MultiMapWithOrdinal</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">An implementation of a multimap that supports constant time look-up by a generic key or an ordinal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/ObjectMapperFactory.html" title="class in org.apache.arrow.vector.util">ObjectMapperFactory</a></td>
<td class="colLast">
<div class="block">A <code>ObjectMapper</code> factory to read/write JSON.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/PromotableMultiMapWithOrdinal.html" title="class in org.apache.arrow.vector.util">PromotableMultiMapWithOrdinal</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Implementation of MapWithOrdinal that allows for promotion to multimap when duplicate fields exist.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/ReusableByteArray.html" title="class in org.apache.arrow.vector.util">ReusableByteArray</a></td>
<td class="colLast">
<div class="block">A wrapper around byte arrays for repeated writing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/SchemaUtility.html" title="class in org.apache.arrow.vector.util">SchemaUtility</a></td>
<td class="colLast">
<div class="block">Schema utility class including serialization and deserialization.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/Text.html" title="class in org.apache.arrow.vector.util">Text</a></td>
<td class="colLast">
<div class="block">A simplified byte wrapper similar to Hadoop's Text class without all the dependencies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/Text.TextSerializer.html" title="class in org.apache.arrow.vector.util">Text.TextSerializer</a></td>
<td class="colLast">
<div class="block">JSON serializer for <a href="../../../../../org/apache/arrow/vector/util/Text.html" title="class in org.apache.arrow.vector.util"><code>Text</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/TransferPairBenchmarks.html" title="class in org.apache.arrow.vector.util">TransferPairBenchmarks</a></td>
<td class="colLast">
<div class="block">Benchmarks for <a href="../../../../../org/apache/arrow/vector/util/TransferPair.html" title="interface in org.apache.arrow.vector.util"><code>TransferPair</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/Validator.html" title="class in org.apache.arrow.vector.util">Validator</a></td>
<td class="colLast">
<div class="block">Utility class for validating arrow data structures.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/ValueVectorUtility.html" title="class in org.apache.arrow.vector.util">ValueVectorUtility</a></td>
<td class="colLast">
<div class="block">Utility methods for <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector"><code>ValueVector</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/VectorAppender.html" title="class in org.apache.arrow.vector.util">VectorAppender</a></td>
<td class="colLast">
<div class="block">Utility to append two vectors together.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/VectorBatchAppender.html" title="class in org.apache.arrow.vector.util">VectorBatchAppender</a></td>
<td class="colLast">
<div class="block">Utility to add vector values in batch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/VectorSchemaRootAppender.html" title="class in org.apache.arrow.vector.util">VectorSchemaRootAppender</a></td>
<td class="colLast">
<div class="block">Utility to append <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector"><code>VectorSchemaRoot</code></a>s with the same schema.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/OversizedAllocationException.html" title="class in org.apache.arrow.vector.util">OversizedAllocationException</a></td>
<td class="colLast">
<div class="block">An exception that is used to signal that allocation request in bytes is greater than the maximum allowed by
<code>allocator</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/vector/util/SchemaChangeRuntimeException.html" title="class in org.apache.arrow.vector.util">SchemaChangeRuntimeException</a></td>
<td class="colLast">
<div class="block">Thrown when child vectors (e.g.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/types/pojo/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/vector/util/jmh_generated/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/vector/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>