Module org.apache.arrow.format

Package org.apache.arrow.flatbuf

Class DictionaryBatch

java.lang.Object

com.google.flatbuffers.Table

org.apache.arrow.flatbuf.DictionaryBatch

public final class DictionaryBatch
extends com.google.flatbuffers.Table

For sending dictionary encoding information. Any Field can be dictionary-encoded, but in this case none of its children may be dictionary-encoded. There is one vector / column per dictionary, but that vector / column may be spread across multiple dictionary batches by using the isDelta flag

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DictionaryBatch.Vector

Field Summary

Fields inherited from class com.google.flatbuffers.Table

bb, bb_pos

Constructor Summary

Constructors

Constructor	Description
DictionaryBatch()

Method Summary

Modifier and Type	Method	Description
DictionaryBatch	__assign(int _i, ByteBuffer _bb)
void	__init(int _i, ByteBuffer _bb)
static void	addData(com.google.flatbuffers.FlatBufferBuilder builder, int dataOffset)
static void	addId(com.google.flatbuffers.FlatBufferBuilder builder, long id)
static void	addIsDelta(com.google.flatbuffers.FlatBufferBuilder builder, boolean isDelta)
static int	createDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder, long id, int dataOffset, boolean isDelta)
RecordBatch	data()
RecordBatch	data(RecordBatch obj)
static int	endDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder)
static DictionaryBatch	getRootAsDictionaryBatch(ByteBuffer _bb)
static DictionaryBatch	getRootAsDictionaryBatch(ByteBuffer _bb, DictionaryBatch obj)
long	id()
boolean	isDelta()	If isDelta is true the values in the dictionary are to be appended to a dictionary with the indicated id.
static void	startDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder)
static void	ValidateVersion()

Methods inherited from class com.google.flatbuffers.Table

__has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

Methods inherited from class java.lang.Object

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

Constructor Details

DictionaryBatch

public DictionaryBatch()

Method Details

ValidateVersion

public static void ValidateVersion()

getRootAsDictionaryBatch

public static DictionaryBatch getRootAsDictionaryBatch(ByteBuffer _bb)

getRootAsDictionaryBatch

public static DictionaryBatch getRootAsDictionaryBatch(ByteBuffer _bb,
 DictionaryBatch obj)

__init

public void __init(int _i,
 ByteBuffer _bb)

__assign

public DictionaryBatch __assign(int _i,
 ByteBuffer _bb)

id

public long id()

data

public RecordBatch data()

data

public RecordBatch data(RecordBatch obj)

isDelta

public boolean isDelta()

If isDelta is true the values in the dictionary are to be appended to a dictionary with the indicated id. If isDelta is false this dictionary should replace the existing dictionary.

createDictionaryBatch

public static int createDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder,
 long id,
 int dataOffset,
 boolean isDelta)

startDictionaryBatch

public static void startDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder)

addId

public static void addId(com.google.flatbuffers.FlatBufferBuilder builder,
 long id)

addData

public static void addData(com.google.flatbuffers.FlatBufferBuilder builder,
 int dataOffset)

addIsDelta

public static void addIsDelta(com.google.flatbuffers.FlatBufferBuilder builder,
 boolean isDelta)

endDictionaryBatch

public static int endDictionaryBatch(com.google.flatbuffers.FlatBufferBuilder builder)