Lucene++ - a full-featured, c++ search engine
API Documentation
A Query that matches documents matching boolean combinations of other queries, eg. TermQuery
s, PhraseQuery
s or other BooleanQuerys.
More...
#include <BooleanQuery.h>
Public Member Functions | |
BooleanQuery (bool disableCoord=false) | |
Constructs an empty boolean query. | |
virtual | ~BooleanQuery () |
virtual String | getClassName () |
boost::shared_ptr< BooleanQuery > | shared_from_this () |
bool | isCoordDisabled () |
Returns true if Similarity#coord(int32_t, int32_t) is disabled in scoring for this query instance. | |
virtual SimilarityPtr | getSimilarity (const SearcherPtr &searcher) |
Implement coord disabling. | |
void | setMinimumNumberShouldMatch (int32_t min) |
Specifies a minimum number of the optional BooleanClauses which must be satisfied. | |
int32_t | getMinimumNumberShouldMatch () |
Gets the minimum number of the optional BooleanClauses which must be satisfied. | |
void | add (const QueryPtr &query, BooleanClause::Occur occur) |
Adds a clause to a boolean query. | |
void | add (const BooleanClausePtr &clause) |
Adds a clause to a boolean query. | |
Collection< BooleanClausePtr > | getClauses () |
Returns the set of clauses in this query. | |
Collection< BooleanClausePtr >::iterator | begin () |
Returns an iterator on the clauses in this query. | |
Collection< BooleanClausePtr >::iterator | end () |
virtual WeightPtr | createWeight (const SearcherPtr &searcher) |
Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves. | |
virtual QueryPtr | rewrite (const IndexReaderPtr &reader) |
Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys. | |
virtual void | extractTerms (SetTerm terms) |
Adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Returns a clone of this query. | |
virtual String | toString (const String &field) |
Prints a query to a string, with field assumed to be the default field and omitted. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual String | toString (const String &field) |
Prints a query to a string, with field assumed to be the default field and omitted. | |
virtual String | toString () |
Prints a query to a string. | |
![]() | |
Query () | |
virtual | ~Query () |
boost::shared_ptr< Query > | shared_from_this () |
virtual void | setBoost (double b) |
Sets the boost for this query clause to b. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by b. | |
virtual double | getBoost () |
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by b. The boost is 1.0 by default. | |
virtual WeightPtr | weight (const SearcherPtr &searcher) |
Constructs and initializes a Weight for a top-level query. | |
virtual QueryPtr | combine (Collection< QueryPtr > queries) |
Called when re-writing queries under MultiSearcher. | |
String | boostString () |
Return given boost value as a string. | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
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 int32_t | getMaxClauseCount () |
Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses cause TooManyClauses to be thrown. | |
static void | setMaxClauseCount (int32_t maxClauseCount) |
Set the maximum number of clauses permitted per BooleanQuery. Default value is 1024. | |
![]() | |
static String | _getClassName () |
static QueryPtr | mergeBooleanQueries (Collection< BooleanQueryPtr > queries) |
Merges the clauses of a set of BooleanQuery's into a single BooleanQuery. | |
Protected Attributes | |
Collection< BooleanClausePtr > | clauses |
bool | disableCoord |
int32_t | minNrShouldMatch |
![]() | |
double | boost |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Static Protected Attributes | |
static int32_t | maxClauseCount |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
A Query that matches documents matching boolean combinations of other queries, eg. TermQuery
s, PhraseQuery
s or other BooleanQuerys.
Lucene::BooleanQuery::BooleanQuery | ( | bool | disableCoord = false | ) |
Constructs an empty boolean query.
Similarity#coord(int32_t, int32_t)
may be disabled in scoring, as appropriate. For example, this score factor does not make sense for most automatically generated queries, like WildcardQuery
and FuzzyQuery
.
disableCoord | disables Similarity#coord(int32_t, int32_t) in scoring. |
|
virtual |
|
inlinestatic |
void Lucene::BooleanQuery::add | ( | const BooleanClausePtr & | clause | ) |
Adds a clause to a boolean query.
void Lucene::BooleanQuery::add | ( | const QueryPtr & | query, |
BooleanClause::Occur | occur | ||
) |
Adds a clause to a boolean query.
Collection< BooleanClausePtr >::iterator Lucene::BooleanQuery::begin | ( | ) |
Returns an iterator on the clauses in this query.
|
virtual |
Returns a clone of this query.
Reimplemented from Lucene::Query.
|
virtual |
Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves.
Reimplemented from Lucene::Query.
Collection< BooleanClausePtr >::iterator Lucene::BooleanQuery::end | ( | ) |
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::Query.
|
virtual |
Adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten
form.
Reimplemented from Lucene::Query.
|
inlinevirtual |
Reimplemented from Lucene::Query.
Collection< BooleanClausePtr > Lucene::BooleanQuery::getClauses | ( | ) |
Returns the set of clauses in this query.
|
static |
Return the maximum number of clauses permitted, 1024 by default. Attempts to add more than the permitted number of clauses cause TooManyClauses to be thrown.
int32_t Lucene::BooleanQuery::getMinimumNumberShouldMatch | ( | ) |
Gets the minimum number of the optional BooleanClauses which must be satisfied.
|
virtual |
Implement coord disabling.
Reimplemented from Lucene::Query.
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::Query.
bool Lucene::BooleanQuery::isCoordDisabled | ( | ) |
Returns true if Similarity#coord(int32_t, int32_t)
is disabled in scoring for this query instance.
|
virtual |
Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
Reimplemented from Lucene::Query.
|
static |
Set the maximum number of clauses permitted per BooleanQuery. Default value is 1024.
void Lucene::BooleanQuery::setMinimumNumberShouldMatch | ( | int32_t | min | ) |
Specifies a minimum number of the optional BooleanClauses which must be satisfied.
By default no optional clauses are necessary for a match (unless there are no required clauses). If this method is used, then the specified number of clauses is required.
Use of this method is totally independent of specifying that any specific clauses are required (or prohibited). This number will only be compared against the number of matching optional clauses.
min | the number of optional clauses that must match |
|
inline |
|
virtual |
Prints a query to a string.
Reimplemented from Lucene::Query.
|
virtual |
Prints a query to a string, with field assumed to be the default field and omitted.
The representation used is one that is supposed to be readable by QueryParser
. However, there are the following limitations:
If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.
Some of the more complicated queries (eg. span queries) don't have a representation that can be parsed by QueryParser.
Reimplemented from Lucene::Query.
|
virtual |
Prints a query to a string, with field assumed to be the default field and omitted.
The representation used is one that is supposed to be readable by QueryParser
. However, there are the following limitations:
If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.
Some of the more complicated queries (eg. span queries) don't have a representation that can be parsed by QueryParser.
Reimplemented from Lucene::Query.
|
protected |
|
protected |
|
staticprotected |
|
protected |