#include <enquire.h>
Public Methods | |
Enquire (const Database &databases, ErrorHandler *errorhandler_=0) | |
Create an Enquire object. More... | |
~Enquire () | |
Close the Enquire object. More... | |
void | set_query (const Query &query_) |
Set the query to run. More... | |
const Query & | get_query () |
Get the query which has been set. More... | |
void | set_weighting_scheme (const Weight &weight_) |
Set the weighting scheme to use for queries. More... | |
void | set_collapse_key (valueno collapse_key) |
Set the collapse key to use for queries. More... | |
void | set_sort_forward (bool sort_forward) |
Set the collapse key to use for queries. More... | |
void | set_cutoff (int percent_cutoff, weight weight_cutoff=0) |
Set the percentage and/or weight cutoffs. More... | |
void | set_sorting (valueno sort_key, int sort_bands) |
Set the percentage and/or weight cutoffs. More... | |
void | set_bias (weight bias_weight, time_t bias_halflife) |
Set the bias functor parameters. More... | |
MSet | get_mset (doccount first, doccount maxitems, const RSet *rset=0, const MatchDecider *mdecider=0) const |
Get (a portion of) the match set for the current query. More... | |
ESet | get_eset (termcount maxitems, const RSet &rset, int flags=0, double k=1.0, const ExpandDecider *edecider=0) const |
Get the expand set for the given rset. More... | |
ESet | get_eset (termcount maxitems, const RSet &rset, const ExpandDecider *edecider) const |
Get the expand set for the given rset. More... | |
TermIterator | get_matching_terms_begin (docid did) const |
Get terms which match a given document, by document id. More... | |
TermIterator | get_matching_terms_end (docid did) const |
End iterator corresponding to get_matching_terms_begin(). More... | |
TermIterator | get_matching_terms_begin (const MSetIterator &it) const |
Get terms which match a given document, by match set item. More... | |
TermIterator | get_matching_terms_end (const MSetIterator &it) const |
End iterator corresponding to get_matching_terms_begin(). More... | |
void | register_match_decider (const std::string &name, const MatchDecider *mdecider=NULL) |
Register an MatchDecider. More... | |
std::string | get_description () const |
Introspection method. More... | |
Public Attributes | |
Internal * | internal |
Static Public Attributes | |
const int | include_query_terms = 1 |
const int | use_exact_termfreq = 2 |
Databases are usually opened lazily, so exceptions may not be thrown where you would expect them to be. You should catch Error exceptions when calling any method in Enquire.
Xapian::InvalidArgumentError | will be thrown if an invalid argument is supplied, for example, an unknown database type. |
Xapian::OpeningError | will be thrown if the database cannot be opened (for example, a required file cannot be found). |
|
Create an Enquire object. This specification cannot be changed once the Enquire is opened: you must create a new Enquire object to access a different database, or set of databases.
|
|
Close the Enquire object. This frees all resources associated with the Enquire object, such as handles on the databases used. As a result, any object which refers to these databases, such as a Document, will become invalid after the destruction of the object, and must not be used subsequently. |
|
Introspection method.
|
|
Get the expand set for the given rset.
|
|
Get the expand set for the given rset.
|
|
Get terms which match a given document, by match set item. This method returns the terms in the current query which match the given document. If the underlying database has suitable support, using this call (rather than passing an docid) will enable the system to ensure that the correct data is returned, and that the document has not been deleted or changed since the query was performed.
|
|
Get terms which match a given document, by document id. This method returns the terms in the current query which match the given document. It is possible for the document to have been removed from the database between the time it is returned in an mset, and the time that this call is made. If possible, you should specify an MSetIterator instead of a docid, since this will enable database backends with suitable support to prevent this occurring. Note that a query does not need to have been run in order to make this call.
|
|
End iterator corresponding to get_matching_terms_begin().
|
|
End iterator corresponding to get_matching_terms_begin().
|
|
Get (a portion of) the match set for the current query.
|
|
Get the query which has been set. This is only valid after set_query() has been called.
|
|
Register an MatchDecider.
|
|
Set the bias functor parameters. NB this is a temporary API for this feature.
|
|
Set the collapse key to use for queries.
|
|
Set the percentage and/or weight cutoffs.
|
|
Set the query to run.
|
|
Set the collapse key to use for queries.
|
|
Set the percentage and/or weight cutoffs.
|
|
Set the weighting scheme to use for queries.
|