LiveSupport::Scheduler::PlayLogFactory Class Reference

#include <PlayLogFactory.h>

Inheritance diagram for LiveSupport::Scheduler::PlayLogFactory:

[legend]
Collaboration diagram for LiveSupport::Scheduler::PlayLogFactory:

[legend]
List of all members.

Detailed Description

The factory to create appropriate PlayLog objects.

This object has to be configured with an element that contains the configuration element that the factory should build. Currently only PostgresqlPlayLog is supported by this factory.

An example configuration element is the following:


      <playLogFactory>
          <postgresqlPlayLog/>
      </playLogFactory>
  

The DTD for the above element is:


  <!ELEMENT playLogFactory (postgresqlPlayLog) >
  

For details on the <postgreslPlayLog> element, see the PostgresqlPlayLog documentation.

Author:
Author
paul
Version:
Revision
2833
See also:
PostgresqlPlayLog

Definition at line 91 of file PlayLogFactory.h.

Public Member Functions

virtual ~PlayLogFactory (void) throw ()
 A virtual destructor, as this class has virtual functions.
virtual void configure (const xmlpp::Element &element) throw (std::invalid_argument, std::logic_error)
 Configure the object based on the XML element supplied.
Ptr< PlayLogInterface >::Ref getPlayLog (void) throw ()
 Return a play log.

Static Public Member Functions

static const std::string getConfigElementName (void) throw ()
 Return the name of the XML element this object expects to be sent to a call to configure().
static Ptr< PlayLogFactory
>::Ref 
getInstance () throw ()
 Returns the singleton instance of this object.


Constructor & Destructor Documentation

virtual LiveSupport::Scheduler::PlayLogFactory::~PlayLogFactory ( void   )  throw () [inline, virtual]

A virtual destructor, as this class has virtual functions.

Definition at line 122 of file PlayLogFactory.h.


Member Function Documentation

void PlayLogFactory::configure ( const xmlpp::Element &  element  )  throw (std::invalid_argument, std::logic_error) [virtual]

Configure the object based on the XML element supplied.

Parameters:
element the XML element to configure the object from.
Exceptions:
std::invalid_argument if the supplied XML element contains bad configuration information
std::logic_error if the object has already been configured, and can not be reconfigured.

Implements LiveSupport::Core::Configurable.

Definition at line 85 of file PlayLogFactory.cxx.

References LiveSupport::Scheduler::PostgresqlPlayLog::getConfigElementName(), and LiveSupport::Db::ConnectionManagerFactory::getInstance().

static const std::string LiveSupport::Scheduler::PlayLogFactory::getConfigElementName ( void   )  throw () [inline, static]

Return the name of the XML element this object expects to be sent to a call to configure().

Returns:
the name of the expected XML configuration element.

Definition at line 133 of file PlayLogFactory.h.

Referenced by LiveSupport::Scheduler::SchedulerDaemon::configure().

Ptr< PlayLogFactory >::Ref PlayLogFactory::getInstance (  )  throw () [static]

Returns the singleton instance of this object.

Returns:
the singleton instance of this object.

Definition at line 71 of file PlayLogFactory.cxx.

Referenced by LiveSupport::Scheduler::SchedulerDaemon::configure().

Ptr<PlayLogInterface>::Ref LiveSupport::Scheduler::PlayLogFactory::getPlayLog ( void   )  throw () [inline]

Return a play log.

Returns:
the appropriate play log, according to the configuration of this factory.

Definition at line 167 of file PlayLogFactory.h.


The documentation for this class was generated from the following files:
Generated on Fri Sep 21 02:00:47 2007 for Campcaster by  1.4.7