---

BasicDocStream Class Reference

A DocStream handler of a stream with the basic lemur format. More...

#include <BasicDocStream.hpp>

Inheritance diagram for BasicDocStream:

List of all members.

Public Methods
	BasicDocStream ()
	BasicDocStream (const string &inputFile)
virtual	~BasicDocStream ()
bool	hasMore ()
void	startDocIteration ()
	start document iteration
Document *	nextDoc ()
	return a pointer to next document (static memory, do not delete returned instance). hasMore() should be called before calling nextDoc()

---

Detailed Description

A DocStream handler of a stream with the basic lemur format.

---

Constructor & Destructor Documentation

BasicDocStream::BasicDocStream (    )  [inline]

BasicDocStream::BasicDocStream (  const string &    inputFile )

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

---

Member Function Documentation

bool BasicDocStream::hasMore (    )  [virtual]

Implements DocStream.

Document * BasicDocStream::nextDoc (    )  [virtual]

return a pointer to next document (static memory, do not delete returned instance). hasMore() should be called before calling nextDoc() Implements DocStream.

void BasicDocStream::startDocIteration (    )  [virtual]

start document iteration Typical usage: See also: Document DocStream &myStream; ... myStream.startDocIteration(); Document *doc; while (myStream.nextDoc(doc)) { Term *term; doc->startTermIteration(); while (doc->nextTerm(term)) { ... process "term" ... YOU MUST NOT DELETE term, as it is a pointer to a local static memory } YOU MUST NOT DELETE doc, as it is a pointer to a local static memory } Implements DocStream.

---

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

• BasicDocStream.hpp
• BasicDocStream.cpp

---