ParquetDataColumnReader (Hive 3.1.1 API)

All Known Implementing Classes:

ParquetDataColumnReaderFactory.DefaultParquetDataColumnReader, ParquetDataColumnReaderFactory.Types32Int2DecimalPageReader, ParquetDataColumnReaderFactory.Types32Int2SmallintPageReader, ParquetDataColumnReaderFactory.Types32Int2TinyintPageReader, ParquetDataColumnReaderFactory.Types32UInt2DecimalPageReader, ParquetDataColumnReaderFactory.Types32UInt2SmallintPageReader, ParquetDataColumnReaderFactory.Types32UInt2TinyintPageReader, ParquetDataColumnReaderFactory.Types64Int2DecimalPageReader, ParquetDataColumnReaderFactory.Types64Int2IntPageReader, ParquetDataColumnReaderFactory.Types64Int2SmallintPageReader, ParquetDataColumnReaderFactory.Types64Int2TinyintPageReader, ParquetDataColumnReaderFactory.Types64UInt2DecimalPageReader, ParquetDataColumnReaderFactory.Types64UInt2IntPageReader, ParquetDataColumnReaderFactory.Types64UInt2SmallintPageReader, ParquetDataColumnReaderFactory.Types64UInt2TinyintPageReader, ParquetDataColumnReaderFactory.TypesFromBooleanPageReader, ParquetDataColumnReaderFactory.TypesFromDecimalPageReader, ParquetDataColumnReaderFactory.TypesFromDoublePageReader, ParquetDataColumnReaderFactory.TypesFromFloatPageReader, ParquetDataColumnReaderFactory.TypesFromInt32PageReader, ParquetDataColumnReaderFactory.TypesFromInt64PageReader, ParquetDataColumnReaderFactory.TypesFromInt96PageReader, ParquetDataColumnReaderFactory.TypesFromStringPageReader, ParquetDataColumnReaderFactory.TypesFromUInt32PageReader, ParquetDataColumnReaderFactory.TypesFromUInt64PageReader
```
public interface ParquetDataColumnReader
```
The interface to wrap the underlying Parquet dictionary and non dictionary encoded page reader.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.apache.parquet.column.Dictionary`	`getDictionary()`
`void`	`initFromPage(int valueCount, org.apache.parquet.bytes.ByteBufferInputStream in)` Initialize the reader by page data.
`boolean`	`isValid(double value)`
`boolean`	`isValid(float value)`
`boolean`	`isValid(long value)`
`boolean`	`readBoolean()`
`boolean`	`readBoolean(int id)`
`byte[]`	`readBytes()`
`byte[]`	`readBytes(int id)`
`byte[]`	`readChar()`
`byte[]`	`readChar(int id)`
`byte[]`	`readDecimal()`
`byte[]`	`readDecimal(int id)`
`double`	`readDouble()`
`double`	`readDouble(int id)`
`float`	`readFloat()`
`float`	`readFloat(int id)`
`long`	`readInteger()`
`long`	`readInteger(int id)`
`long`	`readLong()`
`long`	`readLong(int id)`
`byte[]`	`readString()`
`byte[]`	`readString(int id)`
`Timestamp`	`readTimestamp()`
`Timestamp`	`readTimestamp(int id)`
`int`	`readValueDictionaryId()`
`byte[]`	`readVarchar()`
`byte[]`	`readVarchar(int id)`

- Method Detail
  - initFromPage
```
void initFromPage(int valueCount,
                  org.apache.parquet.bytes.ByteBufferInputStream in)
           throws IOException
```
    Initialize the reader by page data.
    
    Parameters:
    
    valueCount - value count
    
    in - page data
    
    Throws:
    
    IOException
  - readValueDictionaryId
```
int readValueDictionaryId()
```
    Returns:
    
    the next Dictionary ID from the page
  - readLong
```
long readLong()
```
    Returns:
    
    the next Long from the page
  - readInteger
```
long readInteger()
```
    Returns:
    
    the next Integer from the page Though the function is looking for an integer, it will return the value through long. The type of data saved as long can be changed to be int or smallint or tinyint. In that case the value returned to the user will depend on the data. If the data value is within the valid range accommodated by the read type, the data will be returned as is. When data is not within the valid range, a NULL will be returned. A long value saved in parquet files will be returned asis to facilitate the validity check. Also, the vectorized representation uses a LongColumnVector to store integer values.
  - readFloat
```
float readFloat()
```
    Returns:
    
    the next Float from the page
  - readBoolean
```
boolean readBoolean()
```
    Returns:
    
    the next Boolean from the page
  - readString
```
byte[] readString()
```
    Returns:
    
    the next String from the page
  - readVarchar
```
byte[] readVarchar()
```
    Returns:
    
    the next Varchar from the page
  - readChar
```
byte[] readChar()
```
    Returns:
    
    the next Char from the page
  - readBytes
```
byte[] readBytes()
```
    Returns:
    
    the next Bytes from the page
  - readDecimal
```
byte[] readDecimal()
```
    Returns:
    
    the next Decimal from the page
  - readDouble
```
double readDouble()
```
    Returns:
    
    the next Double from the page
  - readTimestamp
```
Timestamp readTimestamp()
```
    Returns:
    
    the next Timestamp from the page
  - isValid
```
boolean isValid(long value)
```
    Parameters:
    
    value - data to be checked for validity
    
    Returns:
    
    is data valid for the type The type of the data in Parquet files need not match the type in HMS. In that case the value returned to the user will depend on the data. If the data value is within the valid range accommodated by the HMS type, the data will be returned as is. When data is not within the valid range, a NULL will be returned. These functions will do the appropriate check.
  - isValid
```
boolean isValid(float value)
```
  - isValid
```
boolean isValid(double value)
```
  - getDictionary
```
org.apache.parquet.column.Dictionary getDictionary()
```
    Returns:
    
    the underlying dictionary if current reader is dictionary encoded
  - readBytes
```
byte[] readBytes(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Bytes from the dictionary by id
  - readFloat
```
float readFloat(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Float from the dictionary by id
  - readDouble
```
double readDouble(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Double from the dictionary by id
  - readInteger
```
long readInteger(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Integer from the dictionary by id Though the function is looking for an integer, it will return the value through long. The type of data saved as long can be changed to be int or smallint or tinyint. In that case the value returned to the user will depend on the data. If the data value is within the valid range accommodated by the read type, the data will be returned as is. When data is not within the valid range, a NULL will be returned. A long value saved in parquet files will be returned asis to facilitate the validity check. Also, the vectorized representation uses a LongColumnVector to store integer values.
  - readLong
```
long readLong(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Long from the dictionary by id
  - readBoolean
```
boolean readBoolean(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Boolean from the dictionary by id
  - readDecimal
```
byte[] readDecimal(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Decimal from the dictionary by id
  - readTimestamp
```
Timestamp readTimestamp(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Timestamp from the dictionary by id
  - readString
```
byte[] readString(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the String from the dictionary by id
  - readVarchar
```
byte[] readVarchar(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Varchar from the dictionary by id
  - readChar
```
byte[] readChar(int id)
```
    Parameters:
    
    id - in dictionary
    
    Returns:
    
    the Char from the dictionary by id

Interface ParquetDataColumnReader

Method Summary

Method Detail

initFromPage

readValueDictionaryId

readLong

readInteger

readFloat

readBoolean

readString

readVarchar

readChar

readBytes

readDecimal

readDouble

readTimestamp

isValid

isValid

isValid

getDictionary

readBytes

readFloat

readDouble

readInteger

readLong

readBoolean

readDecimal

readTimestamp

readString

readVarchar

readChar