#include <query.h>
Collaboration diagram for Xapian::Query:
Public Types | |
enum | op { OP_AND, OP_OR, OP_AND_NOT, OP_XOR, OP_AND_MAYBE, OP_FILTER, OP_NEAR, OP_PHRASE, OP_WEIGHT_CUTOFF, OP_ELITE_SET } |
Enum of possible query operations. More... | |
Public Methods | |
Query (const Query ©me) | |
Copy constructor. More... | |
Query & | operator= (const Query ©me) |
Assignment. More... | |
Query () | |
Default constructor: makes an empty query which matches no documents. More... | |
~Query () | |
Destructor. More... | |
Query (const std::string &tname_, Xapian::termcount wqf_=1, Xapian::termpos pos_=0) | |
A query consisting of a single term. More... | |
Query (Query::op op_, const Query &left, const Query &right) | |
A query consisting of two subqueries, opp-ed together. More... | |
Query (Query::op op_, const std::string &left, const std::string &right) | |
A query consisting of two termnames opp-ed together. More... | |
template<class Iterator> | Query (Query::op op_, Iterator qbegin, Iterator qend) |
Combine a number of Xapian::Query-s with the specified operator. More... | |
template<class SubQ> | Query (Query::op op_, SubQ q) |
Apply the specified operator to a single Xapian::Query object. More... | |
void | set_window (Xapian::termpos window) |
Set the window size, for a NEAR or PHRASE query. More... | |
void | set_cutoff (Xapian::weight cutoff) |
Set the cutoff parameter, for a WEIGHT_CUTOFF query. More... | |
void | set_elite_set_size (Xapian::termcount size) |
Set the elite set size, for ELITE_SET queries. More... | |
Xapian::termcount | get_length () const |
Get the length of the query, used by some ranking formulae. More... | |
Xapian::termcount | set_length (Xapian::termcount qlen) |
Set the length of the query. More... | |
TermIterator | get_terms_begin () const |
Return a Xapian::TermIterator returning all the terms in the query, in order of termpos. More... | |
TermIterator | get_terms_end () const |
Return a Xapian::TermIterator to the end of the list of terms in the query. More... | |
bool | is_empty () const |
Test is the query is empty (i.e. More... | |
std::string | get_description () const |
Returns a string representing the query. More... | |
Public Attributes | |
Xapian::Internal::RefCntPtr< Internal > | internal |
Queries are represented as a tree of objects.
|
|
Copy constructor.
|
|
Default constructor: makes an empty query which matches no documents. Also useful for defining a Query object to be assigned to later. An exception will be thrown if an attempt is made to use an undefined query when building up a composite query. |
|
Destructor.
|
|
A query consisting of a single term.
|
|
A query consisting of two subqueries, opp-ed together.
|
|
A query consisting of two termnames opp-ed together.
|
|
Combine a number of Xapian::Query-s with the specified operator. The Xapian::Query objects are specified with begin and end iterators. AND, OR, NEAR and PHRASE can take any number of subqueries. WEIGHT_CUTOFF takes only one subquery. Other operators take exactly two subqueries. The iterators may be to Xapian::Query objects, pointers to Xapian::Query objects, or termnames (std::string-s). |
|
Apply the specified operator to a single Xapian::Query object. The subquery may a Xapian::Query object, a pointer to a Xapian::Query object or std::string. |
|
Returns a string representing the query. Introspection method. |
|
Get the length of the query, used by some ranking formulae. This value is calculated automatically, but may be overridden using set_length(). |
|
Return a Xapian::TermIterator returning all the terms in the query, in order of termpos. If multiple terms have the same term position, their order is unspecified. Duplicates (same term and termpos) will be removed. |
|
Return a Xapian::TermIterator to the end of the list of terms in the query.
|
|
Test is the query is empty (i.e. was constructed using the default ctor or with an empty iterator ctor). |
|
Assignment.
|
|
Set the cutoff parameter, for a WEIGHT_CUTOFF query.
|
|
Set the elite set size, for ELITE_SET queries.
|
|
Set the length of the query. This overrides the automatically calculated value, which may be desirable in some situations. Returns the old value of the query length. |
|
Set the window size, for a NEAR or PHRASE query.
|