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 reading dictionaries from IPC streams This structure tracks the following associations: - field position (structural) -> dictionary id - dictionary id -> value type - dictionary id -> dictionary (value) data Together, they allow resolving dictionary data when reading an IPC stream, using metadata recorded in the schema message and data recorded in the dictionary batch messages (see ResolveDictionaries). This structure isn't useful for writing an IPC stream, where only DictionaryFieldMapper is necessary.

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, ArrayData dictionary) \brief Add a dictionary to the memo with a particular id.
Status	AddDictionaryDelta(long id, ArrayData dictionary) \brief Append a dictionary delta to the memo with a particular id.
Status	AddDictionaryType(long id, DataType type) \brief Add a dictionary value type to the memo with a particular id.
BoolResult	AddOrReplaceDictionary(long id, ArrayData 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.
DictionaryFieldMapper	fields()
ArrayDataResult	GetDictionary(long id, MemoryPool pool) \brief Return current dictionary corresponding to a particular id.
DataTypeResult	GetDictionaryType(long id) \brief Return dictionary value type corresponding to a particular dictionary id.
DictionaryMemo	getPointer(long i)
boolean	HasDictionary(long id) \brief Return true if we have a dictionary for the input id
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).

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

fields

@ByRef
public DictionaryFieldMapper fields()

GetDictionary

@ByVal
public ArrayDataResult GetDictionary(@Cast(value="int64_t")
                                             long id,
                                             MemoryPool pool)

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

GetDictionaryType

@ByVal
public DataTypeResult GetDictionaryType(@Cast(value="int64_t")
                                                long id)

\brief Return dictionary value type corresponding to a particular dictionary id.

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

AddDictionaryType

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

\brief Add a dictionary value type to the memo with a particular id. Returns KeyError if a different type is already registered with the same id.

AddDictionary

@ByVal
public Status AddDictionary(@Cast(value="int64_t")
                                    long id,
                                    @SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                                    ArrayData 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::ArrayData>"})
                                         ArrayData dictionary)

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

AddOrReplaceDictionary

@ByVal
public BoolResult AddOrReplaceDictionary(@Cast(value="int64_t")
                                                 long id,
                                                 @SharedPtr @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
                                                 ArrayData 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. Return true if the dictionary was added, false if replaced.