Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Xapian::TermIterator Class Reference

An iterator pointing to items in a list of terms. More...

#include <document.h>

List of all members.

Public Types

typedef std::input_iterator_tag iterator_category
typedef termname value_type
typedef termcount_diff difference_type
typedef termname * pointer
typedef termname & reference

Public Methods

 TermIterator (Internal *internal_)
 TermIterator ()
 Default constructor - for declaring an uninitialised iterator. More...

 ~TermIterator ()
 Destructor. More...

 TermIterator (const TermIterator &other)
 Copying is allowed. More...

void operator= (const TermIterator &other)
 Assignment is allowed. More...

termname operator * () const
TermIterator & operator++ ()
void operator++ (int)
void skip_to (const termname &tname)
termcount get_wdf () const
doccount get_termfreq () const
PositionListIterator positionlist_begin ()
PositionListIterator positionlist_end ()
std::string get_description () const
 Returns a string describing this object. More...


Public Attributes

Internal * internal

Friends

class Database
class Document
bool operator== (const TermIterator &a, const TermIterator &b)


Detailed Description

An iterator pointing to items in a list of terms.


Constructor & Destructor Documentation

Xapian::TermIterator::TermIterator  
 

Default constructor - for declaring an uninitialised iterator.

Xapian::TermIterator::~TermIterator  
 

Destructor.

Xapian::TermIterator::TermIterator const TermIterator &    other
 

Copying is allowed.

The internals are reference counted, so copying is also cheap.


Member Function Documentation

std::string Xapian::TermIterator::get_description   const
 

Returns a string describing this object.

Introspection method.

void Xapian::TermIterator::operator= const TermIterator &    other
 

Assignment is allowed.

The internals are reference counted, so assignment is also cheap.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.6.3).
Generated on 24 Dec 2002 by Doxygen 1.2.15.