---

BasicTokenDoc Class Reference

doc representation for BasicDocStream. More...

#include <BasicDocStream.hpp>

Inheritance diagram for BasicTokenDoc:

List of all members.

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

---

Detailed Description

doc representation for BasicDocStream.

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

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

returns the external string ID. Reimplemented from Document.

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

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

TokenTerm * BasicTokenDoc::nextTerm ( ) [virtual]

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

void BasicTokenDoc::skipToEnd ( ) [virtual]

"fast forward" to the end of the document. Reimplemented from Document.

void BasicTokenDoc::startTermIteration ( ) [virtual]

start term iteration. Reimplemented from Document.

---

Friends And Related Function Documentation

class BasicDocStream [friend]

---

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

• BasicDocStream.hpp
• BasicDocStream.cpp

---