Package org.apache.parquet.format

Enum ColumnMetaData._Fields

java.lang.Object

java.lang.Enum<ColumnMetaData._Fields>

org.apache.parquet.format.ColumnMetaData._Fields

All Implemented Interfaces:

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

Enclosing class:

ColumnMetaData

public static enum ColumnMetaData._Fields
extends Enum<ColumnMetaData._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	Description
BLOOM_FILTER_OFFSET	Byte offset from beginning of file to Bloom filter data
CODEC	Compression codec *
DATA_PAGE_OFFSET	Byte offset from beginning of file to first data page *
DICTIONARY_PAGE_OFFSET	Byte offset from the beginning of file to first (only) dictionary page *
ENCODING_STATS	Set of all encodings used for pages in this column chunk.
ENCODINGS	Set of all encodings used for this column.
INDEX_PAGE_OFFSET	Byte offset from beginning of file to root index page *
KEY_VALUE_METADATA	Optional key/value metadata *
NUM_VALUES	Number of values in this column *
PATH_IN_SCHEMA	Path in schema *
STATISTICS	optional statistics for this column chunk
TOTAL_COMPRESSED_SIZE	total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *
TOTAL_UNCOMPRESSED_SIZE	total byte size of all uncompressed pages in this column chunk (including the headers) *
TYPE	Type of this column *

Method Summary

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

TYPE

public static final ColumnMetaData._Fields TYPE

Type of this column *

See Also:

Type

ENCODINGS

public static final ColumnMetaData._Fields ENCODINGS

Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *

PATH_IN_SCHEMA

public static final ColumnMetaData._Fields PATH_IN_SCHEMA

Path in schema *

CODEC

public static final ColumnMetaData._Fields CODEC

Compression codec *

See Also:

CompressionCodec

NUM_VALUES

public static final ColumnMetaData._Fields NUM_VALUES

Number of values in this column *

TOTAL_UNCOMPRESSED_SIZE

public static final ColumnMetaData._Fields TOTAL_UNCOMPRESSED_SIZE

total byte size of all uncompressed pages in this column chunk (including the headers) *

TOTAL_COMPRESSED_SIZE

public static final ColumnMetaData._Fields TOTAL_COMPRESSED_SIZE

total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *

KEY_VALUE_METADATA

public static final ColumnMetaData._Fields KEY_VALUE_METADATA

Optional key/value metadata *

DATA_PAGE_OFFSET

public static final ColumnMetaData._Fields DATA_PAGE_OFFSET

Byte offset from beginning of file to first data page *

INDEX_PAGE_OFFSET

public static final ColumnMetaData._Fields INDEX_PAGE_OFFSET

Byte offset from beginning of file to root index page *

DICTIONARY_PAGE_OFFSET

public static final ColumnMetaData._Fields DICTIONARY_PAGE_OFFSET

Byte offset from the beginning of file to first (only) dictionary page *

STATISTICS

public static final ColumnMetaData._Fields STATISTICS

optional statistics for this column chunk

ENCODING_STATS

public static final ColumnMetaData._Fields ENCODING_STATS

Set of all encodings used for pages in this column chunk. This information can be used to determine if all data pages are dictionary encoded for example *

BLOOM_FILTER_OFFSET

public static final ColumnMetaData._Fields BLOOM_FILTER_OFFSET

Byte offset from beginning of file to Bloom filter data. *

Method Detail

values

public static ColumnMetaData._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 (ColumnMetaData._Fields c : ColumnMetaData._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 ColumnMetaData._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 ColumnMetaData._Fields findByThriftId(int fieldId)

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

findByThriftIdOrThrow

public static ColumnMetaData._Fields findByThriftIdOrThrow(int fieldId)

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

findByName

public static ColumnMetaData._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