---

PushIndex Class Reference

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

#include <PushIndex.hpp>

Inheritance diagram for PushIndex:

List of all members.

Public Methods
virtual	~PushIndex ()
virtual bool	beginDoc (DocumentProps *dp)=0
	the beginning of a new document, returns true if initiation was successful
virtual bool	addTerm (Term &t)=0
	adding a term to the current document, returns true if term was added successfully.
virtual void	endDoc (DocumentProps *dp)=0
	signify the end of current document
virtual void	endCollection (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 char *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 PushIndex::~PushIndex (    )  [inline, virtual]

---

Member Function Documentation

virtual bool PushIndex::addTerm (  Term &    t )  [pure virtual]

adding a term to the current document, returns true if term was added successfully. Implemented in IncPassagePushIndex, InvFPPushIndex, InvPassagePushIndex, InvPushIndex, and KeyfileIncIndex.

virtual bool PushIndex::beginDoc (  DocumentProps *    dp )  [pure virtual]

the beginning of a new document, returns true if initiation was successful Implemented in IncPassagePushIndex, InvPassagePushIndex, InvPushIndex, and KeyfileIncIndex.

virtual void PushIndex::endCollection (  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 InvFPPushIndex, InvPushIndex, and KeyfileIncIndex.

virtual void PushIndex::endDoc (  DocumentProps *    dp )  [pure virtual]

signify the end of current document Implemented in InvPushIndex, and KeyfileIncIndex.

virtual void PushIndex::setDocManager (  const char *    mgrID )  [pure virtual]

Implemented in InvPushIndex, and KeyfileIncIndex.

---

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

• PushIndex.hpp

---