AllTermsList Class Reference

Abstract base class for iterating all terms in a database. More...

#include <alltermslist.h>

Inheritance diagram for AllTermsList:

Inheritance graph
[legend]
Collaboration diagram for AllTermsList:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual Xapian::termcount get_approx_size () const
 Return approximate size of this termlist.
virtual std::string get_termname () const=0
 Return the termname at the current position.
virtual Xapian::termcount get_wdf () const
 Return the wdf for the term at the current position.
virtual Xapian::doccount get_termfreq () const=0
 Return the term frequency for the term at the current position.
virtual Xapian::termcount get_collection_freq () const=0
 Return the collection frequency for the term at the current position.
virtual TermListnext ()=0
 Advance the current position to the next term in the termlist.
virtual TermListskip_to (const std::string &term)=0
 Skip forward to the specified term.
virtual bool at_end () const=0
 Return true if the current position is past the last term in this list.
virtual Xapian::termcount positionlist_count () const
 Return true if the current position is past the last term in this list.
virtual Xapian::PositionIterator positionlist_begin () const
 Return a PositionIterator for the current position.

Protected Member Functions

 AllTermsList ()
 Only constructable as a base class for derived classes.

Private Member Functions

void operator= (const AllTermsList &)
 Don't allow assignment.
 AllTermsList (const AllTermsList &)
 Don't allow copying.

Detailed Description

Abstract base class for iterating all terms in a database.

Definition at line 27 of file alltermslist.h.


Constructor & Destructor Documentation

AllTermsList::AllTermsList ( const AllTermsList  )  [private]

Don't allow copying.

AllTermsList::AllTermsList (  )  [inline, protected]

Only constructable as a base class for derived classes.

Definition at line 36 of file alltermslist.h.


Member Function Documentation

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

Don't allow assignment.

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

Return approximate size of this termlist.

Definition at line 34 of file alltermslist.cc.

References Assert.

virtual std::string AllTermsList::get_termname (  )  const [pure virtual]

Return the termname at the current position.

Implemented in FlintAllTermsList, FlintMetadataTermList, FlintSpellingWordsList, FlintSynonymTermList, InMemoryAllTermsList, QuartzAllTermsList, and MultiAllTermsList.

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

Return the wdf for the term at the current position.

This isn't meaningful for an AllTermsList, and will throw Xapian::InvalidOperationError if called.

Definition at line 42 of file alltermslist.cc.

virtual Xapian::doccount AllTermsList::get_termfreq (  )  const [pure virtual]

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

Implemented in FlintAllTermsList, FlintMetadataTermList, FlintSpellingWordsList, FlintSynonymTermList, InMemoryAllTermsList, QuartzAllTermsList, and MultiAllTermsList.

virtual Xapian::termcount AllTermsList::get_collection_freq (  )  const [pure virtual]

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

Implemented in FlintAllTermsList, FlintMetadataTermList, FlintSpellingWordsList, FlintSynonymTermList, InMemoryAllTermsList, QuartzAllTermsList, and MultiAllTermsList.

virtual TermList* AllTermsList::next (  )  [pure virtual]

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

Implemented in FlintAllTermsList, FlintMetadataTermList, FlintSpellingWordsList, FlintSynonymTermList, InMemoryAllTermsList, QuartzAllTermsList, and MultiAllTermsList.

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

Skip forward to the specified term.

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

Implemented in FlintMetadataTermList, and MultiAllTermsList.

virtual bool AllTermsList::at_end (  )  const [pure virtual]

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

Implemented in FlintAllTermsList, FlintMetadataTermList, FlintSpellingWordsList, FlintSynonymTermList, InMemoryAllTermsList, QuartzAllTermsList, and MultiAllTermsList.

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

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

This isn't meaningful for an AllTermsList, and will throw Xapian::InvalidOperationError if called.

Definition at line 48 of file alltermslist.cc.

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

Return a PositionIterator for the current position.

This isn't meaningful for an AllTermsList, and will throw Xapian::InvalidOperationError if called.

Definition at line 54 of file alltermslist.cc.


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.