Record Class BlockHash.TopNDef

java.lang.Object
java.lang.Record
org.elasticsearch.compute.aggregation.blockhash.BlockHash.TopNDef
Record Components:
order - The order of this group in the sort, starting at 0
asc - True if this group will be sorted ascending. False if descending.
nullsFirst - True if the nulls should be the first elements in the TopN. False if they should be kept last.
limit - The number of elements to keep, including nulls.
Enclosing class:
BlockHash

public static record BlockHash.TopNDef(int order, boolean asc, boolean nullsFirst, int limit) extends Record
Configuration for a BlockHash group spec that is later sorted and limited (Top-N).

Part of a performance improvement to avoid aggregating groups that will not be used.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TopNDef(int order, boolean asc, boolean nullsFirst, int limit)
    Creates an instance of a TopNDef record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    asc()
    Returns the value of the asc record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the limit record component.
    boolean
    Returns the value of the nullsFirst record component.
    int
    Returns the value of the order record component.
    final String
    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

    • TopNDef

      public TopNDef(int order, boolean asc, boolean nullsFirst, int limit)
      Creates an instance of a TopNDef record class.
      Parameters:
      order - the value for the order record component
      asc - the value for the asc record component
      nullsFirst - the value for the nullsFirst record component
      limit - the value for the limit 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.
    • order

      public int order()
      Returns the value of the order record component.
      Returns:
      the value of the order 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
    • limit

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