Home » lucene-3.0.1-src » org.apache » lucene » search » [javadoc | source]
abstract public class: Filter [javadoc | source]

All Implemented Interfaces:

Abstract base class for restricting which documents may be returned during searching.
Method from org.apache.lucene.search.Filter Summary:
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.Filter Detail:
 abstract public DocIdSet getDocIdSet(IndexReader reader) throws IOException
    Creates a DocIdSet enumerating the documents that should be permitted in search results. NOTE: null can be returned if no documents are accepted by this Filter.

    Note: This method will be called once per segment in the index during searching. The returned DocIdSet must refer to document IDs for that segment, not for the top-level reader.