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

#include <remotesubmatch.h>

Inheritance diagram for RemoteSubMatch:

Collaboration diagram for RemoteSubMatch:

Public Member Functions
	RemoteSubMatch (RemoteDatabase *db_, bool decreasing_relevance_, const vector< Xapian::Internal::opt_intrusive_ptr< Xapian::MatchSpy >> &matchspies)
	Constructor. More...

bool	prepare_match (bool nowait, Xapian::Weight::Internal &total_stats)
	Fetch and collate statistics. More...

void	start_match (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, Xapian::Weight::Internal &total_stats)
	Start the match. More...

PostList *	get_postlist (MultiMatch matcher, Xapian::termcount total_subqs_ptr, Xapian::Weight::Internal &total_stats)
	Get PostList. More...

Xapian::doccount	get_uncollapsed_upper_bound () const
	Get uncollapsed_upper_bound from the remote MSet. More...

double	get_percent_factor () const
	Get percentage factor - only valid after get_postlist(). More...

void	get_mset (Xapian::MSet &mset)
	Short-cut for single remote match. More...

Public Member Functions inherited from SubMatch
virtual	~SubMatch ()
	Virtual destructor. More...

Public Member Functions inherited from Xapian::Internal::intrusive_base
	intrusive_base ()
	Construct with no references. More...

Private Member Functions
void	operator= (const RemoteSubMatch &)
	Don't allow assignment. More...

	RemoteSubMatch (const RemoteSubMatch &)
	Don't allow copying. More...

Private Attributes
RemoteDatabase *	db
	The remote database. More...

bool	decreasing_relevance
	Is the sort order such the relevance decreases down the MSet? More...

Xapian::doccount	uncollapsed_upper_bound
	uncollapsed_upper_bound from the remote MSet. More...

double	percent_factor
	The factor to use to convert weights to percentages. More...

const vector< Xapian::Internal::opt_intrusive_ptr< Xapian::MatchSpy > > &	matchspies
	The matchspies to use. More...

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

Detailed Description

Class for performing matching on a remote database.

Definition at line 34 of file remotesubmatch.h.

Constructor & Destructor Documentation

◆ RemoteSubMatch() [1/2]

RemoteSubMatch::RemoteSubMatch ( const RemoteSubMatch & )

private

Don't allow copying.

◆ RemoteSubMatch() [2/2]

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

Constructor.

Definition at line 31 of file remotesubmatch.cc.

References LOGCALL_CTOR.

Member Function Documentation

◆ get_mset()

void RemoteSubMatch::get_mset ( Xapian::MSet & mset )

inline

Short-cut for single remote match.

Definition at line 88 of file remotesubmatch.h.

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

Referenced by MultiMatch::get_mset().

◆ get_percent_factor()

double RemoteSubMatch::get_percent_factor ( ) const

inline

Get percentage factor - only valid after get_postlist().

Definition at line 85 of file remotesubmatch.h.

References percent_factor.

Referenced by MultiMatch::get_mset().

◆ get_postlist()

PostList * RemoteSubMatch::get_postlist	(	MultiMatch *	matcher,
		Xapian::termcount *	total_subqs_ptr,
		Xapian::Weight::Internal &	total_stats
	)

virtual

Get PostList.

Implements SubMatch.

Definition at line 63 of file remotesubmatch.cc.

References db, decreasing_relevance, RemoteDatabase::get_mset(), Xapian::MSet::internal, LOGCALL, matchspies, Xapian::Weight::Internal::merge(), percent_factor, RETURN, and uncollapsed_upper_bound.

◆ get_uncollapsed_upper_bound()

Xapian::doccount RemoteSubMatch::get_uncollapsed_upper_bound ( ) const

inline

Get uncollapsed_upper_bound from the remote MSet.

Definition at line 80 of file remotesubmatch.h.

References uncollapsed_upper_bound.

Referenced by MultiMatch::get_mset().

◆ operator=()

void RemoteSubMatch::operator= ( const RemoteSubMatch & )

private

Don't allow assignment.

◆ prepare_match()

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.

◆ start_match()

void RemoteSubMatch::start_match	(	Xapian::doccount	first,
		Xapian::doccount	maxitems,
		Xapian::doccount	check_at_least,
		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

◆ db

RemoteDatabase* RemoteSubMatch::db

private

The remote database.

Definition at line 42 of file remotesubmatch.h.

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

◆ decreasing_relevance

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().

◆ matchspies

const vector<Xapian::Internal::opt_intrusive_ptr<Xapian::MatchSpy> >& RemoteSubMatch::matchspies

private

The matchspies to use.

Definition at line 57 of file remotesubmatch.h.

Referenced by get_mset(), and get_postlist().

◆ percent_factor

double RemoteSubMatch::percent_factor

private

The factor to use to convert weights to percentages.

Definition at line 54 of file remotesubmatch.h.

Referenced by get_percent_factor(), and get_postlist().

◆ uncollapsed_upper_bound

Xapian::doccount RemoteSubMatch::uncollapsed_upper_bound

private

uncollapsed_upper_bound from the remote MSet.

Definition at line 51 of file remotesubmatch.h.

Referenced by get_postlist(), and get_uncollapsed_upper_bound().

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

matcher/remotesubmatch.h
matcher/remotesubmatch.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RemoteSubMatch() [1/2]

◆ RemoteSubMatch() [2/2]

Member Function Documentation

◆ get_mset()

◆ get_percent_factor()

◆ get_postlist()

◆ get_uncollapsed_upper_bound()

◆ operator=()

◆ prepare_match()

◆ start_match()

Member Data Documentation

◆ db

◆ decreasing_relevance

◆ matchspies

◆ percent_factor

◆ uncollapsed_upper_bound