parquet.format

Enum Encoding

java.lang.Object

java.lang.Enum<Encoding>

parquet.format.Encoding

All Implemented Interfaces:

Serializable, Comparable<Encoding>, org.apache.thrift.TEnum

public enum Encoding
extends Enum<Encoding>
implements org.apache.thrift.TEnum

Encodings supported by Parquet. Not all encodings are valid for all types. These enums are also used to specify the encoding of definition and repetition levels. See the accompanying doc for the details of the more complicated encodings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIT_PACKED Bit packed encoding.
GROUP_VAR_INT Group VarInt encoding for INT32/INT64.
PLAIN Default encoding.
PLAIN_DICTIONARY Dictionary encoding.
RLE Group packed run length encoding.

Method Summary

Methods

Modifier and Type	Method and Description
static Encoding	findByValue(int value) Find a the enum type by its integer value, as defined in the Thrift IDL.
int	getValue() Get the integer value of this enum value, as defined in the Thrift IDL.
static Encoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static Encoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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 Detail

PLAIN

public static final Encoding PLAIN

Default encoding. BOOLEAN - 1 bit per value. 0 is false; 1 is true. INT32 - 4 bytes per value. Stored as little-endian. INT64 - 8 bytes per value. Stored as little-endian. FLOAT - 4 bytes per value. IEEE. Stored as little-endian. DOUBLE - 8 bytes per value. IEEE. Stored as little-endian. BYTE_ARRAY - 4 byte length stored as little endian, followed by bytes. FIXED_LEN_BYTE_ARRAY - Just the bytes.

GROUP_VAR_INT

public static final Encoding GROUP_VAR_INT

Group VarInt encoding for INT32/INT64.

PLAIN_DICTIONARY

public static final Encoding PLAIN_DICTIONARY

Dictionary encoding. The values in the dictionary are encoded in the plain type.

RLE

public static final Encoding RLE

Group packed run length encoding. Usable for definition/reptition levels encoding

BIT_PACKED

public static final Encoding BIT_PACKED

Bit packed encoding. This can only be used if the data has a known max width. Usable for definition/repetition levels encoding. *

Method Detail

values

public static Encoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Encoding c : Encoding.values())
    System.out.println(c);

Returns:

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

valueOf

public static Encoding 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

getValue

public int getValue()

Get the integer value of this enum value, as defined in the Thrift IDL.

Specified by:

getValue in interface org.apache.thrift.TEnum

findByValue

public static Encoding findByValue(int value)

Find a the enum type by its integer value, as defined in the Thrift IDL.

Returns:

null if the value is not found.