org.apache.lucene.search
Class Filter

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CachingWrapperFilter, PrefixFilter, QueryWrapperFilter, RangeFilter, RemoteCachingWrapperFilter, SpanFilter

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

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.

See Also:

Serialized Form

Constructor Summary

Filter()

Method Summary

java.util.BitSet	bits(IndexReader reader) Deprecated. Use getDocIdSet(IndexReader) instead.
DocIdSet	getDocIdSet(IndexReader reader)

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 java.util.BitSet bits(IndexReader reader)
                      throws java.io.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.

Throws:

java.io.IOException

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws java.io.IOException

Returns:

a DocIdSet that provides the documents which should be permitted or prohibited in search results.

Throws:

java.io.IOException

See Also:

DocIdBitSet