org.apache.parquet.hadoop.metadata

Class ColumnChunkMetaData

java.lang.Object

org.apache.parquet.hadoop.metadata.ColumnChunkMetaData

public abstract class ColumnChunkMetaData
extends Object

Column meta data for a block stored in the file footer and passed in the InputSplit

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnChunkMetaData(ColumnChunkProperties columnChunkProperties)
protected	ColumnChunkMetaData(EncodingStats encodingStats, ColumnChunkProperties columnChunkProperties)

Method Summary

Modifier and Type	Method and Description
static ColumnChunkMetaData	get(org.apache.parquet.hadoop.metadata.ColumnPath path, PrimitiveType.PrimitiveTypeName type, org.apache.parquet.hadoop.metadata.CompressionCodecName codec, EncodingStats encodingStats, Set<Encoding> encodings, Statistics statistics, long firstDataPage, long dictionaryPageOffset, long valueCount, long totalSize, long totalUncompressedSize) Deprecated. will be removed in 2.0.0. Use get(ColumnPath, PrimitiveType, CompressionCodecName, EncodingStats, Set, Statistics, long, long, long, long, long) instead.
static ColumnChunkMetaData	get(org.apache.parquet.hadoop.metadata.ColumnPath path, PrimitiveType.PrimitiveTypeName type, org.apache.parquet.hadoop.metadata.CompressionCodecName codec, Set<Encoding> encodings, long firstDataPage, long dictionaryPageOffset, long valueCount, long totalSize, long totalUncompressedSize) Deprecated.
static ColumnChunkMetaData	get(org.apache.parquet.hadoop.metadata.ColumnPath path, PrimitiveType.PrimitiveTypeName type, org.apache.parquet.hadoop.metadata.CompressionCodecName codec, Set<Encoding> encodings, Statistics statistics, long firstDataPage, long dictionaryPageOffset, long valueCount, long totalSize, long totalUncompressedSize) Deprecated.
static ColumnChunkMetaData	get(org.apache.parquet.hadoop.metadata.ColumnPath path, PrimitiveType type, org.apache.parquet.hadoop.metadata.CompressionCodecName codec, EncodingStats encodingStats, Set<Encoding> encodings, Statistics statistics, long firstDataPage, long dictionaryPageOffset, long valueCount, long totalSize, long totalUncompressedSize)
org.apache.parquet.hadoop.metadata.CompressionCodecName	getCodec()
abstract long	getDictionaryPageOffset()
Set<Encoding>	getEncodings()
EncodingStats	getEncodingStats()
abstract long	getFirstDataPageOffset()
org.apache.parquet.hadoop.metadata.ColumnPath	getPath() Deprecated. will be removed in 2.0.0. Use getPrimitiveType() instead.
PrimitiveType	getPrimitiveType()
long	getStartingPos()
abstract Statistics	getStatistics()
abstract long	getTotalSize()
abstract long	getTotalUncompressedSize()
PrimitiveType.PrimitiveTypeName	getType() Deprecated. will be removed in 2.0.0. Use getPrimitiveType() instead.
abstract long	getValueCount()
protected static boolean	positiveLongFitsInAnInt(long value) checks that a positive long value fits in an int.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnChunkMetaData

protected ColumnChunkMetaData(ColumnChunkProperties columnChunkProperties)

ColumnChunkMetaData

protected ColumnChunkMetaData(EncodingStats encodingStats,
                              ColumnChunkProperties columnChunkProperties)

Method Detail

get

@Deprecated
public static ColumnChunkMetaData get(org.apache.parquet.hadoop.metadata.ColumnPath path,
                                                  PrimitiveType.PrimitiveTypeName type,
                                                  org.apache.parquet.hadoop.metadata.CompressionCodecName codec,
                                                  Set<Encoding> encodings,
                                                  long firstDataPage,
                                                  long dictionaryPageOffset,
                                                  long valueCount,
                                                  long totalSize,
                                                  long totalUncompressedSize)

Deprecated.

get

@Deprecated
public static ColumnChunkMetaData get(org.apache.parquet.hadoop.metadata.ColumnPath path,
                                                  PrimitiveType.PrimitiveTypeName type,
                                                  org.apache.parquet.hadoop.metadata.CompressionCodecName codec,
                                                  Set<Encoding> encodings,
                                                  Statistics statistics,
                                                  long firstDataPage,
                                                  long dictionaryPageOffset,
                                                  long valueCount,
                                                  long totalSize,
                                                  long totalUncompressedSize)

Deprecated.

get

@Deprecated
public static ColumnChunkMetaData get(org.apache.parquet.hadoop.metadata.ColumnPath path,
                                                  PrimitiveType.PrimitiveTypeName type,
                                                  org.apache.parquet.hadoop.metadata.CompressionCodecName codec,
                                                  EncodingStats encodingStats,
                                                  Set<Encoding> encodings,
                                                  Statistics statistics,
                                                  long firstDataPage,
                                                  long dictionaryPageOffset,
                                                  long valueCount,
                                                  long totalSize,
                                                  long totalUncompressedSize)

Deprecated. will be removed in 2.0.0. Use get(ColumnPath, PrimitiveType, CompressionCodecName, EncodingStats, Set, Statistics, long, long, long, long, long) instead.

Parameters:

path - the path of this column in the write schema

type - primitive type for this column

codec - the compression codec used to compress

encodingStats - EncodingStats for the encodings used in this column

encodings - a set of encoding used in this column

statistics - statistics for the data in this column

firstDataPage - offset of the first non-dictionary page

dictionaryPageOffset - offset of the the dictionary page

valueCount - number of values

totalSize - total compressed size

totalUncompressedSize - uncompressed data size

Returns:

a column chunk metadata instance

get

public static ColumnChunkMetaData get(org.apache.parquet.hadoop.metadata.ColumnPath path,
                                      PrimitiveType type,
                                      org.apache.parquet.hadoop.metadata.CompressionCodecName codec,
                                      EncodingStats encodingStats,
                                      Set<Encoding> encodings,
                                      Statistics statistics,
                                      long firstDataPage,
                                      long dictionaryPageOffset,
                                      long valueCount,
                                      long totalSize,
                                      long totalUncompressedSize)

getStartingPos

public long getStartingPos()

Returns:

the offset of the first byte in the chunk

positiveLongFitsInAnInt

protected static boolean positiveLongFitsInAnInt(long value)

checks that a positive long value fits in an int. (reindexed on Integer.MIN_VALUE)

Parameters:

value - a long value

Returns:

whether it fits

getCodec

public org.apache.parquet.hadoop.metadata.CompressionCodecName getCodec()

getPath

@Deprecated
public org.apache.parquet.hadoop.metadata.ColumnPath getPath()

Deprecated. will be removed in 2.0.0. Use getPrimitiveType() instead.

Returns:

column identifier

getType

@Deprecated
public PrimitiveType.PrimitiveTypeName getType()

Deprecated. will be removed in 2.0.0. Use getPrimitiveType() instead.

Returns:

type of the column

getPrimitiveType

public PrimitiveType getPrimitiveType()

Returns:

the primitive type object of the column

getFirstDataPageOffset

public abstract long getFirstDataPageOffset()

Returns:

start of the column data offset

getDictionaryPageOffset

public abstract long getDictionaryPageOffset()

Returns:

the location of the dictionary page if any

getValueCount

public abstract long getValueCount()

Returns:

count of values in this block of the column

getTotalUncompressedSize

public abstract long getTotalUncompressedSize()

Returns:

the totalUncompressedSize

getTotalSize

public abstract long getTotalSize()

Returns:

the totalSize

getStatistics

public abstract Statistics getStatistics()

Returns:

the stats for this column

getEncodings

public Set<Encoding> getEncodings()

Returns:

all the encodings used in this column

getEncodingStats

public EncodingStats getEncodingStats()

toString

public String toString()

Overrides:

toString in class Object