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

lemur::api::DocumentManager Class Reference

Abstract API for document manager interface. More...

#include <DocumentManager.hpp>

Inheritance diagram for lemur::api::DocumentManager:

lemur::parse::IndriDocMgr lemur::parse::KeyfileDocMgr lemur::parse::ElemDocMgr List of all members.

Public Member Functions

virtual bool open (const string &manname)=0
 open previously created document manager, return true if opened successfully. index name should be the full name of the table-of-content file for the manager. E.g. "manager.flat" for FlattextDocMgr.

virtual char * getDoc (const string &docID) const =0
 returns the document with the given docID (usually in raw format)

virtual ParsergetParser () const =0
 returns a handle to a Parser object that can handle parsing the raw format of these documents

virtual void buildMgr ()=0
 Construct the data tables for the previously given input files.

virtual const string & getMyID () const =0
 get the ID string to use for opening this later

virtual ~DocumentManager ()

Detailed Description

Abstract API for document manager interface.

The document manager should be able to retrieve a document given its external document id, it should also be able to provide a parser that can parse the raw document format.


Constructor & Destructor Documentation

virtual lemur::api::DocumentManager::~DocumentManager  )  [inline, virtual]
 


Member Function Documentation

virtual void lemur::api::DocumentManager::buildMgr  )  [pure virtual]
 

Construct the data tables for the previously given input files.

Implemented in lemur::parse::IndriDocMgr, and lemur::parse::KeyfileDocMgr.

virtual char* lemur::api::DocumentManager::getDoc const string &  docID  )  const [pure virtual]
 

returns the document with the given docID (usually in raw format)

Implemented in lemur::parse::KeyfileDocMgr.

virtual const string& lemur::api::DocumentManager::getMyID  )  const [pure virtual]
 

get the ID string to use for opening this later

Implemented in lemur::parse::IndriDocMgr, and lemur::parse::KeyfileDocMgr.

virtual Parser* lemur::api::DocumentManager::getParser  )  const [pure virtual]
 

returns a handle to a Parser object that can handle parsing the raw format of these documents

Implemented in lemur::parse::IndriDocMgr, and lemur::parse::KeyfileDocMgr.

virtual bool lemur::api::DocumentManager::open const string &  manname  )  [pure virtual]
 

open previously created document manager, return true if opened successfully. index name should be the full name of the table-of-content file for the manager. E.g. "manager.flat" for FlattextDocMgr.

Implemented in lemur::parse::ElemDocMgr, lemur::parse::IndriDocMgr, and lemur::parse::KeyfileDocMgr.


The documentation for this class was generated from the following file:
Generated on Tue Jun 15 11:03:04 2010 for Lemur by doxygen 1.3.4