org.apache.parquet.format

Enum ColumnChunk._Fields

java.lang.Object

java.lang.Enum<ColumnChunk._Fields>

org.apache.parquet.format.ColumnChunk._Fields

All Implemented Interfaces:

Serializable, Comparable<ColumnChunk._Fields>, org.apache.thrift.TFieldIdEnum

Enclosing class:

ColumnChunk

public static enum ColumnChunk._Fields
extends Enum<ColumnChunk._Fields>
implements org.apache.thrift.TFieldIdEnum

The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLUMN_INDEX_LENGTH Size of ColumnChunk's ColumnIndex, in bytes *
COLUMN_INDEX_OFFSET File offset of ColumnChunk's ColumnIndex *
CRYPTO_METADATA Crypto metadata of encrypted columns *
ENCRYPTED_COLUMN_METADATA Encrypted column metadata for this chunk *
FILE_OFFSET Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk.
FILE_PATH File where column data is stored.
META_DATA Column metadata for this chunk.
OFFSET_INDEX_LENGTH Size of ColumnChunk's OffsetIndex, in bytes *
OFFSET_INDEX_OFFSET File offset of ColumnChunk's OffsetIndex *

Method Summary

Modifier and Type	Method and Description
static ColumnChunk._Fields	findByName(String name) Find the _Fields constant that matches name, or null if its not found.
static ColumnChunk._Fields	findByThriftId(int fieldId) Find the _Fields constant that matches fieldId, or null if its not found.
static ColumnChunk._Fields	findByThriftIdOrThrow(int fieldId) Find the _Fields constant that matches fieldId, throwing an exception if it is not found.
String	getFieldName()
short	getThriftFieldId()
static ColumnChunk._Fields	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColumnChunk._Fields[]	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

FILE_PATH

public static final ColumnChunk._Fields FILE_PATH

File where column data is stored. If not set, assumed to be same file as metadata. This path is relative to the current file.

FILE_OFFSET

public static final ColumnChunk._Fields FILE_OFFSET

Deprecated: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk. In many cases, the ColumnMetaData at this location is wrong. This field is now deprecated and should not be used. Writers should set this field to 0 if no ColumnMetaData has been written outside the footer.

META_DATA

public static final ColumnChunk._Fields META_DATA

Column metadata for this chunk. Some writers may also replicate this at the location pointed to by file_path/file_offset. Note: while marked as optional, this field is in fact required by most major Parquet implementations. As such, writers MUST populate this field.

OFFSET_INDEX_OFFSET

public static final ColumnChunk._Fields OFFSET_INDEX_OFFSET

File offset of ColumnChunk's OffsetIndex *

OFFSET_INDEX_LENGTH

public static final ColumnChunk._Fields OFFSET_INDEX_LENGTH

Size of ColumnChunk's OffsetIndex, in bytes *

COLUMN_INDEX_OFFSET

public static final ColumnChunk._Fields COLUMN_INDEX_OFFSET

File offset of ColumnChunk's ColumnIndex *

COLUMN_INDEX_LENGTH

public static final ColumnChunk._Fields COLUMN_INDEX_LENGTH

Size of ColumnChunk's ColumnIndex, in bytes *

CRYPTO_METADATA

public static final ColumnChunk._Fields CRYPTO_METADATA

Crypto metadata of encrypted columns *

ENCRYPTED_COLUMN_METADATA

public static final ColumnChunk._Fields ENCRYPTED_COLUMN_METADATA

Encrypted column metadata for this chunk *

Method Detail

values

public static ColumnChunk._Fields[] 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 (ColumnChunk._Fields c : ColumnChunk._Fields.values())
    System.out.println(c);

Returns:

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

valueOf

public static ColumnChunk._Fields 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

findByThriftId

public static ColumnChunk._Fields findByThriftId(int fieldId)

Find the _Fields constant that matches fieldId, or null if its not found.

findByThriftIdOrThrow

public static ColumnChunk._Fields findByThriftIdOrThrow(int fieldId)

Find the _Fields constant that matches fieldId, throwing an exception if it is not found.

findByName

public static ColumnChunk._Fields findByName(String name)

Find the _Fields constant that matches name, or null if its not found.

getThriftFieldId

public short getThriftFieldId()

Specified by:

getThriftFieldId in interface org.apache.thrift.TFieldIdEnum

getFieldName

public String getFieldName()

Specified by:

getFieldName in interface org.apache.thrift.TFieldIdEnum