org.apache.parquet.column

Class ColumnDescriptor

java.lang.Object

org.apache.parquet.column.ColumnDescriptor

All Implemented Interfaces:

Comparable<ColumnDescriptor>

public class ColumnDescriptor
extends Object
implements Comparable<ColumnDescriptor>

Describes a column's type as well as its position in its containing schema.

Constructor Summary

Constructors

Constructor and Description
ColumnDescriptor(String[] path, PrimitiveType.PrimitiveTypeName type, int maxRep, int maxDef) Deprecated. will be removed in 2.0.0; Use ColumnDescriptor(String[], PrimitiveType, int, int)
ColumnDescriptor(String[] path, PrimitiveType.PrimitiveTypeName type, int typeLength, int maxRep, int maxDef) Deprecated. will be removed in 2.0.0; Use ColumnDescriptor(String[], PrimitiveType, int, int)
ColumnDescriptor(String[] path, PrimitiveType type, int maxRep, int maxDef)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ColumnDescriptor o)
boolean	equals(Object other)
int	getMaxDefinitionLevel()
int	getMaxRepetitionLevel()
String[]	getPath()
PrimitiveType	getPrimitiveType()
PrimitiveType.PrimitiveTypeName	getType() Deprecated. will removed in 2.0.0. Use getPrimitiveType() instead.
int	getTypeLength() Deprecated. will removed in 2.0.0. Use getPrimitiveType() instead.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnDescriptor

@Deprecated
public ColumnDescriptor(String[] path,
                                    PrimitiveType.PrimitiveTypeName type,
                                    int maxRep,
                                    int maxDef)

Deprecated. will be removed in 2.0.0; Use ColumnDescriptor(String[], PrimitiveType, int, int)

Parameters:

path - the path to the leaf field in the schema

type - the type of the field

maxRep - the maximum repetition level for that path

maxDef - the maximum definition level for that path

ColumnDescriptor

@Deprecated
public ColumnDescriptor(String[] path,
                                    PrimitiveType.PrimitiveTypeName type,
                                    int typeLength,
                                    int maxRep,
                                    int maxDef)

Deprecated. will be removed in 2.0.0; Use ColumnDescriptor(String[], PrimitiveType, int, int)

Parameters:

path - the path to the leaf field in the schema

type - the type of the field

typeLength - the length of the type, if type is a fixed-length byte array

maxRep - the maximum repetition level for that path

maxDef - the maximum definition level for that path

ColumnDescriptor

public ColumnDescriptor(String[] path,
                        PrimitiveType type,
                        int maxRep,
                        int maxDef)

Parameters:

path - the path to the leaf field in the schema

type - the type of the field

maxRep - the maximum repetition level for that path

maxDef - the maximum definition level for that path

Method Detail

getPath

public String[] getPath()

Returns:

the path to the leaf field in the schema

getMaxRepetitionLevel

public int getMaxRepetitionLevel()

Returns:

the maximum repetition level for that path

getMaxDefinitionLevel

public int getMaxDefinitionLevel()

Returns:

the maximum definition level for that path

getType

@Deprecated
public PrimitiveType.PrimitiveTypeName getType()

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

Returns:

the type of that column

getTypeLength

@Deprecated
public int getTypeLength()

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

Returns:

the size of the type

getPrimitiveType

public PrimitiveType getPrimitiveType()

Returns:

the primitive type object of the column

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

compareTo

public int compareTo(ColumnDescriptor o)

Specified by:

compareTo in interface Comparable<ColumnDescriptor>

toString

public String toString()

Overrides:

toString in class Object