|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Filter org.apache.lucene.search.TermsFilter
public class TermsFilter
Constructs a filter for docs matching any of the terms added to this class. Unlike a RangeFilter this can be used for filtering on multiple terms that are not necessarily in a sequence. An example might be a collection of primary keys from a database query result or perhaps a choice of "category" labels picked by the end user. As a filter, this is much faster than the equivalent query (a BooleanQuery with many "should" TermQueries)
Constructor Summary | |
---|---|
TermsFilter()
|
Method Summary | |
---|---|
void |
addTerm(Term term)
Adds a term to the list of acceptable terms |
BitSet |
bits(IndexReader reader)
|
boolean |
equals(Object obj)
|
DocIdSet |
getDocIdSet(IndexReader reader)
Creates a DocIdSet enumerating the documents that should be
permitted in search results. |
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TermsFilter()
Method Detail |
---|
public void addTerm(Term term)
term
- public BitSet bits(IndexReader reader) throws IOException
bits
in class Filter
NOTE: See Filter.getDocIdSet(IndexReader)
for
handling of multi-segment indexes (which applies to
this method as well).
IOException
public DocIdSet getDocIdSet(IndexReader reader) throws IOException
Filter
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.
getDocIdSet
in class Filter
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
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |