org.bytedeco.arrow

Class RecordBatchBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchBuilder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class RecordBatchBuilder
extends Pointer

\class RecordBatchBuilder \brief Helper class for creating record batches iteratively given a known schema

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
RecordBatchBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Flush(boolean reset_builders, RecordBatch batch) \brief Finish current batch and optionally reset
Status	Flush(RecordBatch batch) \brief Finish current batch and reset
ArrayBuilder	GetField(int i) \brief Get base pointer to field builder
long	initial_capacity() \brief The initial capacity for builders
static Status	Make(Schema schema, MemoryPool pool, long initial_capacity, RecordBatchBuilder builder) \brief Create an initialize a RecordBatchBuilder
static Status	Make(Schema schema, MemoryPool pool, RecordBatchBuilder builder) \brief Create an initialize a RecordBatchBuilder
int	num_fields() \brief The number of fields in the schema
Schema	schema() \brief The number of fields in the schema
void	SetInitialCapacity(long _capacity) \brief Set the initial capacity for new builders

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, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordBatchBuilder

public RecordBatchBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Make

@ByVal
public static Status Make(@Const @SharedPtr @ByRef
                                 Schema schema,
                                 MemoryPool pool,
                                 @UniquePtr
                                 RecordBatchBuilder builder)

\brief Create an initialize a RecordBatchBuilder

Parameters:

schema - [in] The schema for the record batch

pool - [in] A MemoryPool to use for allocations

builder - [in] the created builder instance

Make

@ByVal
public static Status Make(@Const @SharedPtr @ByRef
                                 Schema schema,
                                 MemoryPool pool,
                                 @Cast(value="int64_t")
                                 long initial_capacity,
                                 @UniquePtr
                                 RecordBatchBuilder builder)

\brief Create an initialize a RecordBatchBuilder

Parameters:

schema - [in] The schema for the record batch

pool - [in] A MemoryPool to use for allocations

initial_capacity - [in] The initial capacity for the builders

builder - [in] the created builder instance

GetField

public ArrayBuilder GetField(int i)

\brief Get base pointer to field builder

Parameters:

i - the field index

Returns:

pointer to ArrayBuilder

Flush

@ByVal
public Status Flush(@Cast(value="bool")
                           boolean reset_builders,
                           @SharedPtr
                           RecordBatch batch)

\brief Finish current batch and optionally reset

Parameters:

reset_builders - [in] the resulting RecordBatch

batch - [out] the resulting RecordBatch

Returns:

Status

Flush

@ByVal
public Status Flush(@SharedPtr
                           RecordBatch batch)

\brief Finish current batch and reset

Parameters:

batch - [out] the resulting RecordBatch

Returns:

Status

SetInitialCapacity

public void SetInitialCapacity(@Cast(value="int64_t")
                               long _capacity)

\brief Set the initial capacity for new builders

initial_capacity

@Cast(value="int64_t")
public long initial_capacity()

\brief The initial capacity for builders

num_fields

public int num_fields()

\brief The number of fields in the schema

schema

@SharedPtr
 @ByVal
public Schema schema()

\brief The number of fields in the schema