org.bytedeco.arrow

Class Datum

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Datum

All Implemented Interfaces:

AutoCloseable

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

\class Datum \brief Variant type for various Arrow C++ data structures

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Datum.Empty
static class	Datum.Kind

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static long	kUnknownLength

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Datum() \brief Empty datum, to be populated elsewhere
Datum(Array value)
Datum(ArrayData value)
Datum(boolean value)
Datum(byte value)
Datum(BytePointer value)
Datum(ChunkedArray value)
Datum(Datum other)
Datum(DatumVector value)
Datum(double value)
Datum(float value)
Datum(int value)
Datum(long value)
Datum(Pointer p) Pointer cast constructor.
Datum(RecordBatch value)
Datum(Scalar value)
Datum(short value)
Datum(String value)
Datum(Table value)

Method Summary

Modifier and Type	Method and Description
ArrayData	array()
ChunkedArray	chunked_array()
ArrayVector	chunks() \brief The array chunks of the variant, if any
DatumVector	collection()
ValueDescr	descr() \brief Return the shape (array or scalar) and type for supported kinds (ARRAY, CHUNKED_ARRAY, and SCALAR).
boolean	equals(Datum other)
boolean	Equals(Datum other)
boolean	is_array()
boolean	is_arraylike()
boolean	is_collection()
boolean	is_scalar()
boolean	is_value() \brief True if Datum contains a scalar or array-like data
Datum.Kind	kind()
static long	kUnknownLength()
long	length() \brief The value length of the variant, if any
Array	make_array()
ArrayData	mutable_array()
boolean	notEquals(Datum other)
long	null_count()
Datum	put(Datum other)
RecordBatch	record_batch()
Scalar	scalar()
Schema	schema() \brief The schema of the variant, if any
ValueDescr.Shape	shape() \brief Return the shape (array or scalar) for supported kinds (ARRAY, CHUNKED_ARRAY, and SCALAR).
Table	table()
String	ToString()
DataType	type() \brief The value type of the variant, if any

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

Field Detail

kUnknownLength

public static final long kUnknownLength

Constructor Detail

Datum

public Datum(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Datum

public Datum()

\brief Empty datum, to be populated elsewhere

Datum

public Datum(@Const @ByRef
             Datum other)

Datum

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

Datum

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

Datum

public Datum(@Const @ByRef
             Array value)

Datum

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

Datum

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

Datum

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

Datum

public Datum(@ByVal
             DatumVector value)

Datum

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

Datum

public Datum(byte value)

Datum

public Datum(short value)

Datum

public Datum(int value)

Datum

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

Datum

public Datum(float value)

Datum

public Datum(double value)

Datum

public Datum(@StdString
             String value)

Datum

public Datum(@StdString
             BytePointer value)

Method Detail

kUnknownLength

@MemberGetter
 @Cast(value="const int64_t")
public static long kUnknownLength()

put

@ByRef
 @Name(value="operator =")
public Datum put(@Const @ByRef
                                                     Datum other)

kind

public Datum.Kind kind()

array

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

mutable_array

public ArrayData mutable_array()

make_array

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

chunked_array

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

record_batch

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

table

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

collection

@Const
 @ByRef
public DatumVector collection()

scalar

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

is_array

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

is_arraylike

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

is_scalar

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

is_value

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

\brief True if Datum contains a scalar or array-like data

is_collection

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

null_count

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

descr

@ByVal
public ValueDescr descr()

\brief Return the shape (array or scalar) and type for supported kinds (ARRAY, CHUNKED_ARRAY, and SCALAR). Debug asserts otherwise

shape

public ValueDescr.Shape shape()

\brief Return the shape (array or scalar) for supported kinds (ARRAY, CHUNKED_ARRAY, and SCALAR). Debug asserts otherwise

type

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

\brief The value type of the variant, if any

Returns:

nullptr if no type

schema

@SharedPtr
 @ByVal
public Schema schema()

\brief The schema of the variant, if any

Returns:

nullptr if no schema

length

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

\brief The value length of the variant, if any

Returns:

kUnknownLength if no type

chunks

@ByVal
public ArrayVector chunks()

\brief The array chunks of the variant, if any

Returns:

empty if not arraylike

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           Datum other)

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        Datum other)

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                           Datum other)

ToString

@StdString
public String ToString()