Package org.apache.parquet.format
Class ColumnMetaData
- java.lang.Object
-
- org.apache.parquet.format.ColumnMetaData
-
- All Implemented Interfaces:
Serializable,Cloneable,Comparable<ColumnMetaData>,org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>,org.apache.thrift.TSerializable
@Generated(value="Autogenerated by Thrift Compiler (0.16.0)", date="2023-05-12") public class ColumnMetaData extends Object implements org.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>, Serializable, Cloneable, Comparable<ColumnMetaData>
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classColumnMetaData._FieldsThe set of fields this struct contains, along with convenience methods for finding and manipulating them.
-
Field Summary
Fields Modifier and Type Field Description longbloom_filter_offsetByte offset from beginning of file to Bloom filter data.CompressionCodeccodecCompression codec *longdata_page_offsetByte offset from beginning of file to first data page *longdictionary_page_offsetByte offset from the beginning of file to first (only) dictionary page *List<PageEncodingStats>encoding_statsSet of all encodings used for pages in this column chunk.List<Encoding>encodingsSet of all encodings used for this column.longindex_page_offsetByte offset from beginning of file to root index page *List<KeyValue>key_value_metadataOptional key/value metadata *static Map<ColumnMetaData._Fields,org.apache.thrift.meta_data.FieldMetaData>metaDataMaplongnum_valuesNumber of values in this column *List<String>path_in_schemaPath in schema *Statisticsstatisticsoptional statistics for this column chunklongtotal_compressed_sizetotal byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *longtotal_uncompressed_sizetotal byte size of all uncompressed pages in this column chunk (including the headers) *TypetypeType of this column *
-
Constructor Summary
Constructors Constructor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddToEncoding_stats(PageEncodingStats elem)voidaddToEncodings(Encoding elem)voidaddToKey_value_metadata(KeyValue elem)voidaddToPath_in_schema(String elem)voidclear()intcompareTo(ColumnMetaData other)ColumnMetaDatadeepCopy()booleanequals(Object that)booleanequals(ColumnMetaData that)ColumnMetaData._FieldsfieldForId(int fieldId)longgetBloom_filter_offset()Byte offset from beginning of file to Bloom filter data.CompressionCodecgetCodec()Compression codec *longgetData_page_offset()Byte offset from beginning of file to first data page *longgetDictionary_page_offset()Byte offset from the beginning of file to first (only) dictionary page *List<PageEncodingStats>getEncoding_stats()Set of all encodings used for pages in this column chunk.Iterator<PageEncodingStats>getEncoding_statsIterator()intgetEncoding_statsSize()List<Encoding>getEncodings()Set of all encodings used for this column.Iterator<Encoding>getEncodingsIterator()intgetEncodingsSize()ObjectgetFieldValue(ColumnMetaData._Fields field)longgetIndex_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()intgetKey_value_metadataSize()longgetNum_values()Number of values in this column *List<String>getPath_in_schema()Path in schema *Iterator<String>getPath_in_schemaIterator()intgetPath_in_schemaSize()StatisticsgetStatistics()optional statistics for this column chunklonggetTotal_compressed_size()total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *longgetTotal_uncompressed_size()total byte size of all uncompressed pages in this column chunk (including the headers) *TypegetType()Type of this column *inthashCode()booleanisSet(ColumnMetaData._Fields field)Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwisebooleanisSetBloom_filter_offset()Returns true if field bloom_filter_offset is set (has been assigned a value) and false otherwisebooleanisSetCodec()Returns true if field codec is set (has been assigned a value) and false otherwisebooleanisSetData_page_offset()Returns true if field data_page_offset is set (has been assigned a value) and false otherwisebooleanisSetDictionary_page_offset()Returns true if field dictionary_page_offset is set (has been assigned a value) and false otherwisebooleanisSetEncoding_stats()Returns true if field encoding_stats is set (has been assigned a value) and false otherwisebooleanisSetEncodings()Returns true if field encodings is set (has been assigned a value) and false otherwisebooleanisSetIndex_page_offset()Returns true if field index_page_offset is set (has been assigned a value) and false otherwisebooleanisSetKey_value_metadata()Returns true if field key_value_metadata is set (has been assigned a value) and false otherwisebooleanisSetNum_values()Returns true if field num_values is set (has been assigned a value) and false otherwisebooleanisSetPath_in_schema()Returns true if field path_in_schema is set (has been assigned a value) and false otherwisebooleanisSetStatistics()Returns true if field statistics is set (has been assigned a value) and false otherwisebooleanisSetTotal_compressed_size()Returns true if field total_compressed_size is set (has been assigned a value) and false otherwisebooleanisSetTotal_uncompressed_size()Returns true if field total_uncompressed_size is set (has been assigned a value) and false otherwisebooleanisSetType()Returns true if field type is set (has been assigned a value) and false otherwisevoidread(org.apache.thrift.protocol.TProtocol iprot)ColumnMetaDatasetBloom_filter_offset(long bloom_filter_offset)Byte offset from beginning of file to Bloom filter data.voidsetBloom_filter_offsetIsSet(boolean value)ColumnMetaDatasetCodec(CompressionCodec codec)Compression codec *voidsetCodecIsSet(boolean value)ColumnMetaDatasetData_page_offset(long data_page_offset)Byte offset from beginning of file to first data page *voidsetData_page_offsetIsSet(boolean value)ColumnMetaDatasetDictionary_page_offset(long dictionary_page_offset)Byte offset from the beginning of file to first (only) dictionary page *voidsetDictionary_page_offsetIsSet(boolean value)ColumnMetaDatasetEncoding_stats(List<PageEncodingStats> encoding_stats)Set of all encodings used for pages in this column chunk.voidsetEncoding_statsIsSet(boolean value)ColumnMetaDatasetEncodings(List<Encoding> encodings)Set of all encodings used for this column.voidsetEncodingsIsSet(boolean value)voidsetFieldValue(ColumnMetaData._Fields field, Object value)ColumnMetaDatasetIndex_page_offset(long index_page_offset)Byte offset from beginning of file to root index page *voidsetIndex_page_offsetIsSet(boolean value)ColumnMetaDatasetKey_value_metadata(List<KeyValue> key_value_metadata)Optional key/value metadata *voidsetKey_value_metadataIsSet(boolean value)ColumnMetaDatasetNum_values(long num_values)Number of values in this column *voidsetNum_valuesIsSet(boolean value)ColumnMetaDatasetPath_in_schema(List<String> path_in_schema)Path in schema *voidsetPath_in_schemaIsSet(boolean value)ColumnMetaDatasetStatistics(Statistics statistics)optional statistics for this column chunkvoidsetStatisticsIsSet(boolean value)ColumnMetaDatasetTotal_compressed_size(long total_compressed_size)total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *voidsetTotal_compressed_sizeIsSet(boolean value)ColumnMetaDatasetTotal_uncompressed_size(long total_uncompressed_size)total byte size of all uncompressed pages in this column chunk (including the headers) *voidsetTotal_uncompressed_sizeIsSet(boolean value)ColumnMetaDatasetType(Type type)Type of this column *voidsetTypeIsSet(boolean value)StringtoString()voidunsetBloom_filter_offset()voidunsetCodec()voidunsetData_page_offset()voidunsetDictionary_page_offset()voidunsetEncoding_stats()voidunsetEncodings()voidunsetIndex_page_offset()voidunsetKey_value_metadata()voidunsetNum_values()voidunsetPath_in_schema()voidunsetStatistics()voidunsetTotal_compressed_size()voidunsetTotal_uncompressed_size()voidunsetType()voidvalidate()voidwrite(org.apache.thrift.protocol.TProtocol oprot)
-
-
-
Field Detail
-
encodings
public List<Encoding> encodings
Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *
-
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, and potentially encrypted, pages in this column chunk (including the headers) *
-
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
-
encoding_stats
public List<PageEncodingStats> 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 long bloom_filter_offset
Byte offset from beginning of file to Bloom filter data. *
-
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:
deepCopyin interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
clear
public void clear()
- Specified by:
clearin interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
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 assigned a value) and false otherwise
-
setTypeIsSet
public void setTypeIsSet(boolean value)
-
getEncodingsSize
public int getEncodingsSize()
-
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 assigned a value) and false otherwise
-
setEncodingsIsSet
public void setEncodingsIsSet(boolean value)
-
getPath_in_schemaSize
public int getPath_in_schemaSize()
-
addToPath_in_schema
public void addToPath_in_schema(String elem)
-
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 assigned 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 assigned 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 assigned 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 assigned 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, and potentially encrypted, 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, and potentially encrypted, 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 assigned a value) and false otherwise
-
setTotal_compressed_sizeIsSet
public void setTotal_compressed_sizeIsSet(boolean value)
-
getKey_value_metadataSize
public int getKey_value_metadataSize()
-
addToKey_value_metadata
public void addToKey_value_metadata(KeyValue elem)
-
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 assigned 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 assigned 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 assigned 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 assigned 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 assigned a value) and false otherwise
-
setStatisticsIsSet
public void setStatisticsIsSet(boolean value)
-
getEncoding_statsSize
public int getEncoding_statsSize()
-
getEncoding_statsIterator
public Iterator<PageEncodingStats> getEncoding_statsIterator()
-
addToEncoding_stats
public void addToEncoding_stats(PageEncodingStats elem)
-
getEncoding_stats
public List<PageEncodingStats> getEncoding_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 *
-
setEncoding_stats
public ColumnMetaData setEncoding_stats(List<PageEncodingStats> 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 *
-
unsetEncoding_stats
public void unsetEncoding_stats()
-
isSetEncoding_stats
public boolean isSetEncoding_stats()
Returns true if field encoding_stats is set (has been assigned a value) and false otherwise
-
setEncoding_statsIsSet
public void setEncoding_statsIsSet(boolean value)
-
getBloom_filter_offset
public long getBloom_filter_offset()
Byte offset from beginning of file to Bloom filter data. *
-
setBloom_filter_offset
public ColumnMetaData setBloom_filter_offset(long bloom_filter_offset)
Byte offset from beginning of file to Bloom filter data. *
-
unsetBloom_filter_offset
public void unsetBloom_filter_offset()
-
isSetBloom_filter_offset
public boolean isSetBloom_filter_offset()
Returns true if field bloom_filter_offset is set (has been assigned a value) and false otherwise
-
setBloom_filter_offsetIsSet
public void setBloom_filter_offsetIsSet(boolean value)
-
setFieldValue
public void setFieldValue(ColumnMetaData._Fields field, Object value)
- Specified by:
setFieldValuein interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
getFieldValue
public Object getFieldValue(ColumnMetaData._Fields field)
- Specified by:
getFieldValuein interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
isSet
public boolean isSet(ColumnMetaData._Fields field)
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise- Specified by:
isSetin interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
equals
public boolean equals(ColumnMetaData that)
-
compareTo
public int compareTo(ColumnMetaData other)
- Specified by:
compareToin interfaceComparable<ColumnMetaData>
-
fieldForId
public ColumnMetaData._Fields fieldForId(int fieldId)
- Specified by:
fieldForIdin interfaceorg.apache.thrift.TBase<ColumnMetaData,ColumnMetaData._Fields>
-
read
public void read(org.apache.thrift.protocol.TProtocol iprot) throws org.apache.thrift.TException- Specified by:
readin interfaceorg.apache.thrift.TSerializable- Throws:
org.apache.thrift.TException
-
write
public void write(org.apache.thrift.protocol.TProtocol oprot) throws org.apache.thrift.TException- Specified by:
writein interfaceorg.apache.thrift.TSerializable- Throws:
org.apache.thrift.TException
-
validate
public void validate() throws org.apache.thrift.TException- Throws:
org.apache.thrift.TException
-
-