org.bytedeco.arrow

Class StructBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.StructBuilder

All Implemented Interfaces:

AutoCloseable

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

Append, Resize and Reserve methods are acting on StructBuilder. Please make sure all these methods of all child-builders' are consistently called to maintain data-structure consistency.

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
StructBuilder(DataType type, MemoryPool pool, ArrayBuilderVector field_builders) If any of field_builders has indeterminate type, this builder will also
StructBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append()
Status	Append(boolean is_valid) Append an element to the Struct.
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.
Status	AppendValues(long length, byte[] valid_bytes)
Status	AppendValues(long length, ByteBuffer valid_bytes)
Status	AppendValues(long length, BytePointer valid_bytes) Null bitmap is of equal length to every child field, and any zero byte will be considered as a null for that field, but users must using app- end methods or advance methods of the child builders' independently to insert data.
ArrayBuilder	field_builder(int i)
Status	Finish(StructArray out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
int	num_fields()
void	Reset() Reset the builder.
DataType	type() \brief Return the type of the built Array

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, child_builder, child, Finish, Finish, length, null_count, num_children, Reserve, 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, 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

StructBuilder

public StructBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

StructBuilder

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

If any of field_builders has indeterminate type, this builder will also

Method Detail

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
                            StructArray out)

\endcond

AppendValues

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

Null bitmap is of equal length to every child field, and any zero byte will be considered as a null for that field, but users must using app- end methods or advance methods of the child builders' independently to insert data.

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)

Append

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

Append an element to the Struct. All child-builders' Append method must be called independently to maintain data-structure consistency.

Append

@ByVal
public Status Append()

AppendNull

@ByVal
public Status AppendNull()

\brief Append a null value. Automatically appends an empty value to each child builder.

Overrides:

AppendNull in class ArrayBuilder

AppendNulls

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

\brief Append multiple null values. Automatically appends empty values to each child 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

Reset

public void Reset()

Description copied from class: ArrayBuilder

Reset the builder.

Overrides:

Reset in class ArrayBuilder

field_builder

public ArrayBuilder field_builder(int i)

num_fields

public int num_fields()

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