code::FAMIndexNotifier Class Reference

Inheritance diagram for code::FAMIndexNotifier:

List of all members.

---

Detailed Description

Subclasses are database-specific implementations.

Author:

Lakshman

Version:

Id

code_FAMIndexNotifier.h,v 1.2 2009/06/02 20:17:37 lakshman Exp

Public Member Functions
virtual SmartPtr< IndexRecordNotifier >	createNotifier (const URL &url)
	construct a notifier capable of notifying to this place.
virtual	~FAMIndexNotifier ()
virtual void	writeRecord (const Index::Record &rec)
	notify about this record.
virtual void	writeRecords (const std::vector< Index::Record > &rec)
	The default implementation loops through the records, passing each to writeRecord().
Static Public Member Functions
static void	introduceSelf ()
static SmartPtr< IndexRecordNotifier >	createDefaultNotifier (const URL &lbname)
	returns a notifier that will notify to this location.
static SmartPtr< IndexRecordNotifier >	createDefaultNotifierInDirectory (const std::string &dirname)
	returns a notifier that will notify to a code_index.lb or code_index.fam in this directory.
static std::string	getDefaultBaseName ()
	returns the default notification location in a directory.
static std::string	getDefaultSuffix ()
	returns the suffix, e.g: "lb"
Protected Member Functions
	FAMIndexNotifier (const std::string &dirname)
Protected Attributes
std::string	outputDir
std::string	tempDir
std::string	indexPath

---

Constructor & Destructor Documentation

virtual code::FAMIndexNotifier::~FAMIndexNotifier

(

)

[virtual]

code::FAMIndexNotifier::FAMIndexNotifier

(

const std::string &

dirname

)

[protected]

---

Member Function Documentation

static SmartPtr< IndexRecordNotifier > code::IndexRecordNotifier::createDefaultNotifier

(

const URL &

lbname

)

[static, inherited]

returns a notifier that will notify to this location.

This will be a LBNotifier if w2config/misc/notifier says "lb" for example.

static SmartPtr< IndexRecordNotifier > code::IndexRecordNotifier::createDefaultNotifierInDirectory

(

const std::string &

dirname

)

[inline, static, inherited]

returns a notifier that will notify to a code_index.lb or code_index.fam in this directory.

This will be a LBNotifier if w2config/misc/notifier says "lb" for example.

virtual SmartPtr< IndexRecordNotifier > code::FAMIndexNotifier::createNotifier

(

const URL &

url

)

[virtual]

construct a notifier capable of notifying to this place.

Implements code::IndexRecordNotifier.

static std::string code::IndexRecordNotifier::getDefaultBaseName

(

)

[static, inherited]

returns the default notification location in a directory.

For example: code_index.lb or code_index.fam depending on protocol

static std::string code::IndexRecordNotifier::getDefaultSuffix

(

)

[static, inherited]

returns the suffix, e.g: "lb"

static void code::FAMIndexNotifier::introduceSelf

(

)

[static]

virtual void code::FAMIndexNotifier::writeRecord

(

const Index::Record &

rec

)

[virtual]

notify about this record.

Implements code::IndexRecordNotifier.

virtual void code::FAMIndexNotifier::writeRecords

(

const std::vector< Index::Record > &

rec

)

[virtual]

The default implementation loops through the records, passing each to writeRecord().

Reimplemented from code::IndexRecordNotifier.

---

Member Data Documentation

std::string code::FAMIndexNotifier::indexPath [protected]

std::string code::FAMIndexNotifier::outputDir [protected]

std::string code::FAMIndexNotifier::tempDir [protected]

---