#include <omquery.h>
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 | |
OmQuery (const OmQuery ©me) | |
Copy constructor. More... | |
OmQuery & | operator= (const OmQuery ©me) |
Assignment. More... | |
OmQuery () | |
Default constructor: makes an undefined query which can't be used directly. More... | |
~OmQuery () | |
Destructor. More... | |
OmQuery (const om_termname &tname_, om_termcount wqf_=1, om_termpos term_pos_=0) | |
A query consisting of a single term. More... | |
OmQuery (OmQuery::op op_, const OmQuery &left, const OmQuery &right) | |
A query consisting of two subqueries, opp-ed together. More... | |
OmQuery (OmQuery::op op_, const om_termname &left, const om_termname &right) | |
A query consisting of two termnames opp-ed together. More... | |
template<class Iterator> | OmQuery (OmQuery::op op_, Iterator qbegin, Iterator qend) |
A set of OmQuery's, merged together with specified operator. More... | |
template<class SubQ> | OmQuery (OmQuery::op op_, SubQ q) |
A single OmQuery, modified by a specified operator. More... | |
void | set_window (om_termpos window) |
Set the window size, for a NEAR or PHRASE query. More... | |
void | set_cutoff (om_weight cutoff) |
Set the cutoff parameter, for a WEIGHT_CUTOFF query. More... | |
void | set_elite_set_size (om_termcount size) |
Set the elite set size, for ELITE_SET queries. More... | |
om_termcount | get_length () const |
Get the length of the query, used by some ranking formulae. More... | |
om_termcount | set_length (om_termcount qlen) |
Set the length of the query. More... | |
OmTermIterator | get_terms_begin () const |
Return an OmTermIterator returning all the terms in the query, in order of termpos. More... | |
OmTermIterator | get_terms_end () const |
Return an OmTermIterator to the end of the list of terms in the query. More... | |
bool | is_empty () const |
Test is the query is empty (i.e. was set using OmQuery() or with. More... | |
std::string | get_description () const |
Returns a string representing the query. More... | |
Public Attributes | |
Internal * | internal |
Queries are represented as a hierarchy of classes.
|
|
Copy constructor.
|
|
Default constructor: makes an undefined query which can't be used directly. Such queries should be thought of as placeholders: they are provided merely for convenience. An exception will be thrown if an attempt is made to run an undefined query, or 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.
|
|
A set of OmQuery's, merged together with specified operator. (Takes begin and end iterators). AND, OR, NEAR and PHRASE can take any number of subqueries. WEIGHT_CUTOFF takes only one subquery. If the operator is anything else then there must be exactly two subqueries. The iterators may be to any of OmQuery objects, OmQuery pointers, or om_termname objects (ie, strings). |
|
A single OmQuery, modified by a specified operator. The subquery may be any of: an OmQuery object, OmQuery pointer, or om_termname. |
|
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 an OmTermIterator 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 an OmTermIterator to the end of the list of terms in the query.
|
|
Test is the query is empty (i.e. was set using OmQuery() or with.
|
|
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.
|