org.apache.arrow.flatbuf

Class DictionaryEncoding

java.lang.Object

com.google.flatbuffers.Table

org.apache.arrow.flatbuf.DictionaryEncoding

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DictionaryEncoding.Vector

Field Summary

Fields inherited from class com.google.flatbuffers.Table

bb, bb_pos

Constructor Summary

Constructors

Constructor and Description
DictionaryEncoding()

Method Summary

Modifier and Type	Method and Description
DictionaryEncoding	__assign(int _i, ByteBuffer _bb)
void	__init(int _i, ByteBuffer _bb)
static void	addDictionaryKind(com.google.flatbuffers.FlatBufferBuilder builder, short dictionaryKind)
static void	addId(com.google.flatbuffers.FlatBufferBuilder builder, long id)
static void	addIndexType(com.google.flatbuffers.FlatBufferBuilder builder, int indexTypeOffset)
static void	addIsOrdered(com.google.flatbuffers.FlatBufferBuilder builder, boolean isOrdered)
static int	createDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder, long id, int indexTypeOffset, boolean isOrdered, short dictionaryKind)
short	dictionaryKind()
static int	endDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder)
static DictionaryEncoding	getRootAsDictionaryEncoding(ByteBuffer _bb)
static DictionaryEncoding	getRootAsDictionaryEncoding(ByteBuffer _bb, DictionaryEncoding obj)
long	id() The known dictionary id in the application where this data is used.
Int	indexType() The dictionary indices are constrained to be non-negative integers.
Int	indexType(Int obj)
boolean	isOrdered() By default, dictionaries are not ordered, or the order does not have semantic meaning.
static void	startDictionaryEncoding(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_as_bytebuffer, __vector_in_bytebuffer, __vector_len, __vector, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryEncoding

public DictionaryEncoding()

Method Detail

ValidateVersion

public static void ValidateVersion()

getRootAsDictionaryEncoding

public static DictionaryEncoding getRootAsDictionaryEncoding(ByteBuffer _bb)

getRootAsDictionaryEncoding

public static DictionaryEncoding getRootAsDictionaryEncoding(ByteBuffer _bb,
                                                             DictionaryEncoding obj)

__init

public void __init(int _i,
                   ByteBuffer _bb)

__assign

public DictionaryEncoding __assign(int _i,
                                   ByteBuffer _bb)

id

public long id()

The known dictionary id in the application where this data is used. In the file or streaming formats, the dictionary ids are found in the DictionaryBatch messages

indexType

public Int indexType()

The dictionary indices are constrained to be non-negative integers. If this field is null, the indices must be signed int32. To maximize cross-language compatibility and performance, implementations are recommended to prefer signed integer types over unsigned integer types and to avoid uint64 indices unless they are required by an application.

indexType

public Int indexType(Int obj)

isOrdered

public boolean isOrdered()

By default, dictionaries are not ordered, or the order does not have semantic meaning. In some statistical, applications, dictionary-encoding is used to represent ordered categorical data, and we provide a way to preserve that metadata here

dictionaryKind

public short dictionaryKind()

createDictionaryEncoding

public static int createDictionaryEncoding(com.google.flatbuffers.FlatBufferBuilder builder,
                                           long id,
                                           int indexTypeOffset,
                                           boolean isOrdered,
                                           short dictionaryKind)

startDictionaryEncoding

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

addId

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

addIndexType

public static void addIndexType(com.google.flatbuffers.FlatBufferBuilder builder,
                                int indexTypeOffset)

addIsOrdered

public static void addIsOrdered(com.google.flatbuffers.FlatBufferBuilder builder,
                                boolean isOrdered)

addDictionaryKind

public static void addDictionaryKind(com.google.flatbuffers.FlatBufferBuilder builder,
                                     short dictionaryKind)

endDictionaryEncoding

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