Class TopDocsCollector<T>

Sole constructor.

This is used in case GetTopDocs() is called with illegal parameters, or there simply aren't (enough) results.

The priority queue which holds the top documents. Note that different implementations of PriorityQueue<T> give different meaning to 'top documents'. Lucene.Net.Search.HitQueue for example aggregates the top scoring documents, while other priority queue implementations may hold documents sorted by other criteria.

The total number of documents that the collector encountered.

Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to Collect(Int32).

Most Lucene Query implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of BooleanQuery) can achieve faster searching if the ICollector allows them to deliver the docIDs out of order.

Many collectors don't mind getting docIDs out of order, so it's important to return true here.

The number of valid priority queue entries

The total number of documents that matched this query.

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 AtomicReaderContext 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 or on every hit. Doing so can slow searches by an order of magnitude or more.

Returns the top docs that were collected by this collector.

Returns the documents in the rage [start .. pq.Count) that were collected by this collector. Note that if start >= pq.Count, an empty TopDocs is returned.

This method is convenient to call if the application always asks for the last results, starting from the last 'page'.

NOTE: you cannot call this method more than once for each search execution. If you need to call it more than once, passing each time a different start, you should call GetTopDocs() and work with the returned TopDocs object, which will contain all the results this search execution collected.

Returns the documents in the rage [start .. start+howMany) that were collected by this collector. Note that if start >= pq.Count, an empty TopDocs is returned, and if pq.Count - start < howMany, then only the available documents in [start .. pq.Count) are returned.

This method is useful to call in case pagination of search results is allowed by the search application, as well as it attempts to optimize the memory used by allocating only as much as requested by howMany.

NOTE: you cannot call this method more than once for each search execution. If you need to call it more than once, passing each time a different range, you should call GetTopDocs() and work with the returned TopDocs object, which will contain all the results this search execution collected.

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(Int32) or because the arguments to TopDocs were invalid.

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

Called before collecting from each AtomicReaderContext. All doc ids in Collect(Int32) will correspond to Reader.

Add DocBase to the current Reader's internal document id to re-base ids in Collect(Int32).

Called before successive calls to Collect(Int32). Implementations that need the score of the current document (passed-in to Collect(Int32)), should save the passed-in Scorer and call GetScore() when needed.