code::IndexRecordNotifier Class Reference

Inheritance diagram for code::IndexRecordNotifier:

code::FAMIndexNotifier code::SQLIndexNotifier code::XMLNotifier code::LBNotifier List of all members.

Detailed Description

Abstract base class of IndexRecordNotifiers.

You instantiate one that you like using the static method: createDefaultNotifier()

Author:
Lakshman
Version:
Id
code_IndexRecordNotifier.h,v 1.10 2009/06/02 20:17:39 lakshman Exp


Public Member Functions

virtual SmartPtr< IndexRecordNotifiercreateNotifier (const URL &lbname)=0
 construct a notifier capable of notifying to this place.
virtual void writeRecord (const Index::Record &rec)=0
 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 ~IndexRecordNotifier ()

Static Public Member Functions

static SmartPtr< IndexRecordNotifiercreateDefaultNotifier (const URL &lbname)
 returns a notifier that will notify to this location.
static SmartPtr< IndexRecordNotifiercreateDefaultNotifierInDirectory (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::IndexRecordNotifier::~IndexRecordNotifier (  )  [inline, virtual]


Member Function Documentation

static SmartPtr< IndexRecordNotifier > code::IndexRecordNotifier::createDefaultNotifier ( const URL lbname  )  [static]

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]

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]

construct a notifier capable of notifying to this place.

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

static std::string code::IndexRecordNotifier::getDefaultBaseName (  )  [static]

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]

returns the suffix, e.g: "lb"

virtual void code::IndexRecordNotifier::writeRecord ( const Index::Record rec  )  [pure virtual]

notify about this record.

Implemented in code::FAMIndexNotifier, code::SQLIndexNotifier, and code::XMLNotifier.

virtual void code::IndexRecordNotifier::writeRecords ( const std::vector< Index::Record > &  rec  )  [virtual]

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

Reimplemented in code::FAMIndexNotifier, and code::XMLNotifier.


Generated on Fri May 4 13:40:13 2012 for WDSS-IIw2 by  doxygen 1.4.7