Package org.elasticsearch.action.search
Class MaxScoreCollector
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- org.elasticsearch.action.search.MaxScoreCollector
-
- All Implemented Interfaces:
Collector,LeafCollector
public class MaxScoreCollector extends SimpleCollector
A collector that computes the maximum score.
-
-
Constructor Summary
Constructors Constructor Description MaxScoreCollector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcollect(int doc)Called once for every document matching a query, with the unbased document number.floatgetMaxScore()Get the maximum score.ScoreModescoreMode()Indicates what features are required from the scorer.voidsetScorer(Scorable scorer)Called before successive calls toLeafCollector.collect(int).-
Methods inherited from class org.apache.lucene.search.SimpleCollector
doSetNextReader, getLeafCollector
-
-
-
-
Method Detail
-
setScorer
public void setScorer(Scorable scorer)
Description copied from interface:LeafCollectorCalled before successive calls toLeafCollector.collect(int). Implementations that need the score of the current document (passed-in toLeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.- Specified by:
setScorerin interfaceLeafCollector- Overrides:
setScorerin classSimpleCollector
-
scoreMode
public ScoreMode scoreMode()
Description copied from interface:CollectorIndicates what features are required from the scorer.
-
collect
public void collect(int doc) throws IOExceptionDescription copied from interface:LeafCollectorCalled once for every document matching a query, with the unbased document number.Note: The collection of the current segment can be terminated by throwing a
CollectionTerminatedException. In this case, the last docs of the currentLeafReaderContextwill be skipped andIndexSearcherwill swallow the exception and continue collection with the next leaf.Note: This is called in an inner search loop. For good search performance, implementations of this method should not call
IndexSearcher.doc(int)orIndexReader.document(int)on every hit. Doing so can slow searches by an order of magnitude or more.- Specified by:
collectin interfaceLeafCollector- Specified by:
collectin classSimpleCollector- Throws:
IOException
-
getMaxScore
public float getMaxScore()
Get the maximum score. This returnsFloat.NaNif no hits were collected.
-
-