lemur::parse::KeyfileDocMgr Class Reference

#include <KeyfileDocMgr.hpp>

Inheritance diagram for lemur::parse::KeyfileDocMgr:

List of all members.


Public Member Functions
	KeyfileDocMgr ()
	default constructor
	KeyfileDocMgr (const string &name, bool readOnly=true)
	KeyfileDocMgr (string name, string mode, string source)
virtual	~KeyfileDocMgr ()
char *	getDoc (const string &docID) const
	return the document associated with this ID
virtual char *	handleDoc (char *docno)
	add entry for new doc
virtual void	handleEndDoc ()
	finish entry for current doc
virtual char *	handleWord (char *word)
	Add start and end byte offsets for this term to the list of offsets.
virtual void	setParser (lemur::api::Parser *p)
	set myParser to p
virtual lemur::api::Parser *	getParser () const
	returns a handle to a Parser object that can handle parsing the raw format of these documents
virtual void	buildMgr ()
virtual const string &	getMyID () const
	return name of this document manager, with the file extension (.bdm).
vector< Match >	getOffsets (const string &docID) const
virtual bool	open (const string &manname)
	Open and load the toc file manname.
Protected Member Functions
virtual void	writeTOC ()
virtual bool	loadTOC ()
bool	loadFTFiles (const string &fn, int num)
Protected Attributes
lemur::api::Parser *	myparser
vector< Match >	offsets
int	numdocs
string	pm
lemur::file::Keyfile	poslookup
lemur::file::Keyfile	doclookup
int	dbcache
btl	docEntry
char *	myDoc
int	doclen
string	IDname
string	IDnameext
vector< string >	sources
int	numOldSources
	how many sources already processed?
int	fileid
bool	ignoreDoc
	are we ignoring this document?
bool	_readOnly
	are we read only.

Detailed Description

Document manager using Keyfile for data storage. In addition to providing access to raw document text, also stores byte offsets (start and end byte) for each token within the document. Useful for passage windows or using query term match information for highlighting. Implements TextHandler interface for building the manager.

Constructor & Destructor Documentation

lemur::parse::KeyfileDocMgr::KeyfileDocMgr ( ) [inline]

default constructor

lemur::parse::KeyfileDocMgr::KeyfileDocMgr ( const string & name,

bool readOnly = true

)

constructor (for open) name = toc file for this manager (same as getMyID)

lemur::parse::KeyfileDocMgr::KeyfileDocMgr ( string name,

string mode,

string source

)

constructor (for build) name = what to name this manager mode = type of parser to use source = file with list of files this will manage

lemur::parse::KeyfileDocMgr::~KeyfileDocMgr ( ) [virtual]

Member Function Documentation

void lemur::parse::KeyfileDocMgr::buildMgr ( ) [virtual]

Build the document manager tables from the files previously provided in the constructor.
Implements lemur::api::DocumentManager.

char * lemur::parse::KeyfileDocMgr::getDoc ( const string & docID ) const [virtual]

return the document associated with this ID

Implements lemur::api::DocumentManager.

virtual const string& lemur::parse::KeyfileDocMgr::getMyID ( ) const [inline, virtual]

return name of this document manager, with the file extension (.bdm).

Implements lemur::api::DocumentManager.

vector< lemur::parse::Match > lemur::parse::KeyfileDocMgr::getOffsets ( const string & docID ) const

get the array of Match entries for the tokens in the document named docID. The entries are indexed by token position (as is recorded in a TermInfoList object.

virtual lemur::api::Parser* lemur::parse::KeyfileDocMgr::getParser ( ) const [inline, virtual]

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

Implements lemur::api::DocumentManager.

char * lemur::parse::KeyfileDocMgr::handleDoc ( char * docno ) [virtual]

add entry for new doc

Reimplemented from lemur::api::TextHandler.

void lemur::parse::KeyfileDocMgr::handleEndDoc ( ) [virtual]

finish entry for current doc

Reimplemented from lemur::api::TextHandler.

virtual char* lemur::parse::KeyfileDocMgr::handleWord ( char * word ) [inline, virtual]

Add start and end byte offsets for this term to the list of offsets.

Reimplemented from lemur::api::TextHandler.

bool lemur::parse::KeyfileDocMgr::loadFTFiles ( const string & fn,

int num

) [protected]

bool lemur::parse::KeyfileDocMgr::loadTOC ( ) [protected, virtual]

Reimplemented in lemur::parse::ElemDocMgr.

virtual bool lemur::parse::KeyfileDocMgr::open ( const string & manname ) [inline, virtual]

Open and load the toc file manname.

Implements lemur::api::DocumentManager.
Reimplemented in lemur::parse::ElemDocMgr.