ColumnMetaData (Apache Parquet Format (Incubating) 2.2.0-rc1 API)

java.lang.Object
- parquet.format.ColumnMetaData

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ColumnMetaData>, org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
```
public class ColumnMetaData
extends Object
implements org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>, Serializable, Cloneable
```
Description for column metadata

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ColumnMetaData._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
`CompressionCodec`	`codec` Compression codec *
`long`	`data_page_offset` Byte offset from beginning of file to first data page *
`long`	`dictionary_page_offset` Byte offset from the beginning of file to first (only) dictionary page *
`List<Encoding>`	`encodings` Set of all encodings used for this column.
`long`	`index_page_offset` Byte offset from beginning of file to root index page *
`List<KeyValue>`	`key_value_metadata` Optional key/value metadata *
`static Map<ColumnMetaData._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`long`	`num_values` Number of values in this column *
`List<String>`	`path_in_schema` Path in schema *
`Statistics`	`statistics` optional statistics for this column chunk
`long`	`total_compressed_size` total byte size of all compressed pages in this column chunk (including the headers) *
`long`	`total_uncompressed_size` total byte size of all uncompressed pages in this column chunk (including the headers) *
`Type`	`type` Type of this column *

Constructor Summary

Constructors
Constructor and Description
`ColumnMetaData()`
`ColumnMetaData(ColumnMetaData other)` Performs a deep copy on other.
`ColumnMetaData(Type type, List<Encoding> encodings, List<String> path_in_schema, CompressionCodec codec, long num_values, long total_uncompressed_size, long total_compressed_size, long data_page_offset)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToEncodings(Encoding elem)`
`void`	`addToKey_value_metadata(KeyValue elem)`
`void`	`addToPath_in_schema(String elem)`
`void`	`clear()`
`int`	`compareTo(ColumnMetaData other)`
`ColumnMetaData`	`deepCopy()`
`boolean`	`equals(ColumnMetaData that)`
`boolean`	`equals(Object that)`
`ColumnMetaData._Fields`	`fieldForId(int fieldId)`
`CompressionCodec`	`getCodec()` Compression codec *
`long`	`getData_page_offset()` Byte offset from beginning of file to first data page *
`long`	`getDictionary_page_offset()` Byte offset from the beginning of file to first (only) dictionary page *
`List<Encoding>`	`getEncodings()` Set of all encodings used for this column.
`Iterator<Encoding>`	`getEncodingsIterator()`
`int`	`getEncodingsSize()`
`Object`	`getFieldValue(ColumnMetaData._Fields field)`
`long`	`getIndex_page_offset()` Byte offset from beginning of file to root index page *
`List<KeyValue>`	`getKey_value_metadata()` Optional key/value metadata *
`Iterator<KeyValue>`	`getKey_value_metadataIterator()`
`int`	`getKey_value_metadataSize()`
`long`	`getNum_values()` Number of values in this column *
`List<String>`	`getPath_in_schema()` Path in schema *
`Iterator<String>`	`getPath_in_schemaIterator()`
`int`	`getPath_in_schemaSize()`
`Statistics`	`getStatistics()` optional statistics for this column chunk
`long`	`getTotal_compressed_size()` total byte size of all compressed pages in this column chunk (including the headers) *
`long`	`getTotal_uncompressed_size()` total byte size of all uncompressed pages in this column chunk (including the headers) *
`Type`	`getType()` Type of this column *
`int`	`hashCode()`
`boolean`	`isSet(ColumnMetaData._Fields field)` Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
`boolean`	`isSetCodec()` Returns true if field codec is set (has been asigned a value) and false otherwise
`boolean`	`isSetData_page_offset()` Returns true if field data_page_offset is set (has been asigned a value) and false otherwise
`boolean`	`isSetDictionary_page_offset()` Returns true if field dictionary_page_offset is set (has been asigned a value) and false otherwise
`boolean`	`isSetEncodings()` Returns true if field encodings is set (has been asigned a value) and false otherwise
`boolean`	`isSetIndex_page_offset()` Returns true if field index_page_offset is set (has been asigned a value) and false otherwise
`boolean`	`isSetKey_value_metadata()` Returns true if field key_value_metadata is set (has been asigned a value) and false otherwise
`boolean`	`isSetNum_values()` Returns true if field num_values is set (has been asigned a value) and false otherwise
`boolean`	`isSetPath_in_schema()` Returns true if field path_in_schema is set (has been asigned a value) and false otherwise
`boolean`	`isSetStatistics()` Returns true if field statistics is set (has been asigned a value) and false otherwise
`boolean`	`isSetTotal_compressed_size()` Returns true if field total_compressed_size is set (has been asigned a value) and false otherwise
`boolean`	`isSetTotal_uncompressed_size()` Returns true if field total_uncompressed_size is set (has been asigned a value) and false otherwise
`boolean`	`isSetType()` Returns true if field type is set (has been asigned a value) and false otherwise
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`ColumnMetaData`	`setCodec(CompressionCodec codec)` Compression codec *
`void`	`setCodecIsSet(boolean value)`
`ColumnMetaData`	`setData_page_offset(long data_page_offset)` Byte offset from beginning of file to first data page *
`void`	`setData_page_offsetIsSet(boolean value)`
`ColumnMetaData`	`setDictionary_page_offset(long dictionary_page_offset)` Byte offset from the beginning of file to first (only) dictionary page *
`void`	`setDictionary_page_offsetIsSet(boolean value)`
`ColumnMetaData`	`setEncodings(List<Encoding> encodings)` Set of all encodings used for this column.
`void`	`setEncodingsIsSet(boolean value)`
`void`	`setFieldValue(ColumnMetaData._Fields field, Object value)`
`ColumnMetaData`	`setIndex_page_offset(long index_page_offset)` Byte offset from beginning of file to root index page *
`void`	`setIndex_page_offsetIsSet(boolean value)`
`ColumnMetaData`	`setKey_value_metadata(List<KeyValue> key_value_metadata)` Optional key/value metadata *
`void`	`setKey_value_metadataIsSet(boolean value)`
`ColumnMetaData`	`setNum_values(long num_values)` Number of values in this column *
`void`	`setNum_valuesIsSet(boolean value)`
`ColumnMetaData`	`setPath_in_schema(List<String> path_in_schema)` Path in schema *
`void`	`setPath_in_schemaIsSet(boolean value)`
`ColumnMetaData`	`setStatistics(Statistics statistics)` optional statistics for this column chunk
`void`	`setStatisticsIsSet(boolean value)`
`ColumnMetaData`	`setTotal_compressed_size(long total_compressed_size)` total byte size of all compressed pages in this column chunk (including the headers) *
`void`	`setTotal_compressed_sizeIsSet(boolean value)`
`ColumnMetaData`	`setTotal_uncompressed_size(long total_uncompressed_size)` total byte size of all uncompressed pages in this column chunk (including the headers) *
`void`	`setTotal_uncompressed_sizeIsSet(boolean value)`
`ColumnMetaData`	`setType(Type type)` Type of this column *
`void`	`setTypeIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetCodec()`
`void`	`unsetData_page_offset()`
`void`	`unsetDictionary_page_offset()`
`void`	`unsetEncodings()`
`void`	`unsetIndex_page_offset()`
`void`	`unsetKey_value_metadata()`
`void`	`unsetNum_values()`
`void`	`unsetPath_in_schema()`
`void`	`unsetStatistics()`
`void`	`unsetTotal_compressed_size()`
`void`	`unsetTotal_uncompressed_size()`
`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
```
    Type of this column *
    
    See Also:
    Type
  - encodings
```
public List<Encoding> encodings
```
    Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *
  - path_in_schema
```
public List<String> path_in_schema
```
    Path in schema *
  - codec
```
public CompressionCodec codec
```
    Compression codec *
    
    See Also:
    CompressionCodec
  - num_values
```
public long num_values
```
    Number of values in this column *
  - total_uncompressed_size
```
public long total_uncompressed_size
```
    total byte size of all uncompressed pages in this column chunk (including the headers) *
  - total_compressed_size
```
public long total_compressed_size
```
    total byte size of all compressed pages in this column chunk (including the headers) *
  - key_value_metadata
```
public List<KeyValue> key_value_metadata
```
    Optional key/value metadata *
  - data_page_offset
```
public long data_page_offset
```
    Byte offset from beginning of file to first data page *
  - index_page_offset
```
public long index_page_offset
```
    Byte offset from beginning of file to root index page *
  - dictionary_page_offset
```
public long dictionary_page_offset
```
    Byte offset from the beginning of file to first (only) dictionary page *
  - statistics
```
public Statistics statistics
```
    optional statistics for this column chunk
  - metaDataMap
```
public static final Map<ColumnMetaData._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - ColumnMetaData
```
public ColumnMetaData()
```
  - ColumnMetaData
```
public ColumnMetaData(Type type,
              List<Encoding> encodings,
              List<String> path_in_schema,
              CompressionCodec codec,
              long num_values,
              long total_uncompressed_size,
              long total_compressed_size,
              long data_page_offset)
```
  - ColumnMetaData
```
public ColumnMetaData(ColumnMetaData other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public ColumnMetaData deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
  - getType
```
public Type getType()
```
    Type of this column *
    
    See Also:
    Type
  - setType
```
public ColumnMetaData setType(Type type)
```
    Type of this column *
    
    See Also:
    Type
  - unsetType
```
public void unsetType()
```
  - isSetType
```
public boolean isSetType()
```
    Returns true if field type is set (has been asigned a value) and false otherwise
  - setTypeIsSet
```
public void setTypeIsSet(boolean value)
```
  - getEncodingsSize
```
public int getEncodingsSize()
```
  - getEncodingsIterator
```
public Iterator<Encoding> getEncodingsIterator()
```
  - addToEncodings
```
public void addToEncodings(Encoding elem)
```
  - getEncodings
```
public List<Encoding> getEncodings()
```
    Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *
  - setEncodings
```
public ColumnMetaData setEncodings(List<Encoding> encodings)
```
    Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *
  - unsetEncodings
```
public void unsetEncodings()
```
  - isSetEncodings
```
public boolean isSetEncodings()
```
    Returns true if field encodings is set (has been asigned a value) and false otherwise
  - setEncodingsIsSet
```
public void setEncodingsIsSet(boolean value)
```
  - getPath_in_schemaSize
```
public int getPath_in_schemaSize()
```
  - getPath_in_schemaIterator
```
public Iterator<String> getPath_in_schemaIterator()
```
  - addToPath_in_schema
```
public void addToPath_in_schema(String elem)
```
  - getPath_in_schema
```
public List<String> getPath_in_schema()
```
    Path in schema *
  - setPath_in_schema
```
public ColumnMetaData setPath_in_schema(List<String> path_in_schema)
```
    Path in schema *
  - unsetPath_in_schema
```
public void unsetPath_in_schema()
```
  - isSetPath_in_schema
```
public boolean isSetPath_in_schema()
```
    Returns true if field path_in_schema is set (has been asigned a value) and false otherwise
  - setPath_in_schemaIsSet
```
public void setPath_in_schemaIsSet(boolean value)
```
  - getCodec
```
public CompressionCodec getCodec()
```
    Compression codec *
    
    See Also:
    CompressionCodec
  - setCodec
```
public ColumnMetaData setCodec(CompressionCodec codec)
```
    Compression codec *
    
    See Also:
    CompressionCodec
  - unsetCodec
```
public void unsetCodec()
```
  - isSetCodec
```
public boolean isSetCodec()
```
    Returns true if field codec is set (has been asigned a value) and false otherwise
  - setCodecIsSet
```
public void setCodecIsSet(boolean value)
```
  - getNum_values
```
public long getNum_values()
```
    Number of values in this column *
  - setNum_values
```
public ColumnMetaData setNum_values(long num_values)
```
    Number of values in this column *
  - unsetNum_values
```
public void unsetNum_values()
```
  - isSetNum_values
```
public boolean isSetNum_values()
```
    Returns true if field num_values is set (has been asigned a value) and false otherwise
  - setNum_valuesIsSet
```
public void setNum_valuesIsSet(boolean value)
```
  - getTotal_uncompressed_size
```
public long getTotal_uncompressed_size()
```
    total byte size of all uncompressed pages in this column chunk (including the headers) *
  - setTotal_uncompressed_size
```
public ColumnMetaData setTotal_uncompressed_size(long total_uncompressed_size)
```
    total byte size of all uncompressed pages in this column chunk (including the headers) *
  - unsetTotal_uncompressed_size
```
public void unsetTotal_uncompressed_size()
```
  - isSetTotal_uncompressed_size
```
public boolean isSetTotal_uncompressed_size()
```
    Returns true if field total_uncompressed_size is set (has been asigned a value) and false otherwise
  - setTotal_uncompressed_sizeIsSet
```
public void setTotal_uncompressed_sizeIsSet(boolean value)
```
  - getTotal_compressed_size
```
public long getTotal_compressed_size()
```
    total byte size of all compressed pages in this column chunk (including the headers) *
  - setTotal_compressed_size
```
public ColumnMetaData setTotal_compressed_size(long total_compressed_size)
```
    total byte size of all compressed pages in this column chunk (including the headers) *
  - unsetTotal_compressed_size
```
public void unsetTotal_compressed_size()
```
  - isSetTotal_compressed_size
```
public boolean isSetTotal_compressed_size()
```
    Returns true if field total_compressed_size is set (has been asigned a value) and false otherwise
  - setTotal_compressed_sizeIsSet
```
public void setTotal_compressed_sizeIsSet(boolean value)
```
  - getKey_value_metadataSize
```
public int getKey_value_metadataSize()
```
  - getKey_value_metadataIterator
```
public Iterator<KeyValue> getKey_value_metadataIterator()
```
  - addToKey_value_metadata
```
public void addToKey_value_metadata(KeyValue elem)
```
  - getKey_value_metadata
```
public List<KeyValue> getKey_value_metadata()
```
    Optional key/value metadata *
  - setKey_value_metadata
```
public ColumnMetaData setKey_value_metadata(List<KeyValue> key_value_metadata)
```
    Optional key/value metadata *
  - unsetKey_value_metadata
```
public void unsetKey_value_metadata()
```
  - isSetKey_value_metadata
```
public boolean isSetKey_value_metadata()
```
    Returns true if field key_value_metadata is set (has been asigned a value) and false otherwise
  - setKey_value_metadataIsSet
```
public void setKey_value_metadataIsSet(boolean value)
```
  - getData_page_offset
```
public long getData_page_offset()
```
    Byte offset from beginning of file to first data page *
  - setData_page_offset
```
public ColumnMetaData setData_page_offset(long data_page_offset)
```
    Byte offset from beginning of file to first data page *
  - unsetData_page_offset
```
public void unsetData_page_offset()
```
  - isSetData_page_offset
```
public boolean isSetData_page_offset()
```
    Returns true if field data_page_offset is set (has been asigned a value) and false otherwise
  - setData_page_offsetIsSet
```
public void setData_page_offsetIsSet(boolean value)
```
  - getIndex_page_offset
```
public long getIndex_page_offset()
```
    Byte offset from beginning of file to root index page *
  - setIndex_page_offset
```
public ColumnMetaData setIndex_page_offset(long index_page_offset)
```
    Byte offset from beginning of file to root index page *
  - unsetIndex_page_offset
```
public void unsetIndex_page_offset()
```
  - isSetIndex_page_offset
```
public boolean isSetIndex_page_offset()
```
    Returns true if field index_page_offset is set (has been asigned a value) and false otherwise
  - setIndex_page_offsetIsSet
```
public void setIndex_page_offsetIsSet(boolean value)
```
  - getDictionary_page_offset
```
public long getDictionary_page_offset()
```
    Byte offset from the beginning of file to first (only) dictionary page *
  - setDictionary_page_offset
```
public ColumnMetaData setDictionary_page_offset(long dictionary_page_offset)
```
    Byte offset from the beginning of file to first (only) dictionary page *
  - unsetDictionary_page_offset
```
public void unsetDictionary_page_offset()
```
  - isSetDictionary_page_offset
```
public boolean isSetDictionary_page_offset()
```
    Returns true if field dictionary_page_offset is set (has been asigned a value) and false otherwise
  - setDictionary_page_offsetIsSet
```
public void setDictionary_page_offsetIsSet(boolean value)
```
  - getStatistics
```
public Statistics getStatistics()
```
    optional statistics for this column chunk
  - setStatistics
```
public ColumnMetaData setStatistics(Statistics statistics)
```
    optional statistics for this column chunk
  - unsetStatistics
```
public void unsetStatistics()
```
  - isSetStatistics
```
public boolean isSetStatistics()
```
    Returns true if field statistics is set (has been asigned a value) and false otherwise
  - setStatisticsIsSet
```
public void setStatisticsIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(ColumnMetaData._Fields field,
                 Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
  - getFieldValue
```
public Object getFieldValue(ColumnMetaData._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
  - isSet
```
public boolean isSet(ColumnMetaData._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(ColumnMetaData that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(ColumnMetaData other)
```
    Specified by:
    
    compareTo in interface Comparable<ColumnMetaData>
  - fieldForId
```
public ColumnMetaData._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._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<ColumnMetaData,ColumnMetaData._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<ColumnMetaData,ColumnMetaData._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 ColumnMetaData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

encodings

path_in_schema

codec

num_values

total_uncompressed_size

total_compressed_size

key_value_metadata

data_page_offset

index_page_offset

dictionary_page_offset

statistics

metaDataMap

Constructor Detail

ColumnMetaData

ColumnMetaData

ColumnMetaData

Method Detail

deepCopy

clear

getType

setType

unsetType

isSetType

setTypeIsSet

getEncodingsSize

getEncodingsIterator

addToEncodings

getEncodings

setEncodings

unsetEncodings

isSetEncodings

setEncodingsIsSet

getPath_in_schemaSize

getPath_in_schemaIterator

addToPath_in_schema

getPath_in_schema

setPath_in_schema

unsetPath_in_schema

isSetPath_in_schema

setPath_in_schemaIsSet

getCodec

setCodec

unsetCodec

isSetCodec

setCodecIsSet

getNum_values

setNum_values

unsetNum_values

isSetNum_values

setNum_valuesIsSet

getTotal_uncompressed_size

setTotal_uncompressed_size

unsetTotal_uncompressed_size

isSetTotal_uncompressed_size

setTotal_uncompressed_sizeIsSet

getTotal_compressed_size

setTotal_compressed_size

unsetTotal_compressed_size

isSetTotal_compressed_size

setTotal_compressed_sizeIsSet

getKey_value_metadataSize

getKey_value_metadataIterator

addToKey_value_metadata

getKey_value_metadata

setKey_value_metadata

unsetKey_value_metadata

isSetKey_value_metadata

setKey_value_metadataIsSet

getData_page_offset

setData_page_offset

unsetData_page_offset

isSetData_page_offset