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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DictionaryPageHeader>, org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>, org.apache.thrift.TSerializable
```
@Generated(value="Autogenerated by Thrift Compiler (0.22.0)",
           date="2025-12-22")
public class DictionaryPageHeader
extends Object
implements org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>, Serializable, Cloneable, Comparable<DictionaryPageHeader>
```
The dictionary page must be placed at the first position of the column chunk if it is partly or completely dictionary encoded. At most one dictionary page can be placed in a column chunk.

See Also:

Serialized Form

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`Encoding`	`encoding`	Encoding using this dictionary page *
`boolean`	`is_sorted`	If true, the entries in the dictionary are sorted in ascending order *
`static Map<DictionaryPageHeader._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`int`	`num_values`	Number of values in the dictionary *

Constructor Summary

Constructors
Constructor	Description
`DictionaryPageHeader()`
`DictionaryPageHeader(int num_values, Encoding encoding)`
`DictionaryPageHeader(DictionaryPageHeader other)`	Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`int`	`compareTo(DictionaryPageHeader other)`
`DictionaryPageHeader`	`deepCopy()`
`boolean`	`equals(Object that)`
`boolean`	`equals(DictionaryPageHeader that)`
`DictionaryPageHeader._Fields`	`fieldForId(int fieldId)`
`Encoding`	`getEncoding()`	Encoding using this dictionary page *
`Object`	`getFieldValue(DictionaryPageHeader._Fields field)`
`int`	`getNum_values()`	Number of values in the dictionary *
`int`	`hashCode()`
`boolean`	`isIs_sorted()`	If true, the entries in the dictionary are sorted in ascending order *
`boolean`	`isSet(DictionaryPageHeader._Fields field)`	Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetEncoding()`	Returns true if field encoding is set (has been assigned a value) and false otherwise
`boolean`	`isSetIs_sorted()`	Returns true if field is_sorted is set (has been assigned a value) and false otherwise
`boolean`	`isSetNum_values()`	Returns true if field num_values is set (has been assigned a value) and false otherwise
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`DictionaryPageHeader`	`setEncoding(Encoding encoding)`	Encoding using this dictionary page *
`void`	`setEncodingIsSet(boolean value)`
`void`	`setFieldValue(DictionaryPageHeader._Fields field, Object value)`
`DictionaryPageHeader`	`setIs_sorted(boolean is_sorted)`	If true, the entries in the dictionary are sorted in ascending order *
`void`	`setIs_sortedIsSet(boolean value)`
`DictionaryPageHeader`	`setNum_values(int num_values)`	Number of values in the dictionary *
`void`	`setNum_valuesIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetEncoding()`
`void`	`unsetIs_sorted()`
`void`	`unsetNum_values()`
`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
  - num_values
```
public int num_values
```
    Number of values in the dictionary *
  - encoding
```
public Encoding encoding
```
    Encoding using this dictionary page *
    
    See Also:
    
    Encoding
  - is_sorted
```
public boolean is_sorted
```
    If true, the entries in the dictionary are sorted in ascending order *
  - metaDataMap
```
public static final Map<DictionaryPageHeader._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - DictionaryPageHeader
```
public DictionaryPageHeader()
```
  - DictionaryPageHeader
```
public DictionaryPageHeader(int num_values,
                            Encoding encoding)
```
  - DictionaryPageHeader
```
public DictionaryPageHeader(DictionaryPageHeader other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public DictionaryPageHeader deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - getNum_values
```
public int getNum_values()
```
    Number of values in the dictionary *
  - setNum_values
```
public DictionaryPageHeader setNum_values(int num_values)
```
    Number of values in the dictionary *
  - 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)
```
  - getEncoding
```
public Encoding getEncoding()
```
    Encoding using this dictionary page *
    
    See Also:
    
    Encoding
  - setEncoding
```
public DictionaryPageHeader setEncoding(Encoding encoding)
```
    Encoding using this dictionary page *
    
    See Also:
    
    Encoding
  - unsetEncoding
```
public void unsetEncoding()
```
  - isSetEncoding
```
public boolean isSetEncoding()
```
    Returns true if field encoding is set (has been assigned a value) and false otherwise
  - setEncodingIsSet
```
public void setEncodingIsSet(boolean value)
```
  - isIs_sorted
```
public boolean isIs_sorted()
```
    If true, the entries in the dictionary are sorted in ascending order *
  - setIs_sorted
```
public DictionaryPageHeader setIs_sorted(boolean is_sorted)
```
    If true, the entries in the dictionary are sorted in ascending order *
  - unsetIs_sorted
```
public void unsetIs_sorted()
```
  - isSetIs_sorted
```
public boolean isSetIs_sorted()
```
    Returns true if field is_sorted is set (has been assigned a value) and false otherwise
  - setIs_sortedIsSet
```
public void setIs_sortedIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(DictionaryPageHeader._Fields field,
                          Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - getFieldValue
```
public Object getFieldValue(DictionaryPageHeader._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - isSet
```
public boolean isSet(DictionaryPageHeader._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<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(DictionaryPageHeader that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(DictionaryPageHeader other)
```
    Specified by:
    
    compareTo in interface Comparable<DictionaryPageHeader>
  - fieldForId
```
public DictionaryPageHeader._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<DictionaryPageHeader,DictionaryPageHeader._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.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:
    
    write in interface org.apache.thrift.TSerializable
    
    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 DictionaryPageHeader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

num_values

encoding

is_sorted

metaDataMap

Constructor Detail

DictionaryPageHeader

DictionaryPageHeader

DictionaryPageHeader

Method Detail

deepCopy

clear

getNum_values

setNum_values

unsetNum_values

isSetNum_values

setNum_valuesIsSet

getEncoding

setEncoding

unsetEncoding

isSetEncoding

setEncodingIsSet

isIs_sorted

setIs_sorted

unsetIs_sorted

isSetIs_sorted

setIs_sortedIsSet

setFieldValue

getFieldValue

isSet

equals

equals

hashCode

compareTo

fieldForId

read

write

toString

validate