org.apache.lucene.search
Class MultiTermQueryWrapperFilter

java.lang.Object
  org.apache.lucene.search.Filter
      org.apache.lucene.search.MultiTermQueryWrapperFilter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NumericRangeFilter, PrefixFilter, RangeFilter, TermRangeFilter

public class MultiTermQueryWrapperFilter
extends Filter

A wrapper for MultiTermQuery, that exposes its functionality as a Filter.

MultiTermQueryWrapperFilter is not designed to be used by itself. Normally you subclass it to provide a Filter counterpart for a MultiTermQuery subclass.

For example, TermRangeFilter and PrefixFilter extend MultiTermQueryWrapperFilter. This class also provides the functionality behind MultiTermQuery.CONSTANT_SCORE_FILTER_REWRITE; this is why it is not abstract.

See Also:

Serialized Form

Field Summary

protected MultiTermQuery

query

Constructor Summary

protected

MultiTermQueryWrapperFilter(MultiTermQuery query) Wrap a MultiTermQuery as a Filter.

Method Summary

BitSet	bits(IndexReader reader) Deprecated. Use getDocIdSet(IndexReader) instead.
void	clearTotalNumberOfTerms() Expert: Resets the counting of unique terms.
boolean	equals(Object o)
DocIdSet	getDocIdSet(IndexReader reader) Returns a DocIdSet with documents that should be permitted in search results.
int	getTotalNumberOfTerms() Expert: Return the number of unique terms visited during execution of the filter.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

query

protected final MultiTermQuery query

Constructor Detail

MultiTermQueryWrapperFilter

protected MultiTermQueryWrapperFilter(MultiTermQuery query)

Wrap a MultiTermQuery as a Filter.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getTotalNumberOfTerms

public int getTotalNumberOfTerms()

Expert: Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index.

This method is not thread safe, be sure to only call it when no filter is running! If you re-use the same filter instance for another search, be sure to first reset the term counter with clearTotalNumberOfTerms().

See Also:

clearTotalNumberOfTerms()

clearTotalNumberOfTerms

public void clearTotalNumberOfTerms()

Expert: Resets the counting of unique terms. Do this before executing the filter.

See Also:

getTotalNumberOfTerms()

bits

public BitSet bits(IndexReader reader)
            throws IOException

Deprecated. Use getDocIdSet(IndexReader) instead.

Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

Overrides:

bits in class Filter

Returns:

A BitSet with true for documents which should be permitted in search results, and false for those that should not.

NOTE: See Filter.getDocIdSet(IndexReader) for handling of multi-segment indexes (which applies to this method as well).

Throws:

IOException

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws IOException

Returns a DocIdSet with documents that should be permitted in search results.

Overrides:

getDocIdSet in class Filter

Parameters:

reader - a IndexReader instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment.

Returns:

a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.

Throws:

IOException

See Also:

DocIdBitSet