Lucene++ - a full-featured, c++ search engine
API Documentation
The abstract base class for queries. More...
#include <Query.h>
Public Member Functions | |
Query () | |
virtual | ~Query () |
virtual String | getClassName () |
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 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. | |
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 WeightPtr | weight (const SearcherPtr &searcher) |
Constructs and initializes a Weight for a top-level query. | |
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 QueryPtr | combine (Collection< QueryPtr > queries) |
Called when re-writing queries under MultiSearcher. | |
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 SimilarityPtr | getSimilarity (const SearcherPtr &searcher) |
Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Returns a clone of this query. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
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 QueryPtr | mergeBooleanQueries (Collection< BooleanQueryPtr > queries) |
Merges the clauses of a set of BooleanQuery's into a single BooleanQuery. | |
Protected Attributes | |
double | boost |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
The abstract base class for queries.
Instantiable subclasses are:
TermQuery
MultiTermQuery
BooleanQuery
WildcardQuery
PhraseQuery
PrefixQuery
MultiPhraseQuery
FuzzyQuery
TermRangeQuery
NumericRangeQuery
org.apache.lucene.search.spans.SpanQuery
A parser for queries is contained in: QueryParser
Lucene::Query::Query | ( | ) |
|
virtual |
|
inlinestatic |
String Lucene::Query::boostString | ( | ) |
Return given boost value as a string.
|
virtual |
Returns a clone of this query.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::MultiTermQuery, Lucene::NumericRangeQuery, Lucene::PayloadNearQuery, Lucene::PayloadTermQuery, Lucene::PhraseQuery, Lucene::PrefixQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanTermQuery, Lucene::TermQuery, Lucene::TermRangeQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
virtual |
Called when re-writing queries under MultiSearcher.
Create a single query suitable for use by all subsearchers (in 1-1 correspondence with queries). This is an optimization of the OR of all queries. We handle the common optimization cases of equal queries and overlapping clauses of boolean OR queries (as generated by MultiTermQuery.rewrite()). Be careful overriding this method as queries[0] determines which method will be called and is not necessarily of the same type as the other queries.
|
virtual |
Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::PayloadNearQuery, Lucene::PayloadTermQuery, Lucene::PhraseQuery, Lucene::SpanQuery, Lucene::TermQuery, and Lucene::ValueSourceQuery.
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::MultiTermQuery, Lucene::NumericRangeQuery, Lucene::PayloadNearQuery, Lucene::PayloadTermQuery, Lucene::PhraseQuery, Lucene::PrefixQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanTermQuery, Lucene::TermQuery, Lucene::TermRangeQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
virtual |
Adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten
form.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::PhraseQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanTermQuery, Lucene::TermQuery, and Lucene::ValueSourceQuery.
|
virtual |
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.
|
inlinevirtual |
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FieldScoreQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::MultiTermQuery, Lucene::NumericRangeQuery, Lucene::PayloadNearQuery, Lucene::PayloadTermQuery, Lucene::PhraseQuery, Lucene::PrefixQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanQuery, Lucene::SpanTermQuery, Lucene::TermQuery, Lucene::TermRangeQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
virtual |
Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned.
Reimplemented in Lucene::BooleanQuery, and Lucene::FieldMaskingSpanQuery.
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::MultiTermQuery, Lucene::NumericRangeQuery, Lucene::PayloadNearQuery, Lucene::PayloadTermQuery, Lucene::PhraseQuery, Lucene::PrefixQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanTermQuery, Lucene::TermQuery, Lucene::TermRangeQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
static |
Merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
A utility for use by combine(Query[])
implementations.
|
virtual |
Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MultiPhraseQuery, Lucene::MultiTermQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
virtual |
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.
|
inline |
|
virtual |
Prints a query to a string.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::FilteredQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::PhraseQuery, Lucene::TermQuery, and Lucene::ValueSourceQuery.
|
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 in Lucene::BooleanQuery, Lucene::BooleanQuery, Lucene::ConstantScoreQuery, Lucene::ConstantScoreQuery, Lucene::CustomScoreQuery, Lucene::CustomScoreQuery, Lucene::DisjunctionMaxQuery, Lucene::DisjunctionMaxQuery, Lucene::FieldMaskingSpanQuery, Lucene::FilteredQuery, Lucene::FilteredQuery, Lucene::FuzzyQuery, Lucene::MatchAllDocsQuery, Lucene::MatchAllDocsQuery, Lucene::MultiPhraseQuery, Lucene::MultiPhraseQuery, Lucene::NumericRangeQuery, Lucene::PayloadNearQuery, Lucene::PayloadNearQuery, Lucene::PhraseQuery, Lucene::PhraseQuery, Lucene::PrefixQuery, Lucene::SpanFirstQuery, Lucene::SpanNearQuery, Lucene::SpanNotQuery, Lucene::SpanOrQuery, Lucene::SpanTermQuery, Lucene::TermQuery, Lucene::TermQuery, Lucene::TermRangeQuery, Lucene::ValueSourceQuery, Lucene::ValueSourceQuery, and Lucene::WildcardQuery.
|
virtual |
Constructs and initializes a Weight for a top-level query.
|
protected |