Lucene++ - a full-featured, c++ search engine
API Documentation
A clause in a BooleanQuery. More...
#include <BooleanClause.h>
Public Types | |
enum | Occur { MUST, SHOULD, MUST_NOT } |
Specifies how clauses are to occur in matching documents. More... | |
Public Member Functions | |
BooleanClause (const QueryPtr &query, Occur occur) | |
virtual | ~BooleanClause () |
virtual String | getClassName () |
boost::shared_ptr< BooleanClause > | shared_from_this () |
Occur | getOccur () |
void | setOccur (Occur occur) |
QueryPtr | getQuery () |
void | setQuery (const QueryPtr &query) |
bool | isProhibited () |
bool | isRequired () |
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 String | toString () |
Returns a string representation of the object. More... | |
![]() | |
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 () |
Protected Attributes | |
QueryPtr | query |
The query whose matching documents are combined by the boolean query. More... | |
Occur | occur |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
A clause in a BooleanQuery.
Specifies how clauses are to occur in matching documents.
Enumerator | |
---|---|
MUST |
Use this operator for clauses that must appear in the matching documents. |
SHOULD |
Use this operator for clauses that should appear in the matching documents. For a BooleanQuery with no MUST clauses one or more SHOULD clauses must match a document for the BooleanQuery to match. |
MUST_NOT |
Use this operator for clauses that must not appear in the matching documents. Note that it is not possible to search for queries that only consist of a MUST_NOT clause. |
|
virtual |
|
inlinestatic |
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
|
inlinevirtual |
Occur Lucene::BooleanClause::getOccur | ( | ) |
QueryPtr Lucene::BooleanClause::getQuery | ( | ) |
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
bool Lucene::BooleanClause::isProhibited | ( | ) |
bool Lucene::BooleanClause::isRequired | ( | ) |
void Lucene::BooleanClause::setOccur | ( | Occur | occur | ) |
void Lucene::BooleanClause::setQuery | ( | const QueryPtr & | query | ) |
|
inline |
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
|
protected |
|
protected |
The query whose matching documents are combined by the boolean query.