Module org.apache.lucene.core

Package org.apache.lucene.search

Class TopFieldCollector

java.lang.Object

org.apache.lucene.search.TopDocsCollector<FieldValueHitQueue.Entry>

org.apache.lucene.search.TopFieldCollector

All Implemented Interfaces:

Collector

Direct Known Subclasses:

TopFieldCollector.PagingFieldCollector, TopFieldCollector.SimpleFieldCollector

public abstract class TopFieldCollector
extends TopDocsCollector<FieldValueHitQueue.Entry>

A Collector that sorts by SortField using FieldComparators.

See the constructor of TopFieldCollectorManager for instantiating a TopFieldCollectorManager with support for concurrency in IndexSearcher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	TopFieldCollector.PagingFieldCollector
(package private) static class	TopFieldCollector.SimpleFieldCollector
private class	TopFieldCollector.TopFieldLeafCollector

Field Summary

Fields

Modifier and Type	Field	Description
(package private) FieldValueHitQueue.Entry	bottom
(package private) final boolean	canSetMinScore
(package private) int	docBase
private static final ScoreDoc[]	EMPTY_SCOREDOCS
(package private) final FieldComparator<?>	firstComparator
(package private) float	minCompetitiveScore
(package private) final MaxScoreAccumulator	minScoreAcc
(package private) final boolean	needsScores
(package private) final int	numComparators
(package private) final int	numHits
(package private) boolean	queueFull
(package private) final ScoreMode	scoreMode
(package private) Boolean	searchSortPartOfIndexSort
(package private) final int	totalHitsThreshold

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

EMPTY_TOPDOCS, pq, totalHits, totalHitsRelation

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TopFieldCollector(FieldValueHitQueue<FieldValueHitQueue.Entry> pq, int numHits, int totalHitsThreshold, boolean needsScores, MaxScoreAccumulator minScoreAcc)

Method Summary

Modifier and Type	Method	Description
(package private) final void	add(int slot, int doc)
(package private) static boolean	canEarlyTerminate(Sort searchSort, Sort indexSort)
private static boolean	canEarlyTerminateOnDocId(Sort searchSort)
private static boolean	canEarlyTerminateOnPrefix(Sort searchSort, Sort indexSort)
boolean	isEarlyTerminated()	Return whether collection terminated early.
protected TopDocs	newTopDocs(ScoreDoc[] results, int start)	Returns a TopDocs instance containing the given results.
protected void	populateResults(ScoreDoc[] results, int howMany)	Populates the results array with the ScoreDoc instances.
static void	populateScores(ScoreDoc[] topDocs, IndexSearcher searcher, Query query)	Populate scores of the given topDocs.
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
TopFieldDocs	topDocs()	Returns the top docs that were collected by this collector.
(package private) final void	updateBottom(int doc)
protected void	updateGlobalMinCompetitiveScore(Scorable scorer)
protected void	updateMinCompetitiveScore(Scorable scorer)

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

getTotalHits, 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

EMPTY_SCOREDOCS

private static final ScoreDoc[] EMPTY_SCOREDOCS

numHits

final int numHits

totalHitsThreshold

final int totalHitsThreshold

firstComparator

final FieldComparator<?> firstComparator

canSetMinScore

final boolean canSetMinScore

searchSortPartOfIndexSort

Boolean searchSortPartOfIndexSort

minScoreAcc

final MaxScoreAccumulator minScoreAcc

minCompetitiveScore

float minCompetitiveScore

numComparators

final int numComparators

bottom

FieldValueHitQueue.Entry bottom

queueFull

boolean queueFull

docBase

int docBase

needsScores

final boolean needsScores

scoreMode

final ScoreMode scoreMode

Constructor Details

TopFieldCollector

private TopFieldCollector(FieldValueHitQueue<FieldValueHitQueue.Entry> pq,
 int numHits,
 int totalHitsThreshold,
 boolean needsScores,
 MaxScoreAccumulator minScoreAcc)

Method Details

canEarlyTerminate

static boolean canEarlyTerminate(Sort searchSort,
 Sort indexSort)

canEarlyTerminateOnDocId

private static boolean canEarlyTerminateOnDocId(Sort searchSort)

canEarlyTerminateOnPrefix

private static boolean canEarlyTerminateOnPrefix(Sort searchSort,
 Sort indexSort)

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

populateScores

public static void populateScores(ScoreDoc[] topDocs,
 IndexSearcher searcher,
 Query query)
                           throws IOException

Populate scores of the given topDocs.

Parameters:

topDocs - the top docs to populate

searcher - the index searcher that has been used to compute topDocs

query - the query that has been used to compute topDocs

Throws:

IllegalArgumentException - if there is evidence that topDocs have been computed against a different searcher or a different query.

IOException

add

final void add(int slot,
 int doc)

updateBottom

final void updateBottom(int doc)

populateResults

protected void populateResults(ScoreDoc[] results,
 int howMany)

Description copied from class: TopDocsCollector

Populates the results array with the ScoreDoc instances. This can be overridden in case a different ScoreDoc type should be returned.

Overrides:

populateResults in class TopDocsCollector<FieldValueHitQueue.Entry>

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<FieldValueHitQueue.Entry>

topDocs

public TopFieldDocs topDocs()

Description copied from class: TopDocsCollector

Returns the top docs that were collected by this collector.

Overrides:

topDocs in class TopDocsCollector<FieldValueHitQueue.Entry>

isEarlyTerminated

public boolean isEarlyTerminated()

Return whether collection terminated early.