Lucene++ - a full-featured, c++ search engine
API Documentation
MultiPhraseQuery is a generalized version of PhraseQuery, with an added method add(Term[])
. To use this class, to search for the phrase "Microsoft app*" first use add(Term) on the term "Microsoft", then find all terms that have "app" as prefix using IndexReader.terms(Term), and use MultiPhraseQuery.add(Term[] terms) to add them to the query.
More...
#include <MultiPhraseQuery.h>
Public Member Functions | |
MultiPhraseQuery () | |
virtual | ~MultiPhraseQuery () |
virtual String | getClassName () |
boost::shared_ptr< MultiPhraseQuery > | shared_from_this () |
void | setSlop (int32_t s) |
Sets the phrase slop for this query. | |
int32_t | getSlop () |
Gets the phrase slop for this query. | |
void | add (const TermPtr &term) |
Add a single term at the next position in the phrase. | |
void | add (Collection< TermPtr > terms) |
Add multiple terms at the next position in the phrase. Any of the terms may match. | |
void | add (Collection< TermPtr > terms, int32_t position) |
Allows to specify the relative position of terms within the phrase. | |
Collection< Collection< TermPtr > > | getTermArrays () |
Returns a List of the terms in the multiphrase. Do not modify the List or its contents. | |
Collection< int32_t > | getPositions () |
Returns the relative positions of terms in this phrase. | |
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 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 WeightPtr | createWeight (const SearcherPtr &searcher) |
Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves. | |
virtual String | toString (const String &field) |
Prints a user-readable version of this query. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
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 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. | |
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. | |
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 String | _getClassName () |
static QueryPtr | mergeBooleanQueries (Collection< BooleanQueryPtr > queries) |
Merges the clauses of a set of BooleanQuery's into a single BooleanQuery. | |
Protected Member Functions | |
int32_t | termArraysHashCode () |
bool | termArraysEquals (Collection< Collection< TermPtr > > first, Collection< Collection< TermPtr > > second) |
![]() | |
LuceneObject () | |
Protected Attributes | |
String | field |
Collection< Collection< TermPtr > > | termArrays |
Collection< int32_t > | positions |
int32_t | slop |
![]() | |
double | boost |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
MultiPhraseQuery is a generalized version of PhraseQuery, with an added method add(Term[])
. To use this class, to search for the phrase "Microsoft app*" first use add(Term) on the term "Microsoft", then find all terms that have "app" as prefix using IndexReader.terms(Term), and use MultiPhraseQuery.add(Term[] terms) to add them to the query.
Lucene::MultiPhraseQuery::MultiPhraseQuery | ( | ) |
|
virtual |
|
inlinestatic |
void Lucene::MultiPhraseQuery::add | ( | Collection< TermPtr > | terms | ) |
Add multiple terms at the next position in the phrase. Any of the terms may match.
void Lucene::MultiPhraseQuery::add | ( | Collection< TermPtr > | terms, |
int32_t | position | ||
) |
Allows to specify the relative position of terms within the phrase.
void Lucene::MultiPhraseQuery::add | ( | const TermPtr & | term | ) |
Add a single term at the next position in the phrase.
|
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.
|
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< int32_t > Lucene::MultiPhraseQuery::getPositions | ( | ) |
Returns the relative positions of terms in this phrase.
int32_t Lucene::MultiPhraseQuery::getSlop | ( | ) |
Gets the phrase slop for this query.
Collection< Collection< TermPtr > > Lucene::MultiPhraseQuery::getTermArrays | ( | ) |
Returns a List of the terms in the multiphrase. Do not modify the List or its contents.
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::Query.
|
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.
void Lucene::MultiPhraseQuery::setSlop | ( | int32_t | s | ) |
Sets the phrase slop for this query.
|
inline |
|
protected |
|
protected |
|
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 user-readable version of this query.
Reimplemented from Lucene::Query.
|
protected |
|
protected |
|
protected |
|
protected |