Xapian::MSet::Internal Class Reference

#include <omenquireinternal.h>

Inheritance diagram for Xapian::MSet::Internal:

Inheritance graph
[legend]
Collaboration diagram for Xapian::MSet::Internal:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Internal ()
 Internal (Xapian::doccount firstitem_, Xapian::doccount matches_upper_bound_, Xapian::doccount matches_lower_bound_, Xapian::doccount matches_estimated_, Xapian::weight max_possible_, Xapian::weight max_attained_, const vector< Xapian::Internal::MSetItem > &items_, const map< string, TermFreqAndWeight > &termfreqandwts_, Xapian::weight percent_factor_)
Xapian::Document get_doc_by_index (Xapian::doccount index) const
 get a document by index in MSet, via the cache.
percent convert_to_percent_internal (Xapian::weight wt) const
 Converts a weight to a percentage weight.
string get_description () const
 Return a string describing this object.
void fetch_items (Xapian::doccount first, Xapian::doccount last) const
 Fetch items specified into the document cache.

Public Attributes

double percent_factor
 Factor to multiply weights by to convert them to percentages.
Xapian::Internal::RefCntPtr<
const Enquire::Internal
enquire
 Xapian::Enquire reference, for getting documents.
map< string, TermFreqAndWeighttermfreqandwts
 The term frequencies and weights returned by the match process.
vector< Xapian::Internal::MSetItemitems
 A list of items comprising the (selected part of the) MSet.
Xapian::doccount firstitem
 Rank of first item in MSet.
Xapian::doccount matches_lower_bound
Xapian::doccount matches_estimated
Xapian::doccount matches_upper_bound
Xapian::weight max_possible
Xapian::weight max_attained

Private Member Functions

void read_docs () const
 Read and cache the documents so far requested.
 Internal (const Internal &)
 Copy not allowed.
void operator= (const Internal &)
 Assignment not allowed.

Private Attributes

set< Xapian::doccountrequested_docs
 The set of documents which have been requested but not yet collected.
map< Xapian::doccount, Xapian::Documentindexeddocs
 Cache of documents, indexed by MSet index.

Classes

struct  TermFreqAndWeight
 A structure containing the term frequency and weight for a given query term. More...

Detailed Description

Definition at line 205 of file omenquireinternal.h.


Constructor & Destructor Documentation

Xapian::MSet::Internal::Internal ( const Internal  )  [private]

Copy not allowed.

Xapian::MSet::Internal::Internal (  )  [inline]

Definition at line 265 of file omenquireinternal.h.

Xapian::MSet::Internal::Internal ( Xapian::doccount  firstitem_,
Xapian::doccount  matches_upper_bound_,
Xapian::doccount  matches_lower_bound_,
Xapian::doccount  matches_estimated_,
Xapian::weight  max_possible_,
Xapian::weight  max_attained_,
const vector< Xapian::Internal::MSetItem > &  items_,
const map< string, TermFreqAndWeight > &  termfreqandwts_,
Xapian::weight  percent_factor_ 
) [inline]

Definition at line 274 of file omenquireinternal.h.


Member Function Documentation

void Xapian::MSet::Internal::read_docs (  )  const [private]

Read and cache the documents so far requested.

Definition at line 427 of file omenquire.cc.

References DEBUGLINE, enquire, firstitem, indexeddocs, items, and requested_docs.

Referenced by get_doc_by_index().

void Xapian::MSet::Internal::operator= ( const Internal  )  [private]

Assignment not allowed.

Document Xapian::MSet::Internal::get_doc_by_index ( Xapian::doccount  index  )  const

get a document by index in MSet, via the cache.

Definition at line 358 of file omenquire.cc.

References Assert, DEBUGCALL, fetch_items(), firstitem, indexeddocs, items, om_tostring(), read_docs(), and RETURN.

percent Xapian::MSet::Internal::convert_to_percent_internal ( Xapian::weight  wt  )  const

Converts a weight to a percentage weight.

Definition at line 340 of file omenquire.cc.

References DEBUGAPICALL, DEBUGLINE, max_possible, percent_factor, and RETURN.

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

Return a string describing this object.

Definition at line 404 of file omenquire.cc.

References firstitem, items, matches_estimated, matches_lower_bound, matches_upper_bound, max_attained, max_possible, and om_tostring().

void Xapian::MSet::Internal::fetch_items ( Xapian::doccount  first,
Xapian::doccount  last 
) const

Fetch items specified into the document cache.

Definition at line 380 of file omenquire.cc.

References DEBUGAPICALL, enquire, firstitem, Xapian::Internal::RefCntPtr< T >::get(), indexeddocs, items, and requested_docs.

Referenced by get_doc_by_index().


Member Data Documentation

double Xapian::MSet::Internal::percent_factor

Factor to multiply weights by to convert them to percentages.

Definition at line 208 of file omenquireinternal.h.

Referenced by convert_to_percent_internal().

set<Xapian::doccount> Xapian::MSet::Internal::requested_docs [mutable, private]

The set of documents which have been requested but not yet collected.

Definition at line 214 of file omenquireinternal.h.

Referenced by fetch_items(), and read_docs().

map<Xapian::doccount, Xapian::Document> Xapian::MSet::Internal::indexeddocs [mutable, private]

Cache of documents, indexed by MSet index.

Definition at line 217 of file omenquireinternal.h.

Referenced by fetch_items(), get_doc_by_index(), and read_docs().

Xapian::Internal::RefCntPtr<const Enquire::Internal> Xapian::MSet::Internal::enquire

Xapian::Enquire reference, for getting documents.

Definition at line 229 of file omenquireinternal.h.

Referenced by fetch_items(), and read_docs().

map<string, TermFreqAndWeight> Xapian::MSet::Internal::termfreqandwts

The term frequencies and weights returned by the match process.

This map contains information for each term which was in the query.

Definition at line 247 of file omenquireinternal.h.

vector<Xapian::Internal::MSetItem> Xapian::MSet::Internal::items

A list of items comprising the (selected part of the) MSet.

Definition at line 250 of file omenquireinternal.h.

Referenced by fetch_items(), get_description(), get_doc_by_index(), and read_docs().

Xapian::doccount Xapian::MSet::Internal::firstitem

Rank of first item in MSet.

Definition at line 253 of file omenquireinternal.h.

Referenced by fetch_items(), get_description(), get_doc_by_index(), and read_docs().

Xapian::doccount Xapian::MSet::Internal::matches_lower_bound

Definition at line 255 of file omenquireinternal.h.

Referenced by get_description().

Xapian::doccount Xapian::MSet::Internal::matches_estimated

Definition at line 257 of file omenquireinternal.h.

Referenced by get_description().

Xapian::doccount Xapian::MSet::Internal::matches_upper_bound

Definition at line 259 of file omenquireinternal.h.

Referenced by get_description().

Xapian::weight Xapian::MSet::Internal::max_possible

Definition at line 261 of file omenquireinternal.h.

Referenced by convert_to_percent_internal(), and get_description().

Xapian::weight Xapian::MSet::Internal::max_attained

Definition at line 263 of file omenquireinternal.h.

Referenced by get_description().


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.