Lucene++ - a full-featured, c++ search engine
API Documentation
A wrapper for MultiTermQuery
, that exposes its functionality as a Filter
.
More...
#include <MultiTermQueryWrapperFilter.h>
Public Member Functions | |
virtual | ~MultiTermQueryWrapperFilter () |
virtual String | getClassName () |
boost::shared_ptr< MultiTermQueryWrapperFilter > | shared_from_this () |
virtual String | toString () |
Returns a string representation of the object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
int32_t | getTotalNumberOfTerms () |
Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index. | |
void | clearTotalNumberOfTerms () |
Resets the counting of unique terms. Do this before executing the filter. | |
virtual DocIdSetPtr | getDocIdSet (const IndexReaderPtr &reader) |
Returns a DocIdSet with documents that should be permitted in search results. | |
![]() | |
virtual | ~Filter () |
boost::shared_ptr< Filter > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Protected Attributes | |
MultiTermQueryPtr | query |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
A wrapper for 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.
|
virtual |
|
inlinestatic |
void Lucene::MultiTermQueryWrapperFilter::clearTotalNumberOfTerms | ( | ) |
Resets the counting of unique terms. Do this before executing the filter.
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
|
inlinevirtual |
Reimplemented from Lucene::Filter.
Reimplemented in Lucene::NumericRangeFilter, Lucene::PrefixFilter, and Lucene::TermRangeFilter.
|
virtual |
Returns a DocIdSet with documents that should be permitted in search results.
Implements Lucene::Filter.
int32_t Lucene::MultiTermQueryWrapperFilter::getTotalNumberOfTerms | ( | ) |
Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index.
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
.
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
|
inline |
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::PrefixFilter.
|
protected |