lemur::api::Document Class Reference

Abstract document class. More...

#include <Document.hpp>

Inheritance diagram for lemur::api::Document:

List of all members.

Public Member Functions
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 lemur::api::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 lemur::parse::DocumentProps *	property ()
	return the DocumentProps handle
Private Attributes
lemur::parse::DocumentProps *	props

---

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 lemur::api::Document::~Document (   )  [inline, virtual]

---

Member Function Documentation

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

returns the external string ID Implemented in lemur::parse::BasicTokenDoc, and lemur::api::QueryDocument.

virtual bool lemur::api::Document::hasMore (   )  const [pure virtual]

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

virtual const lemur::api::Term* lemur::api::Document::nextTerm (   )  const [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 lemur::parse::BasicTokenDoc, and lemur::api::QueryDocument.

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

return the DocumentProps handle

virtual void lemur::api::Document::skipToEnd (   )  const [pure virtual]

"fast forward" to the end of the document Implemented in lemur::parse::BasicTokenDoc, and lemur::api::QueryDocument.

virtual void lemur::api::Document::startTermIteration (   )  const [pure virtual]

start term iteration Implemented in lemur::parse::BasicTokenDoc, and lemur::api::QueryDocument.

---

Member Data Documentation

lemur::parse::DocumentProps* lemur::api::Document::props [private]

---

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

• Document.hpp

---