Package org.apache.druid.frame

Enum FrameType

java.lang.Object

java.lang.Enum<FrameType>

org.apache.druid.frame.FrameType

All Implemented Interfaces:

Serializable, Comparable<FrameType>

public enum FrameType
extends Enum<FrameType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLUMNAR	Columnar frames, written by ColumnarFrameWriter.
ROW_BASED_V1	Row-based frames (version 1), written by RowBasedFrameWriter.
ROW_BASED_V2	Row-based frames (version 2), written by RowBasedFrameWriter.

Method Summary

Modifier and Type	Method	Description
static FrameType	forVersion(byte versionByte)	Returns the frame type for a particular version byte, or null if the version byte is unrecognized.
boolean	isColumnar()	Whether this is a columnar type, written by ColumnarFrameWriter.
boolean	isRowBased()	Whether this is a row-based type, written by RowBasedFrameWriter.
static FrameType	latestColumnar()	Returns the latest columnar frame type.
static FrameType	latestRowBased()	Returns the latest row-based frame type.
static FrameType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FrameType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
byte	version()

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COLUMNAR

public static final FrameType COLUMNAR

Columnar frames, written by ColumnarFrameWriter.

ROW_BASED_V1

public static final FrameType ROW_BASED_V1

Row-based frames (version 1), written by RowBasedFrameWriter. Obsolete. Differs from ROW_BASED_V2 in how floating-point numbers are serialized. This one uses TransformUtils.transformFromDoubleLegacy(double) and TransformUtils.transformFromFloatLegacy(float), which sort incorrectly.

ROW_BASED_V2

public static final FrameType ROW_BASED_V2

Row-based frames (version 2), written by RowBasedFrameWriter.

Method Details

values

public static FrameType[] values()

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

Returns:

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

valueOf

public static FrameType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

forVersion

@Nullable
public static FrameType forVersion(byte versionByte)

Returns the frame type for a particular version byte, or null if the version byte is unrecognized.

latestRowBased

public static FrameType latestRowBased()

Returns the latest row-based frame type.

latestColumnar

public static FrameType latestColumnar()

Returns the latest columnar frame type.

version

public byte version()

isRowBased

public boolean isRowBased()

Whether this is a row-based type, written by RowBasedFrameWriter.

isColumnar

public boolean isColumnar()

Whether this is a columnar type, written by ColumnarFrameWriter.