org.bytedeco.arrow

Class SparseUnionBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.BasicUnionBuilder

org.bytedeco.arrow.SparseUnionBuilder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class SparseUnionBuilder
extends BasicUnionBuilder

\class SparseUnionBuilder This API is EXPERIMENTAL.

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
SparseUnionBuilder(MemoryPool pool) Use this constructor to initialize the UnionBuilder with no child builders, allowing type to be inferred.
SparseUnionBuilder(MemoryPool pool, ArrayBuilderVector children, DataType type) Use this constructor to specify the type explicitly.
SparseUnionBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append(byte next_type) \brief Append an element to the UnionArray.
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.
Status	AppendNulls(long length) \brief Append multiple null values.

Methods inherited from class org.bytedeco.arrow.BasicUnionBuilder

AppendChild, AppendChild, AppendChild, Finish, FinishInternal, length, type

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, AppendScalar, AppendScalar, AppendScalars, child_builder, child, Finish, Finish, null_count, num_children, put, Reserve, Reset, Resize

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

SparseUnionBuilder

public SparseUnionBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

SparseUnionBuilder

public SparseUnionBuilder(MemoryPool pool)

Use this constructor to initialize the UnionBuilder with no child builders, allowing type to be inferred. You will need to call AppendChild for each of the children builders you want to use.

SparseUnionBuilder

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

Use this constructor to specify the type explicitly. You can still add child builders to the union after using this constructor

Method Detail

AppendNull

@ByVal
public Status AppendNull()

\brief Append a null value. A null is appended to the first child, empty values to the other children.

Overrides:

AppendNull in class ArrayBuilder

AppendNulls

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

\brief Append multiple null values. Nulls are appended to the first child, empty values to the other children.

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

Append

@ByVal
public Status Append(byte next_type)

\brief Append an element to the UnionArray. This must be followed by an append to the appropriate child builder.

Parameters:

next_type - [in] type_id of the child to which the next value will be appended. The corresponding child builder must be appended to independently after this method is called, and all other child builders must have null or empty value appended.

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