Module org.elasticsearch.compute
Package org.elasticsearch.compute.aggregation.blockhash

Record Class BlockHash.SortKey

java.lang.Object
java.lang.Record
org.elasticsearch.compute.aggregation.blockhash.BlockHash.SortKey
Record Components:
groupingIndex - index of the corresponding entry in the GroupSpec list (0 = first grouping key)
asc - true if this key sorts ascending, false for descending
nullsFirst - true if nulls sort before non-null values
Enclosing class:
BlockHash
public static record BlockHash.SortKey(int groupingIndex, boolean asc, boolean nullsFirst) extends Record
A single sort key entry in a composite BlockHash.TopNDef.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SortKey(int groupingIndex, boolean asc, boolean nullsFirst)
    Creates an instance of a SortKey record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    asc()
    Returns the value of the asc record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    groupingIndex()
    Returns the value of the groupingIndex record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    nullsFirst()
    Returns the value of the nullsFirst record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SortKey

      public SortKey(int groupingIndex, boolean asc, boolean nullsFirst)
      Creates an instance of a SortKey record class.
      Parameters:
      groupingIndex - the value for the groupingIndex record component
      asc - the value for the asc record component
      nullsFirst - the value for the nullsFirst record component

  • Method Details

    • 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 '=='.
      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.

    • groupingIndex

      public int groupingIndex()
      Returns the value of the groupingIndex record component.
      Returns:
      the value of the groupingIndex record component

    • asc

      public boolean asc()
      Returns the value of the asc record component.
      Returns:
      the value of the asc record component

    • nullsFirst

      public boolean nullsFirst()
      Returns the value of the nullsFirst record component.
      Returns:
      the value of the nullsFirst record component