| <!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>BaseTable (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="BaseTable (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":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseTable.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/arrow/vector/table/Row.html" title="class in org.apache.arrow.vector.table"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/table/BaseTable.html" target="_top">Frames</a></li> |
| <li><a href="BaseTable.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.table</div> |
| <h2 title="Class BaseTable" class="title">Class BaseTable</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.vector.table.BaseTable</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/arrow/vector/table/Table.html" title="class in org.apache.arrow.vector.table">Table</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseTable</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">Abstract base class for Table. |
| <p> |
| This API is EXPERIMENTAL.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#dictionaryProvider">dictionaryProvider</a></span></code> |
| <div class="block">An optional DictionaryProvider.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/table/BaseTable.html#fieldVectors">fieldVectors</a></span></code> |
| <div class="block">The field vectors holding the data in this table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</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/table/BaseTable.html#fieldVectorsMap">fieldVectorsMap</a></span></code> |
| <div class="block">A map of Fields to FieldVectors used to select Fields.</div> |
| </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/table/BaseTable.html#rowCount">rowCount</a></span></code> |
| <div class="block">The number of rows of data in the table; not necessarily the same as the table row capacity.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#schema">schema</a></span></code> |
| <div class="block">The schema for the table.</div> |
| </td> |
| </tr> |
| </table> |
| </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/table/BaseTable.html#BaseTable-java.util.List-int-org.apache.arrow.vector.dictionary.DictionaryProvider-">BaseTable</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/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>> fieldVectors, |
| int rowCount, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider)</code> |
| <div class="block">Constructs new instance with the given rowCount, and containing the schema and each of the |
| given vectors.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></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/table/BaseTable.html#close--">close</a></span>()</code> |
| <div class="block">Closes all the vectors holding data for this table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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/table/BaseTable.html#contentToTSVString--">contentToTSVString</a></span>()</code> |
| <div class="block">Returns a tab separated value of vectors (based on their java object representation).</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#decode-java.lang.String-long-">decode</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> vectorName, |
| long dictionaryId)</code> |
| <div class="block">Returns a ValueVector containing the decoded version of the vector with the given name.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#encode-java.lang.String-long-">encode</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> vectorName, |
| long dictionaryId)</code> |
| <div class="block">Returns a ValueVector containing the encoded version of the vector with the given name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getDictionaryProvider--">getDictionaryProvider</a></span>()</code> |
| <div class="block">Returns the DictionaryProvider for this table.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getField-java.lang.String-">getField</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> fieldName)</code> |
| <div class="block">Returns the Field with the given name if one exists in this table.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getReader-org.apache.arrow.vector.types.pojo.Field-">getReader</a></span>(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field)</code> |
| <div class="block">Returns a FieldReader for the given field.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getReader-int-">getReader</a></span>(int index)</code> |
| <div class="block">Returns a FieldReader for the field at the given vector index.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getReader-java.lang.String-">getReader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns a FieldReader for the vector with the given name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getRowCount--">getRowCount</a></span>()</code> |
| <div class="block">Returns the number of rows in this table.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getSchema--">getSchema</a></span>()</code> |
| <div class="block">Returns the schema for this Table.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getVectorCopy-int-">getVectorCopy</a></span>(int columnIndex)</code> |
| <div class="block">Returns a copy of the vector at the given position.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getVectorCopy-java.lang.String-">getVectorCopy</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> columnName)</code> |
| <div class="block">Returns a copy of the vector with the given name, or throws IllegalArgumentException if the name is not found.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#getVectorCount--">getVectorCount</a></span>()</code> |
| <div class="block">Returns the number of vectors (columns) in this table.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/table/Row.html" title="class in org.apache.arrow.vector.table">Row</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#immutableRow--">immutableRow</a></span>()</code> |
| <div class="block">Returns an immutable Row object holding a reference to this table.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#isRowDeleted-int-">isRowDeleted</a></span>(int rowNumber)</code> |
| <div class="block">Returns true if the row at the given index has been deleted and false otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/table/BaseTable.html#toVectorSchemaRoot--">toVectorSchemaRoot</a></span>()</code> |
| <div class="block">Returns a new VectorSchemaRoot with the data and schema from this table.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="fieldVectors"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldVectors</h4> |
| <pre>protected final <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>> fieldVectors</pre> |
| <div class="block">The field vectors holding the data in this table.</div> |
| </li> |
| </ul> |
| <a name="dictionaryProvider"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dictionaryProvider</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> dictionaryProvider</pre> |
| <div class="block">An optional DictionaryProvider. One must be present if any vector in the table is dictionary |
| encoded.</div> |
| </li> |
| </ul> |
| <a name="fieldVectorsMap"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldVectorsMap</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a>,<a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>> fieldVectorsMap</pre> |
| <div class="block">A map of Fields to FieldVectors used to select Fields.</div> |
| </li> |
| </ul> |
| <a name="schema"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre>protected <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a> schema</pre> |
| <div class="block">The schema for the table.</div> |
| </li> |
| </ul> |
| <a name="rowCount"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rowCount</h4> |
| <pre>protected int rowCount</pre> |
| <div class="block">The number of rows of data in the table; not necessarily the same as the table row capacity.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BaseTable-java.util.List-int-org.apache.arrow.vector.dictionary.DictionaryProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseTable</h4> |
| <pre>public BaseTable(<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>> fieldVectors, |
| int rowCount, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider)</pre> |
| <div class="block">Constructs new instance with the given rowCount, and containing the schema and each of the |
| given vectors.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldVectors</code> - the FieldVectors containing the table's data</dd> |
| <dd><code>rowCount</code> - the number of rows in the table</dd> |
| <dd><code>provider</code> - a dictionary provider, may be null if none of the vectors in the table are |
| encoded</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="getReader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a> getReader(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Returns a FieldReader for the vector with the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of a vector in this Table (case-sensitive)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A FieldReader for the named FieldVector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReader-org.apache.arrow.vector.types.pojo.Field-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a> getReader(<a href="../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field)</pre> |
| <div class="block">Returns a FieldReader for the given field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>field</code> - The field to be read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A FieldReader for the given field</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReader-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReader</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/complex/reader/FieldReader.html" title="interface in org.apache.arrow.vector.complex.reader">FieldReader</a> getReader(int index)</pre> |
| <div class="block">Returns a FieldReader for the field at the given vector index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The 0-based index of the field desired.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A FieldReader for the requested field</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a> getSchema()</pre> |
| <div class="block">Returns the schema for this Table.</div> |
| </li> |
| </ul> |
| <a name="getField-java.lang.String-"> |
| <!-- --> |
| </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(<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> fieldName)</pre> |
| <div class="block">Returns the Field with the given name if one exists in this table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a field with the given name if one is present</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 the field was not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVectorCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVectorCount</h4> |
| <pre>public int getVectorCount()</pre> |
| <div class="block">Returns the number of vectors (columns) in this table.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Closes all the vectors holding data for this table.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> 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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRowCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowCount</h4> |
| <pre>public long getRowCount()</pre> |
| <div class="block">Returns the number of rows in this table.</div> |
| </li> |
| </ul> |
| <a name="toVectorSchemaRoot--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toVectorSchemaRoot</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> toVectorSchemaRoot()</pre> |
| <div class="block">Returns a new VectorSchemaRoot with the data and schema from this table. Data is transferred to |
| the new VectorSchemaRoot, so this table is cleared and the rowCount is set to 0;</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new VectorSchemaRoot</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVectorCopy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVectorCopy</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> getVectorCopy(<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> columnName)</pre> |
| <div class="block">Returns a copy of the vector with the given name, or throws IllegalArgumentException if the name is not found. |
| Names are case-sensitive.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columnName</code> - The name of the vector to copy</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A copy of the Vector with the given name</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 the name is not the name of a vector in the table.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVectorCopy-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVectorCopy</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> getVectorCopy(int columnIndex)</pre> |
| <div class="block">Returns a copy of the vector at the given position.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columnIndex</code> - The 0-based position of the vector to be copied</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="immutableRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>immutableRow</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/table/Row.html" title="class in org.apache.arrow.vector.table">Row</a> immutableRow()</pre> |
| <div class="block">Returns an immutable Row object holding a reference to this table. The default character |
| encoding used by the cursor to decode Strings will be StandardCharsets.UTF_8 as this is the only charset |
| supported in Arrow format.</div> |
| </li> |
| </ul> |
| <a name="contentToTSVString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contentToTSVString</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> contentToTSVString()</pre> |
| <div class="block">Returns a tab separated value of vectors (based on their java object representation).</div> |
| </li> |
| </ul> |
| <a name="isRowDeleted-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRowDeleted</h4> |
| <pre>public boolean isRowDeleted(int rowNumber)</pre> |
| <div class="block">Returns true if the row at the given index has been deleted and false otherwise. |
| |
| <p>If the index is larger than the number of rows, the method returns true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rowNumber</code> - The 0-based index of the possibly deleted row</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the row at the index was deleted; false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDictionaryProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDictionaryProvider</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> getDictionaryProvider()</pre> |
| <div class="block">Returns the DictionaryProvider for this table. It can be used to decode an encoded values</div> |
| </li> |
| </ul> |
| <a name="decode-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> decode(<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> vectorName, |
| long dictionaryId)</pre> |
| <div class="block">Returns a ValueVector containing the decoded version of the vector with the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vectorName</code> - The name of the vector to decode</dd> |
| <dd><code>dictionaryId</code> - The identifier for the dictionary to use when decoding. Must match the id returned by the |
| dictionary's getId() method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A ValueVector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public <a href="../../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a> encode(<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> vectorName, |
| long dictionaryId)</pre> |
| <div class="block">Returns a ValueVector containing the encoded version of the vector with the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vectorName</code> - The name of the vector to encode</dd> |
| <dd><code>dictionaryId</code> - The identifier for the dictionary to use when encoding. Must match the id returned by the |
| dictionary's getId() method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A ValueVector</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseTable.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/arrow/vector/table/Row.html" title="class in org.apache.arrow.vector.table"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/table/BaseTable.html" target="_top">Frames</a></li> |
| <li><a href="BaseTable.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> |