org.bytedeco.arrow

Class FixedSizeListBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.FixedSizeListBuilder

All Implemented Interfaces:

AutoCloseable

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

\class FixedSizeListBuilder \brief Builder class for fixed-length list array value types

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
FixedSizeListBuilder(MemoryPool pool, ArrayBuilder value_builder, DataType type) Use this constructor to infer the built array's type.
FixedSizeListBuilder(MemoryPool pool, ArrayBuilder value_builder, int list_size) Use this constructor to define the built array's type explicitly.
FixedSizeListBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append() \brief Append a valid fixed length list.
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 fixed length list.
Status	AppendNulls(long length) \brief Append length null fixed length lists.
Status	AppendValues(long length)
Status	AppendValues(long length, byte[] valid_bytes)
Status	AppendValues(long length, ByteBuffer valid_bytes)
Status	AppendValues(long length, BytePointer valid_bytes) \brief Vector append If passed, valid_bytes wil be read and any zero byte will cause the corresponding slot to be null This function affects only the validity bitmap; the child values must be appended using the child array builder.
Status	Finish(FixedSizeListArray out) \endcond
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) \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
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

FixedSizeListBuilder

public FixedSizeListBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

FixedSizeListBuilder

public FixedSizeListBuilder(MemoryPool pool,
                            @Const @SharedPtr @ByRef
                            ArrayBuilder value_builder,
                            int list_size)

Use this constructor to define the built array's type explicitly. If value_builder has indeterminate type, this builder will also.

FixedSizeListBuilder

public FixedSizeListBuilder(MemoryPool pool,
                            @Const @SharedPtr @ByRef
                            ArrayBuilder value_builder,
                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                            DataType type)

Use this constructor to infer the built array's type. If value_builder has indeterminate type, this builder will also.

Method Detail

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

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset 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

Finish

@ByVal
public Status Finish(@SharedPtr
                            FixedSizeListArray out)

\endcond

Append

@ByVal
public Status Append()

\brief Append a valid fixed length list. This function affects only the validity bitmap; the child values must be appended using the child array builder.

AppendValues

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

\brief Vector append If passed, valid_bytes wil be read and any zero byte will cause the corresponding slot to be null This function affects only the validity bitmap; the child values must be appended using the child array builder. This includes appending nulls for null lists. XXX this restriction is confusing, should this method be omitted?

AppendValues

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

AppendValues

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

AppendValues

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

AppendNull

@ByVal
public Status AppendNull()

\brief Append a null fixed length list. The child array builder will have the appropriate number of nulls appended automatically.

Overrides:

AppendNull in class ArrayBuilder

AppendNulls

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

\brief Append length null fixed length lists. The child array builder will have the appropriate number of nulls appended automatically.

Overrides:

AppendNulls in class ArrayBuilder

ValidateOverflow

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

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

value_builder

public ArrayBuilder value_builder()

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

maximum_elements

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