org.apache.lucene.search
Class Filter

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BooleanFilter, CachingWrapperFilter, ChainedFilter, PrefixFilter, QueryWrapperFilter, RangeFilter, RemoteCachingWrapperFilter, TermsFilter

public abstract class Filter
extends java.lang.Object
implements java.io.Serializable

Abstract base class providing a mechanism to restrict searches to a subset of an index.

See Also:

Serialized Form

Constructor Summary

Filter()

Method Summary

abstract java.util.BitSet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

bits

public abstract java.util.BitSet bits(IndexReader reader)
                               throws java.io.IOException

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

Throws:

java.io.IOException