Module org.elasticsearch.server
Package org.elasticsearch.action.search

Record Class SearchPhaseController.SortedTopDocs

java.lang.Object
java.lang.Record
org.elasticsearch.action.search.SearchPhaseController.SortedTopDocs
Enclosing class:
SearchPhaseController
public static record SearchPhaseController.SortedTopDocs(org.apache.lucene.search.ScoreDoc[] scoreDocs, boolean isSortedByField, org.apache.lucene.search.SortField[] sortFields, String collapseField, Object[] collapseValues, int numberOfCompletionsSuggestions) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SearchPhaseController.SortedTopDocs
    EMPTY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SortedTopDocs(org.apache.lucene.search.ScoreDoc[] scoreDocs, boolean isSortedByField, org.apache.lucene.search.SortField[] sortFields, String collapseField, Object[] collapseValues, int numberOfCompletionsSuggestions)
    Creates an instance of a SortedTopDocs record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    collapseField()
    Returns the value of the collapseField record component.
    Object[]
    collapseValues()
    Returns the value of the collapseValues record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isSortedByField()
    Returns the value of the isSortedByField record component.
    int
    numberOfCompletionsSuggestions()
    Returns the value of the numberOfCompletionsSuggestions record component.
    org.apache.lucene.search.ScoreDoc[]
    scoreDocs()
    Returns the value of the scoreDocs record component.
    org.apache.lucene.search.SortField[]
    sortFields()
    Returns the value of the sortFields 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

  • Field Details

  • Constructor Details

    • SortedTopDocs

      public SortedTopDocs(org.apache.lucene.search.ScoreDoc[] scoreDocs, boolean isSortedByField, org.apache.lucene.search.SortField[] sortFields, String collapseField, Object[] collapseValues, int numberOfCompletionsSuggestions)
      Creates an instance of a SortedTopDocs record class.
      Parameters:
      scoreDocs - the value for the scoreDocs record component
      isSortedByField - the value for the isSortedByField record component
      sortFields - the value for the sortFields record component
      collapseField - the value for the collapseField record component
      collapseValues - the value for the collapseValues record component
      numberOfCompletionsSuggestions - the value for the numberOfCompletionsSuggestions 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. 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.

    • scoreDocs

      public org.apache.lucene.search.ScoreDoc[] scoreDocs()
      Returns the value of the scoreDocs record component.
      Returns:
      the value of the scoreDocs record component

    • isSortedByField

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

    • sortFields

      public org.apache.lucene.search.SortField[] sortFields()
      Returns the value of the sortFields record component.
      Returns:
      the value of the sortFields record component

    • collapseField

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

    • collapseValues

      public Object[] collapseValues()
      Returns the value of the collapseValues record component.
      Returns:
      the value of the collapseValues record component

    • numberOfCompletionsSuggestions

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