Initializes a new instance of the TopDocsCollector class

* Return

CopyC#

true

if this collector does not * require the matching docIDs to be delivered in int sort * order (smallest to largest) to {@link #collect}. * *

Most Lucene Query implementations will visit * matching docIDs in order. However, some queries * (currently limited to certain cases of {@link * BooleanQuery}) can achieve faster searching if the *

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

* here. *

Called once for every document matching a query, with the unbased document number.

Note: This is called in an inner search loop. For good search performance, implementations of this method should not call {@link Searcher#Doc(int)} or {@link Lucene.Net.Index.IndexReader#Document(int)} on every hit. Doing so can slow searches by an order of magnitude or more.

Determines whether the specified Object is equal to the current Object.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Serves as a hash function for a particular type.

The total number of documents that matched this query.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Returns a {@link TopDocs} instance containing the given results. If

CopyC#

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.

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

Called before collecting from each IndexReader. All doc ids in {@link #Collect(int)} will correspond to reader. Add docBase to the current IndexReaders internal document id to re-base ids in {@link #Collect(int)}.

Called before successive calls to {@link #Collect(int)}. Implementations that need the score of the current document (passed-in to {@link #Collect(int)}), should save the passed-in Scorer and call scorer.score() when needed.

Returns the top docs that were collected by this collector.

Returns the documents in the rage [start .. pq.size()) that were collected by this collector. Note that if start >= pq.size(), an empty TopDocs is returned.
This method is convenient to call if the application allways 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

CopyC#

start

, you should call {@link #TopDocs()} and work with the returned {@link 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.size(), an empty TopDocs is returned, and if pq.size() - start < howMany, then only the available documents in [start .. pq.size()) 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 {@link #TopDocs()} and work with the returned {@link TopDocs} object, which will contain all the results this search execution collected.

Returns a String that represents the current Object.

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

The total number of documents that the collector encountered.