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

Packages that use TopDocs

Package	Description
org.apache.lucene.classification	Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).
org.apache.lucene.classification.document	Uses already seen data (the indexed documents) to classify new documents.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.misc.search	Misc search implementations.
org.apache.lucene.sandbox.search	This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial queries.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.search.knn	Classes related to vector search: knn and vector fields.
org.apache.lucene.search.matchhighlight	This package contains several components useful to build a highlighter on top of the Matches API.
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.search.uhighlight	The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.
org.apache.lucene.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.

Uses of TopDocs in org.apache.lucene.classification

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

Modifier and Type	Method	Description
private TopDocs	KNearestFuzzyClassifier.knnSearch(String text)
private TopDocs	KNearestNeighborClassifier.knnSearch(String text)

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

Modifier and Type	Method	Description
private List<ClassificationResult<BytesRef>>	KNearestFuzzyClassifier.buildListFromTopDocs(TopDocs topDocs)	build a list of classification results from search results
protected List<ClassificationResult<BytesRef>>	KNearestNeighborClassifier.buildListFromTopDocs(TopDocs topDocs)	build a list of classification results from search results
protected ClassificationResult<BytesRef>	KNearestNeighborClassifier.classifyFromTopDocs(TopDocs knnResults)	TODO

Uses of TopDocs in org.apache.lucene.classification.document

Methods in org.apache.lucene.classification.document that return TopDocs

Modifier and Type	Method	Description
private TopDocs	KNearestNeighborDocumentClassifier.knnSearch(Document document)	Returns the top k results from a More Like This query based on the input document

Uses of TopDocs in org.apache.lucene.index

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

Modifier and Type	Method	Description
final TopDocs	LeafReader.searchNearestVectors(String field, byte[] target, int k, Bits acceptDocs, int visitedLimit)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.
final TopDocs	LeafReader.searchNearestVectors(String field, float[] target, int k, Bits acceptDocs, int visitedLimit)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.

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

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

Modifier and Type	Method	Description
protected TopDocs	DiversifiedTopDocsCollector.newTopDocs(ScoreDoc[] results, int start)

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

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

Modifier and Type	Method	Description
protected TopDocs	LargeNumHitsTopDocsCollector.newTopDocs(ScoreDoc[] results)	Returns a TopDocs instance containing the given results.
TopDocs	LargeNumHitsTopDocsCollector.topDocs()	Returns the top docs that were collected by this collector.
TopDocs	LargeNumHitsTopDocsCollector.topDocs(int howMany)	Returns the top docs that were collected by this collector.

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
static final TopDocs	TopDocsCollector.EMPTY_TOPDOCS	This is used in case topDocs() is called with illegal parameters, or there simply aren't (enough) results.
private static final TopDocs	AbstractKnnVectorQuery.NO_RESULTS
private static final TopDocs	KnnByteVectorQuery.NO_RESULTS
private static final TopDocs	KnnFloatVectorQuery.NO_RESULTS

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

Modifier and Type	Method	Description
protected abstract TopDocs	AbstractKnnVectorQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit, KnnCollectorManager knnCollectorManager)
protected abstract TopDocs	AbstractVectorSimilarityQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)
protected TopDocs	ByteVectorSimilarityQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)
protected TopDocs	FloatVectorSimilarityQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitLimit)
protected TopDocs	KnnByteVectorQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit, KnnCollectorManager knnCollectorManager)
protected TopDocs	KnnFloatVectorQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit, KnnCollectorManager knnCollectorManager)
protected TopDocs	AbstractKnnVectorQuery.exactSearch(LeafReaderContext context, DocIdSetIterator acceptIterator, QueryTimeout queryTimeout)
private TopDocs	AbstractKnnVectorQuery.getLeafResults(LeafReaderContext ctx, Weight filterWeight, TimeLimitingKnnCollectorManager timeLimitingKnnCollectorManager)
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits)	Same as merge(int, TopDocs[]) but also ignores the top start top docs.
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Same as above, but accepts the passed in tie breaker
static TopDocs	TopDocs.merge(int topN, TopDocs[] shardHits)	Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
private static TopDocs	TopDocs.mergeAux(Sort sort, int start, int size, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Auxiliary method used by the merge(int, org.apache.lucene.search.TopDocs[]) impls.
protected TopDocs	AbstractKnnVectorQuery.mergeLeafResults(TopDocs[] perLeafResults)	Merges all segment-level kNN results to get the index-level kNN results.
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)
protected TopDocs	TopScoreDocCollector.PagingTopScoreDocCollector.newTopDocs(ScoreDoc[] results, int start)
TopDocs	TopScoreDocCollectorManager.reduce(Collection<TopScoreDocCollector> collectors)
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	SortRescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)
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).
private TopDocs	AbstractKnnVectorQuery.searchLeaf(LeafReaderContext ctx, Weight filterWeight, TimeLimitingKnnCollectorManager timeLimitingKnnCollectorManager)
abstract TopDocs	AbstractKnnCollector.topDocs()
TopDocs	KnnCollector.topDocs()	This drains the collected nearest kNN results and returns them in a new TopDocs collection, ordered by score descending.
TopDocs	TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector.topDocs()
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 ..
TopDocs	TopKnnCollector.topDocs()
TopDocs	VectorSimilarityCollector.topDocs()

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, ScoreDoc after, int totalHitsThreshold)	Deprecated. This method is deprecated in favor of the constructor of TopScoreDocCollectorManager due to its support for concurrency in IndexSearcher

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

Modifier and Type	Method	Description
private Query	AbstractKnnVectorQuery.createRewrittenQuery(IndexReader reader, TopDocs topK)
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits)	Same as merge(int, TopDocs[]) but also ignores the top start top docs.
static TopDocs	TopDocs.merge(int start, int topN, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Same as above, but accepts the passed in tie breaker
static TopDocs	TopDocs.merge(int topN, TopDocs[] shardHits)	Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
private static TopDocs	TopDocs.mergeAux(Sort sort, int start, int size, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)	Auxiliary method used by the merge(int, org.apache.lucene.search.TopDocs[]) impls.
protected TopDocs	AbstractKnnVectorQuery.mergeLeafResults(TopDocs[] perLeafResults)	Merges all segment-level kNN results to get the index-level kNN results.
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	SortRescorer.rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)

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

Modifier	Constructor	Description
	MergeSortQueue(Sort sort, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker)
	ScoreMergeSortQueue(TopDocs[] shardHits, Comparator<ScoreDoc> tieBreakerComparator)

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

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

Modifier and Type	Field	Description
private static final TopDocs	DiversifyingChildrenByteKnnVectorQuery.NO_RESULTS
private static final TopDocs	DiversifyingChildrenFloatKnnVectorQuery.NO_RESULTS

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

Modifier and Type	Method	Description
protected TopDocs	DiversifyingChildrenByteKnnVectorQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit, KnnCollectorManager knnCollectorManager)
protected TopDocs	DiversifyingChildrenFloatKnnVectorQuery.approximateSearch(LeafReaderContext context, Bits acceptDocs, int visitedLimit, KnnCollectorManager knnCollectorManager)
protected TopDocs	DiversifyingChildrenByteKnnVectorQuery.exactSearch(LeafReaderContext context, DocIdSetIterator acceptIterator, QueryTimeout queryTimeout)
protected TopDocs	DiversifyingChildrenFloatKnnVectorQuery.exactSearch(LeafReaderContext context, DocIdSetIterator acceptIterator, QueryTimeout queryTimeout)
TopDocs	DiversifyingNearestChildrenKnnCollector.topDocs()

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

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

Modifier and Type	Method	Description
TopDocs	MultiLeafKnnCollector.topDocs()

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

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

Modifier and Type	Method	Description
Stream<MatchHighlighter.DocHighlights>	MatchHighlighter.highlight(TopDocs topDocs, Query... queries)
void	MatchRegionRetriever.highlightDocuments(TopDocs topDocs, MatchRegionRetriever.MatchOffsetsConsumer consumer)

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.apache.lucene.util.hnsw

Methods in org.apache.lucene.util.hnsw that return TopDocs

Modifier and Type	Method	Description
TopDocs	HnswGraphBuilder.GraphBuilderKnnCollector.topDocs()
TopDocs	OrdinalTranslatedKnnCollector.topDocs()