SchemaElement (Apache Parquet Format (Incubating) 2.3.0-incubating API)

java.lang.Object
- org.apache.parquet.format.SchemaElement

All Implemented Interfaces:

Serializable, Cloneable, Comparable<SchemaElement>, org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
```
public class SchemaElement
extends Object
implements org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>, Serializable, Cloneable
```
Represents a element inside a schema definition. - if it is a group (inner node) then type is undefined and num_children is defined - if it is a primitive type (leaf) then type is defined and num_children is undefined the nodes are listed in depth first traversal order.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SchemaElement._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type	Field and Description
`ConvertedType`	`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.
`int`	`field_id` When the original schema supports field ids, this will save the original field id in the parquet schema
`static Map<SchemaElement._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`String`	`name` Name of the field in the schema
`int`	`num_children` Nested fields.
`int`	`precision`
`FieldRepetitionType`	`repetition_type` repetition of the field.
`int`	`scale` Used when this column contains decimal data.
`Type`	`type` Data type for this field.
`int`	`type_length` If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the vales.

Constructor Summary

Constructors
Constructor and Description

SchemaElement()

SchemaElement(SchemaElement other)
Performs a deep copy on other.

SchemaElement(String name)

Constructors
Constructor and Description
`SchemaElement()`
`SchemaElement(SchemaElement other)` Performs a deep copy on other.
`SchemaElement(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`int`	`compareTo(SchemaElement other)`
`SchemaElement`	`deepCopy()`
`boolean`	`equals(Object that)`
`boolean`	`equals(SchemaElement that)`
`SchemaElement._Fields`	`fieldForId(int fieldId)`
`ConvertedType`	`getConverted_type()` When the schema is the result of a conversion from another model Used to record the original type to help with cross conversion.
`int`	`getField_id()` When the original schema supports field ids, this will save the original field id in the parquet schema
`Object`	`getFieldValue(SchemaElement._Fields field)`
`String`	`getName()` Name of the field in the schema
`int`	`getNum_children()` Nested fields.
`int`	`getPrecision()`
`FieldRepetitionType`	`getRepetition_type()` repetition of the field.
`int`	`getScale()` Used when this column contains decimal data.
`int`	`getType_length()` If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the vales.
`Type`	`getType()` Data type for this field.
`int`	`hashCode()`
`boolean`	`isSet(SchemaElement._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetConverted_type()` Returns true if field converted_type is set (has been assigned a value) and false otherwise
`boolean`	`isSetField_id()` Returns true if field field_id is set (has been assigned a value) and false otherwise
`boolean`	`isSetName()` Returns true if field name is set (has been assigned a value) and false otherwise
`boolean`	`isSetNum_children()` Returns true if field num_children is set (has been assigned a value) and false otherwise
`boolean`	`isSetPrecision()` Returns true if field precision is set (has been assigned a value) and false otherwise
`boolean`	`isSetRepetition_type()` Returns true if field repetition_type is set (has been assigned a value) and false otherwise
`boolean`	`isSetScale()` Returns true if field scale is set (has been assigned a value) and false otherwise
`boolean`	`isSetType_length()` Returns true if field type_length is set (has been assigned a value) and false otherwise
`boolean`	`isSetType()` Returns true if field type is set (has been assigned a value) and false otherwise
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`SchemaElement`	`setConverted_type(ConvertedType 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.
`void`	`setConverted_typeIsSet(boolean value)`
`SchemaElement`	`setField_id(int field_id)` When the original schema supports field ids, this will save the original field id in the parquet schema
`void`	`setField_idIsSet(boolean value)`
`void`	`setFieldValue(SchemaElement._Fields field, Object value)`
`SchemaElement`	`setName(String name)` Name of the field in the schema
`void`	`setNameIsSet(boolean value)`
`SchemaElement`	`setNum_children(int num_children)` Nested fields.
`void`	`setNum_childrenIsSet(boolean value)`
`SchemaElement`	`setPrecision(int precision)`
`void`	`setPrecisionIsSet(boolean value)`
`SchemaElement`	`setRepetition_type(FieldRepetitionType repetition_type)` repetition of the field.
`void`	`setRepetition_typeIsSet(boolean value)`
`SchemaElement`	`setScale(int scale)` Used when this column contains decimal data.
`void`	`setScaleIsSet(boolean value)`
`SchemaElement`	`setType_length(int type_length)` If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the vales.
`void`	`setType_lengthIsSet(boolean value)`
`SchemaElement`	`setType(Type type)` Data type for this field.
`void`	`setTypeIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetConverted_type()`
`void`	`unsetField_id()`
`void`	`unsetName()`
`void`	`unsetNum_children()`
`void`	`unsetPrecision()`
`void`	`unsetRepetition_type()`
`void`	`unsetScale()`
`void`	`unsetType_length()`
`void`	`unsetType()`
`void`	`validate()`
`void`	`write(org.apache.thrift.protocol.TProtocol oprot)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
public Type type
```
    Data type for this field. Not set if the current element is a non-leaf node
    
    See Also:
    Type
  - type_length
```
public int 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 FieldRepetitionType 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 String name
```
    Name of the field in the schema
  - num_children
```
public int 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 ConvertedType 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 int scale
```
    Used when this column contains decimal data. See the DECIMAL converted type for more details.
  - precision
```
public int precision
```
  - field_id
```
public int field_id
```
    When the original schema supports field ids, this will save the original field id in the parquet schema
  - metaDataMap
```
public static final Map<SchemaElement._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - SchemaElement
```
public SchemaElement()
```
  - SchemaElement
```
public SchemaElement(String name)
```
  - SchemaElement
```
public SchemaElement(SchemaElement other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public SchemaElement deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - getType
```
public Type getType()
```
    Data type for this field. Not set if the current element is a non-leaf node
    
    See Also:
    Type
  - setType
```
public SchemaElement setType(Type type)
```
    Data type for this field. Not set if the current element is a non-leaf node
    
    See Also:
    Type
  - unsetType
```
public void unsetType()
```
  - isSetType
```
public boolean isSetType()
```
    Returns true if field type is set (has been assigned a value) and false otherwise
  - setTypeIsSet
```
public void setTypeIsSet(boolean value)
```
  - getType_length
```
public int getType_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.
  - setType_length
```
public SchemaElement setType_length(int 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.
  - unsetType_length
```
public void unsetType_length()
```
  - isSetType_length
```
public boolean isSetType_length()
```
    Returns true if field type_length is set (has been assigned a value) and false otherwise
  - setType_lengthIsSet
```
public void setType_lengthIsSet(boolean value)
```
  - getRepetition_type
```
public FieldRepetitionType getRepetition_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
  - setRepetition_type
```
public SchemaElement setRepetition_type(FieldRepetitionType 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
  - unsetRepetition_type
```
public void unsetRepetition_type()
```
  - isSetRepetition_type
```
public boolean isSetRepetition_type()
```
    Returns true if field repetition_type is set (has been assigned a value) and false otherwise
  - setRepetition_typeIsSet
```
public void setRepetition_typeIsSet(boolean value)
```
  - getName
```
public String getName()
```
    Name of the field in the schema
  - setName
```
public SchemaElement setName(String name)
```
    Name of the field in the schema
  - unsetName
```
public void unsetName()
```
  - isSetName
```
public boolean isSetName()
```
    Returns true if field name is set (has been assigned a value) and false otherwise
  - setNameIsSet
```
public void setNameIsSet(boolean value)
```
  - getNum_children
```
public int getNum_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
  - setNum_children
```
public SchemaElement setNum_children(int 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
  - unsetNum_children
```
public void unsetNum_children()
```
  - isSetNum_children
```
public boolean isSetNum_children()
```
    Returns true if field num_children is set (has been assigned a value) and false otherwise
  - setNum_childrenIsSet
```
public void setNum_childrenIsSet(boolean value)
```
  - getConverted_type
```
public ConvertedType getConverted_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
  - setConverted_type
```
public SchemaElement setConverted_type(ConvertedType 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
  - unsetConverted_type
```
public void unsetConverted_type()
```
  - isSetConverted_type
```
public boolean isSetConverted_type()
```
    Returns true if field converted_type is set (has been assigned a value) and false otherwise
  - setConverted_typeIsSet
```
public void setConverted_typeIsSet(boolean value)
```
  - getScale
```
public int getScale()
```
    Used when this column contains decimal data. See the DECIMAL converted type for more details.
  - setScale
```
public SchemaElement setScale(int scale)
```
    Used when this column contains decimal data. See the DECIMAL converted type for more details.
  - unsetScale
```
public void unsetScale()
```
  - isSetScale
```
public boolean isSetScale()
```
    Returns true if field scale is set (has been assigned a value) and false otherwise
  - setScaleIsSet
```
public void setScaleIsSet(boolean value)
```
  - getPrecision
```
public int getPrecision()
```
  - setPrecision
```
public SchemaElement setPrecision(int precision)
```
  - unsetPrecision
```
public void unsetPrecision()
```
  - isSetPrecision
```
public boolean isSetPrecision()
```
    Returns true if field precision is set (has been assigned a value) and false otherwise
  - setPrecisionIsSet
```
public void setPrecisionIsSet(boolean value)
```
  - getField_id
```
public int getField_id()
```
    When the original schema supports field ids, this will save the original field id in the parquet schema
  - setField_id
```
public SchemaElement setField_id(int field_id)
```
    When the original schema supports field ids, this will save the original field id in the parquet schema
  - unsetField_id
```
public void unsetField_id()
```
  - isSetField_id
```
public boolean isSetField_id()
```
    Returns true if field field_id is set (has been assigned a value) and false otherwise
  - setField_idIsSet
```
public void setField_idIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(SchemaElement._Fields field,
                 Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - getFieldValue
```
public Object getFieldValue(SchemaElement._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - isSet
```
public boolean isSet(SchemaElement._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(SchemaElement that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(SchemaElement other)
```
    Specified by:
    
    compareTo in interface Comparable<SchemaElement>
  - fieldForId
```
public SchemaElement._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - write
```
public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
```
    Specified by:
    
    write in interface org.apache.thrift.TBase<SchemaElement,SchemaElement._Fields>
    
    Throws:
    
    org.apache.thrift.TException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
              throws org.apache.thrift.TException
```
    Throws:
    
    org.apache.thrift.TException

Class SchemaElement

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

type_length

repetition_type

name

num_children

converted_type

scale

precision

field_id

metaDataMap

Constructor Detail

SchemaElement

SchemaElement

SchemaElement

Method Detail

deepCopy

clear

getType

setType

unsetType

isSetType

setTypeIsSet

getType_length

setType_length

unsetType_length

isSetType_length

setType_lengthIsSet

getRepetition_type

setRepetition_type

unsetRepetition_type

isSetRepetition_type

setRepetition_typeIsSet

getName

setName

unsetName

isSetName

setNameIsSet

getNum_children

setNum_children

unsetNum_children

isSetNum_children

setNum_childrenIsSet

getConverted_type

setConverted_type

unsetConverted_type

isSetConverted_type

setConverted_typeIsSet

getScale

setScale

unsetScale

isSetScale

setScaleIsSet

getPrecision

setPrecision

unsetPrecision

isSetPrecision

setPrecisionIsSet

getField_id

setField_id

unsetField_id

isSetField_id

setField_idIsSet

setFieldValue

getFieldValue

isSet

equals

equals

hashCode

compareTo

fieldForId

read

write

toString