Uses of Interface
org.apache.arrow.vector.dictionary.DictionaryProvider

Packages that use DictionaryProvider

Package	Description
org.apache.arrow.adapter.avro
org.apache.arrow.adapter.orc
org.apache.arrow.c
org.apache.arrow.dataset.jni
org.apache.arrow.dataset.scanner
org.apache.arrow.flight
org.apache.arrow.vector.dictionary
org.apache.arrow.vector.ipc
org.apache.arrow.vector.table
org.apache.arrow.vector.util

Uses of DictionaryProvider in org.apache.arrow.adapter.avro

Methods in org.apache.arrow.adapter.avro with parameters of type DictionaryProvider

Modifier and Type	Method	Description
static org.apache.avro.Schema	ArrowToAvroUtils.createAvroSchema(List<Field> arrowFields, String typeName, String namespace, DictionaryProvider dictionaries)	Create an Avro record schema for a given list of Arrow fields.
static org.apache.avro.Schema	ArrowToAvroUtils.createAvroSchema(List<Field> arrowFields, DictionaryProvider dictionaries)	Overload provided for convenience, sets name = GENERIC_RECORD_TYPE_NAME and namespace = null.
static CompositeAvroProducer	ArrowToAvroUtils.createCompositeProducer(List<FieldVector> vectors, DictionaryProvider dictionaries)	Create a composite Avro producer for a set of field vectors (typically the root set of a VSR).

Uses of DictionaryProvider in org.apache.arrow.adapter.orc

Classes in org.apache.arrow.adapter.orc that implement DictionaryProvider

Modifier and Type	Class	Description
class	OrcStripeReader	Orc stripe that load data into ArrowRecordBatch.

Uses of DictionaryProvider in org.apache.arrow.c

Classes in org.apache.arrow.c that implement DictionaryProvider

Modifier and Type	Class	Description
class	CDataDictionaryProvider	A DictionaryProvider that is used in C Data Interface for imports.

Methods in org.apache.arrow.c with parameters of type DictionaryProvider

Modifier and Type	Method	Description
static void	Data.exportField(BufferAllocator allocator, Field field, DictionaryProvider provider, ArrowSchema out)	Export Java Field using the C data interface format.
static void	Data.exportSchema(BufferAllocator allocator, Schema schema, DictionaryProvider provider, ArrowSchema out)	Export Java Schema using the C data interface format.
static void	Data.exportTable(BufferAllocator allocator, Table table, DictionaryProvider provider, ArrowArray out)	Export the current contents of a Java Table using the C data interface format.
static void	Data.exportTable(BufferAllocator allocator, Table table, DictionaryProvider provider, ArrowArray out, ArrowSchema outSchema)	Export the current contents of a Java Table using the C data interface format.
static void	Data.exportVector(BufferAllocator allocator, FieldVector vector, DictionaryProvider provider, ArrowArray out)	Export Java FieldVector using the C data interface format.
static void	Data.exportVector(BufferAllocator allocator, FieldVector vector, DictionaryProvider provider, ArrowArray out, ArrowSchema outSchema)	Export Java FieldVector using the C data interface format.
static void	Data.exportVectorSchemaRoot(BufferAllocator allocator, VectorSchemaRoot vsr, DictionaryProvider provider, ArrowArray out)	Export the current contents of a Java VectorSchemaRoot using the C data interface format.
static void	Data.exportVectorSchemaRoot(BufferAllocator allocator, VectorSchemaRoot vsr, DictionaryProvider provider, ArrowArray out, ArrowSchema outSchema)	Export the current contents of a Java VectorSchemaRoot using the C data interface format.
static void	Data.importIntoVector(BufferAllocator allocator, ArrowArray array, FieldVector vector, DictionaryProvider provider)	Equivalent to calling Data.importIntoVector(BufferAllocator, ArrowArray, FieldVector, DictionaryProvider, boolean) importIntoVector(allocator, array, vector, provider, true)}.
static void	Data.importIntoVector(BufferAllocator allocator, ArrowArray array, FieldVector vector, DictionaryProvider provider, boolean closeImportedStructs)	Import Java vector from the C data interface.
static void	Data.importIntoVectorSchemaRoot(BufferAllocator allocator, ArrowArray array, VectorSchemaRoot root, DictionaryProvider provider)	Equivalent to calling importIntoVectorSchemaRoot(allocator, array, root, provider, true).
static void	Data.importIntoVectorSchemaRoot(BufferAllocator allocator, ArrowArray array, VectorSchemaRoot root, DictionaryProvider provider, boolean closeImportedStructs)	Import record batch from the C data interface into vector schema root.

Uses of DictionaryProvider in org.apache.arrow.dataset.jni

Classes in org.apache.arrow.dataset.jni that implement DictionaryProvider

Modifier and Type	Class	Description
class	NativeScanner.NativeReader	ArrowReader implementation for NativeDataset.

Uses of DictionaryProvider in org.apache.arrow.dataset.scanner

Classes in org.apache.arrow.dataset.scanner that implement DictionaryProvider

Modifier and Type	Class	Description
class	ArrowScannerReader	An implementation of ArrowReader that reads the dataset from Scanner.

Uses of DictionaryProvider in org.apache.arrow.flight

Methods in org.apache.arrow.flight that return DictionaryProvider

Modifier and Type	Method	Description
DictionaryProvider	FlightStream.getDictionaryProvider()	Get the provider for dictionaries in this stream.
DictionaryProvider	FlightStream.takeDictionaryOwnership()	Get an owned reference to the dictionaries in this stream.

Methods in org.apache.arrow.flight with parameters of type DictionaryProvider

Modifier and Type	Method	Description
default void	OutboundStreamListener.start(VectorSchemaRoot root, DictionaryProvider dictionaries)	Start sending data, using the schema of the given VectorSchemaRoot.
void	OutboundStreamListener.start(VectorSchemaRoot root, DictionaryProvider dictionaries, IpcOption option)	Start sending data, using the schema of the given VectorSchemaRoot.
FlightClient.ClientStreamListener	FlightClient.startPut(FlightDescriptor descriptor, VectorSchemaRoot root, DictionaryProvider provider, FlightClient.PutListener metadataListener, CallOption... options)	Create or append a descriptor with another stream.

Uses of DictionaryProvider in org.apache.arrow.vector.dictionary

Classes in org.apache.arrow.vector.dictionary that implement DictionaryProvider

Modifier and Type	Class	Description
static class	DictionaryProvider.MapDictionaryProvider	Implementation of DictionaryProvider that is backed by a hash-map.

Methods in org.apache.arrow.vector.dictionary with parameters of type DictionaryProvider

Modifier and Type	Method	Description
void	DictionaryProvider.MapDictionaryProvider.copyStructureFrom(DictionaryProvider other, BufferAllocator allocator)	Initialize the map structure from another provider, but with empty vectors.

Uses of DictionaryProvider in org.apache.arrow.vector.ipc

Classes in org.apache.arrow.vector.ipc that implement DictionaryProvider

Modifier and Type	Class	Description
class	ArrowFileReader	An implementation of ArrowReader that reads the standard arrow binary file format.
class	ArrowReader	Abstract class to read Schema and ArrowRecordBatches.
class	ArrowStreamReader	This class reads from an input stream and produces ArrowRecordBatches.
class	JsonFileReader	A reader for JSON files that translates them into vectors.

Methods in org.apache.arrow.vector.ipc with parameters of type DictionaryProvider

Modifier and Type	Method	Description
protected void	ArrowFileWriter.ensureDictionariesWritten(DictionaryProvider provider, Set<Long> dictionaryIdsUsed)
protected void	ArrowStreamWriter.ensureDictionariesWritten(DictionaryProvider provider, Set<Long> dictionaryIdsUsed)
protected abstract void	ArrowWriter.ensureDictionariesWritten(DictionaryProvider provider, Set<Long> dictionaryIdsUsed)	Write dictionaries after schema and before recordBatches, dictionaries won't be written if empty stream (only has schema data in IPC).
void	JsonFileWriter.start(Schema schema, DictionaryProvider provider)	Writes out the "header" of the file including the schema and any dictionaries required.

Constructors in org.apache.arrow.vector.ipc with parameters of type DictionaryProvider

Modifier	Constructor	Description
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, Map<String,String> metaData, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)
	ArrowFileWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, OutputStream out)	Construct an ArrowStreamWriter with an optional DictionaryProvider for the OutputStream.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out)	Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)	Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType)	Construct an ArrowStreamWriter with compression enabled.
	ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)	Construct an ArrowStreamWriter with compression enabled.
protected	ArrowWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out)
protected	ArrowWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option)
protected	ArrowWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out, IpcOption option, CompressionCodec.Factory compressionFactory, CompressionUtil.CodecType codecType, Optional<Integer> compressionLevel)	Note: fields are not closed when the writer is closed.

Uses of DictionaryProvider in org.apache.arrow.vector.table

Fields in org.apache.arrow.vector.table declared as DictionaryProvider

Modifier and Type	Field	Description
protected DictionaryProvider	BaseTable.dictionaryProvider	An optional DictionaryProvider.

Methods in org.apache.arrow.vector.table that return DictionaryProvider

Modifier and Type	Method	Description
DictionaryProvider	BaseTable.getDictionaryProvider()	Returns the DictionaryProvider for this table.

Constructors in org.apache.arrow.vector.table with parameters of type DictionaryProvider

Modifier	Constructor	Description
	BaseTable(List<FieldVector> fieldVectors, int rowCount, DictionaryProvider provider)	Constructs new instance with the given rowCount, and containing the schema and each of the given vectors.
	Table(List<FieldVector> fieldVectors, int rowCount, DictionaryProvider provider)	Constructs a new instance.

Uses of DictionaryProvider in org.apache.arrow.vector.util

Methods in org.apache.arrow.vector.util with parameters of type DictionaryProvider

Modifier and Type	Method	Description
static void	Validator.compareDictionaries(List<DictionaryEncoding> encodings1, List<DictionaryEncoding> encodings2, DictionaryProvider provider1, DictionaryProvider provider2)	Validate two Dictionary encodings and dictionaries with id's from the encodings.
static void	Validator.compareDictionaryProviders(DictionaryProvider provider1, DictionaryProvider provider2)	Validate two dictionary providers are equal in structure and contents.
static Field	DictionaryUtility.toMessageFormat(Field field, DictionaryProvider provider, Set<Long> dictionaryIdsUsed)	Convert field and child fields that have a dictionary encoding to message format, so fields have the dictionary type.