org.apache.lucene.search

Class FilterLeafCollector

java.lang.Object

org.apache.lucene.search.FilterLeafCollector

All Implemented Interfaces:

LeafCollector

public class FilterLeafCollector
extends Object
implements LeafCollector

LeafCollector delegator.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
protected LeafCollector	in

Constructor Summary

Constructors

Constructor and Description
FilterLeafCollector(LeafCollector in) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsDocsOutOfOrder() Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to LeafCollector.collect(int).
void	collect(int doc) Called once for every document matching a query, with the unbased document number.
void	setScorer(Scorer scorer) Called before successive calls to LeafCollector.collect(int).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

in

protected final LeafCollector in

Constructor Detail

FilterLeafCollector

public FilterLeafCollector(LeafCollector in)

Sole constructor.

Method Detail

setScorer

public void setScorer(Scorer scorer)
               throws IOException

Description copied from interface: LeafCollector

Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in interface LeafCollector

Throws:

IOException

collect

public void collect(int doc)
             throws IOException

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 current AtomicReaderContext will be skipped and IndexSearcher 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) or IndexReader.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in interface LeafCollector

Throws:

IOException

acceptsDocsOutOfOrder

public boolean acceptsDocsOutOfOrder()

Description copied from interface: LeafCollector

Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to LeafCollector.collect(int).

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 true here.

Specified by:

acceptsDocsOutOfOrder in interface LeafCollector

toString

public String toString()

Overrides:

toString in class Object