RemoteSubMatch Class Reference

Class for performing matching on a remote database. More...

#include <remotesubmatch.h>

Inheritance diagram for RemoteSubMatch:

Collaboration diagram for RemoteSubMatch:

List of all members.

Public Member Functions

RemoteSubMatch (RemoteDatabase *db_, bool decreasing_relevance_, const vector< Xapian::MatchSpy * > &matchspies)

Constructor.

bool prepare_match (bool nowait, Xapian::Weight::Internal &total_stats)

Fetch and collate statistics.

void start_match (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const Xapian::Weight::Internal &total_stats)

Start the match.

PostList * get_postlist_and_term_info (MultiMatch *matcher, std::map< std::string, Xapian::MSet::Internal::TermFreqAndWeight > *termfreqandwts, Xapian::termcount *total_subqs_ptr)

Get PostList and term info.

double get_percent_factor () const

Get percentage factor - only valid after get_postlist_and_term_info().

void get_mset (Xapian::MSet &mset)

Short-cut for single remote match.

Private Member Functions

void operator= (const RemoteSubMatch &)

Don't allow assignment.

RemoteSubMatch (const RemoteSubMatch &)

Don't allow copying.

Private Attributes

RemoteDatabase * db

The remote database.

bool decreasing_relevance

Is the sort order such the relevance decreases down the MSet?

double percent_factor

The factor to use to convert weights to percentages.

const vector< Xapian::MatchSpy * > & matchspies

The matchspies to use.

Detailed Description

Class for performing matching on a remote database.

Definition at line 34 of file remotesubmatch.h.

Constructor & Destructor Documentation

RemoteSubMatch::RemoteSubMatch ( const RemoteSubMatch & ) [private]

Don't allow copying.

RemoteSubMatch::RemoteSubMatch	(	RemoteDatabase *	db_,
		bool	decreasing_relevance_,
		const vector< Xapian::MatchSpy * > &	matchspies
	)

Constructor.

Definition at line 31 of file remotesubmatch.cc.

References LOGCALL_CTOR.

Member Function Documentation

void RemoteSubMatch::get_mset ( Xapian::MSet & mset ) [inline]

Short-cut for single remote match.

Definition at line 81 of file remotesubmatch.h.

References db, RemoteDatabase::get_mset(), and matchspies.

Referenced by MultiMatch::get_mset().

double RemoteSubMatch::get_percent_factor ( ) const [inline]

Get percentage factor - only valid after get_postlist_and_term_info().

Definition at line 78 of file remotesubmatch.h.

References percent_factor.

Referenced by MultiMatch::get_mset().

PostList * RemoteSubMatch::get_postlist_and_term_info	(	MultiMatch *	matcher,
		std::map< std::string, Xapian::MSet::Internal::TermFreqAndWeight > *	termfreqandwts,
		Xapian::termcount *	total_subqs_ptr
	)			`[virtual]`

Get PostList and term info.

Implements SubMatch.

Definition at line 63 of file remotesubmatch.cc.

References db, decreasing_relevance, RemoteDatabase::get_mset(), Xapian::MSet::internal, LOGCALL, matchspies, and percent_factor.

void RemoteSubMatch::operator= ( const RemoteSubMatch & ) [private]

Don't allow assignment.

bool RemoteSubMatch::prepare_match	(	bool	nowait,
		Xapian::Weight::Internal &	total_stats
	)			`[virtual]`

Fetch and collate statistics.

Implements SubMatch.

Definition at line 42 of file remotesubmatch.cc.

References db, RemoteDatabase::get_remote_stats(), LOGCALL, and RETURN.

void RemoteSubMatch::start_match	(	Xapian::doccount	first,
		Xapian::doccount	maxitems,
		Xapian::doccount	check_at_least,
		const Xapian::Weight::Internal &	total_stats
	)			`[virtual]`

Start the match.

Implements SubMatch.

Definition at line 53 of file remotesubmatch.cc.

References db, LOGCALL_VOID, and RemoteDatabase::send_global_stats().

Referenced by MultiMatch::get_mset().

Member Data Documentation

RemoteDatabase* RemoteSubMatch::db [private]

The remote database.

Definition at line 42 of file remotesubmatch.h.

Referenced by get_mset(), get_postlist_and_term_info(), prepare_match(), and start_match().

bool RemoteSubMatch::decreasing_relevance [private]

Is the sort order such the relevance decreases down the MSet?

This is true for sort_by_relevance and sort_by_relevance_then_value.

Definition at line 48 of file remotesubmatch.h.

Referenced by get_postlist_and_term_info().

const vector<Xapian::MatchSpy *>& RemoteSubMatch::matchspies [private]

The matchspies to use.

Definition at line 54 of file remotesubmatch.h.

Referenced by get_mset(), and get_postlist_and_term_info().

double RemoteSubMatch::percent_factor [private]

The factor to use to convert weights to percentages.

Definition at line 51 of file remotesubmatch.h.

Referenced by get_percent_factor(), and get_postlist_and_term_info().

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

matcher/remotesubmatch.h
matcher/remotesubmatch.cc


Public Member Functions
	RemoteSubMatch (RemoteDatabase db_, bool decreasing_relevance_, const vector< Xapian::MatchSpy > &matchspies)
	Constructor.
bool	prepare_match (bool nowait, Xapian::Weight::Internal &total_stats)
	Fetch and collate statistics.
void	start_match (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const Xapian::Weight::Internal &total_stats)
	Start the match.
PostList *	get_postlist_and_term_info (MultiMatch matcher, std::map< std::string, Xapian::MSet::Internal::TermFreqAndWeight > termfreqandwts, Xapian::termcount *total_subqs_ptr)
	Get PostList and term info.
double	get_percent_factor () const
	Get percentage factor - only valid after get_postlist_and_term_info().
void	get_mset (Xapian::MSet &mset)
	Short-cut for single remote match.
Private Member Functions
void	operator= (const RemoteSubMatch &)
	Don't allow assignment.
	RemoteSubMatch (const RemoteSubMatch &)
	Don't allow copying.
Private Attributes
RemoteDatabase *	db
	The remote database.
bool	decreasing_relevance
	Is the sort order such the relevance decreases down the MSet?
double	percent_factor
	The factor to use to convert weights to percentages.
const vector< Xapian::MatchSpy * > &	matchspies
	The matchspies to use.