Lucene++ - a full-featured, c++ search engine
API Documentation
Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information. More...
#include <SpanFilter.h>
Public Member Functions | |
virtual | ~SpanFilter () |
virtual String | getClassName () |
boost::shared_ptr< SpanFilter > | shared_from_this () |
virtual SpanFilterResultPtr | bitSpans (const IndexReaderPtr &reader)=0 |
Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match. | |
![]() | |
virtual | ~Filter () |
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 () |
![]() | |
static String | _getClassName () |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information.
This is useful if you want to compare the positions from a SpanQuery with the positions of items in a filter. For instance, if you had a SpanFilter that marked all the occurrences of the word "foo" in documents, and then you entered a new SpanQuery containing bar, you could not only filter by the word foo, but you could then compare position information for post processing.
|
virtual |
|
inlinestatic |
|
pure virtual |
Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.
reader | The IndexReader to load position and DocIdSet information from |
SpanFilterResult
Implemented in Lucene::CachingSpanFilter, and Lucene::SpanQueryFilter.
|
inlinevirtual |
Reimplemented from Lucene::Filter.
Reimplemented in Lucene::CachingSpanFilter, and Lucene::SpanQueryFilter.
|
inline |