public class MultiTermQueryWrapperFilter extends Filter
MultiTermQuery
, that exposes its
functionality as a Filter
.
MultiTermQueryWrapperFilter
is not designed to
be used by itself. Normally you subclass it to provide a Filter
counterpart for a MultiTermQuery
subclass.
For example, TermRangeFilter
and PrefixFilter
extend
MultiTermQueryWrapperFilter
.
This class also provides the functionality behind
MultiTermQuery.CONSTANT_SCORE_FILTER_REWRITE
;
this is why it is not abstract.
Modifier and Type | Field and Description |
---|---|
protected MultiTermQuery |
query |
Modifier | Constructor and Description |
---|---|
protected |
MultiTermQueryWrapperFilter(MultiTermQuery query)
Wrap a
MultiTermQuery as a Filter. |
Modifier and Type | Method and Description |
---|---|
BitSet |
bits(IndexReader reader)
Deprecated.
Use
getDocIdSet(IndexReader) instead. |
void |
clearTotalNumberOfTerms()
Expert: Resets the counting of unique terms.
|
boolean |
equals(Object o) |
DocIdSet |
getDocIdSet(IndexReader reader)
Returns a DocIdSet with documents that should be
permitted in search results.
|
int |
getTotalNumberOfTerms()
Expert: Return the number of unique terms visited during execution of the filter.
|
int |
hashCode() |
String |
toString() |
protected final MultiTermQuery query
protected MultiTermQueryWrapperFilter(MultiTermQuery query)
MultiTermQuery
as a Filter.public int getTotalNumberOfTerms()
This method is not thread safe, be sure to only call it when no filter is running!
If you re-use the same filter instance for another
search, be sure to first reset the term counter
with clearTotalNumberOfTerms()
.
clearTotalNumberOfTerms()
public void clearTotalNumberOfTerms()
getTotalNumberOfTerms()
public BitSet bits(IndexReader reader) throws IOException
getDocIdSet(IndexReader)
instead.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
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
Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.