Class TopScoreDocCollector

java.lang.Object
org.apache.lucene.search.TopDocsCollector<ScoreDoc>
org.apache.lucene.search.TopScoreDocCollector
All Implemented Interfaces:
Collector

public abstract class TopScoreDocCollector extends TopDocsCollector<ScoreDoc>
A Collector implementation that collects the top-scoring hits, returning them as a TopDocs. This is used by IndexSearcher to implement TopDocs-based search. Hits are sorted by score descending and then (when the scores are tied) docID ascending. When you create an instance of this collector you should know in advance whether documents are going to be collected in doc Id order or not.

NOTE: The values Float.NaN and Float.NEGATIVE_INFINITY are not valid scores. This collector will not properly collect hits with such scores.

  • Method Details

    • newTopDocs

      protected TopDocs newTopDocs(ScoreDoc[] results, int start)
      Description copied from class: TopDocsCollector
      Returns a TopDocs instance containing the given results. If results is null it means there are no results to return, either because there were 0 calls to collect() or because the arguments to topDocs were invalid.
      Overrides:
      newTopDocs in class TopDocsCollector<ScoreDoc>
    • scoreMode

      public ScoreMode scoreMode()
      Description copied from interface: Collector
      Indicates what features are required from the scorer.
    • updateGlobalMinCompetitiveScore

      protected void updateGlobalMinCompetitiveScore(Scorable scorer) throws IOException
      Throws:
      IOException
    • updateMinCompetitiveScore

      protected void updateMinCompetitiveScore(Scorable scorer) throws IOException
      Throws:
      IOException