---

Document Class Reference

Abstract document class. More...

#include <Document.hpp>

Inheritance diagram for Document:

List of all members.

Public Methods
virtual	~Document ()
virtual char*	getID ()const=0
	returns the external string ID.
virtual void	startTermIteration ()=0
	start term iteration.
virtual bool	hasMore ()=0
	returns true iff there's at least one term for iteration.
virtual TokenTerm*	nextTerm ()=0
	returns a pointer to next term (static memory, do not delete the returned instance). caller should check hasMore() before calling it.
virtual void	skipToEnd ()=0
	"fast forward" to the end of the document.
virtual DocumentProps*	property ()
	return the DocumentProps handle.

---

Detailed Description

Abstract document class.

The class represents a document that is composed of a string (external) ID and a sequence of tokens. Subclasses may add extra information such as title and date.

---

Constructor & Destructor Documentation

Document::~Document ( ) [inline, virtual]

---

Member Function Documentation

char * Document::getID ( ) const [pure virtual]

returns the external string ID. Reimplemented in BasicTokenDoc.

bool Document::hasMore ( ) [pure virtual]

returns true iff there's at least one term for iteration. Reimplemented in BasicTokenDoc.

TokenTerm * Document::nextTerm ( ) [pure virtual]

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

DocumentProps * Document::property ( ) [inline, virtual]

return the DocumentProps handle.

void Document::skipToEnd ( ) [pure virtual]

"fast forward" to the end of the document. Reimplemented in BasicTokenDoc.

void Document::startTermIteration ( ) [pure virtual]

start term iteration. Reimplemented in BasicTokenDoc.

---

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

• Document.hpp

---