org.apache.arrow.vector.ipc.message

Class ArrowRecordBatch

java.lang.Object

org.apache.arrow.vector.ipc.message.ArrowRecordBatch

All Implemented Interfaces:

AutoCloseable, ArrowMessage, FBSerializable

public class ArrowRecordBatch
extends Object
implements ArrowMessage

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.vector.ipc.message.ArrowMessage

ArrowMessage.ArrowMessageVisitor<T>

Constructor Summary

Constructors

Constructor and Description
ArrowRecordBatch(int length, List<ArrowFieldNode> nodes, List<ArrowBuf> buffers)
ArrowRecordBatch(int length, List<ArrowFieldNode> nodes, List<ArrowBuf> buffers, boolean alignBuffers)

Method Summary

Modifier and Type	Method and Description
<T> T	accepts(ArrowMessage.ArrowMessageVisitor<T> visitor)
void	close() releases the buffers
int	computeBodyLength() Computes the size of the serialized body for this recordBatch.
List<ArrowBuf>	getBuffers()
List<ArrowBuffer>	getBuffersLayout()
int	getLength()
List<ArrowFieldNode>	getNodes()
String	toString()
int	writeTo(com.google.flatbuffers.FlatBufferBuilder builder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArrowRecordBatch

public ArrowRecordBatch(int length,
                        List<ArrowFieldNode> nodes,
                        List<ArrowBuf> buffers)

ArrowRecordBatch

public ArrowRecordBatch(int length,
                        List<ArrowFieldNode> nodes,
                        List<ArrowBuf> buffers,
                        boolean alignBuffers)

Parameters:

length - how many rows in this batch

nodes - field level info

buffers - will be retained until this recordBatch is closed

Method Detail

getLength

public int getLength()

getNodes

public List<ArrowFieldNode> getNodes()

Returns:

the FieldNodes corresponding to the schema

getBuffers

public List<ArrowBuf> getBuffers()

Returns:

the buffers containing the data

getBuffersLayout

public List<ArrowBuffer> getBuffersLayout()

Returns:

the serialized layout if we send the buffers on the wire

writeTo

public int writeTo(com.google.flatbuffers.FlatBufferBuilder builder)

Specified by:

writeTo in interface FBSerializable

accepts

public <T> T accepts(ArrowMessage.ArrowMessageVisitor<T> visitor)

Specified by:

accepts in interface ArrowMessage

close

public void close()

releases the buffers

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

computeBodyLength

public int computeBodyLength()

Computes the size of the serialized body for this recordBatch.

Specified by:

computeBodyLength in interface ArrowMessage