org.bytedeco.arrow

Class ArrayBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BaseBinaryBuilder, BaseLargeBinaryBuilder, BaseLargeListBuilder, BaseListBuilder, BasicUnionBuilder, BooleanBuilder, DayTimeIntervalBuilder, DoubleBuilder, FixedSizeBinaryBuilder, FixedSizeListBuilder, FloatBuilder, HalfFloatBuilder, Int16Builder, Int32Builder, Int64Builder, Int8Builder, MapBuilder, MonthDayNanoIntervalBuilder, NullBuilder, StructBuilder, UInt16Builder, UInt32Builder, UInt64Builder, UInt8Builder

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

Base class for all data array builders. This class provides a facilities for incrementally building the null bitmap (see Append methods) and as a side effect the current number of slots and the null count. \note Users are expected to use builders as one of the concrete types below. For example, ArrayBuilder* pointing to BinaryBuilder should be downcast before use.

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
ArrayBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
long	_capacity()
Status	Advance(long elements) Deprecated.
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	AppendScalar(Scalar scalar) \brief Append a value from a scalar
Status	AppendScalar(Scalar scalar, long n_repeats)
Status	AppendScalars(ScalarVector scalars)
ArrayBuilder	child_builder(int i)
ArrayBuilder	child(int i) For nested types.
ArrayResult	Finish() \brief Return result of builder as an Array object.
Status	Finish(Array out) \brief Return result of builder as an Array object.
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
long	length()
long	null_count()
int	num_children()
ArrayBuilder	put(ArrayBuilder arg0)
Status	Reserve(long additional_capacity) \brief Ensure that there is enough space allocated to append the indicated number of elements without any further reallocation.
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

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

ArrayBuilder

public ArrayBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

put

@ByRef
 @Name(value="operator =")
public ArrayBuilder put(@ByRef(value=true)
                                                            ArrayBuilder arg0)

child

public ArrayBuilder child(int i)

For nested types. Since the objects are owned by this class instance, we skip shared pointers and just return a raw pointer

child_builder

@Const
 @SharedPtr
 @ByRef
public ArrayBuilder child_builder(int i)

num_children

public int num_children()

length

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

null_count

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

_capacity

@Cast(value="int64_t")
 @Name(value="capacity")
public long _capacity()

Resize

@ByVal
public Status Resize(@Cast(value="int64_t")
                             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. 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.

Parameters:

capacity - [in] the minimum number of total array values to accommodate. Must be greater than the current capacity.

Returns:

Status

Reserve

@ByVal
public Status Reserve(@Cast(value="int64_t")
                              long additional_capacity)

\brief Ensure that there is enough space allocated to append the indicated number of elements without any further reallocation. Overallocation is used in order to minimize the impact of incremental Reserve() calls. Note that additional_capacity is relative to the current number of elements rather than to the current capacity, so calls to Reserve() which are not interspersed with addition of new elements may not increase the capacity.

Parameters:

additional_capacity - [in] the number of additional array values

Returns:

Status

Reset

public void Reset()

Reset the builder.

AppendNull

@ByVal
public Status AppendNull()

\brief Append a null value to builder

AppendNulls

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

\brief Append a number of null values to builder

AppendEmptyValue

@ByVal
public 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. This method is useful when appending a null value to a parent nested type.

AppendEmptyValues

@ByVal
public Status AppendEmptyValues(@Cast(value="int64_t")
                                        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. This method is useful when appending null values to a parent nested type.

AppendScalar

@ByVal
public Status AppendScalar(@Const @ByRef
                                   Scalar scalar)

\brief Append a value from a scalar

AppendScalar

@ByVal
public Status AppendScalar(@Const @ByRef
                                   Scalar scalar,
                                   @Cast(value="int64_t")
                                   long n_repeats)

AppendScalars

@ByVal
public Status AppendScalars(@Const @ByRef
                                    ScalarVector scalars)

AppendArraySlice

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

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

Advance

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

Deprecated.

For cases where raw data was memcpy'd into the internal buffers, allows us to advance the length of the builder. It is your responsibility to use this function responsibly.

FinishInternal

@ByVal
public Status FinishInternal(@SharedPtr
                                     ArrayData out)

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

Parameters:

out - [out] the finalized ArrayData object

Returns:

Status

Finish

@ByVal
public Status Finish(@SharedPtr
                             Array out)

\brief Return result of builder as an Array object. The builder is reset except for DictionaryBuilder.

Parameters:

out - [out] the finalized Array object

Returns:

Status

Finish

@ByVal
public ArrayResult Finish()

\brief Return result of builder as an Array object. The builder is reset except for DictionaryBuilder.

Returns:

The finalized Array object

type

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

\brief Return the type of the built Array