hydra.langs.parquet.format.SchemaElement Maven / Gradle / Ivy

Go to download
package hydra.langs.parquet.format;

import java.io.Serializable;

/**
 * Represents a element inside a schema definition.
 * - if it is a group (inner node) then type is undefined and num_children is defined
 * - if it is a primitive type (leaf) then type is defined and num_children is undefined
 * the nodes are listed in depth first traversal order.
 */
public class SchemaElement implements Serializable {
  public static final hydra.core.Name NAME = new hydra.core.Name("hydra/langs/parquet/format.SchemaElement");
  
  /**
   * Data type for this field. Not set if the current element is a non-leaf node
   */
  public final java.util.Optional type;
  
  /**
   * If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the values. Otherwise, if specified, this is the maximum bit length to store any of the values. (e.g. a low cardinality INT col could have this set to 3).  Note that this is in the schema, and therefore fixed for the entire file.
   */
  public final java.util.Optional typeLength;
  
  /**
   * repetition of the field. The root of the schema does not have a repetition_type. All other nodes must have one
   */
  public final java.util.Optional repetitionType;
  
  /**
   * Name of the field in the schema
   */
  public final String name;
  
  /**
   * Nested fields.  Since thrift does not support nested fields, the nesting is flattened to a single list by a depth-first traversal. The children count is used to construct the nested relationship. This field is not set when the element is a primitive type
   */
  public final java.util.Optional numChildren;
  
  /**
   * When the original schema supports field ids, this will save the original field id in the parquet schema
   */
  public final java.util.Optional fieldId;
  
  /**
   * The logical type of this SchemaElement. LogicalType replaces ConvertedType, but ConvertedType is still required for some logical types to ensure forward-compatibility in format v1.
   */
  public final java.util.Optional logicalType;
  
  public SchemaElement (java.util.Optional type, java.util.Optional typeLength, java.util.Optional repetitionType, String name, java.util.Optional numChildren, java.util.Optional fieldId, java.util.Optional logicalType) {
    this.type = type;
    this.typeLength = typeLength;
    this.repetitionType = repetitionType;
    this.name = name;
    this.numChildren = numChildren;
    this.fieldId = fieldId;
    this.logicalType = logicalType;
  }
  
  @Override
  public boolean equals(Object other) {
    if (!(other instanceof SchemaElement)) {
      return false;
    }
    SchemaElement o = (SchemaElement) (other);
    return type.equals(o.type) && typeLength.equals(o.typeLength) && repetitionType.equals(o.repetitionType) && name.equals(o.name) && numChildren.equals(o.numChildren) && fieldId.equals(o.fieldId) && logicalType.equals(o.logicalType);
  }
  
  @Override
  public int hashCode() {
    return 2 * type.hashCode() + 3 * typeLength.hashCode() + 5 * repetitionType.hashCode() + 7 * name.hashCode() + 11 * numChildren.hashCode() + 13 * fieldId.hashCode() + 17 * logicalType.hashCode();
  }
  
  public SchemaElement withType(java.util.Optional type) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withTypeLength(java.util.Optional typeLength) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withRepetitionType(java.util.Optional repetitionType) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withName(String name) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withNumChildren(java.util.Optional numChildren) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withFieldId(java.util.Optional fieldId) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
  
  public SchemaElement withLogicalType(java.util.Optional logicalType) {
    return new SchemaElement(type, typeLength, repetitionType, name, numChildren, fieldId, logicalType);
  }
}