Xapian::TermIterator::Internal Class Reference

Abstract base class for termlists. More...

#include <termlist.h>

Inheritance diagram for Xapian::TermIterator::Internal:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~Internal ()
 We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor.
virtual Xapian::termcount get_approx_size () const=0
 Return approximate size of this termlist.
virtual void accumulate_stats (Xapian::Internal::ExpandStats &stats) const
 Collate weighting information for the current term.
virtual std::string get_termname () const=0
 Return the termname at the current position.
virtual Xapian::termcount get_wdf () const=0
 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
 Return the collection frequency for the term at the current position.
virtual Internalnext ()=0
 Advance the current position to the next term in the termlist.
virtual Internalskip_to (const std::string &term)
 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=0
 Return the length of the position list for the current position.
virtual Xapian::PositionIterator positionlist_begin () const=0
 Return a PositionIterator for the current position.

Protected Member Functions

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

Private Member Functions

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

Detailed Description

Abstract base class for termlists.

Definition at line 38 of file termlist.h.


Constructor & Destructor Documentation

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

Don't allow copying.

Xapian::TermIterator::Internal::Internal (  )  [inline, protected]

Only constructable as a base class for derived classes.

Definition at line 47 of file termlist.h.

Xapian::TermIterator::Internal::~Internal (  )  [virtual]

We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor.

Definition at line 31 of file termlist.cc.


Member Function Documentation

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

Don't allow assignment.

virtual Xapian::termcount Xapian::TermIterator::Internal::get_approx_size (  )  const [pure virtual]

Return approximate size of this termlist.

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

Collate weighting information for the current term.

Definition at line 34 of file termlist.cc.

References Assert.

virtual std::string Xapian::TermIterator::Internal::get_termname (  )  const [pure virtual]

Return the termname at the current position.

virtual Xapian::termcount Xapian::TermIterator::Internal::get_wdf (  )  const [pure virtual]

Return the wdf for the term at the current position.

virtual Xapian::doccount Xapian::TermIterator::Internal::get_termfreq (  )  const [pure virtual]

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

Xapian::termcount Xapian::TermIterator::Internal::get_collection_freq (  )  const [virtual]

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

This method is only implemented for subclasses of AllTermsList (and isn't currently used).

Definition at line 41 of file termlist.cc.

References Assert.

virtual Internal* Xapian::TermIterator::Internal::next (  )  [pure 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.

virtual Internal* Xapian::TermIterator::Internal::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).

virtual bool Xapian::TermIterator::Internal::at_end (  )  const [pure virtual]

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

virtual Xapian::termcount Xapian::TermIterator::Internal::positionlist_count (  )  const [pure virtual]

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

virtual Xapian::PositionIterator Xapian::TermIterator::Internal::positionlist_begin (  )  const [pure virtual]

Return a PositionIterator for the current position.


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.