org.bytedeco.arrow

Class ListArray

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

org.bytedeco.arrow.BaseListArray

org.bytedeco.arrow.ListArray

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MapArray

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

Concrete Array class for list data

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

Method Summary

Modifier and Type	Method and Description
ArrayResult	Flatten()
ArrayResult	Flatten(MemoryPool memory_pool) \brief Return an Array that is a concatenation of the lists in this array.
static ArrayResult	FromArrays(Array offsets, Array values)
static ArrayResult	FromArrays(Array offsets, Array values, MemoryPool pool) \brief Construct ListArray from array of offsets and child value array 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.
Array	offsets() \brief Return list offsets as an Int32Array

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, 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, 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

ListArray

public ListArray(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

ListArray

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

ListArray

public ListArray(@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)

ListArray

public ListArray(@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(@Const @ByRef
                                             Array offsets,
                                             @Const @ByRef
                                             Array values,
                                             MemoryPool pool)

\brief Construct ListArray from array of offsets and child value array 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

values - [in] Array containing list values

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

FromArrays

@ByVal
public static ArrayResult FromArrays(@Const @ByRef
                                             Array offsets,
                                             @Const @ByRef
                                             Array values)

Flatten

@ByVal
public ArrayResult Flatten(MemoryPool memory_pool)

\brief Return an Array that is a concatenation of the lists in this array. Note that it's different from values() in that it takes into consideration of this array's offsets as well as null elements backed by non-empty lists (they are skipped, thus copying may be needed).

Flatten

@ByVal
public ArrayResult Flatten()

offsets

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

\brief Return list offsets as an Int32Array