org.bytedeco.arrow

Class ArrayData

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ArrayData

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow")
 @NoOffset
 @Properties(inherit=arrow.class)
public class ArrayData
extends Pointer

\class ArrayData \brief Mutable container for generic Arrow array data This data structure is a self-contained representation of the memory and metadata inside an Arrow array data structure (called vectors in Java). The classes arrow::Array and its subclasses provide strongly-typed accessors with support for the visitor pattern and other affordances. This class is designed for easy internal data manipulation, analytical data processing, and data transport to and from IPC messages. For example, we could cast from int64 to float64 like so: Int64Array arr = GetMyData(); auto new_data = arr.data()->Copy(); new_data->type = arrow::float64(); DoubleArray double_arr(new_data); This object is also useful in an analytics setting where memory may be reused. For example, if we had a group of operations all returning doubles, say: Log(Sqrt(Expr(arr))) Then the low-level implementations of each of these functions could have the signatures void Log(const ArrayData& values, ArrayData* out); As another example a function may consume one or more memory buffers in an input array and replace them with newly-allocated data, changing the output data type as well.

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
ArrayData()
ArrayData(ArrayData other)
ArrayData(DataType type, long length)
ArrayData(DataType type, long length, BufferVector buffers)
ArrayData(DataType type, long length, BufferVector buffers, ArrayDataVector child_data)
ArrayData(DataType type, long length, BufferVector buffers, ArrayDataVector child_data, long null_count, long offset)
ArrayData(DataType type, long length, BufferVector buffers, long null_count, long offset)
ArrayData(DataType type, long length, long null_count, long offset)
ArrayData(long size) Native array allocator.
ArrayData(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
BufferVector	buffers()
ArrayData	buffers(BufferVector setter)
ArrayDataVector	child_data()
ArrayData	child_data(ArrayDataVector setter)
ArrayData	Copy()
ArrayData	dictionary()
ArrayData	dictionary(ArrayData setter)
long	GetNullCount() \brief Return null count, or compute and set it if it's not known
ArrayData	getPointer(long i)
BytePointer	GetValuesByte(int i)
BytePointer	GetValuesByte(int i, long absolute_offset)
DoublePointer	GetValuesDouble(int i)
DoublePointer	GetValuesDouble(int i, long absolute_offset)
FloatPointer	GetValuesFloat(int i)
FloatPointer	GetValuesFloat(int i, long absolute_offset)
IntPointer	GetValuesInt(int i)
IntPointer	GetValuesInt(int i, long absolute_offset)
LongPointer	GetValuesLong(int i)
LongPointer	GetValuesLong(int i, long absolute_offset)
ShortPointer	GetValuesShort(int i)
ShortPointer	GetValuesShort(int i, long absolute_offset)
long	length()
ArrayData	length(long setter)
static ArrayData	Make(DataType type, long length)
static ArrayData	Make(DataType type, long length, BufferVector buffers)
static ArrayData	Make(DataType type, long length, BufferVector buffers, ArrayDataVector child_data)
static ArrayData	Make(DataType type, long length, BufferVector buffers, ArrayDataVector child_data, ArrayData dictionary)
static ArrayData	Make(DataType type, long length, BufferVector buffers, ArrayDataVector child_data, ArrayData dictionary, long null_count, long offset)
static ArrayData	Make(DataType type, long length, BufferVector buffers, ArrayDataVector child_data, long null_count, long offset)
static ArrayData	Make(DataType type, long length, BufferVector buffers, long null_count, long offset)
static ArrayData	Make(DataType type, long length, long null_count, long offset)
boolean	MayHaveNulls()
long	offset()
ArrayData	offset(long setter)
ArrayData	position(long position)
ArrayData	put(ArrayData other)
void	SetNullCount(long v)
ArrayData	Slice(long offset, long length) \brief Construct a zero-copy slice of the data with the given offset and length
ArrayDataResult	SliceSafe(long offset, long length) \brief Input-checking variant of Slice An Invalid Status is returned if the requested slice falls out of bounds.
DataType	type()
ArrayData	type(DataType setter)

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

ArrayData

public ArrayData(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ArrayData

public ArrayData(long size)

Native array allocator. Access with Pointer.position(long).

ArrayData

public ArrayData()

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length,
                 @Cast(value="int64_t")
                 long null_count,
                 @Cast(value="int64_t")
                 long offset)

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length)

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length,
                 @ByVal
                 BufferVector buffers,
                 @Cast(value="int64_t")
                 long null_count,
                 @Cast(value="int64_t")
                 long offset)

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length,
                 @ByVal
                 BufferVector buffers)

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length,
                 @ByVal
                 BufferVector buffers,
                 @ByVal
                 ArrayDataVector child_data,
                 @Cast(value="int64_t")
                 long null_count,
                 @Cast(value="int64_t")
                 long offset)

ArrayData

public ArrayData(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="int64_t")
                 long length,
                 @ByVal
                 BufferVector buffers,
                 @ByVal
                 ArrayDataVector child_data)

ArrayData

public ArrayData(@ByRef(value=true)
                 ArrayData other)

Method Detail

position

public ArrayData position(long position)

Overrides:

position in class Pointer

getPointer

public ArrayData getPointer(long i)

Overrides:

getPointer in class Pointer

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long null_count,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long offset)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers,
                                                                                                 @ByVal
                                                                                                 ArrayDataVector child_data,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long null_count,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long offset)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers,
                                                                                                 @ByVal
                                                                                                 ArrayDataVector child_data)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers,
                                                                                                 @ByVal
                                                                                                 ArrayDataVector child_data,
                                                                                                 @SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                                                                                                 ArrayData dictionary,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long null_count,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long offset)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @ByVal
                                                                                                 BufferVector buffers,
                                                                                                 @ByVal
                                                                                                 ArrayDataVector child_data,
                                                                                                 @SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                                                                                                 ArrayData dictionary)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long null_count,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long offset)

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public static ArrayData Make(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                                                                                 DataType type,
                                                                                                 @Cast(value="int64_t")
                                                                                                 long length)

put

@ByRef
 @Name(value="operator =")
public ArrayData put(@ByRef(value=true)
                                                         ArrayData other)

Copy

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

GetValuesByte

@Const
 @Name(value="GetValues<jbyte>")
public BytePointer GetValuesByte(int i,
                                                                           @Cast(value="int64_t")
                                                                           long absolute_offset)

GetValuesShort

@Const
 @Name(value="GetValues<jshort>")
public ShortPointer GetValuesShort(int i,
                                                                              @Cast(value="int64_t")
                                                                              long absolute_offset)

GetValuesInt

@Const
 @Name(value="GetValues<jint>")
public IntPointer GetValuesInt(int i,
                                                                        @Cast(value="int64_t")
                                                                        long absolute_offset)

GetValuesLong

@Const
 @Name(value="GetValues<jlong>")
public LongPointer GetValuesLong(int i,
                                                                           @Cast(value="int64_t")
                                                                           long absolute_offset)

GetValuesFloat

@Const
 @Name(value="GetValues<float>")
public FloatPointer GetValuesFloat(int i,
                                                                             @Cast(value="int64_t")
                                                                             long absolute_offset)

GetValuesDouble

@Const
 @Name(value="GetValues<double>")
public DoublePointer GetValuesDouble(int i,
                                                                                @Cast(value="int64_t")
                                                                                long absolute_offset)

GetValuesByte

@Const
 @Name(value="GetValues<jbyte>")
public BytePointer GetValuesByte(int i)

GetValuesShort

@Const
 @Name(value="GetValues<jshort>")
public ShortPointer GetValuesShort(int i)

GetValuesInt

@Const
 @Name(value="GetValues<jint>")
public IntPointer GetValuesInt(int i)

GetValuesLong

@Const
 @Name(value="GetValues<jlong>")
public LongPointer GetValuesLong(int i)

GetValuesFloat

@Const
 @Name(value="GetValues<float>")
public FloatPointer GetValuesFloat(int i)

GetValuesDouble

@Const
 @Name(value="GetValues<double>")
public DoublePointer GetValuesDouble(int i)

Slice

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public ArrayData Slice(@Cast(value="int64_t")
                                                                                           long offset,
                                                                                           @Cast(value="int64_t")
                                                                                           long length)

\brief Construct a zero-copy slice of the data with the given offset and length

SliceSafe

@ByVal
public ArrayDataResult SliceSafe(@Cast(value="int64_t")
                                         long offset,
                                         @Cast(value="int64_t")
                                         long length)

\brief Input-checking variant of Slice An Invalid Status is returned if the requested slice falls out of bounds. Note that unlike Slice, length isn't clamped to the available buffer size.

SetNullCount

public void SetNullCount(@Cast(value="int64_t")
                         long v)

GetNullCount

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

\brief Return null count, or compute and set it if it's not known

MayHaveNulls

@Cast(value="bool")
public boolean MayHaveNulls()

type

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

type

public ArrayData type(DataType setter)

length

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

length

public ArrayData length(long setter)

offset

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

offset

public ArrayData offset(long setter)

buffers

@ByRef
public BufferVector buffers()

buffers

public ArrayData buffers(BufferVector setter)

child_data

@ByRef
public ArrayDataVector child_data()

child_data

public ArrayData child_data(ArrayDataVector setter)

dictionary

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

dictionary

public ArrayData dictionary(ArrayData setter)