Module org.apache.lucene.core

Package org.apache.lucene.search

Class TopScoreDocCollector

java.lang.Object

org.apache.lucene.search.TopDocsCollector<ScoreDoc>

org.apache.lucene.search.TopScoreDocCollector

All Implemented Interfaces:

Collector

Direct Known Subclasses:

TopScoreDocCollector.PagingTopScoreDocCollector, TopScoreDocCollector.SimpleTopScoreDocCollector

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TopScoreDocCollector.PagingTopScoreDocCollector
static class	TopScoreDocCollector.ScorerLeafCollector	Scorable leaf collector
private static class	TopScoreDocCollector.SimpleTopScoreDocCollector

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	docBase
(package private) final HitsThresholdChecker	hitsThresholdChecker
(package private) float	minCompetitiveScore
(package private) final MaxScoreAccumulator	minScoreAcc
(package private) ScoreDoc	pqTop

Fields inherited from class org.apache.lucene.search.TopDocsCollector

EMPTY_TOPDOCS, pq, totalHits, totalHitsRelation

Constructor Summary

Constructors

Constructor	Description
TopScoreDocCollector(int numHits, HitsThresholdChecker hitsThresholdChecker, MaxScoreAccumulator minScoreAcc)

Method Summary

Modifier and Type	Method	Description
static TopScoreDocCollector	create(int numHits, int totalHitsThreshold)	Creates a new TopScoreDocCollector given the number of hits to collect and the number of hits to count accurately.
static TopScoreDocCollector	create(int numHits, ScoreDoc after, int totalHitsThreshold)	Creates a new TopScoreDocCollector given the number of hits to collect, the bottom of the previous page, and the number of hits to count accurately.
(package private) static TopScoreDocCollector	create(int numHits, ScoreDoc after, HitsThresholdChecker hitsThresholdChecker, MaxScoreAccumulator minScoreAcc)
static CollectorManager<TopScoreDocCollector,TopDocs>	createSharedManager(int numHits, ScoreDoc after, int totalHitsThreshold)	Create a CollectorManager which uses a shared hit counter to maintain number of hits and a shared MaxScoreAccumulator to propagate the minimum score accross segments
protected TopDocs	newTopDocs(ScoreDoc[] results, int start)	Returns a TopDocs instance containing the given results.
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
protected void	updateGlobalMinCompetitiveScore(Scorable scorer)
protected void	updateMinCompetitiveScore(Scorable scorer)

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

getTotalHits, populateResults, topDocs, topDocs, topDocs, topDocsSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.search.Collector

getLeafCollector, setWeight

Field Details

docBase

int docBase

pqTop

ScoreDoc pqTop

hitsThresholdChecker

final HitsThresholdChecker hitsThresholdChecker

minScoreAcc

final MaxScoreAccumulator minScoreAcc

minCompetitiveScore

float minCompetitiveScore

Constructor Details

TopScoreDocCollector

TopScoreDocCollector(int numHits,
 HitsThresholdChecker hitsThresholdChecker,
 MaxScoreAccumulator minScoreAcc)

Method Details

create

public static TopScoreDocCollector create(int numHits,
 int totalHitsThreshold)

Creates a new TopScoreDocCollector given the number of hits to collect and the number of hits to count accurately.

NOTE: If the total hit count of the top docs is less than or exactly totalHitsThreshold then this value is accurate. On the other hand, if the TopDocs.totalHits value is greater than totalHitsThreshold then its value is a lower bound of the hit count. A value of Integer.MAX_VALUE will make the hit count accurate but will also likely make query processing slower.

NOTE: The instances returned by this method pre-allocate a full array of length numHits, and fill the array with sentinel objects.

create

public static TopScoreDocCollector create(int numHits,
 ScoreDoc after,
 int totalHitsThreshold)

Creates a new TopScoreDocCollector given the number of hits to collect, the bottom of the previous page, and the number of hits to count accurately.

NOTE: If the total hit count of the top docs is less than or exactly totalHitsThreshold then this value is accurate. On the other hand, if the TopDocs.totalHits value is greater than totalHitsThreshold then its value is a lower bound of the hit count. A value of Integer.MAX_VALUE will make the hit count accurate but will also likely make query processing slower.

NOTE: The instances returned by this method pre-allocate a full array of length numHits, and fill the array with sentinel objects.

create

static TopScoreDocCollector create(int numHits,
 ScoreDoc after,
 HitsThresholdChecker hitsThresholdChecker,
 MaxScoreAccumulator minScoreAcc)

createSharedManager

public static CollectorManager<TopScoreDocCollector,TopDocs> createSharedManager(int numHits,
 ScoreDoc after,
 int totalHitsThreshold)

Create a CollectorManager which uses a shared hit counter to maintain number of hits and a shared MaxScoreAccumulator to propagate the minimum score accross segments

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