SubMatch Class Reference

#include <submatch.h>

Inheritance diagram for SubMatch:

[legend]Collaboration diagram for SubMatch:

[legend]List of all members.

Public Member Functions
virtual	~SubMatch ()
	Virtual destructor required because we have virtual methods.
virtual bool	prepare_match (bool nowait, Stats &total_stats)=0
	Fetch and collate statistics.
virtual void	start_match (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const Stats &total_stats)=0
	Start the match.
virtual PostList *	get_postlist_and_term_info (MultiMatch *matcher, map< string, Xapian::MSet::Internal::TermFreqAndWeight > *termfreqandwts)=0
	Get PostList and term info.

---

Detailed Description

Definition at line 33 of file submatch.h.

---

Constructor & Destructor Documentation

virtual SubMatch::~SubMatch

(

)

[inline, virtual]

Virtual destructor required because we have virtual methods.

Definition at line 36 of file submatch.h.

---

Member Function Documentation

virtual bool SubMatch::prepare_match	(	bool	nowait,
		Stats &	total_stats
	)			[pure virtual]

Fetch and collate statistics.

Before we can calculate term weights we need to fetch statistics from each database involved and collate them.

Parameters:

	nowait	A RemoteSubMatch may not be able to report statistics when first asked. If nowait is true, it will return false in this situation allowing the matcher to ask other database. If nowait is false, then this method will block until statistics are available.
	total_stats	A Stats object which the statistics should be added to.

Returns:

If nowait is true and results aren't available yet then false will be returned and this method must be called again before the match can proceed. If results are available or nowait is false, then this method returns true.

Implemented in EmptySubMatch, LocalSubMatch, and RemoteSubMatch.

virtual void SubMatch::start_match	(	Xapian::doccount	first,
		Xapian::doccount	maxitems,
		Xapian::doccount	check_at_least,
		const Stats &	total_stats
	)			[pure virtual]

Start the match.

Parameters:

	first	The first item in the result set to return.
	maxitems	The maximum number of items to return.
	check_at_least	The minimum number of items to check.
	total_stats	The total statistics for the collection.

Implemented in EmptySubMatch, LocalSubMatch, and RemoteSubMatch.

virtual PostList* SubMatch::get_postlist_and_term_info	(	MultiMatch *	matcher,
		map< string, Xapian::MSet::Internal::TermFreqAndWeight > *	termfreqandwts
	)			[pure virtual]

Get PostList and term info.

Implemented in EmptySubMatch, and RemoteSubMatch.

---

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

• common/submatch.h

---