Internals of enquire system. More...

#include <omenquireinternal.h>

Inheritance diagram for Xapian::Enquire::Internal:

Collaboration diagram for Xapian::Enquire::Internal:

Public Types
enum	sort_setting { REL, VAL, VAL_REL, REL_VAL }

Public Member Functions
	Internal (const Xapian::Database &databases)

	~Internal ()

void	request_doc (const Xapian::Internal::MSetItem &item) const
	Request a document from the database. More...

Xapian::Document	read_doc (const Xapian::Internal::MSetItem &item) const
	Read a previously requested document from the database. More...

Xapian::Document	get_document (const Xapian::Internal::MSetItem &item) const

void	set_query (const Query &query_, termcount qlen_)

const Query &	get_query () const

MSet	get_mset (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const RSet omrset, const MatchDecider mdecider) const

ESet	get_eset (Xapian::termcount maxitems, const RSet &omrset, int flags, const ExpandDecider *edecider, double 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 Member Functions inherited from Xapian::Internal::intrusive_base
	intrusive_base ()
	Construct with no references. More...

Public Attributes
Xapian::valueno	collapse_key

Xapian::doccount	collapse_max

Xapian::Enquire::docid_order	order

int	percent_cutoff

double	weight_cutoff

Xapian::valueno	sort_key

sort_setting	sort_by

bool	sort_value_forward

Xapian::Internal::opt_intrusive_ptr< KeyMaker >	sorter

double	time_limit

Weight *	weight
	The weight to use for this query. More...

std::string	eweightname
	The weighting scheme to use for query expansion. More...

double	expand_k
	The parameter required for TradWeight query expansion. More...

vector< Xapian::Internal::opt_intrusive_ptr< MatchSpy > >	spies

Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned	_refs
	Reference count. More...

Private Member Functions
	Internal (const Internal &)
	Copy not allowed. More...

void	operator= (const Internal &)
	Assignment not allowed. More...

Private Attributes
const Xapian::Database	db
	The database which this enquire object uses. More...

Query	query
	The user's query. More...

termcount	qlen
	The query length. More...

Friends
class	MSet::Internal

Detailed Description

Internals of enquire system.

This allows the implementation of Xapian::Enquire to be hidden and reference counted.

Definition at line 122 of file omenquireinternal.h.

Member Enumeration Documentation

◆ sort_setting

enum Xapian::Enquire::Internal::sort_setting

Enumerator
REL
VAL
VAL_REL
REL_VAL

Definition at line 140 of file omenquireinternal.h.

Constructor & Destructor Documentation

◆ Internal() [1/2]

Xapian::Enquire::Internal::Internal ( const Internal & )

private

Copy not allowed.

◆ Internal() [2/2]

Xapian::Enquire::Internal::Internal ( const Xapian::Database & databases )

explicit

Definition at line 507 of file omenquire.cc.

References db, and Xapian::Database::internal.

◆ ~Internal()

Xapian::Enquire::Internal::~Internal ( )

Definition at line 519 of file omenquire.cc.

References weight.

Member Function Documentation

◆ get_description()

string Xapian::Enquire::Internal::get_description ( ) const

Definition at line 710 of file omenquire.cc.

References db, Xapian::Database::get_description(), Xapian::Query::get_description(), and query.

◆ get_document()

Document Xapian::Enquire::Internal::get_document ( const Xapian::Internal::MSetItem & item ) const

Definition at line 745 of file omenquire.cc.

References db, Xapian::Internal::MSetItem::did, and Xapian::Database::internal.

◆ get_eset()

ESet Xapian::Enquire::Internal::get_eset	(	Xapian::termcount	maxitems,
		const RSet &	omrset,
		int	flags,
		const ExpandDecider *	edecider,
		double	min_wt
	)		const

Definition at line 594 of file omenquire.cc.

References db, Xapian::RSet::empty(), Xapian::Query::empty(), eweightname, expand_k, Xapian::Query::get_terms_begin(), Xapian::Query::get_terms_end(), Xapian::Enquire::INCLUDE_QUERY_TERMS, Xapian::ESet::internal, LOGCALL, LOGVALUE, query, RETURN, Xapian::RSet::size(), and Xapian::Enquire::USE_EXACT_TERMFREQ.

◆ get_matching_terms() [1/2]

TermIterator Xapian::Enquire::Internal::get_matching_terms ( Xapian::docid did ) const

Definition at line 659 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().

◆ get_matching_terms() [2/2]

TermIterator Xapian::Enquire::Internal::get_matching_terms ( const Xapian::MSetIterator & it ) const

Definition at line 696 of file omenquire.cc.

References get_matching_terms().

◆ get_mset()

MSet Xapian::Enquire::Internal::get_mset	(	Xapian::doccount	first,
		Xapian::doccount	maxitems,
		Xapian::doccount	check_at_least,
		const RSet *	omrset,
		const MatchDecider *	mdecider
	)		const

Definition at line 539 of file omenquire.cc.

References Assert, collapse_key, collapse_max, db, Xapian::Database::get_doccount(), Xapian::MSet::internal, LOGCALL, order, percent_cutoff, qlen, query, RETURN, sort_by, sort_key, sort_value_forward, sorter, spies, time_limit, VAL, VAL_REL, and weight_cutoff.

◆ get_query()

const Query & Xapian::Enquire::Internal::get_query ( ) const

Definition at line 533 of file omenquire.cc.

References query.

◆ get_termfreq()

Xapian::doccount Xapian::Enquire::Internal::get_termfreq ( const string & tname ) const

Definition at line 704 of file omenquire.cc.

References db, and Xapian::Database::get_termfreq().

◆ operator=()

void Xapian::Enquire::Internal::operator= ( const Internal & )

private

Assignment not allowed.

◆ read_doc()

Document Xapian::Enquire::Internal::read_doc ( const Xapian::Internal::MSetItem & item ) const

Read a previously requested document from the database.

Definition at line 732 of file omenquire.cc.

References db, Xapian::Internal::MSetItem::did, and Xapian::Database::internal.

◆ request_doc()

void Xapian::Enquire::Internal::request_doc ( const Xapian::Internal::MSetItem & item ) const

Request a document from the database.

Definition at line 721 of file omenquire.cc.

References db, Xapian::Internal::MSetItem::did, and Xapian::Database::internal.

◆ set_query()

void Xapian::Enquire::Internal::set_query	(	const Query &	query_,
		termcount	qlen_
	)

Definition at line 526 of file omenquire.cc.

References Xapian::Query::get_length(), qlen, and query.

Friends And Related Function Documentation

◆ MSet::Internal

friend class MSet::Internal

friend

Definition at line 123 of file omenquireinternal.h.

Member Data Documentation

◆ collapse_key

Xapian::valueno Xapian::Enquire::Internal::collapse_key

Definition at line 142 of file omenquireinternal.h.

Referenced by get_mset().

◆ collapse_max

Xapian::doccount Xapian::Enquire::Internal::collapse_max

Definition at line 144 of file omenquireinternal.h.

Referenced by get_mset().

◆ db

const Xapian::Database Xapian::Enquire::Internal::db

private

The database which this enquire object uses.

Definition at line 126 of file omenquireinternal.h.

Referenced by get_description(), get_document(), get_eset(), get_matching_terms(), get_mset(), get_termfreq(), Internal(), read_doc(), and request_doc().

◆ eweightname

std::string Xapian::Enquire::Internal::eweightname

The weighting scheme to use for query expansion.

Definition at line 168 of file omenquireinternal.h.

Referenced by get_eset().

◆ expand_k

double Xapian::Enquire::Internal::expand_k

The parameter required for TradWeight query expansion.

Definition at line 171 of file omenquireinternal.h.

Referenced by get_eset().

◆ order

Xapian::Enquire::docid_order Xapian::Enquire::Internal::order

Definition at line 146 of file omenquireinternal.h.

Referenced by get_mset().

◆ percent_cutoff

int Xapian::Enquire::Internal::percent_cutoff

Definition at line 148 of file omenquireinternal.h.

Referenced by get_mset().

◆ qlen

termcount Xapian::Enquire::Internal::qlen

private

The query length.

Definition at line 132 of file omenquireinternal.h.

Referenced by get_mset(), and set_query().

◆ query

Query Xapian::Enquire::Internal::query

private

The user's query.

Definition at line 129 of file omenquireinternal.h.

Referenced by get_description(), get_eset(), get_matching_terms(), get_mset(), get_query(), and set_query().

◆ sort_by

sort_setting Xapian::Enquire::Internal::sort_by

Definition at line 153 of file omenquireinternal.h.

Referenced by get_mset().

◆ sort_key

Xapian::valueno Xapian::Enquire::Internal::sort_key

Definition at line 152 of file omenquireinternal.h.

Referenced by get_mset().

◆ sort_value_forward

bool Xapian::Enquire::Internal::sort_value_forward

Definition at line 154 of file omenquireinternal.h.

Referenced by get_mset().

◆ sorter

Xapian::Internal::opt_intrusive_ptr<KeyMaker> Xapian::Enquire::Internal::sorter

Definition at line 156 of file omenquireinternal.h.

Referenced by get_mset().

◆ spies

vector<Xapian::Internal::opt_intrusive_ptr<MatchSpy> > Xapian::Enquire::Internal::spies

Definition at line 173 of file omenquireinternal.h.

Referenced by get_mset().

◆ time_limit

double Xapian::Enquire::Internal::time_limit

Definition at line 158 of file omenquireinternal.h.

Referenced by get_mset().

◆ weight

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 165 of file omenquireinternal.h.

Referenced by ~Internal().

◆ weight_cutoff

double Xapian::Enquire::Internal::weight_cutoff

Definition at line 150 of file omenquireinternal.h.

Referenced by get_mset().

The documentation for this class was generated from the following files:

api/omenquireinternal.h
api/omenquire.cc

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ sort_setting

Constructor & Destructor Documentation

◆ Internal() [1/2]

◆ Internal() [2/2]

◆ ~Internal()

Member Function Documentation

◆ get_description()

◆ get_document()

◆ get_eset()

◆ get_matching_terms() [1/2]

◆ get_matching_terms() [2/2]

◆ get_mset()

◆ get_query()

◆ get_termfreq()

◆ operator=()

◆ read_doc()

◆ request_doc()

◆ set_query()

Friends And Related Function Documentation

◆ MSet::Internal

Member Data Documentation

◆ collapse_key

◆ collapse_max

◆ db

◆ eweightname

◆ expand_k

◆ order

◆ percent_cutoff

◆ qlen

◆ query

◆ sort_by

◆ sort_key

◆ sort_value_forward

◆ sorter

◆ spies

◆ time_limit

◆ weight

◆ weight_cutoff