Module org.apache.arrow.c

Package org.apache.arrow.c

Class CDataDictionaryProvider

java.lang.Object

org.apache.arrow.c.CDataDictionaryProvider

All Implemented Interfaces:

AutoCloseable, DictionaryProvider

public class CDataDictionaryProvider
extends Object
implements DictionaryProvider, AutoCloseable

A DictionaryProvider that is used in C Data Interface for imports.

CDataDictionaryProvider is similar to DictionaryProvider.MapDictionaryProvider with a key difference that the dictionaries are owned by the provider so it must eventually be closed.

The typical usage is to create the CDataDictionaryProvider and pass it to Data.importField(org.apache.arrow.memory.BufferAllocator, org.apache.arrow.c.ArrowSchema, org.apache.arrow.c.CDataDictionaryProvider) or Data.importSchema(org.apache.arrow.memory.BufferAllocator, org.apache.arrow.c.ArrowSchema, org.apache.arrow.c.CDataDictionaryProvider) to allocate empty dictionaries based on the information in ArrowSchema. Then you can re-use the same dictionary provider in any function that imports an ArrowArray that has the same schema.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.vector.dictionary.DictionaryProvider

DictionaryProvider.MapDictionaryProvider

Constructor Summary

Constructors

Constructor	Description
CDataDictionaryProvider()

Method Summary

Modifier and Type	Method	Description
void	close()
final Set<Long>	getDictionaryIds()	Get all dictionary IDs.
Dictionary	lookup(long id)	Return the dictionary for the given ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CDataDictionaryProvider

public CDataDictionaryProvider()

Method Details

getDictionaryIds

public final Set<Long> getDictionaryIds()

Description copied from interface: DictionaryProvider

Get all dictionary IDs.

Specified by:

getDictionaryIds in interface DictionaryProvider

lookup

public Dictionary lookup(long id)

Description copied from interface: DictionaryProvider

Return the dictionary for the given ID.

Specified by:

lookup in interface DictionaryProvider

close

public void close()

Specified by:

close in interface AutoCloseable