Package org.apache.lucene.search
Class FilterLeafCollector
- java.lang.Object
-
- org.apache.lucene.search.FilterLeafCollector
-
- All Implemented Interfaces:
LeafCollector
public abstract class FilterLeafCollector extends Object implements LeafCollector
LeafCollectordelegator.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected LeafCollectorin
-
Constructor Summary
Constructors Constructor Description FilterLeafCollector(LeafCollector in)Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcollect(int doc)Called once for every document matching a query, with the unbased document number.voidfinish()Hook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when aCollectionTerminatedExceptionis thrown.voidsetScorer(Scorable scorer)Called before successive calls toLeafCollector.collect(int).StringtoString()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.search.LeafCollector
collect, competitiveIterator
-
-
-
-
Field Detail
-
in
protected final LeafCollector in
-
-
Constructor Detail
-
FilterLeafCollector
public FilterLeafCollector(LeafCollector in)
Sole constructor.
-
-
Method Detail
-
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 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
-
finish
public void finish() throws IOExceptionDescription copied from interface:LeafCollectorHook that gets called once the leaf that is associated with this collector has finished collecting successfully, including when aCollectionTerminatedExceptionis thrown. This is typically useful to compile data that has been collected on this leaf, e.g. to convert facet counts on leaf ordinals to facet counts on global ordinals. The default implementation does nothing.Note: It can be assumed that this method will only be called once per LeafCollector instance.
- Specified by:
finishin interfaceLeafCollector- Throws:
IOException
-
-