org.bytedeco.arrow

Class UnionArray

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Array

org.bytedeco.arrow.UnionArray

All Implemented Interfaces:

AutoCloseable

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

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

Method Summary

Modifier and Type	Method and Description
int	child_id(long i) The physical child id containing value at index.
Array	child(int pos)
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, Array out) \brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, byte[] type_codes, Array out)
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, ByteBuffer type_codes, Array out)
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, BytePointer type_codes, Array out) \brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, StringVector field_names, Array out) \brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, StringVector field_names, byte[] type_codes, Array out)
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, StringVector field_names, ByteBuffer type_codes, Array out)
static Status	MakeDense(Array type_ids, Array value_offsets, ArrayVector children, StringVector field_names, BytePointer type_codes, Array out) \brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeSparse(Array type_ids, ArrayVector children, Array out) \brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeSparse(Array type_ids, ArrayVector children, byte[] type_codes, Array out)
static Status	MakeSparse(Array type_ids, ArrayVector children, ByteBuffer type_codes, Array out)
static Status	MakeSparse(Array type_ids, ArrayVector children, BytePointer type_codes, Array out) \brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeSparse(Array type_ids, ArrayVector children, StringVector field_names, Array out) \brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.
static Status	MakeSparse(Array type_ids, ArrayVector children, StringVector field_names, byte[] type_codes, Array out)
static Status	MakeSparse(Array type_ids, ArrayVector children, StringVector field_names, ByteBuffer type_codes, Array out)
static Status	MakeSparse(Array type_ids, ArrayVector children, StringVector field_names, BytePointer type_codes, Array out) \brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.
UnionMode.type	mode()
BytePointer	raw_type_codes()
BytePointer	raw_type_ids() Deprecated.
IntPointer	raw_value_offsets() For dense arrays only.
ArrowBuffer	type_codes() Note that this buffer does not account for any slice offset
ArrowBuffer	type_ids() Deprecated.
UnionType	union_type()
int	value_offset(long i) For dense arrays only.
ArrowBuffer	value_offsets() For dense arrays only.

Methods inherited from class org.bytedeco.arrow.Array

Accept, ApproxEquals, ApproxEquals, data, Diff, Equals, Equals, IsNull, IsValid, length, null_bitmap_data, null_bitmap, null_count, num_fields, offset, RangeEquals, RangeEquals, Slice, Slice, 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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnionArray

public UnionArray(Pointer p)

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

UnionArray

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

UnionArray

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

UnionArray

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

Method Detail

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Const @ByRef
                                      StringVector field_names,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      BytePointer type_codes,
                                      @SharedPtr
                                      Array out)

\brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types. The value_offsets are assumed to be well-formed.

Parameters:

type_ids - [in] An array of logical type ids for the union type

value_offsets - [in] An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing.

children - [in] Vector of children Arrays containing the data for each type.

field_names - [in] Vector of strings containing the name of each field.

type_codes - [in] Vector of type codes.

out - [out] Will have length equal to value_offsets.length()

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Const @ByRef
                                      StringVector field_names,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      ByteBuffer type_codes,
                                      @SharedPtr
                                      Array out)

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Const @ByRef
                                      StringVector field_names,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      byte[] type_codes,
                                      @SharedPtr
                                      Array out)

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Const @ByRef
                                      StringVector field_names,
                                      @SharedPtr
                                      Array out)

\brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types. The value_offsets are assumed to be well-formed.

Parameters:

type_ids - [in] An array of logical type ids for the union type

value_offsets - [in] An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing.

children - [in] Vector of children Arrays containing the data for each type.

field_names - [in] Vector of strings containing the name of each field.

out - [out] Will have length equal to value_offsets.length()

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      BytePointer type_codes,
                                      @SharedPtr
                                      Array out)

\brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types. The value_offsets are assumed to be well-formed.

Parameters:

type_ids - [in] An array of logical type ids for the union type

value_offsets - [in] An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing.

children - [in] Vector of children Arrays containing the data for each type.

type_codes - [in] Vector of type codes.

out - [out] Will have length equal to value_offsets.length()

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      ByteBuffer type_codes,
                                      @SharedPtr
                                      Array out)

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                      byte[] type_codes,
                                      @SharedPtr
                                      Array out)

MakeDense

@ByVal
public static Status MakeDense(@Const @ByRef
                                      Array type_ids,
                                      @Const @ByRef
                                      Array value_offsets,
                                      @Const @ByRef
                                      ArrayVector children,
                                      @SharedPtr
                                      Array out)

\brief Construct Dense UnionArray from types_ids, value_offsets and children This function does the bare minimum of validation of the offsets and input types. The value_offsets are assumed to be well-formed. The name of each field is filled by the index of the field.

Parameters:

type_ids - [in] An array of logical type ids for the union type

value_offsets - [in] An array of signed int32 values indicating the relative offset into the respective child array for the type in a given slot. The respective offsets for each child value array must be in order / increasing.

children - [in] Vector of children Arrays containing the data for each type.

out - [out] Will have length equal to value_offsets.length()

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Const @ByRef
                                       StringVector field_names,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       BytePointer type_codes,
                                       @SharedPtr
                                       Array out)

\brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.

Parameters:

type_ids - [in] An array of logical type ids for the union type

children - [in] Vector of children Arrays containing the data for each type.

field_names - [in] Vector of strings containing the name of each field.

type_codes - [in] Vector of type codes.

out - [out] Will have length equal to type_ids.length()

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Const @ByRef
                                       StringVector field_names,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       ByteBuffer type_codes,
                                       @SharedPtr
                                       Array out)

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Const @ByRef
                                       StringVector field_names,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       byte[] type_codes,
                                       @SharedPtr
                                       Array out)

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Const @ByRef
                                       StringVector field_names,
                                       @SharedPtr
                                       Array out)

\brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.

Parameters:

type_ids - [in] An array of logical type ids for the union type

children - [in] Vector of children Arrays containing the data for each type.

field_names - [in] Vector of strings containing the name of each field.

out - [out] Will have length equal to type_ids.length()

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       BytePointer type_codes,
                                       @SharedPtr
                                       Array out)

\brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types.

Parameters:

type_ids - [in] An array of logical type ids for the union type

children - [in] Vector of children Arrays containing the data for each type.

type_codes - [in] Vector of type codes.

out - [out] Will have length equal to type_ids.length()

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       ByteBuffer type_codes,
                                       @SharedPtr
                                       Array out)

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @Cast(value="arrow::UnionArray::type_code_t*") @StdVector
                                       byte[] type_codes,
                                       @SharedPtr
                                       Array out)

MakeSparse

@ByVal
public static Status MakeSparse(@Const @ByRef
                                       Array type_ids,
                                       @Const @ByRef
                                       ArrayVector children,
                                       @SharedPtr
                                       Array out)

\brief Construct Sparse UnionArray from type_ids and children This function does the bare minimum of validation of the offsets and input types. The name of each field is filled by the index of the field.

Parameters:

type_ids - [in] An array of logical type ids for the union type

children - [in] Vector of children Arrays containing the data for each type.

out - [out] Will have length equal to type_ids.length()

type_codes

@SharedPtr
public ArrowBuffer type_codes()

Note that this buffer does not account for any slice offset

raw_type_codes

@Cast(value="const arrow::UnionArray::type_code_t*")
public BytePointer raw_type_codes()

type_ids

@Deprecated
 @SharedPtr
public ArrowBuffer type_ids()

Deprecated.

raw_type_ids

@Cast(value="const arrow::UnionArray::type_code_t*")
 @Deprecated
public BytePointer raw_type_ids()

Deprecated.

child_id

public int child_id(@Cast(value="int64_t")
                    long i)

The physical child id containing value at index.

value_offsets

@SharedPtr
public ArrowBuffer value_offsets()

For dense arrays only. Note that this buffer does not account for any slice offset

value_offset

public int value_offset(@Cast(value="int64_t")
                        long i)

For dense arrays only.

raw_value_offsets

@Const
public IntPointer raw_value_offsets()

For dense arrays only.

union_type

@Const
public UnionType union_type()

mode

public UnionMode.type mode()

child

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