lemur::index::PushIndex Class Reference

Abstract Class for push method of building an index. More...

#include <PushIndex.hpp>

Inheritance diagram for lemur::index::PushIndex:

List of all members.

Public Member Functions
virtual	~PushIndex ()
virtual bool	beginDoc (const lemur::parse::DocumentProps *dp)=0
	the beginning of a new document, returns true if initiation was successful
virtual bool	addTerm (const lemur::api::Term &t)=0
	adding a term to the current document, returns true if term was added successfully.
virtual void	endDoc (const lemur::parse::DocumentProps *dp)=0
	signify the end of current document
virtual void	endCollection (const lemur::parse::CollectionProps *cp)=0
	signify the end of this collection. properties passed at the beginning of a collection should be handled by the constructor.
virtual void	setDocManager (const string &mgrID)=0

---

Detailed Description

Abstract Class for push method of building an index.

This is an abstract class that provides a uniform interface for building an indexed document collection where the index is unaware of the parser (docstream).

---

Constructor & Destructor Documentation

virtual lemur::index::PushIndex::~PushIndex (   )  [inline, virtual]

---

Member Function Documentation

virtual bool lemur::index::PushIndex::addTerm (  const lemur::api::Term &  t  )  [pure virtual]

adding a term to the current document, returns true if term was added successfully. Implemented in lemur::index::KeyfileIncIndex.

virtual bool lemur::index::PushIndex::beginDoc (  const lemur::parse::DocumentProps *  dp  )  [pure virtual]

the beginning of a new document, returns true if initiation was successful Implemented in lemur::index::KeyfileIncIndex.

virtual void lemur::index::PushIndex::endCollection (  const lemur::parse::CollectionProps *  cp  )  [pure virtual]

signify the end of this collection. properties passed at the beginning of a collection should be handled by the constructor. Implemented in lemur::index::KeyfileIncIndex.

virtual void lemur::index::PushIndex::endDoc (  const lemur::parse::DocumentProps *  dp  )  [pure virtual]

signify the end of current document Implemented in lemur::index::KeyfileIncIndex.

virtual void lemur::index::PushIndex::setDocManager (  const string &  mgrID  )  [pure virtual]

Implemented in lemur::index::KeyfileIncIndex.

---

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

• PushIndex.hpp

---