org.bytedeco.arrow

Class BaseBinaryBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.BaseBinaryBuilder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BinaryBuilder

@Name(value="arrow::BaseBinaryBuilder<arrow::BinaryType>")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BaseBinaryBuilder
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
BaseBinaryBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(byte[] value, int length)
Status	Append(ByteBuffer value, int length)
Status	Append(BytePointer value, int length)
Status	Append(String value, int length)
Status	AppendArraySlice(ArrayData array, long offset, long length) \brief Append a range of values from an array.
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[] values, long length)
Status	AppendValues(byte[] values, long length, byte[] valid_bytes)
Status	AppendValues(ByteBuffer values, long length)
Status	AppendValues(ByteBuffer values, long length, ByteBuffer valid_bytes)
Status	AppendValues(BytePointer values, long length)
Status	AppendValues(BytePointer values, long length, BytePointer valid_bytes)
Status	AppendValues(PointerPointer values, long length, BytePointer valid_bytes) \brief Append a sequence of nul-terminated strings in one shot.
Status	AppendValues(StringVector values)
Status	AppendValues(StringVector values, byte[] valid_bytes)
Status	AppendValues(StringVector values, ByteBuffer valid_bytes)
Status	AppendValues(StringVector values, BytePointer valid_bytes) \brief Append a sequence of strings in one shot.
Status	ExtendCurrent(byte[] value, int length)
Status	ExtendCurrent(ByteBuffer value, int length)
Status	ExtendCurrent(BytePointer value, int length) Extend the last appended value by appending more data at the end Unlike Append, this does not create a new offset.
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
byte[]	GetValue(long i, int[] out_length)
ByteBuffer	GetValue(long i, IntBuffer out_length)
BytePointer	GetValue(long i, IntPointer out_length) Temporary access to a value.
static long	memory_limit() Temporary access to a value.
int	offset(long i)
IntPointer	offsets_data()
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.
void	UnsafeAppend(byte[] value, int length)
void	UnsafeAppend(ByteBuffer value, int length)
void	UnsafeAppend(BytePointer value)
void	UnsafeAppend(BytePointer value, int length) \brief Append without checking capacity Offsets and data should have been presized using Reserve() and ReserveData(), respectively.
void	UnsafeAppend(String value)
void	UnsafeAppend(String value, int length)
void	UnsafeAppendEmptyValue()
void	UnsafeAppendNull()
void	UnsafeExtendCurrent(byte[] value, int length)
void	UnsafeExtendCurrent(ByteBuffer value, int length)
void	UnsafeExtendCurrent(BytePointer value, int length) Like ExtendCurrent, but do not check capacity
Status	ValidateOverflow(long new_bytes)
long	value_data_capacity()
long	value_data_length()
BytePointer	value_data()

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, AppendScalar, AppendScalar, AppendScalars, child_builder, child, Finish, Finish, length, null_count, num_children, put, Reserve, type

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, interruptDeallocatorThread, 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

BaseBinaryBuilder

public BaseBinaryBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                             BytePointer value,
                             @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                             int length)

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                             ByteBuffer value,
                             @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                             int length)

Append

@ByVal
public Status Append(@Cast(value="const uint8_t*")
                             byte[] value,
                             @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                             int length)

Append

@ByVal
public Status Append(String value,
                             @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                             int length)

ExtendCurrent

@ByVal
public Status ExtendCurrent(@Cast(value="const uint8_t*")
                                    BytePointer value,
                                    @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                    int length)

Extend the last appended value by appending more data at the end Unlike Append, this does not create a new offset.

ExtendCurrent

@ByVal
public Status ExtendCurrent(@Cast(value="const uint8_t*")
                                    ByteBuffer value,
                                    @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                    int length)

ExtendCurrent

@ByVal
public Status ExtendCurrent(@Cast(value="const uint8_t*")
                                    byte[] value,
                                    @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                    int length)

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

AppendNull

@ByVal
public Status AppendNull()

Description copied from class: ArrayBuilder

\brief Append a null value to builder

Overrides:

AppendNull 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,
                         @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                         int length)

\brief Append without checking capacity Offsets and data should have been presized using Reserve() and ReserveData(), respectively.

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t*")
                         ByteBuffer value,
                         @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                         int length)

UnsafeAppend

public void UnsafeAppend(@Cast(value="const uint8_t*")
                         byte[] value,
                         @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                         int length)

UnsafeAppend

public void UnsafeAppend(String value,
                         @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                         int length)

UnsafeAppend

public void UnsafeAppend(@StdString
                         String value)

UnsafeAppend

public void UnsafeAppend(@StdString
                         BytePointer value)

UnsafeExtendCurrent

public void UnsafeExtendCurrent(@Cast(value="const uint8_t*")
                                BytePointer value,
                                @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                int length)

Like ExtendCurrent, but do not check capacity

UnsafeExtendCurrent

public void UnsafeExtendCurrent(@Cast(value="const uint8_t*")
                                ByteBuffer value,
                                @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                int length)

UnsafeExtendCurrent

public void UnsafeExtendCurrent(@Cast(value="const uint8_t*")
                                byte[] value,
                                @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
                                int length)

UnsafeAppendNull

public void UnsafeAppendNull()

UnsafeAppendEmptyValue

public void UnsafeAppendEmptyValue()

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   StringVector values,
                                   @Cast(value="const uint8_t*")
                                   BytePointer valid_bytes)

\brief Append a sequence of strings in one shot.

Parameters:

values - [in] a vector of strings

valid_bytes - [in] an optional sequence of bytes where non-zero indicates a valid (non-null) value

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   StringVector values)

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   StringVector values,
                                   @Cast(value="const uint8_t*")
                                   ByteBuffer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Const @ByRef
                                   StringVector values,
                                   @Cast(value="const uint8_t*")
                                   byte[] valid_bytes)

AppendValues

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

\brief Append a sequence of nul-terminated strings in one shot. If one of the values is NULL, it is processed as a null value even if the corresponding valid_bytes entry is 1.

Parameters:

values - [in] a contiguous C array of nul-terminated char *

length - [in] the number of values to append

valid_bytes - [in] an optional sequence of bytes where non-zero indicates a valid (non-null) value

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const char**") @ByPtrPtr
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

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

AppendValues

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

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const char**") @ByPtrPtr
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

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

AppendValues

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

AppendArraySlice

@ByVal
public Status AppendArraySlice(@Const @ByRef
                                       ArrayData array,
                                       @Cast(value="int64_t")
                                       long offset,
                                       @Cast(value="int64_t")
                                       long length)

Description copied from class: ArrayBuilder

\brief Append a range of values from an array. The given array must be the same type as the builder.

Overrides:

AppendArraySlice in class ArrayBuilder

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset in class ArrayBuilder

ValidateOverflow

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

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

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

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

value_data

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

Returns:

data pointer of the value date builder

value_data_length

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

Returns:

size of values buffer so far

value_data_capacity

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

Returns:

capacity of values buffer

offsets_data

@Cast(value="const arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type*")
public IntPointer offsets_data()

Returns:

data pointer of the value date builder

GetValue

@Cast(value="const uint8_t*")
public BytePointer GetValue(@Cast(value="int64_t")
                                                           long i,
                                                           @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type*")
                                                           IntPointer out_length)

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

GetValue

@Cast(value="const uint8_t*")
public ByteBuffer GetValue(@Cast(value="int64_t")
                                                          long i,
                                                          @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type*")
                                                          IntBuffer out_length)

GetValue

@Cast(value="const uint8_t*")
public byte[] GetValue(@Cast(value="int64_t")
                                                      long i,
                                                      @Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type*")
                                                      int[] out_length)

offset

@Cast(value="arrow::BaseBinaryBuilder<arrow::BinaryType>::offset_type")
public int offset(@Cast(value="int64_t")
                                                                                           long i)

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.