Xapian::Enquire::Internal Class Reference
Internals of enquire system. More...
#include <omenquireinternal.h>
Public Types | |
| enum | sort_setting { REL, VAL, VAL_REL, REL_VAL } |
Public Member Functions | |
| Internal (const Xapian::Database &databases, ErrorHandler *errorhandler_) | |
| ~Internal () | |
| void | request_doc (const Xapian::Internal::MSetItem &item) const |
| Request a document from the database. | |
| Xapian::Document | read_doc (const Xapian::Internal::MSetItem &item) const |
| Read a previously requested document from the database. | |
| void | set_query (const Query &query_, termcount qlen_) |
| const Query & | get_query () |
| MSet | get_mset (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const RSet *omrset, const MatchDecider *mdecider, const MatchDecider *matchspy_legacy) const |
| ESet | get_eset (Xapian::termcount maxitems, const RSet &omrset, int flags, double k, const ExpandDecider *edecider, Xapian::weight min_wt) const |
| TermIterator | get_matching_terms (Xapian::docid did) const |
| TermIterator | get_matching_terms (const Xapian::MSetIterator &it) const |
| Xapian::doccount | get_termfreq (const string &tname) const |
| string | get_description () const |
Public Attributes | |
| Xapian::valueno | collapse_key |
| Xapian::doccount | collapse_max |
| Xapian::Enquire::docid_order | order |
| percent | percent_cutoff |
| Xapian::weight | weight_cutoff |
| Xapian::valueno | sort_key |
| sort_setting | sort_by |
| bool | sort_value_forward |
| KeyMaker * | sorter |
| ErrorHandler * | errorhandler |
| The error handler, if set. | |
| Weight * | weight |
| The weight to use for this query. | |
| vector< MatchSpy * > | spies |
Private Member Functions | |
| Internal (const Internal &) | |
| Copy not allowed. | |
| void | operator= (const Internal &) |
| Assignment not allowed. | |
Private Attributes | |
| const Xapian::Database | db |
| The database which this enquire object uses. | |
| Query | query |
| The user's query. | |
| termcount | qlen |
| The query length. | |
Detailed Description
Internals of enquire system.This allows the implementation of Xapian::Enquire to be hidden and reference counted.
Definition at line 116 of file omenquireinternal.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
| Xapian::Enquire::Internal::Internal | ( | const Internal & | ) | [private] |
Copy not allowed.
| Xapian::Enquire::Internal::Internal | ( | const Xapian::Database & | databases, | |
| ErrorHandler * | errorhandler_ | |||
| ) |
| Xapian::Enquire::Internal::~Internal | ( | ) |
Member Function Documentation
| string Xapian::Enquire::Internal::get_description | ( | ) | const |
Definition at line 807 of file omenquire.cc.
References db, Xapian::Query::get_description(), Xapian::Database::get_description(), and query.
| ESet Xapian::Enquire::Internal::get_eset | ( | Xapian::termcount | maxitems, | |
| const RSet & | omrset, | |||
| int | flags, | |||
| double | k, | |||
| const ExpandDecider * | edecider, | |||
| Xapian::weight | min_wt | |||
| ) | const |
Definition at line 692 of file omenquire.cc.
References db, Xapian::Query::empty(), Xapian::RSet::empty(), Xapian::Query::get_terms_begin(), Xapian::Query::get_terms_end(), Xapian::Enquire::INCLUDE_QUERY_TERMS, LOGCALL, LOGVALUE, query, RETURN, Xapian::RSet::size(), and Xapian::Enquire::USE_EXACT_TERMFREQ.
| TermIterator Xapian::Enquire::Internal::get_matching_terms | ( | const Xapian::MSetIterator & | it | ) | const |
| TermIterator Xapian::Enquire::Internal::get_matching_terms | ( | Xapian::docid | did | ) | const |
Definition at line 754 of file omenquire.cc.
References db, Xapian::Query::empty(), Xapian::Query::get_terms_begin(), Xapian::Query::get_terms_end(), query, Xapian::Database::termlist_begin(), and Xapian::Database::termlist_end().
Referenced by get_matching_terms().
| MSet Xapian::Enquire::Internal::get_mset | ( | Xapian::doccount | first, | |
| Xapian::doccount | maxitems, | |||
| Xapian::doccount | check_at_least, | |||
| const RSet * | omrset, | |||
| const MatchDecider * | mdecider, | |||
| const MatchDecider * | matchspy_legacy | |||
| ) | const |
Definition at line 640 of file omenquire.cc.
References Assert, collapse_key, collapse_max, db, errorhandler, Xapian::Internal::RefCntPtr< T >::get(), Xapian::Database::get_doccount(), Xapian::Query::internal, LOGCALL, order, percent_cutoff, qlen, query, sort_by, sort_key, sort_value_forward, sorter, spies, VAL, VAL_REL, weight, and weight_cutoff.
| const Query & Xapian::Enquire::Internal::get_query | ( | ) |
| Xapian::doccount Xapian::Enquire::Internal::get_termfreq | ( | const string & | tname | ) | const |
| void Xapian::Enquire::Internal::operator= | ( | const Internal & | ) | [private] |
Assignment not allowed.
| Document Xapian::Enquire::Internal::read_doc | ( | const Xapian::Internal::MSetItem & | item | ) | const |
Read a previously requested document from the database.
Definition at line 834 of file omenquire.cc.
References db, Xapian::Internal::MSetItem::did, errorhandler, and Xapian::Database::internal.
| void Xapian::Enquire::Internal::request_doc | ( | const Xapian::Internal::MSetItem & | item | ) | const |
Request a document from the database.
Definition at line 818 of file omenquire.cc.
References db, Xapian::Internal::MSetItem::did, errorhandler, and Xapian::Database::internal.
Definition at line 627 of file omenquire.cc.
References Xapian::Query::get_length(), qlen, and query.
Member Data Documentation
const Xapian::Database Xapian::Enquire::Internal::db [private] |
The database which this enquire object uses.
Definition at line 119 of file omenquireinternal.h.
Referenced by get_description(), get_eset(), get_matching_terms(), get_mset(), get_termfreq(), Internal(), read_doc(), and request_doc().
The error handler, if set.
(0 if not set).
Definition at line 153 of file omenquireinternal.h.
Referenced by get_mset(), read_doc(), and request_doc().
termcount Xapian::Enquire::Internal::qlen [private] |
The query length.
Definition at line 125 of file omenquireinternal.h.
Referenced by get_mset(), and set_query().
Query Xapian::Enquire::Internal::query [private] |
The user's query.
Definition at line 122 of file omenquireinternal.h.
Referenced by get_description(), get_eset(), get_matching_terms(), get_mset(), get_query(), and set_query().
| vector<MatchSpy *> Xapian::Enquire::Internal::spies |
Weight* Xapian::Enquire::Internal::weight [mutable] |
The weight to use for this query.
This is mutable so that the default BM25Weight object can be created lazily when first required.
Definition at line 160 of file omenquireinternal.h.
Referenced by get_mset(), and ~Internal().
The documentation for this class was generated from the following files:
- common/omenquireinternal.h
- api/omenquire.cc