org.bytedeco.arrow

Class UInt8Builder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.UInt8Builder

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::NumericBuilder<arrow::UInt8Type>")
 @NoOffset
 @Properties(inherit=arrow.class)
public class UInt8Builder
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
UInt8Builder(DataType type, MemoryPool pool)
UInt8Builder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(byte val) Append a single scalar and increase the size if necessary.
Status	AppendArraySlice(ArrayData array, long offset, long length) \brief Append a sequence of elements in one shot, with a specified nullmap
Status	AppendEmptyValue() \brief Append a empty element
Status	AppendEmptyValues(long length) \brief Append several empty elements
Status	AppendNull() \brief Append a single null element
Status	AppendNulls(long length) Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory The memory at the corresponding data slot is set to 0 to prevent uninitialized memory access
Status	AppendValues(byte[] values)
Status	AppendValues(byte[] values, BoolVector is_valid)
Status	AppendValues(byte[] values, long length)
Status	AppendValues(byte[] values, long length, BoolVector is_valid)
Status	AppendValues(byte[] values, long length, byte[] valid_bytes)
Status	AppendValues(byte[] values, long length, byte[] bitmap, long bitmap_offset)
Status	AppendValues(ByteBuffer values)
Status	AppendValues(ByteBuffer values, BoolVector is_valid)
Status	AppendValues(ByteBuffer values, long length)
Status	AppendValues(ByteBuffer values, long length, BoolVector is_valid)
Status	AppendValues(ByteBuffer values, long length, ByteBuffer valid_bytes)
Status	AppendValues(ByteBuffer values, long length, ByteBuffer bitmap, long bitmap_offset)
Status	AppendValues(BytePointer values) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, BoolVector is_valid) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, long length)
Status	AppendValues(BytePointer values, long length, BoolVector is_valid) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, long length, BytePointer valid_bytes) \brief Append a sequence of elements in one shot
Status	AppendValues(BytePointer values, long length, BytePointer bitmap, long bitmap_offset) \brief Append a sequence of elements in one shot
Status	Finish(byte[] out)
Status	Finish(ByteBuffer out)
Status	Finish(BytePointer out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
BytePointer	get(long index)
byte	GetValue(long index)
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 val) Append a single scalar under the assumption that the underlying Buffer is large enough.
void	UnsafeAppendNull()

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

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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

UInt8Builder

public UInt8Builder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

UInt8Builder

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

Method Detail

Append

@ByVal
public Status Append(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type")
                             byte val)

Append a single scalar and increase the size if necessary.

AppendNulls

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

Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory The memory at the corresponding data slot is set to 0 to prevent uninitialized memory access

Overrides:

AppendNulls in class ArrayBuilder

AppendNull

@ByVal
public Status AppendNull()

\brief Append a single null element

Overrides:

AppendNull in class ArrayBuilder

AppendEmptyValue

@ByVal
public Status AppendEmptyValue()

\brief Append a empty element

Overrides:

AppendEmptyValue in class ArrayBuilder

AppendEmptyValues

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

\brief Append several empty elements

Overrides:

AppendEmptyValues in class ArrayBuilder

GetValue

@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type")
public byte GetValue(@Cast(value="int64_t")
                                                                                         long index)

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

get

@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
 @ByRef
 @Name(value="operator []")
public BytePointer get(@Cast(value="int64_t")
                                                                                                                                  long index)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   BytePointer valid_bytes)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a contiguous C array of values

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 arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   ByteBuffer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   byte[] valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   BytePointer bitmap,
                                   @Cast(value="int64_t")
                                   long bitmap_offset)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a contiguous C array of values

length - [in] the number of values to append

bitmap - [in] a validity bitmap to copy (may be null)

bitmap_offset - [in] an offset into the validity bitmap

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   ByteBuffer bitmap,
                                   @Cast(value="int64_t")
                                   long bitmap_offset)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Cast(value="const uint8_t*")
                                   byte[] bitmap,
                                   @Cast(value="int64_t")
                                   long bitmap_offset)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   BytePointer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a contiguous C array of values

length - [in] the number of values to append

is_valid - [in] an std::vector indicating valid (1) or null (0). Equal in length to values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   ByteBuffer values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type*")
                                   byte[] values,
                                   @Cast(value="int64_t")
                                   long length,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   BytePointer values,
                                   @Const @ByRef
                                   BoolVector is_valid)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a std::vector of values

is_valid - [in] an std::vector indicating valid (1) or null (0). Equal in length to values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   ByteBuffer values,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   byte[] values,
                                   @Const @ByRef
                                   BoolVector is_valid)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   BytePointer values)

\brief Append a sequence of elements in one shot

Parameters:

values - [in] a std::vector of values

Returns:

Status

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   ByteBuffer values)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::value_type*") @StdVector
                                   byte[] values)

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(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::ArrayType*") @SharedPtr
                             BytePointer out)

\endcond

Finish

@ByVal
public Status Finish(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::ArrayType*") @SharedPtr
                             ByteBuffer out)

Finish

@ByVal
public Status Finish(@Cast(value="arrow::NumericBuilder<arrow::UInt8Type>::ArrayType*") @SharedPtr
                             byte[] out)

AppendArraySlice

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

\brief Append a sequence of elements in one shot, with a specified nullmap

Overrides:

AppendArraySlice in class ArrayBuilder

Parameters:

values_begin - [in] InputIterator to the beginning of the values

values_end - [in] InputIterator pointing to the end of the values

valid_begin - [in] InputIterator with elements indication valid(1) or null(0) values.

Returns:

Status

UnsafeAppend

public void UnsafeAppend(@Cast(value="const arrow::NumericBuilder<arrow::UInt8Type>::value_type")
                         byte val)

Append a single scalar under the assumption that the underlying Buffer is large enough. This method does not capacity-check; make sure to call Reserve beforehand.

UnsafeAppendNull

public void UnsafeAppendNull()

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