code::XMLNotifier Class Reference

Inheritance diagram for code::XMLNotifier:

List of all members.

---

Detailed Description

Helper intermediate class for IndexRecordNotifiers that wish to notify XML strings.

Author:

Lakshman

Version:

Id

code_XMLNotifier.h,v 1.4 2009/06/02 20:17:40 lakshman Exp

Public Member Functions
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().
virtual	~XMLNotifier ()
virtual void	write (std::string &content)=0
	XMLNotifier (const URL &file)
	XMLNotifier ()
	For STL use only.
virtual SmartPtr< IndexRecordNotifier >	createNotifier (const URL &lbname)=0
	construct a notifier capable of notifying to this place.
Static Public Member Functions
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"

---

Constructor & Destructor Documentation

virtual code::XMLNotifier::~XMLNotifier

(

)

[virtual]

code::XMLNotifier::XMLNotifier

(

const URL &

file

)

code::XMLNotifier::XMLNotifier

(

)

[inline]

For STL use only.

---

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::IndexRecordNotifier::createNotifier

(

const URL &

lbname

)

[pure virtual, inherited]

construct a notifier capable of notifying to this place.

Implemented in code::FAMIndexNotifier, and code::LBNotifier.

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"

virtual void code::XMLNotifier::write

(

std::string &

content

)

[pure virtual]

Implemented in code::LBNotifier.

virtual void code::XMLNotifier::writeRecord

(

const Index::Record &

rec

)

[virtual]

notify about this record.

Implements code::IndexRecordNotifier.

virtual void code::XMLNotifier::writeRecords

(

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

rec

)

[virtual]

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

Reimplemented from code::IndexRecordNotifier.

---