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

Record Class BlockHash.TopNDef

java.lang.Object
java.lang.Record
org.elasticsearch.compute.aggregation.blockhash.BlockHash.TopNDef
Record Components:
sortKeys - ordered list of sort specifications; index 0 is the primary (most significant) key
limit - the maximum number of groups to keep, including any null group
Enclosing class:
BlockHash
public static record BlockHash.TopNDef(List<BlockHash.SortKey> sortKeys, 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 Details

    • TopNDef

      public TopNDef(List<BlockHash.SortKey> sortKeys, int limit)
      Creates an instance of a TopNDef record class.
      Parameters:
      sortKeys - the value for the sortKeys record component
      limit - the value for the limit record component

  • Method Details

    • primaryKey

      public BlockHash.SortKey primaryKey()
      Returns the primary (most significant) sort key.

    • isSingleKey

      public boolean isSingleKey()
      True when only a single sort key is present.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • sortKeys

      public List<BlockHash.SortKey> sortKeys()
      Returns the value of the sortKeys record component.
      Returns:
      the value of the sortKeys record component

    • limit

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