| <!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>ArrowRecordBatch (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="ArrowRecordBatch (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}; |
| 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/ArrowRecordBatch.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/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatchBenchmarks.html" title="class in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" target="_top">Frames</a></li> |
| <li><a href="ArrowRecordBatch.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.ipc.message</div> |
| <h2 title="Class ArrowRecordBatch" class="title">Class ArrowRecordBatch</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.ipc.message.ArrowRecordBatch</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>, <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>, <a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html" title="interface in org.apache.arrow.vector.ipc.message">FBSerializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ArrowRecordBatch</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="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></pre> |
| <div class="block">POJO representation of a RecordBatch IPC message (https://arrow.apache.org/docs/format/Columnar.html#recordbatch-message).</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.arrow.vector.ipc.message.ArrowMessage"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.arrow.vector.ipc.message.<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></h3> |
| <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage.ArrowMessageVisitor</a><<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="type parameter in ArrowMessage.ArrowMessageVisitor">T</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/ipc/message/ArrowRecordBatch.html#ArrowRecordBatch-int-java.util.List-java.util.List-">ArrowRecordBatch</a></span>(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-">ArrowRecordBatch</a></span>(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-boolean-">ArrowRecordBatch</a></span>(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression, |
| boolean alignBuffers)</code> |
| <div class="block">Construct a record batch from nodes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-boolean-boolean-">ArrowRecordBatch</a></span>(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression, |
| boolean alignBuffers, |
| boolean retainBuffers)</code> |
| <div class="block">Construct a record batch from nodes.</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><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#accepts-org.apache.arrow.vector.ipc.message.ArrowMessage.ArrowMessageVisitor-">accepts</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage.ArrowMessageVisitor</a><T> visitor)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#cloneWithTransfer-org.apache.arrow.memory.BufferAllocator-">cloneWithTransfer</a></span>(<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> |
| <div class="block">Create a new ArrowRecordBatch which has the same information as this batch but whose buffers |
| are owned by that Allocator.</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/ipc/message/ArrowRecordBatch.html#close--">close</a></span>()</code> |
| <div class="block">Releases the buffers.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#computeBodyLength--">computeBodyLength</a></span>()</code> |
| <div class="block">Computes the size of the serialized body for this recordBatch.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#getBodyCompression--">getBodyCompression</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" 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/ipc/message/ArrowRecordBatch.html#getBuffers--">getBuffers</a></span>()</code> |
| <div class="block">Get the record batch buffers.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/ipc/message/ArrowBuffer.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBuffer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#getBuffersLayout--">getBuffersLayout</a></span>()</code> |
| <div class="block">Get the serialized layout.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#getLength--">getLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#getMessageType--">getMessageType</a></span>()</code> |
| <div class="block">Returns the flatbuffer enum value indicating the type of the message.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#getNodes--">getNodes</a></span>()</code> |
| <div class="block">Get the nodes in this record batch.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/ipc/message/ArrowRecordBatch.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html#writeTo-com.google.flatbuffers.FlatBufferBuilder-">writeTo</a></span>(com.google.flatbuffers.FlatBufferBuilder builder)</code> |
| <div class="block">Returns the number of bytes taken to serialize the data in builder after writing to it.</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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ArrowRecordBatch-int-java.util.List-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowRecordBatch</h4> |
| <pre>public ArrowRecordBatch(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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)</pre> |
| </li> |
| </ul> |
| <a name="ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowRecordBatch</h4> |
| <pre>public ArrowRecordBatch(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression)</pre> |
| </li> |
| </ul> |
| <a name="ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowRecordBatch</h4> |
| <pre>public ArrowRecordBatch(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression, |
| boolean alignBuffers)</pre> |
| <div class="block">Construct a record batch from nodes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>length</code> - how many rows in this batch</dd> |
| <dd><code>nodes</code> - field level info</dd> |
| <dd><code>buffers</code> - will be retained until this recordBatch is closed</dd> |
| <dd><code>bodyCompression</code> - compression info.</dd> |
| <dd><code>alignBuffers</code> - Whether to align buffers to an 8 byte boundary.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ArrowRecordBatch-int-java.util.List-java.util.List-org.apache.arrow.vector.ipc.message.ArrowBodyCompression-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ArrowRecordBatch</h4> |
| <pre>public ArrowRecordBatch(int length, |
| <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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> nodes, |
| <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/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> bodyCompression, |
| boolean alignBuffers, |
| boolean retainBuffers)</pre> |
| <div class="block">Construct a record batch from nodes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>length</code> - how many rows in this batch</dd> |
| <dd><code>nodes</code> - field level info</dd> |
| <dd><code>buffers</code> - will be retained until this recordBatch is closed</dd> |
| <dd><code>bodyCompression</code> - compression info.</dd> |
| <dd><code>alignBuffers</code> - Whether to align buffers to an 8 byte boundary.</dd> |
| <dd><code>retainBuffers</code> - Whether to retain() each source buffer in the constructor. If false, the caller is |
| responsible for retaining the buffers beforehand.</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="getMessageType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageType</h4> |
| <pre>public byte getMessageType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html#getMessageType--">ArrowMessage</a></code></span></div> |
| <div class="block">Returns the flatbuffer enum value indicating the type of the message.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html#getMessageType--">getMessageType</a></code> in interface <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLength</h4> |
| <pre>public int getLength()</pre> |
| </li> |
| </ul> |
| <a name="getBodyCompression--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyCompression</h4> |
| <pre>public <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a> getBodyCompression()</pre> |
| </li> |
| </ul> |
| <a name="getNodes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodes</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/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a>> getNodes()</pre> |
| <div class="block">Get the nodes in this record batch.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the FieldNodes corresponding to the schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBuffers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBuffers</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>> getBuffers()</pre> |
| <div class="block">Get the record batch buffers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the buffers containing the data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cloneWithTransfer-org.apache.arrow.memory.BufferAllocator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cloneWithTransfer</h4> |
| <pre>public <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a> cloneWithTransfer(<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> |
| <div class="block">Create a new ArrowRecordBatch which has the same information as this batch but whose buffers |
| are owned by that Allocator. |
| |
| <p>This will also close this record batch and make it no longer useful.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A cloned ArrowRecordBatch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBuffersLayout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBuffersLayout</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/ipc/message/ArrowBuffer.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBuffer</a>> getBuffersLayout()</pre> |
| <div class="block">Get the serialized layout.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serialized layout if we send the buffers on the wire</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeTo-com.google.flatbuffers.FlatBufferBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeTo</h4> |
| <pre>public int writeTo(com.google.flatbuffers.FlatBufferBuilder builder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html#writeTo-com.google.flatbuffers.FlatBufferBuilder-">FBSerializable</a></code></span></div> |
| <div class="block">Returns the number of bytes taken to serialize the data in builder after writing to it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html#writeTo-com.google.flatbuffers.FlatBufferBuilder-">writeTo</a></code> in interface <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html" title="interface in org.apache.arrow.vector.ipc.message">FBSerializable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accepts-org.apache.arrow.vector.ipc.message.ArrowMessage.ArrowMessageVisitor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accepts</h4> |
| <pre>public <T> T accepts(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage.ArrowMessageVisitor</a><T> visitor)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html#accepts-org.apache.arrow.vector.ipc.message.ArrowMessage.ArrowMessageVisitor-">accepts</a></code> in interface <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</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">Releases the buffers.</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="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="computeBodyLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>computeBodyLength</h4> |
| <pre>public long computeBodyLength()</pre> |
| <div class="block">Computes the size of the serialized body for this recordBatch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html#computeBodyLength--">computeBodyLength</a></code> in interface <code><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ArrowRecordBatch.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/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatchBenchmarks.html" title="class in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" target="_top">Frames</a></li> |
| <li><a href="ArrowRecordBatch.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
