Package org.apache.lucene.search
Class TotalHitCountCollector
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- org.apache.lucene.search.TotalHitCountCollector
-
- All Implemented Interfaces:
Collector
,LeafCollector
public class TotalHitCountCollector extends SimpleCollector
Just counts the total number of hits.
-
-
Constructor Summary
Constructors Constructor Description TotalHitCountCollector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
collect(int doc)
Called once for every document matching a query, with the unbased document number.int
getTotalHits()
Returns how many hits matched the search.ScoreMode
scoreMode()
Indicates what features are required from the scorer.-
Methods inherited from class org.apache.lucene.search.SimpleCollector
doSetNextReader, getLeafCollector, setScorer
-
-
-
-
Method Detail
-
getTotalHits
public int getTotalHits()
Returns how many hits matched the search.
-
collect
public void collect(int doc)
Description copied from interface:LeafCollector
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 currentLeafReaderContext
will be skipped andIndexSearcher
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
IndexSearcher.doc(int)
orIndexReader.document(int)
on every hit. Doing so can slow searches by an order of magnitude or more.- Specified by:
collect
in interfaceLeafCollector
- Specified by:
collect
in classSimpleCollector
-
-