org.bytedeco.arrow

Class StructArray

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

org.bytedeco.arrow.StructArray

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class StructArray
extends Array

Concrete Array class for struct 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
StructArray(ArrayData data)
StructArray(DataType type, long length, ArrayVector children)
StructArray(DataType type, long length, ArrayVector children, ArrowBuffer null_bitmap, long null_count, long offset)
StructArray(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Array	field(int pos)
ArrayVector	fields()
ArrayVectorResult	Flatten()
ArrayVectorResult	Flatten(MemoryPool pool) \brief Flatten this array as a vector of arrays, one for each field
Array	GetFieldByName(BytePointer name)
Array	GetFieldByName(String name) Returns null if name not found
static StructArrayResult	Make(ArrayVector children, FieldVector fields)
static StructArrayResult	Make(ArrayVector children, FieldVector fields, ArrowBuffer null_bitmap, long null_count, long offset) \brief Return a StructArray from child arrays and fields.
static StructArrayResult	Make(ArrayVector children, StringVector field_names)
static StructArrayResult	Make(ArrayVector children, StringVector field_names, ArrowBuffer null_bitmap, long null_count, long offset) \brief Return a StructArray from child arrays and field names.
StructType	struct_type()

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

StructArray

public StructArray(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

StructArray

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

StructArray

public StructArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                   DataType type,
                   @Cast(value="int64_t")
                   long length,
                   @Const @ByRef
                   ArrayVector children,
                   @SharedPtr
                   ArrowBuffer null_bitmap,
                   @Cast(value="int64_t")
                   long null_count,
                   @Cast(value="int64_t")
                   long offset)

StructArray

public StructArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                   DataType type,
                   @Cast(value="int64_t")
                   long length,
                   @Const @ByRef
                   ArrayVector children)

Method Detail

Make

@ByVal
public static StructArrayResult Make(@Const @ByRef
                                             ArrayVector children,
                                             @Const @ByRef
                                             StringVector field_names,
                                             @SharedPtr
                                             ArrowBuffer null_bitmap,
                                             @Cast(value="int64_t")
                                             long null_count,
                                             @Cast(value="int64_t")
                                             long offset)

\brief Return a StructArray from child arrays and field names. The length and data type are automatically inferred from the arguments. There should be at least one child array.

Make

@ByVal
public static StructArrayResult Make(@Const @ByRef
                                             ArrayVector children,
                                             @Const @ByRef
                                             StringVector field_names)

Make

@ByVal
public static StructArrayResult Make(@Const @ByRef
                                             ArrayVector children,
                                             @Const @ByRef
                                             FieldVector fields,
                                             @SharedPtr
                                             ArrowBuffer null_bitmap,
                                             @Cast(value="int64_t")
                                             long null_count,
                                             @Cast(value="int64_t")
                                             long offset)

\brief Return a StructArray from child arrays and fields. The length is automatically inferred from the arguments. There should be at least one child array. This method does not check that field types and child array types are consistent.

Make

@ByVal
public static StructArrayResult Make(@Const @ByRef
                                             ArrayVector children,
                                             @Const @ByRef
                                             FieldVector fields)

struct_type

@Const
public StructType struct_type()

field

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

fields

@Const
 @ByRef
public ArrayVector fields()

GetFieldByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array GetFieldByName(@StdString
                                                                                            String name)

Returns null if name not found

GetFieldByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array GetFieldByName(@StdString
                                                                                            BytePointer name)

Flatten

@ByVal
public ArrayVectorResult Flatten(MemoryPool pool)

\brief Flatten this array as a vector of arrays, one for each field

Parameters:

pool - [in] The pool to allocate null bitmaps from, if necessary

Flatten

@ByVal
public ArrayVectorResult Flatten()