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

Modifier and Type	Method	Description
void	collect(int doc)	Called once for every document matching a query, with the unbased document number.
float	getMaxScore()	Get the maximum score.
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
void	setScorer(Scorable scorer)	Called before successive calls to LeafCollector.collect(int).

Methods inherited from class org.apache.lucene.search.SimpleCollector

doSetNextReader, getLeafCollector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaxScoreCollector

public MaxScoreCollector()

Method Detail

setScorer

public void setScorer(Scorable scorer)

Description copied from interface: LeafCollector

Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in interface LeafCollector

Overrides:

setScorer in class SimpleCollector

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

collect

public void collect(int doc)
             throws IOException

Description copied from interface: LeafCollector

Called 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 current LeafReaderContext will be skipped and IndexSearcher will 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) or IndexReader.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in interface LeafCollector

Specified by:

collect in class SimpleCollector

Throws:

IOException

getMaxScore

public float getMaxScore()

Get the maximum score. This returns Float.NaN if no hits were collected.