Uses of Class
org.apache.lucene.search.TopDocs

Packages that use TopDocs

Package	Description
org.apache.lucene.search
org.apache.lucene.search.grouping
org.apache.lucene.search.suggest.document
org.apache.lucene.search.uhighlight
org.elasticsearch.common.lucene
org.elasticsearch.common.lucene.search
org.elasticsearch.search.rescore

Uses of TopDocs in org.apache.lucene.search

Subclasses of TopDocs in org.apache.lucene.search

Modifier and Type	Class	Description
class	TopFieldDocs	Represents hits returned by IndexSearcher.search(Query,int,Sort).

Fields in org.apache.lucene.search declared as TopDocs

Modifier and Type	Field	Description
protected static TopDocs	TopDocsCollector.EMPTY_TOPDOCS	This is used in case topDocs() is called with illegal parameters, or there simply aren't (enough) results.

Methods in org.apache.lucene.search that return TopDocs

Modifier and Type	Method	Description
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits, boolean setShardIndex)	Same as merge(int, TopDocs[]) but also ignores the top start top docs.
static TopDocs	TopDocs.merge(int topN, TopDocs[] shardHits)	Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
protected TopDocs	DiversifiedTopDocsCollector.newTopDocs(ScoreDoc[] results, int start)
protected TopDocs	TopDocsCollector.newTopDocs(ScoreDoc[] results, int start)	Returns a TopDocs instance containing the given results.
protected TopDocs	TopFieldCollector.newTopDocs(ScoreDoc[] results, int start)
protected TopDocs	TopScoreDocCollector.newTopDocs(ScoreDoc[] results, int start)
TopDocs	QueryRescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)
static TopDocs	QueryRescorer.rescore(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN)	Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScore
abstract TopDocs	Rescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)	Rescore an initial first-pass TopDocs.
TopDocs	IndexSearcher.search(Query query, int n)	Finds the top n hits for query.
TopDocs	IndexSearcher.searchAfter(ScoreDoc after, Query query, int numHits)	Finds the top n hits for query where all results are after a previous result (after).
TopDocs	IndexSearcher.searchAfter(ScoreDoc after, Query query, int n, Sort sort)	Finds the top n hits for query where all results are after a previous result (after).
TopDocs	TopDocsCollector.topDocs()	Returns the top docs that were collected by this collector.
TopDocs	TopDocsCollector.topDocs(int start)	Returns the documents in the range [start ..
TopDocs	TopDocsCollector.topDocs(int start, int howMany)	Returns the documents in the range [start ..

Methods in org.apache.lucene.search that return types with arguments of type TopDocs

Modifier and Type	Method	Description
static CollectorManager<TopScoreDocCollector,TopDocs>	TopScoreDocCollector.createSharedManager(int numHits, FieldDoc 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

Methods in org.apache.lucene.search with parameters of type TopDocs

Modifier and Type	Method	Description
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits, boolean setShardIndex)	Same as merge(int, TopDocs[]) but also ignores the top start top docs.
static TopDocs	TopDocs.merge(int topN, TopDocs[] shardHits)	Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
TopDocs	QueryRescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)
static TopDocs	QueryRescorer.rescore(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN)	Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScore
abstract TopDocs	Rescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)	Rescore an initial first-pass TopDocs.

Uses of TopDocs in org.apache.lucene.search.grouping

Subclasses of TopDocs in org.apache.lucene.search.grouping

Modifier and Type	Class	Description
class	CollapseTopFieldDocs	Represents hits returned by CollapsingTopDocsCollector.getTopDocs().

Uses of TopDocs in org.apache.lucene.search.suggest.document

Subclasses of TopDocs in org.apache.lucene.search.suggest.document

Modifier and Type	Class	Description
class	TopSuggestDocs	TopDocs wrapper with an additional CharSequence key per ScoreDoc

Uses of TopDocs in org.apache.lucene.search.uhighlight

Methods in org.apache.lucene.search.uhighlight with parameters of type TopDocs

Modifier and Type	Method	Description
String[]	UnifiedHighlighter.highlight(String field, Query query, TopDocs topDocs)	Highlights the top passages from a single field.
String[]	UnifiedHighlighter.highlight(String field, Query query, TopDocs topDocs, int maxPassages)	Highlights the top-N passages from a single field.
Map<String,String[]>	UnifiedHighlighter.highlightFields(String[] fields, Query query, TopDocs topDocs)	Highlights the top passages from multiple fields.
Map<String,String[]>	UnifiedHighlighter.highlightFields(String[] fields, Query query, TopDocs topDocs, int[] maxPassages)	Highlights the top-N passages from multiple fields.

Uses of TopDocs in org.elasticsearch.common.lucene

Fields in org.elasticsearch.common.lucene declared as TopDocs

Modifier and Type	Field	Description
static TopDocs	Lucene.EMPTY_TOP_DOCS

Uses of TopDocs in org.elasticsearch.common.lucene.search

Fields in org.elasticsearch.common.lucene.search declared as TopDocs

Modifier and Type	Field	Description
TopDocs	TopDocsAndMaxScore.topDocs

Constructors in org.elasticsearch.common.lucene.search with parameters of type TopDocs

Constructor	Description
TopDocsAndMaxScore(TopDocs topDocs, float maxScore)

Uses of TopDocs in org.elasticsearch.search.rescore

Methods in org.elasticsearch.search.rescore that return TopDocs

Modifier and Type	Method	Description
TopDocs	QueryRescorer.rescore(TopDocs topDocs, IndexSearcher searcher, RescoreContext rescoreContext)
TopDocs	Rescorer.rescore(TopDocs topDocs, IndexSearcher searcher, RescoreContext rescoreContext)	Modifies the result of the previously executed search (TopDocs) in place based on the given RescoreContext.

Methods in org.elasticsearch.search.rescore with parameters of type TopDocs

Modifier and Type	Method	Description
TopDocs	QueryRescorer.rescore(TopDocs topDocs, IndexSearcher searcher, RescoreContext rescoreContext)
TopDocs	Rescorer.rescore(TopDocs topDocs, IndexSearcher searcher, RescoreContext rescoreContext)	Modifies the result of the previously executed search (TopDocs) in place based on the given RescoreContext.