---

Document Class Reference

Abstract document class. More...

#include <Document.hpp>

Inheritance diagram for Document:

List of all members.

Public Methods
virtual	~Document ()
virtual const char *	getID () const=0
	returns the external string ID
virtual void	startTermIteration () const=0
	start term iteration
virtual bool	hasMore () const=0
	returns true iff there's at least one term for iteration
virtual const Term *	nextTerm () const=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 () const=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

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

---

Member Function Documentation

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

returns the external string ID Implemented in BasicTokenDoc, and QueryDocument.

virtual bool Document::hasMore (    )  [pure virtual]

returns true iff there's at least one term for iteration Implemented in BasicTokenDoc, and QueryDocument.

virtual const Term* 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 Implemented in BasicTokenDoc, and QueryDocument.

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

return the DocumentProps handle

virtual void Document::skipToEnd (    )  [pure virtual]

"fast forward" to the end of the document Implemented in BasicTokenDoc, and QueryDocument.

virtual void Document::startTermIteration (    )  [pure virtual]

start term iteration Implemented in BasicTokenDoc, and QueryDocument.

---

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

• Document.hpp

---