#include <enquire.h>
Public Methods | |
Enquire (const Database &databases, ErrorHandler *errorhandler_=0) | |
Create an Xapian::Enquire object. More... | |
~Enquire () | |
Close the Xapian::Enquire object. More... | |
void | set_query (const Xapian::Query &query_) |
Set the query to run. More... | |
const Xapian::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 (Xapian::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 (Xapian::percent percent_cutoff, Xapian::weight weight_cutoff=0) |
Set the percentage and/or weight cutoffs. More... | |
void | set_sorting (Xapian::valueno sort_key, int sort_bands) |
Set the sorting key and number of sort bands. More... | |
void | set_bias (Xapian::weight bias_weight, time_t bias_halflife) |
Set the bias functor parameters. More... | |
MSet | get_mset (Xapian::doccount first, Xapian::doccount maxitems, const RSet *omrset=0, const MatchDecider *mdecider=0) const |
Get (a portion of) the match set for the current query. More... | |
ESet | get_eset (Xapian::termcount maxitems, const RSet &omrset, int flags=0, double k=1.0, const Xapian::ExpandDecider *edecider=0) const |
Get the expand set for the given rset. More... | |
ESet | get_eset (Xapian::termcount maxitems, const RSet &omrset, const Xapian::ExpandDecider *edecider) const |
Get the expand set for the given rset. More... | |
TermIterator | get_matching_terms_begin (Xapian::docid did) const |
Get terms which match a given document, by document id. More... | |
TermIterator | get_matching_terms_end (Xapian::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 a MatchDecider. More... | |
std::string | get_description () const |
Introspection method. More... | |
Public Attributes | |
Xapian::Internal::RefCntPtr< 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 Xapian::Error exceptions when calling any method in Xapian::Enquire.
Xapian::InvalidArgumentError | will be thrown if an invalid argument is supplied, for example, an unknown database type. |
Xapian::DatabaseOpeningError | will be thrown if the database cannot be opened (for example, a required file cannot be found). |
|
Create an Xapian::Enquire object. This specification cannot be changed once the Xapian::Enquire is opened: you must create a new Xapian::Enquire object to access a different database, or set of databases.
|
|
Close the Xapian::Enquire object.
|
|
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 Xapian::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 Xapian::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 a MatchDecider.
|
|
Set the bias functor parameters. NB this is a temporary API for this feature.
|
|
Set the collapse key to use for queries.
An example use might be to create a value for each document containing an MD5 hash of the document contents. Then duplicate documents from different sources can be eliminated at search time (it's better to eliminate duplicates at index time, but this may not be always be possible - for example the search may be over more than one Xapian database). Another use is to group matches in a particular category (e.g. you might collapse a mailing list search on the Subject: so that there's only one result per discussion thread). In this case you can use get_collapse_count() to give the user some idea how many other results there are. And if you index the Subject: as a boolean term as well as putting it in a value, you can offer a link to a non-collapsed search restricted to that thread using a boolean filter. (default is Xapian::valueno(-1) which means no collapsing). |
|
Set the percentage and/or weight cutoffs.
|
|
Set the query to run.
|
|
Set the collapse key to use for queries.
|
|
Set the sorting key and number of sort bands.
|
|
Set the weighting scheme to use for queries.
|