public class TotalHitCountCollector extends Collector
|Constructor and Description|
|Modifier and Type||Method and Description|
Called once for every document matching a query, with the unbased document number.
Returns how many hits matched the search.
Called before collecting from each
Called before successive calls to
public int getTotalHits()
public void setScorer(Scorer scorer)
Collector.collect(int). Implementations that need the score of the current document (passed-in to
Collector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.
public void collect(int doc)
Note: The collection of the current segment can be terminated by throwing
CollectionTerminatedException. In this case, the last docs of the
AtomicReaderContext will be skipped and
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
IndexReader.document(int) on every hit.
Doing so can slow searches by an order of magnitude or more.
public void setNextReader(AtomicReaderContext context)
AtomicReaderContext. All doc ids in
Collector.collect(int)will correspond to
AtomicReaderContext.docBaseto the current
IndexReaderContext.reader()'s internal document id to re-base ids in
context- next atomic reader context
public boolean acceptsDocsOutOfOrder()
trueif this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to
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
Collector 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
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.