org.bytedeco.arrow

Class MapArray

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

org.bytedeco.arrow.BaseListArray

org.bytedeco.arrow.ListArray

org.bytedeco.arrow.MapArray

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class MapArray
extends ListArray

Concrete Array class for map data NB: "value" in this context refers to a pair of a key and the corresponding item

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
MapArray(ArrayData data)
MapArray(DataType type, long length, ArrowBuffer value_offsets, Array values)
MapArray(DataType type, long length, ArrowBuffer value_offsets, Array keys, Array items)
MapArray(DataType type, long length, ArrowBuffer value_offsets, Array keys, Array items, ArrowBuffer null_bitmap, long null_count, long offset)
MapArray(DataType type, long length, ArrowBuffer value_offsets, Array values, ArrowBuffer null_bitmap, long null_count, long offset)
MapArray(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static ArrayResult	FromArrays(Array offsets, Array keys, Array items)
static ArrayResult	FromArrays(Array offsets, Array keys, Array items, MemoryPool pool) \brief Construct MapArray from array of offsets and child key, item arrays This function does the bare minimum of validation of the offsets and input types, and will allocate a new offsets array if necessary (i.e.
static ArrayResult	FromArrays(DataType type, Array offsets, Array keys, Array items)
static ArrayResult	FromArrays(DataType type, Array offsets, Array keys, Array items, MemoryPool pool)
Array	items() \brief Return array object containing all mapped items
Array	keys() \brief Return array object containing all map keys
MapType	map_type()
static Status	ValidateChildData(ArrayDataVector child_data) Validate child data before constructing the actual MapArray.

Methods inherited from class org.bytedeco.arrow.ListArray

Flatten, Flatten, FromArrays, FromArrays, offsets

Methods inherited from class org.bytedeco.arrow.BaseListArray

getPointer, list_type, position, raw_value_offsets, value_length, value_offset, value_offsets, value_slice, value_type, values

Methods inherited from class org.bytedeco.arrow.Array

Accept, ApproxEquals, ApproxEquals, data, Diff, Equals, Equals, GetScalar, IsNull, IsValid, length, null_bitmap_data, null_bitmap, null_count, num_fields, offset, RangeEquals, RangeEquals, RangeEquals, RangeEquals, Slice, Slice, SliceSafe, SliceSafe, ToString, type_id, type, Validate, ValidateFull, View

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, 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

MapArray

public MapArray(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

MapArray

public MapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                ArrayData data)

MapArray

public MapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                DataType type,
                @Cast(value="int64_t")
                long length,
                @SharedPtr
                ArrowBuffer value_offsets,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array keys,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array items,
                @SharedPtr
                ArrowBuffer null_bitmap,
                @Cast(value="int64_t")
                long null_count,
                @Cast(value="int64_t")
                long offset)

MapArray

public MapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                DataType type,
                @Cast(value="int64_t")
                long length,
                @SharedPtr
                ArrowBuffer value_offsets,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array keys,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array items)

MapArray

public MapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                DataType type,
                @Cast(value="int64_t")
                long length,
                @SharedPtr
                ArrowBuffer value_offsets,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array values,
                @SharedPtr
                ArrowBuffer null_bitmap,
                @Cast(value="int64_t")
                long null_count,
                @Cast(value="int64_t")
                long offset)

MapArray

public MapArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                DataType type,
                @Cast(value="int64_t")
                long length,
                @SharedPtr
                ArrowBuffer value_offsets,
                @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                Array values)

Method Detail

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array offsets,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array keys,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array items,
                                            MemoryPool pool)

\brief Construct MapArray from array of offsets and child key, item arrays This function does the bare minimum of validation of the offsets and input types, and will allocate a new offsets array if necessary (i.e. if the offsets contain any nulls). If the offsets do not have nulls, they are assumed to be well-formed

Parameters:

offsets - [in] Array containing n + 1 offsets encoding length and size. Must be of int32 type

keys - [in] Array containing key values

items - [in] Array containing item values

pool - [in] MemoryPool in case new offsets array needs to be allocated because of null values

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array offsets,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array keys,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array items)

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                            DataType type,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array offsets,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array keys,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array items,
                                            MemoryPool pool)

FromArrays

@ByVal
public static ArrayResult FromArrays(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                            DataType type,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array offsets,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array keys,
                                            @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array items)

map_type

@Const
public MapType map_type()

keys

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

\brief Return array object containing all map keys

items

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

\brief Return array object containing all mapped items

ValidateChildData

@ByVal
public static Status ValidateChildData(@Const @ByRef
                                              ArrayDataVector child_data)

Validate child data before constructing the actual MapArray.