Package io.deephaven.extensions.barrage

Enum Class ColumnEncoding

java.lang.Object

java.lang.Enum<ColumnEncoding>

io.deephaven.extensions.barrage.ColumnEncoding

All Implemented Interfaces:

Serializable, Comparable<ColumnEncoding>, java.lang.constant.Constable

public enum ColumnEncoding
extends Enum<ColumnEncoding>

Arrow encoding to apply to a column when generating a Barrage schema. Auto-detected per column by BarrageUtil.schemaFromTable(io.deephaven.engine.table.Table) when structural guarantees make a particular encoding clearly beneficial, or specified explicitly via Table.BARRAGE_SCHEMA_ATTRIBUTE.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DICTIONARY_ENCODED
RUN_END_ENCODED_INT16
RUN_END_ENCODED_INT32
RUN_END_ENCODED_INT64

Method Summary

Modifier and Type	Method	Description
boolean	isRunEndEncoded()	Returns true for any run-end encoding variant.
static ColumnEncoding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ColumnEncoding[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RUN_END_ENCODED_INT16

public static final ColumnEncoding RUN_END_ENCODED_INT16

RUN_END_ENCODED_INT32

public static final ColumnEncoding RUN_END_ENCODED_INT32

RUN_END_ENCODED_INT64

public static final ColumnEncoding RUN_END_ENCODED_INT64

DICTIONARY_ENCODED

public static final ColumnEncoding DICTIONARY_ENCODED

Method Details

values

public static ColumnEncoding[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ColumnEncoding valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isRunEndEncoded

public boolean isRunEndEncoded()

Returns true for any run-end encoding variant.