Lucene++ - a full-featured, c++ search engine
API Documentation
Abstract base class for restricting which documents may be returned during searching. More...
#include <Filter.h>
Public Member Functions | |
virtual | ~Filter () |
virtual String | getClassName () |
boost::shared_ptr< Filter > | shared_from_this () |
virtual DocIdSetPtr | getDocIdSet (const IndexReaderPtr &reader)=0 |
Creates a DocIdSet enumerating the documents that should be permitted in search results. | |
![]() | |
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 | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
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 () |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Abstract base class for restricting which documents may be returned during searching.
|
virtual |
|
inlinestatic |
|
inlinevirtual |
Reimplemented in Lucene::CachingSpanFilter, Lucene::CachingWrapperFilter, Lucene::FieldCacheRangeFilter, Lucene::FieldCacheTermsFilter, Lucene::MultiTermQueryWrapperFilter, Lucene::NumericRangeFilter, Lucene::PrefixFilter, Lucene::QueryWrapperFilter, Lucene::SpanFilter, Lucene::SpanQueryFilter, and Lucene::TermRangeFilter.
|
pure virtual |
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.
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 ie. if the index has more than one segment the given reader only represents a single segment. |
Implemented in Lucene::CachingSpanFilter, Lucene::CachingWrapperFilter, Lucene::FieldCacheTermsFilter, Lucene::MultiTermQueryWrapperFilter, Lucene::QueryWrapperFilter, and Lucene::SpanQueryFilter.
|
inline |