Home » lucene-2.4.1-src » org.apache » lucene » search » [javadoc | source]

org.apache.lucene.search
abstract public class: Filter [javadoc | source]

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

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    BooleanFilter, DateFilter, RemoteCachingWrapperFilter, QueryWrapperFilter, QueryFilter, ChainedFilter, TermsFilter, CachingSpanFilter, CachingWrapperFilter, MockFilter, SpanQueryFilter, RangeFilter, SpanFilter, DuplicateFilter, PrefixFilter

Abstract base class providing a mechanism to use a subset of an index for restriction or permission of index search results.

Note: In Lucene 3.0 #bits(IndexReader) will be removed and #getDocIdSet(IndexReader) will be defined as abstract. All implementing classes must therefore implement #getDocIdSet(IndexReader) in order to work with Lucene 3.0.

Method from org.apache.lucene.search.Filter Summary:
bits,   getDocIdSet

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.lucene.search.Filter Detail:
public BitSet bits(IndexReader reader) throws IOException { return null; } Deprecated! Use - #getDocIdSet(IndexReader) instead.
public DocIdSet getDocIdSet(IndexReader reader) throws IOException { return new DocIdBitSet(bits(reader)); }