---

BasicTokenDoc Class Reference

doc representation for BasicDocStream More...

#include <BasicDocStream.hpp>

Inheritance diagram for BasicTokenDoc:

List of all members.

Public Methods
	BasicTokenDoc ()
	BasicTokenDoc (ifstream *stream)
void	startTermIteration () const
	start term iteration
const char *	getID () const
	returns the external string ID
bool	hasMore () const
	returns true iff there's at least one term for iteration
const Term *	nextTerm () const
	returns a pointer to next term (static memory, do not delete the returned instance). caller should check hasMore() before calling it
void	skipToEnd () const
	"fast forward" to the end of the document
Friends
class	BasicDocStream

---

Detailed Description

doc representation for BasicDocStream

---

Constructor & Destructor Documentation

BasicTokenDoc::BasicTokenDoc (    )  [inline]

BasicTokenDoc::BasicTokenDoc (  ifstream *    stream )  [inline]

---

Member Function Documentation

const char* BasicTokenDoc::getID (    )  [inline, virtual]

returns the external string ID Implements Document.

bool BasicTokenDoc::hasMore (    )  [inline, virtual]

returns true iff there's at least one term for iteration Implements Document.

const Term * BasicTokenDoc::nextTerm (    )  [virtual]

returns a pointer to next term (static memory, do not delete the returned instance). caller should check hasMore() before calling it Implements Document.

void BasicTokenDoc::skipToEnd (    )  [virtual]

"fast forward" to the end of the document Implements Document.

void BasicTokenDoc::startTermIteration (    )  [virtual]

start term iteration Implements Document.

---

Friends And Related Function Documentation

friend class BasicDocStream [friend]

---

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

• BasicDocStream.hpp
• BasicDocStream.cpp

---