org.bytedeco.arrow

Class FixedSizeBinaryBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.FixedSizeBinaryBuilder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Decimal128Builder, Decimal256Builder

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class FixedSizeBinaryBuilder
extends ArrayBuilder

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
FixedSizeBinaryBuilder(DataType type)
FixedSizeBinaryBuilder(DataType type, MemoryPool pool)
FixedSizeBinaryBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(byte[] value)
Status	Append(ByteBuffer value)
Status	Append(BytePointer value)
Status	Append(String value)
Status	AppendEmptyValue() \brief Append a non-null value to builder The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized.
Status	AppendEmptyValues(long length) \brief Append a number of non-null values to builder The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized.
Status	AppendNull() \brief Append a null value to builder
Status	AppendNulls(long length) \brief Append a number of null values to builder
Status	AppendValues(byte[] data, long length)
Status	AppendValues(byte[] data, long length, byte[] valid_bytes)
Status	AppendValues(ByteBuffer data, long length)
Status	AppendValues(ByteBuffer data, long length, ByteBuffer valid_bytes)
Status	AppendValues(BytePointer data, long length)
Status	AppendValues(BytePointer data, long length, BytePointer valid_bytes)
int	byte_width()
Status	Finish(FixedSizeBinaryArray out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
BytePointer	GetValue(long i) Temporary access to a value.
static long	memory_limit() Temporary access to a value.
Status	ReserveData(long elements) \brief Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations
void	Reset() Reset the builder.
Status	Resize(long _capacity) \brief Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended.
DataType	type() \brief Return the type of the built Array
void	UnsafeAppend(byte[] value)
void	UnsafeAppend(ByteBuffer value)
void	UnsafeAppend(BytePointer value)
void	UnsafeAppend(String value)
void	UnsafeAppendNull()
Status	ValidateOverflow(long new_bytes)
long	value_data_length()

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, child_builder, child, Finish, Finish, length, null_count, num_children, Reserve

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

FixedSizeBinaryBuilder

public FixedSizeBinaryBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FixedSizeBinaryBuilder

public FixedSizeBinaryBuilder(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                              DataType type,
                              MemoryPool pool)

FixedSizeBinaryBuilder

public FixedSizeBinaryBuilder(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                              DataType type)

Method Detail

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                            BytePointer value)

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                            ByteBuffer value)

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                            byte[] value)

Append

@ByVal
public Status Append(String value)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  BytePointer data,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  BytePointer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  BytePointer data,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  ByteBuffer data,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  ByteBuffer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  ByteBuffer data,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  byte[] data,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  byte[] valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const uint8_t*")
                                  byte[] data,
                                  @Cast(value="int64_t")
                                  long length)

AppendNull

@ByVal
public Status AppendNull()

Description copied from class: ArrayBuilder

\brief Append a null value to builder

Overrides:

AppendNull in class ArrayBuilder

AppendNulls

@ByVal
public Status AppendNulls(@Cast(value="int64_t")
                                 long length)

Description copied from class: ArrayBuilder

\brief Append a number of null values to builder

Overrides:

AppendNulls in class ArrayBuilder

AppendEmptyValue

@ByVal
public Status AppendEmptyValue()

Description copied from class: ArrayBuilder

\brief Append a non-null value to builder The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type.

Overrides:

AppendEmptyValue in class ArrayBuilder

AppendEmptyValues

@ByVal
public Status AppendEmptyValues(@Cast(value="int64_t")
                                       long length)

Description copied from class: ArrayBuilder

\brief Append a number of non-null values to builder The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type.

Overrides:

AppendEmptyValues in class ArrayBuilder

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t*")
                         BytePointer value)

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t*")
                         ByteBuffer value)

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t*")
                         byte[] value)

UnsafeAppend

public void UnsafeAppend(String value)

UnsafeAppendNull

public void UnsafeAppendNull()

ValidateOverflow

@ByVal
public Status ValidateOverflow(@Cast(value="int64_t")
                                      long new_bytes)

ReserveData

@ByVal
public Status ReserveData(@Cast(value="int64_t")
                                 long elements)

\brief Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset in class ArrayBuilder

Resize

@ByVal
public Status Resize(@Cast(value="int64_t")
                            long _capacity)

Description copied from class: ArrayBuilder

\brief Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.

Overrides:

Resize in class ArrayBuilder

Returns:

Status

FinishInternal

@ByVal
public Status FinishInternal(@SharedPtr
                                    ArrayData out)

Description copied from class: ArrayBuilder

\brief Return result of builder as an internal generic ArrayData object. Resets builder except for dictionary builder

Overrides:

FinishInternal in class ArrayBuilder

Parameters:

out - [out] the finalized ArrayData object

Returns:

Status

Finish

@ByVal
public Status Finish(@SharedPtr
                            FixedSizeBinaryArray out)

\endcond

value_data_length

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

Returns:

size of values buffer so far

byte_width

public int byte_width()

GetValue

@Cast(value="const uint8_t*")
public BytePointer GetValue(@Cast(value="int64_t")
                                                          long i)

Temporary access to a value. This pointer becomes invalid on the next modifying operation.

memory_limit

@Cast(value="const int64_t")
public static long memory_limit()

Temporary access to a value. This view becomes invalid on the next modifying operation.

type

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::DataType>"})
public DataType type()

Description copied from class: ArrayBuilder

\brief Return the type of the built Array

Overrides:

type in class ArrayBuilder