Package org.apache.parquet.format

Enum SchemaElement._Fields

java.lang.Object

java.lang.Enum<SchemaElement._Fields>

org.apache.parquet.format.SchemaElement._Fields

All Implemented Interfaces:

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

Enclosing class:

SchemaElement

public static enum SchemaElement._Fields
extends Enum<SchemaElement._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
CONVERTED_TYPE	When the schema is the result of a conversion from another model Used to record the original type to help with cross conversion.
FIELD_ID	When the original schema supports field ids, this will save the original field id in the parquet schema
LOGICAL_TYPE	The logical type of this SchemaElement LogicalType replaces ConvertedType, but ConvertedType is still required for some logical types to ensure forward-compatibility in format v1.
NAME	Name of the field in the schema
NUM_CHILDREN	Nested fields.
PRECISION
REPETITION_TYPE	repetition of the field.
SCALE	Used when this column contains decimal data.
TYPE	Data type for this field.
TYPE_LENGTH	If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the vales.

Method Summary

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

Data type for this field. Not set if the current element is a non-leaf node

See Also:

Type

TYPE_LENGTH

public static final SchemaElement._Fields TYPE_LENGTH

If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the vales. Otherwise, if specified, this is the maximum bit length to store any of the values. (e.g. a low cardinality INT col could have this set to 3). Note that this is in the schema, and therefore fixed for the entire file.

REPETITION_TYPE

public static final SchemaElement._Fields REPETITION_TYPE

repetition of the field. The root of the schema does not have a repetition_type. All other nodes must have one

See Also:

FieldRepetitionType

NAME

public static final SchemaElement._Fields NAME

Name of the field in the schema

NUM_CHILDREN

public static final SchemaElement._Fields NUM_CHILDREN

Nested fields. Since thrift does not support nested fields, the nesting is flattened to a single list by a depth-first traversal. The children count is used to construct the nested relationship. This field is not set when the element is a primitive type

CONVERTED_TYPE

public static final SchemaElement._Fields CONVERTED_TYPE

When the schema is the result of a conversion from another model Used to record the original type to help with cross conversion.

See Also:

ConvertedType

SCALE

public static final SchemaElement._Fields SCALE

Used when this column contains decimal data. See the DECIMAL converted type for more details.

PRECISION

public static final SchemaElement._Fields PRECISION

FIELD_ID

public static final SchemaElement._Fields FIELD_ID

When the original schema supports field ids, this will save the original field id in the parquet schema

LOGICAL_TYPE

public static final SchemaElement._Fields LOGICAL_TYPE

The logical type of this SchemaElement LogicalType replaces ConvertedType, but ConvertedType is still required for some logical types to ensure forward-compatibility in format v1.

Method Detail

values

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

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

findByThriftIdOrThrow

public static SchemaElement._Fields findByThriftIdOrThrow(int fieldId)

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

findByName

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