org.bytedeco.arrow

Class DictionaryMemo

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.DictionaryMemo

All Implemented Interfaces:

AutoCloseable

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

\brief Memoization data structure for assigning id numbers to dictionaries and tracking their current state through possible deltas in an IPC stream

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
DictionaryMemo()
DictionaryMemo(long size) Native array allocator.
DictionaryMemo(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	AddDictionary(long id, Array dictionary) \brief Add a dictionary to the memo with a particular id.
Status	AddDictionaryDelta(long id, Array dictionary, MemoryPool pool) \brief Append a dictionary delta to the memo with a particular id.
Status	AddField(long id, Field field) \brief Add field to the memo, return KeyError if already present
Status	AddOrReplaceDictionary(long id, Array dictionary) \brief Add a dictionary to the memo if it does not have one with the id, otherwise, replace the dictionary with the new one.
DictionaryVector	dictionaries() \brief The stored dictionaries, in ascending id order.
Status	GetDictionary(long id, Array dictionary) \brief Return current dictionary corresponding to a particular id.
Status	GetDictionaryType(long id, DataType type) \brief Return dictionary value type corresponding to a particular dictionary id.
Status	GetId(Field type, long[] id)
Status	GetId(Field type, LongBuffer id)
Status	GetId(Field type, LongPointer id) \brief Return id for dictionary if it exists, otherwise return KeyError
Status	GetOrAssignId(Field field, long[] out)
Status	GetOrAssignId(Field field, LongBuffer out)
Status	GetOrAssignId(Field field, LongPointer out) \brief Return id for dictionary, computing new id if necessary
DictionaryMemo	getPointer(long i)
boolean	HasDictionary(Field type) \brief Return true if dictionary for type is in this memo
boolean	HasDictionary(long id) \brief Return true if we have a dictionary for the input id
int	num_dictionaries()
int	num_fields() \brief The number of fields tracked in the memo
DictionaryMemo	position(long position)

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

DictionaryMemo

public DictionaryMemo(Pointer p)

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

DictionaryMemo

public DictionaryMemo(long size)

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

DictionaryMemo

public DictionaryMemo()

Method Detail

position

public DictionaryMemo position(long position)

Overrides:

position in class Pointer

getPointer

public DictionaryMemo getPointer(long i)

Overrides:

getPointer in class Pointer

GetDictionary

@ByVal
public Status GetDictionary(@Cast(value="int64_t")
                                    long id,
                                    @SharedPtr
                                    Array dictionary)

\brief Return current dictionary corresponding to a particular id. Returns KeyError if id not found

GetDictionaryType

@ByVal
public Status GetDictionaryType(@Cast(value="int64_t")
                                        long id,
                                        @SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>*"})
                                        DataType type)

\brief Return dictionary value type corresponding to a particular dictionary id. This permits multiple fields to reference the same dictionary in IPC and JSON

GetOrAssignId

@ByVal
public Status GetOrAssignId(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                                    Field field,
                                    @Cast(value="int64_t*")
                                    LongPointer out)

\brief Return id for dictionary, computing new id if necessary

GetOrAssignId

@ByVal
public Status GetOrAssignId(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                                    Field field,
                                    @Cast(value="int64_t*")
                                    LongBuffer out)

GetOrAssignId

@ByVal
public Status GetOrAssignId(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                                    Field field,
                                    @Cast(value="int64_t*")
                                    long[] out)

GetId

@ByVal
public Status GetId(@Const
                            Field type,
                            @Cast(value="int64_t*")
                            LongPointer id)

\brief Return id for dictionary if it exists, otherwise return KeyError

GetId

@ByVal
public Status GetId(@Const
                            Field type,
                            @Cast(value="int64_t*")
                            LongBuffer id)

GetId

@ByVal
public Status GetId(@Const
                            Field type,
                            @Cast(value="int64_t*")
                            long[] id)

HasDictionary

@Cast(value="bool")
public boolean HasDictionary(@Const @ByRef
                                                  Field type)

\brief Return true if dictionary for type is in this memo

HasDictionary

@Cast(value="bool")
public boolean HasDictionary(@Cast(value="int64_t")
                                                  long id)

\brief Return true if we have a dictionary for the input id

AddField

@ByVal
public Status AddField(@Cast(value="int64_t")
                               long id,
                               @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Field>"})
                               Field field)

\brief Add field to the memo, return KeyError if already present

AddDictionary

@ByVal
public Status AddDictionary(@Cast(value="int64_t")
                                    long id,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                    Array dictionary)

\brief Add a dictionary to the memo with a particular id. Returns KeyError if that dictionary already exists

AddDictionaryDelta

@ByVal
public Status AddDictionaryDelta(@Cast(value="int64_t")
                                         long id,
                                         @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                         Array dictionary,
                                         MemoryPool pool)

\brief Append a dictionary delta to the memo with a particular id. Returns KeyError if that dictionary does not exists

AddOrReplaceDictionary

@ByVal
public Status AddOrReplaceDictionary(@Cast(value="int64_t")
                                             long id,
                                             @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                             Array dictionary)

\brief Add a dictionary to the memo if it does not have one with the id, otherwise, replace the dictionary with the new one.

dictionaries

@ByVal
public DictionaryVector dictionaries()

\brief The stored dictionaries, in ascending id order.

num_fields

public int num_fields()

\brief The number of fields tracked in the memo

num_dictionaries

public int num_dictionaries()