org.bytedeco.arrow

Class MapBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayBuilder

org.bytedeco.arrow.MapBuilder

All Implemented Interfaces:

AutoCloseable

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

\class MapBuilder \brief Builder class for arrays of variable-size maps To use this class, you must append values to the key and item array builders and use the Append function to delimit each distinct map (once the keys and items have been appended) or use the bulk API to append a sequence of offsets and null maps. Key uniqueness and ordering are not validated.

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
MapBuilder(MemoryPool pool, ArrayBuilder key_builder, ArrayBuilder item_builder)
MapBuilder(MemoryPool pool, ArrayBuilder key_builder, ArrayBuilder item_builder, boolean keys_sorted) Use this constructor to infer the built array's type.
MapBuilder(MemoryPool pool, ArrayBuilder key_builder, ArrayBuilder item_builder, DataType type) Use this constructor to define the built array's type explicitly.
MapBuilder(MemoryPool pool, ArrayBuilder item_builder, DataType type)
MapBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Append() \brief Start a new variable-length map slot This function should be called before beginning to append elements to the key and item builders
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	AppendValues(int[] offsets, long length)
Status	AppendValues(int[] offsets, long length, byte[] valid_bytes)
Status	AppendValues(IntBuffer offsets, long length)
Status	AppendValues(IntBuffer offsets, long length, ByteBuffer valid_bytes)
Status	AppendValues(IntPointer offsets, long length)
Status	AppendValues(IntPointer offsets, long length, BytePointer valid_bytes) \brief Vector append If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot
Status	Finish(MapArray out) \endcond
Status	FinishInternal(ArrayData out) \brief Return result of builder as an internal generic ArrayData object.
ArrayBuilder	item_builder() \brief Get builder to append items Appending an item with this builder should have been preceded by appending a key with key_builder().
ArrayBuilder	key_builder() \brief Get builder to append keys.
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() \brief Get builder to add Map entries as struct values.

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

MapBuilder

public MapBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

MapBuilder

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

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

MapBuilder

public MapBuilder(MemoryPool pool,
                  @Const @SharedPtr @ByRef
                  ArrayBuilder key_builder,
                  @Const @SharedPtr @ByRef
                  ArrayBuilder item_builder,
                  @Cast(value="bool")
                  boolean keys_sorted)

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

MapBuilder

public MapBuilder(MemoryPool pool,
                  @Const @SharedPtr @ByRef
                  ArrayBuilder key_builder,
                  @Const @SharedPtr @ByRef
                  ArrayBuilder item_builder)

MapBuilder

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

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

\endcond

AppendValues

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

\brief Vector append If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot

AppendValues

@ByVal
public Status AppendValues(@Const
                                  IntPointer offsets,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

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

AppendValues

@ByVal
public Status AppendValues(@Const
                                  IntBuffer offsets,
                                  @Cast(value="int64_t")
                                  long length)

AppendValues

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

AppendValues

@ByVal
public Status AppendValues(@Const
                                  int[] offsets,
                                  @Cast(value="int64_t")
                                  long length)

Append

@ByVal
public Status Append()

\brief Start a new variable-length map slot This function should be called before beginning to append elements to the key and item builders

AppendNull

@ByVal
public Status AppendNull()

Description copied from class: ArrayBuilder

\brief Append a null value to builder

Overrides:

AppendNull in class ArrayBuilder

AppendNulls

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

Description copied from class: ArrayBuilder

\brief Append a number of null values to 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

key_builder

public ArrayBuilder key_builder()

\brief Get builder to append keys. Append a key with this builder should be followed by appending an item or null value with item_builder().

item_builder

public ArrayBuilder item_builder()

\brief Get builder to append items Appending an item with this builder should have been preceded by appending a key with key_builder().

value_builder

public ArrayBuilder value_builder()

\brief Get builder to add Map entries as struct values. This is used instead of key_builder()/item_builder() and allows the Map to be built as a list of struct values.

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

ValidateOverflow

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