Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

BasicDocStream Class Reference

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

#include <BasicDocStream.hpp>

Inheritance diagram for BasicDocStream:

DocStream List of all members.

Public Methods

 BasicDocStream ()
 BasicDocStream (const char *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()


Private Attributes

char file [1024]
ifstream * ifs
char buf [2000]
bool nextTokenRead
BasicTokenDoc doc

Detailed Description

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

Constructor & Destructor Documentation

BasicDocStream::BasicDocStream (    )  [inline]
 

BasicDocStream::BasicDocStream (  const char *    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.

Member Data Documentation

char BasicDocStream::buf[2000] [private]
 

BasicTokenDoc BasicDocStream::doc [private]
 

char BasicDocStream::file[1024] [private]
 

ifstream* BasicDocStream::ifs [private]
 

bool BasicDocStream::nextTokenRead [private]
 

The documentation for this class was generated from the following files:
Generated on Fri Feb 6 07:11:57 2004 for LEMUR by doxygen1.2.16