org.bytedeco.arrow

Class BasicUnionBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.BasicUnionBuilder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DenseUnionBuilder, SparseUnionBuilder

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

\brief Base class for union array builds. Note that while we subclass ArrayBuilder, as union types do not have a validity bitmap, the bitmap builder member of ArrayBuilder is not used.

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

Method Summary

Modifier and Type	Method and Description
byte	AppendChild(ArrayBuilder new_child)
byte	AppendChild(ArrayBuilder new_child, BytePointer field_name)
byte	AppendChild(ArrayBuilder new_child, String field_name) \brief Make a new child builder available to the UnionArray
Status	Finish(UnionArray out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
long	length()
DataType	type() \brief Return the type of the built Array

Methods inherited from class org.bytedeco.arrow.ArrayBuilder

_capacity, Advance, AppendEmptyValue, AppendEmptyValues, AppendNull, AppendNulls, child_builder, child, Finish, Finish, null_count, num_children, 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, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, 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

BasicUnionBuilder

public BasicUnionBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

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

\endcond

AppendChild

public byte AppendChild(@Const @SharedPtr @ByRef
                        ArrayBuilder new_child,
                        @StdString
                        String field_name)

\brief Make a new child builder available to the UnionArray

Parameters:

new_child - [in] the child builder

field_name - [in] the name of the field in the union array type if type inference is used

Returns:

child index, which is the "type" argument that needs to be passed to the "Append" method to add a new element to the union array.

AppendChild

public byte AppendChild(@Const @SharedPtr @ByRef
                        ArrayBuilder new_child)

AppendChild

public byte AppendChild(@Const @SharedPtr @ByRef
                        ArrayBuilder new_child,
                        @StdString
                        BytePointer field_name)

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

length

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

Overrides:

length in class ArrayBuilder