|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Filter
public abstract class Filter
Abstract base class for restricting which documents may be returned during searching.
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.
Constructor Summary | |
---|---|
Filter()
|
Method Summary | |
---|---|
BitSet |
bits(IndexReader reader)
Deprecated. Use getDocIdSet(IndexReader) instead. |
DocIdSet |
getDocIdSet(IndexReader reader)
Creates a DocIdSet enumerating the documents that should be
permitted in search results. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Filter()
Method Detail |
---|
public BitSet bits(IndexReader reader) throws IOException
getDocIdSet(IndexReader)
instead.
NOTE: See getDocIdSet(IndexReader)
for
handling of multi-segment indexes (which applies to
this method as well).
IOException
public DocIdSet getDocIdSet(IndexReader reader) throws IOException
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.
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.
IOException
DocIdBitSet
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |