Package org.apache.lucene.search
Class SimpleCollector
- java.lang.Object
-
- org.apache.lucene.search.SimpleCollector
-
- All Implemented Interfaces:
Collector,LeafCollector
public abstract class SimpleCollector extends Object implements Collector, LeafCollector
BaseCollectorimplementation that is used to collect all contexts.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description SimpleCollector()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidcollect(int doc)Called once for every document matching a query, with the unbased document number.protected voiddoSetNextReader(LeafReaderContext context)This method is called before collectingcontext.LeafCollectorgetLeafCollector(LeafReaderContext context)Create a newcollectorto collect the given context.voidsetScorer(Scorable scorer)Called before successive calls toLeafCollector.collect(int).-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator, finish
-
-
-
-
Method Detail
-
getLeafCollector
public final LeafCollector getLeafCollector(LeafReaderContext context) throws IOException
Description copied from interface:CollectorCreate a newcollectorto collect the given context.- Specified by:
getLeafCollectorin interfaceCollector- Parameters:
context- next atomic reader context- Throws:
IOException
-
doSetNextReader
protected void doSetNextReader(LeafReaderContext context) throws IOException
This method is called before collectingcontext.- Throws:
IOException
-
setScorer
public void setScorer(Scorable scorer) throws IOException
Description copied from interface:LeafCollectorCalled before successive calls toLeafCollector.collect(int). Implementations that need the score of the current document (passed-in toLeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.- Specified by:
setScorerin interfaceLeafCollector- Throws:
IOException
-
collect
public abstract void collect(int doc) throws IOExceptionDescription copied from interface:LeafCollectorCalled 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 currentLeafReaderContextwill be skipped andIndexSearcherwill 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
StoredFields.document(int)on every hit. Doing so can slow searches by an order of magnitude or more.- Specified by:
collectin interfaceLeafCollector- Throws:
IOException
-
-