Record Class ColumnSchema

java.lang.Object

java.lang.Record

dev.hardwood.schema.ColumnSchema

Record Components:

fieldPath - path from the schema root to this leaf column (unambiguous across schemas with duplicate leaf names)

type - physical (storage) type of the column

repetitionType - whether the column is required, optional, or repeated

typeLength - fixed byte length for PhysicalType.FIXED_LEN_BYTE_ARRAY columns, or null otherwise

columnIndex - zero-based index of this column among all leaf columns in the schema

maxDefinitionLevel - maximum definition level, computed from the schema hierarchy

maxRepetitionLevel - maximum repetition level, computed from the schema hierarchy

logicalType - logical type annotation, or null if absent

public record ColumnSchema(FieldPath fieldPath, PhysicalType type, RepetitionType repetitionType, Integer typeLength, int columnIndex, int maxDefinitionLevel, int maxRepetitionLevel, LogicalType logicalType)
extends Record

Represents a primitive column in a Parquet schema. Stores computed definition and repetition levels based on schema hierarchy.

See Also:

• File Format – Nested Encoding
• parquet.thrift

Constructor Summary

Constructors

Constructor	Description
ColumnSchema(FieldPath fieldPath, PhysicalType type, RepetitionType repetitionType, Integer typeLength, int columnIndex, int maxDefinitionLevel, int maxRepetitionLevel, LogicalType logicalType)	Creates an instance of a ColumnSchema record class.

Method Summary

Modifier and Type	Method	Description
int	columnIndex()	Returns the value of the columnIndex record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FieldPath	fieldPath()	Returns the value of the fieldPath record component.
final int	hashCode()	Returns a hash code value for this object.
LogicalType	logicalType()	Returns the value of the logicalType record component.
int	maxDefinitionLevel()	Returns the value of the maxDefinitionLevel record component.
int	maxRepetitionLevel()	Returns the value of the maxRepetitionLevel record component.
String	name()	Returns the leaf (last) element of the field path, i.e. the column name.
RepetitionType	repetitionType()	Returns the value of the repetitionType record component.
String	toString()	Returns a string representation of this record class.
PhysicalType	type()	Returns the value of the type record component.
Integer	typeLength()	Returns the value of the typeLength record component.

Methods inherited from class Object

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

Constructor Details

ColumnSchema

public ColumnSchema(FieldPath fieldPath,
 PhysicalType type,
 RepetitionType repetitionType,
 Integer typeLength,
 int columnIndex,
 int maxDefinitionLevel,
 int maxRepetitionLevel,
 LogicalType logicalType)

Creates an instance of a ColumnSchema record class.

Parameters:

fieldPath - the value for the fieldPath record component

type - the value for the type record component

repetitionType - the value for the repetitionType record component

typeLength - the value for the typeLength record component

columnIndex - the value for the columnIndex record component

maxDefinitionLevel - the value for the maxDefinitionLevel record component

maxRepetitionLevel - the value for the maxRepetitionLevel record component

logicalType - the value for the logicalType record component

Method Details

name

public String name()

Returns the leaf (last) element of the field path, i.e. the column name.

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fieldPath

public FieldPath fieldPath()

Returns the value of the fieldPath record component.

Returns:

the value of the fieldPath record component

type

public PhysicalType type()

Returns the value of the type record component.

Returns:

the value of the type record component

repetitionType

public RepetitionType repetitionType()

Returns the value of the repetitionType record component.

Returns:

the value of the repetitionType record component

typeLength

public Integer typeLength()

Returns the value of the typeLength record component.

Returns:

the value of the typeLength record component

columnIndex

public int columnIndex()

Returns the value of the columnIndex record component.

Returns:

the value of the columnIndex record component

maxDefinitionLevel

public int maxDefinitionLevel()

Returns the value of the maxDefinitionLevel record component.

Returns:

the value of the maxDefinitionLevel record component

maxRepetitionLevel

public int maxRepetitionLevel()

Returns the value of the maxRepetitionLevel record component.

Returns:

the value of the maxRepetitionLevel record component

logicalType

public LogicalType logicalType()

Returns the value of the logicalType record component.

Returns:

the value of the logicalType record component