Lucene++ - a full-featured, c++ search engine
API Documentation
Constrains search results to only match those which also match a provided query. Also provides position information about where each document matches at the cost of extra space compared with the QueryWrapperFilter. There is an added cost to this above what is stored in a QueryWrapperFilter. Namely, the position information for each matching document is stored. More...
#include <SpanQueryFilter.h>
Public Member Functions | |
SpanQueryFilter (const SpanQueryPtr &query=SpanQueryPtr()) | |
Constructs a filter which only matches documents matching query. More... | |
virtual | ~SpanQueryFilter () |
virtual String | getClassName () |
boost::shared_ptr< SpanQueryFilter > | shared_from_this () |
virtual DocIdSetPtr | getDocIdSet (const IndexReaderPtr &reader) |
Creates a DocIdSet enumerating the documents that should be permitted in search results. More... | |
virtual SpanFilterResultPtr | bitSpans (const IndexReaderPtr &reader) |
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. More... | |
SpanQueryPtr | getQuery () |
virtual String | toString () |
Returns a string representation of the object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
![]() | |
virtual | ~SpanFilter () |
boost::shared_ptr< SpanFilter > | shared_from_this () |
![]() | |
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. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Protected Attributes | |
SpanQueryPtr | query |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
Constrains search results to only match those which also match a provided query. Also provides position information about where each document matches at the cost of extra space compared with the QueryWrapperFilter. There is an added cost to this above what is stored in a QueryWrapperFilter. Namely, the position information for each matching document is stored.
This filter does not cache. See the CachingSpanFilter for a wrapper that caches.
Lucene::SpanQueryFilter::SpanQueryFilter | ( | const SpanQueryPtr & | query = SpanQueryPtr() | ) |
|
virtual |
|
inlinestatic |
|
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 |
Implements Lucene::SpanFilter.
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
|
inlinevirtual |
Reimplemented from Lucene::SpanFilter.
|
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. |
Implements Lucene::Filter.
SpanQueryPtr Lucene::SpanQueryFilter::getQuery | ( | ) |
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
|
inline |
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
|
protected |