RemoteSubMatch Class Reference

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

#include <remotesubmatch.h>

Inheritance diagram for RemoteSubMatch:

Inheritance graph
[legend]
Collaboration diagram for RemoteSubMatch:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 RemoteSubMatch (RemoteDatabase *db_, bool decreasing_relevance_)
 Constructor.
bool prepare_match (bool nowait, Stats &total_stats)
 Fetch and collate statistics.
void start_match (Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount check_at_least, const Stats &total_stats)
 Start the match.
PostListget_postlist_and_term_info (MultiMatch *matcher, map< string, Xapian::MSet::Internal::TermFreqAndWeight > *termfreqandwts)
 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

RemoteDatabasedb
 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.

Detailed Description

Class for performing matching on a remote database.

Definition at line 31 of file remotesubmatch.h.


Constructor & Destructor Documentation

RemoteSubMatch::RemoteSubMatch ( const RemoteSubMatch  )  [private]

Don't allow copying.

RemoteSubMatch::RemoteSubMatch ( RemoteDatabase db_,
bool  decreasing_relevance_ 
)

Constructor.

Definition at line 30 of file remotesubmatch.cc.

References DEBUGCALL.


Member Function Documentation

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

Don't allow assignment.

bool RemoteSubMatch::prepare_match ( bool  nowait,
Stats total_stats 
) [virtual]

Fetch and collate statistics.

Implements SubMatch.

Definition at line 38 of file remotesubmatch.cc.

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

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

Start the match.

Implements SubMatch.

Definition at line 48 of file remotesubmatch.cc.

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

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

Get PostList and term info.

Implements SubMatch.

Definition at line 59 of file remotesubmatch.cc.

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

double RemoteSubMatch::get_percent_factor (  )  const [inline]

Get percentage factor - only valid after get_postlist_and_term_info().

Definition at line 68 of file remotesubmatch.h.

References percent_factor.

Referenced by MultiMatch::get_mset().

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

Short-cut for single remote match.

Definition at line 71 of file remotesubmatch.h.

References db, and RemoteDatabase::get_mset().


Member Data Documentation

RemoteDatabase* RemoteSubMatch::db [private]

The remote database.

Definition at line 39 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 45 of file remotesubmatch.h.

Referenced by get_postlist_and_term_info().

double RemoteSubMatch::percent_factor [private]

The factor to use to convert weights to percentages.

Definition at line 48 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:
Documentation for Xapian (version 1.0.10).
Generated on 24 Dec 2008 by Doxygen 1.5.2.