org.apache.lucene.search

Class FilteredQuery.FilterStrategy

java.lang.Object

org.apache.lucene.search.FilteredQuery.FilterStrategy

Direct Known Subclasses:

FilteredQuery.RandomAccessFilterStrategy

Enclosing class:

FilteredQuery

public abstract static class FilteredQuery.FilterStrategy
extends Object

Abstract class that defines how the filter (DocIdSet) applied during document collection.

Constructor Summary

Constructors

Constructor and Description
FilteredQuery.FilterStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
BulkScorer	filteredBulkScorer(LeafReaderContext context, Weight weight, DocIdSet docIdSet) Returns a filtered BulkScorer based on this strategy.
abstract Scorer	filteredScorer(LeafReaderContext context, Weight weight, DocIdSet docIdSet) Returns a filtered Scorer based on this strategy.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredQuery.FilterStrategy

public FilteredQuery.FilterStrategy()

Method Detail

filteredScorer

public abstract Scorer filteredScorer(LeafReaderContext context,
                    Weight weight,
                    DocIdSet docIdSet)
                               throws IOException

Returns a filtered Scorer based on this strategy.

Parameters:

context - the LeafReaderContext for which to return the Scorer.

weight - the FilteredQuery Weight to create the filtered scorer.

docIdSet - the filter DocIdSet to apply

Returns:

a filtered scorer

Throws:

IOException - if an IOException occurs

filteredBulkScorer

public BulkScorer filteredBulkScorer(LeafReaderContext context,
                            Weight weight,
                            DocIdSet docIdSet)
                              throws IOException

Returns a filtered BulkScorer based on this strategy. This is an optional method: the default implementation just calls filteredScorer(org.apache.lucene.index.LeafReaderContext, org.apache.lucene.search.Weight, org.apache.lucene.search.DocIdSet) and wraps that into a BulkScorer.

Parameters:

context - the LeafReaderContext for which to return the Scorer.

weight - the FilteredQuery Weight to create the filtered scorer.

docIdSet - the filter DocIdSet to apply

Returns:

a filtered top scorer

Throws:

IOException