org.bytedeco.arrow

Class RecordBatchStreamReader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchReader

org.bytedeco.arrow.RecordBatchStreamReader

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc")
 @NoOffset
 @Properties(inherit=arrow.class)
public class RecordBatchStreamReader
extends RecordBatchReader

\class RecordBatchStreamReader \brief Synchronous batch stream reader that reads from io::InputStream This class reads the schema (plus any dictionaries) as the first messages in the stream, followed by record batches. For more granular zero-copy reads see the ReadRecordBatch functions

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
RecordBatchStreamReader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static Status	Open(InputStream stream, RecordBatchReader out) \brief Record batch stream reader from InputStream
static Status	Open(MessageReader message_reader, RecordBatchReader out) Create batch reader from generic MessageReader.
Status	ReadNext(RecordBatch batch) \brief Read the next record batch in the stream.
Schema	schema() \brief Returns the schema read from the stream

Methods inherited from class org.bytedeco.arrow.RecordBatchReader

Next, ReadAll, ReadAll

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordBatchStreamReader

public RecordBatchStreamReader(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

Open

@ByVal
public static Status Open(@UniquePtr
                                 MessageReader message_reader,
                                 @SharedPtr
                                 RecordBatchReader out)

Create batch reader from generic MessageReader. This will take ownership of the given MessageReader.

Parameters:

message_reader - [in] a MessageReader implementation

out - [out] the created RecordBatchReader object

Returns:

Status

Open

@ByVal
public static Status Open(InputStream stream,
                                 @SharedPtr
                                 RecordBatchReader out)

\brief Record batch stream reader from InputStream

Parameters:

stream - [in] an input stream instance. Must stay alive throughout lifetime of stream reader

out - [out] the created RecordBatchStreamReader object

Returns:

Status

schema

@SharedPtr
 @ByVal
public Schema schema()

\brief Returns the schema read from the stream

Overrides:

schema in class RecordBatchReader

Returns:

the shared schema of the record batches in the stream

ReadNext

@ByVal
public Status ReadNext(@SharedPtr
                              RecordBatch batch)

Description copied from class: RecordBatchReader

\brief Read the next record batch in the stream. Return null for batch when reaching end of stream

Overrides:

ReadNext in class RecordBatchReader

Parameters:

batch - [out] the next loaded batch, null at end of stream

Returns:

Status