org.bytedeco.arrow

Class BaseListBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.BaseListBuilder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ListBuilder

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

Method Summary

Modifier and Type	Method and Description
Status	Append()
Status	Append(boolean is_valid) \brief Start a new variable-length list slot This function should be called before beginning to append elements to the value builder
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(int[] offsets, long length)
Status	AppendValues(int[] offsets, long length, byte[] valid_bytes)
Status	AppendValues(IntBuffer offsets, long length)
Status	AppendValues(IntBuffer offsets, long length, ByteBuffer valid_bytes)
Status	AppendValues(IntPointer offsets, long length)
Status	AppendValues(IntPointer offsets, long length, BytePointer valid_bytes) \brief Vector append If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
static long	maximum_elements()
void	Reset() Reset the builder.
Status	Resize(long _capacity) Use this constructor to incrementally build the value array along with offsets and null bitmap.
DataType	type() \brief Return the type of the built Array
Status	ValidateOverflow(long new_elements)
ArrayBuilder	value_builder()

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

BaseListBuilder

public BaseListBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Resize

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

Use this constructor to incrementally build the value array along with offsets and null bitmap.

Overrides:

Resize in class ArrayBuilder

Returns:

Status

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset in class ArrayBuilder

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  IntPointer offsets,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  BytePointer valid_bytes)

\brief Vector append If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  IntPointer offsets,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  IntBuffer offsets,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  ByteBuffer valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  IntBuffer offsets,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  int[] offsets,
                                  @Cast(value="int64_t")
                                  long length,
                                  @Cast(value="const uint8_t*")
                                  byte[] valid_bytes)

AppendValues

@ByVal
public Status AppendValues(@Cast(value="const arrow::BaseListBuilder<arrow::ListType>::offset_type*")
                                  int[] offsets,
                                  @Cast(value="int64_t")
                                  long length)

Append

@ByVal
public Status Append(@Cast(value="bool")
                            boolean is_valid)

\brief Start a new variable-length list slot This function should be called before beginning to append elements to the value builder

Append

@ByVal
public Status Append()

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

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

ValidateOverflow

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

value_builder

public ArrayBuilder value_builder()

maximum_elements

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

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