MultiTermList Class Reference

#include <multi_termlist.h>

Inheritance diagram for MultiTermList:

Inheritance graph
[legend]
Collaboration diagram for MultiTermList:

Collaboration graph
[legend]

List of all members.

Public Member Functions

Xapian::termcount get_approx_size () const
 Return approximate size of this termlist.
void accumulate_stats (Xapian::Internal::ExpandStats &stats) const
 Collate weighting information for the current term.
string get_termname () const
 Return the termname at the current position.
Xapian::termcount get_wdf () const
 Return the wdf for the term at the current position.
Xapian::doccount get_termfreq () const
 Return the term frequency for the term at the current position.
TermListnext ()
 Advance the current position to the next term in the termlist.
TermListskip_to (const std::string &term)
 Skip forward to the specified term.
bool at_end () const
 Return true if the current position is past the last term in this list.
Xapian::termcount positionlist_count () const
 Return the length of the position list for the current position.
Xapian::PositionIterator positionlist_begin () const
 Return a PositionIterator for the current position.
 ~MultiTermList ()

Private Member Functions

 MultiTermList (TermList *tl_, const Xapian::Database &db_, size_t db_index_)

Private Attributes

TermListtl
const Xapian::Databasedb
size_t db_index
double termfreq_factor

Friends

class Xapian::Database


Detailed Description

Definition at line 28 of file multi_termlist.h.


Constructor & Destructor Documentation

MultiTermList::MultiTermList ( TermList tl_,
const Xapian::Database db_,
size_t  db_index_ 
) [private]

MultiTermList::~MultiTermList (  ) 

Definition at line 40 of file multi_termlist.cc.

References tl.


Member Function Documentation

void MultiTermList::accumulate_stats ( Xapian::Internal::ExpandStats stats  )  const [virtual]

Collate weighting information for the current term.

Reimplemented from Xapian::TermIterator::Internal.

Definition at line 52 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::accumulate_stats(), db_index, Xapian::Internal::ExpandStats::db_index, and tl.

bool MultiTermList::at_end (  )  const [virtual]

Return true if the current position is past the last term in this list.

Implements Xapian::TermIterator::Internal.

Definition at line 87 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::at_end(), and tl.

Xapian::termcount MultiTermList::get_approx_size (  )  const [virtual]

Return approximate size of this termlist.

Implements Xapian::TermIterator::Internal.

Definition at line 46 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::get_approx_size(), and tl.

Xapian::doccount MultiTermList::get_termfreq (  )  const [virtual]

Return the term frequency for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 71 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::get_termfreq(), termfreq_factor, and tl.

string MultiTermList::get_termname (  )  const [virtual]

Return the termname at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 61 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::get_termname(), and tl.

Xapian::termcount MultiTermList::get_wdf (  )  const [virtual]

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 66 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::get_wdf(), and tl.

TermList * MultiTermList::next (  )  [virtual]

Advance the current position to the next term in the termlist.

The list starts before the first term in the list, so next() must be called before any methods which need the context of the current position.

Returns:
If a non-NULL pointer is returned, then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.

Implements Xapian::TermIterator::Internal.

Definition at line 77 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::next(), and tl.

Xapian::PositionIterator MultiTermList::positionlist_begin (  )  const [virtual]

Return a PositionIterator for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 99 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::positionlist_begin(), and tl.

Xapian::termcount MultiTermList::positionlist_count (  )  const [virtual]

Return the length of the position list for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 93 of file multi_termlist.cc.

References Xapian::TermIterator::Internal::positionlist_count(), and tl.

TermList* MultiTermList::skip_to ( const std::string &  term  )  [virtual]

Skip forward to the specified term.

If the specified term isn't in the list, position ourselves on the first term after tname (or at_end() if no terms after tname exist).

Implements Xapian::TermIterator::Internal.


Friends And Related Function Documentation

friend class Xapian::Database [friend]

Definition at line 29 of file multi_termlist.h.


Member Data Documentation

Definition at line 32 of file multi_termlist.h.

Referenced by MultiTermList().

size_t MultiTermList::db_index [private]

Definition at line 33 of file multi_termlist.h.

Referenced by accumulate_stats(), and MultiTermList().

Definition at line 34 of file multi_termlist.h.

Referenced by get_termfreq(), and MultiTermList().


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

Documentation for Xapian (version 1.2.8).
Generated on 14 Dec 2011 by Doxygen 1.5.9.