Record Class SchemaElement

java.lang.Object
java.lang.Record
dev.hardwood.metadata.SchemaElement
Record Components:
name - column or group name
type - physical type of this element, or null for group nodes
typeLength - byte length of the values for PhysicalType.FIXED_LEN_BYTE_ARRAY; for any other physical type, it denotes the maximum bit length used to store a value; or, null otherwise
repetitionType - repetition level (required, optional, or repeated)
numChildren - number of child elements for group nodes, or null for primitive nodes
convertedType - legacy converted type annotation, or null if absent
scale - decimal scale (number of digits after the decimal point), or null if not a decimal
precision - decimal precision (total number of digits), or null if not a decimal
fieldId - Thrift field id from the schema, or null if absent
logicalType - logical type annotation, or null if absent
public record SchemaElement(String name, PhysicalType type, Integer typeLength, RepetitionType repetitionType, Integer numChildren, ConvertedType convertedType, Integer scale, Integer precision, Integer fieldId, LogicalType logicalType) extends Record
Schema element in Parquet file metadata.
See Also:

  • Constructor Details

  • Method Details

    • root

      public static SchemaElement root(String name, int numChildren)
      Creates a root group element, which carries no repetition.
      Parameters:
      name - group name; the root group is named "schema" by convention
      numChildren - number of child elements, zero or more
      Returns:
      the group element
      Throws:
      IllegalArgumentException - if numChildren is negative

    • group

      public static SchemaElement group(String name, RepetitionType repetitionType, int numChildren)
      Creates a group element.
      Parameters:
      name - group name
      repetitionType - repetition level; only the root element may omit it, via root(String, int)
      numChildren - number of child elements, zero or more
      Returns:
      the group element
      Throws:
      IllegalArgumentException - if repetitionType is null or numChildren is negative

    • group

      public static SchemaElement group(String name, RepetitionType repetitionType, int numChildren, LogicalType logicalType)
      Creates a group element.
      Parameters:
      name - group name
      repetitionType - repetition level; only the root element may omit it, via root(String, int)
      numChildren - number of child elements, zero or more
      logicalType - logical type annotation, or null for none
      Returns:
      the group element
      Throws:
      IllegalArgumentException - if repetitionType is null or numChildren is negative

    • primitive

      public static SchemaElement primitive(String name, PhysicalType type, RepetitionType repetitionType)
      Creates a primitive element
      Parameters:
      name - column name
      type - physical type
      repetitionType - repetition level
      Returns:
      the primitive element
      Throws:
      IllegalArgumentException - if repetitionType is null, or type is null or is PhysicalType.FIXED_LEN_BYTE_ARRAY, which needs a width

    • primitive

      public static SchemaElement primitive(String name, PhysicalType type, RepetitionType repetitionType, LogicalType logicalType)
      Creates a primitive element.
      Parameters:
      name - column name
      type - physical type
      repetitionType - repetition level
      logicalType - nullable logical type annotation
      Returns:
      the primitive element
      Throws:
      IllegalArgumentException - if repetitionType is null, or type is null or is PhysicalType.FIXED_LEN_BYTE_ARRAY, which needs a width

    • fixedLengthPrimitive

      public static SchemaElement fixedLengthPrimitive(String name, int typeLength, RepetitionType repetitionType)
      Creates a PhysicalType.FIXED_LEN_BYTE_ARRAY element.
      Parameters:
      name - column name
      typeLength - fixed byte length: must be positive
      repetitionType - repetition level
      Returns:
      the fixed-length primitive element
      Throws:
      IllegalArgumentException - if repetitionType is null or typeLength is not positive

    • fixedLengthPrimitive

      public static SchemaElement fixedLengthPrimitive(String name, int typeLength, RepetitionType repetitionType, LogicalType logicalType)
      Creates a PhysicalType.FIXED_LEN_BYTE_ARRAY element.
      Parameters:
      name - column name
      typeLength - fixed byte length: must be positive
      repetitionType - repetition level
      logicalType - nullable logical type annotation
      Returns:
      the fixed-length primitive element
      Throws:
      IllegalArgumentException - if repetitionType is null or typeLength is not positive

    • isGroup

      public boolean isGroup()
      Returns true if this element is a group node (has no physical type).

    • isPrimitive

      public boolean isPrimitive()
      Returns true if this element is a primitive node (has a physical type).

    • toString

      public final 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • type

      public PhysicalType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • typeLength

      public Integer typeLength()
      Returns the value of the typeLength record component.
      Returns:
      the value of the typeLength record component

    • repetitionType

      public RepetitionType repetitionType()
      Returns the value of the repetitionType record component.
      Returns:
      the value of the repetitionType record component

    • numChildren

      public Integer numChildren()
      Returns the value of the numChildren record component.
      Returns:
      the value of the numChildren record component

    • convertedType

      public ConvertedType convertedType()
      Returns the value of the convertedType record component.
      Returns:
      the value of the convertedType record component

    • scale

      public Integer scale()
      Returns the value of the scale record component.
      Returns:
      the value of the scale record component

    • precision

      public Integer precision()
      Returns the value of the precision record component.
      Returns:
      the value of the precision record component

    • fieldId

      public Integer fieldId()
      Returns the value of the fieldId record component.
      Returns:
      the value of the fieldId record component

    • logicalType

      public LogicalType logicalType()
      Returns the value of the logicalType record component.
      Returns:
      the value of the logicalType record component