Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Attributes | List of all members
te::xml::AbstractWriterFactory Class Referenceabstract
XML

This is the abstract factory for XML writers. More...

#include <AbstractWriterFactory.h>

Inheritance diagram for te::xml::AbstractWriterFactory:
te::common::AbstractFactory< te::xml::AbstractWriter, std::string > te::xerces::WriterFactory

Public Types

typedef FactoryDictionary< AbstractFactory< te::xml::AbstractWriter, std::string, std::less< std::string > >, std::string, std::less< std::string > > dictionary_type
 
typedef AbstractFactory factory_type
 

Public Member Functions

const std::string & getKey () const
 It returns the factory key associated to the concreate factory.
 
virtual ~AbstractWriterFactory ()
 Virtual destructor.
 

Static Public Member Functions

static const factory_type * find (const std::string &factoryKey)
 
static dictionary_type & getDictionary ()
 It returns a reference to the internal dictionary of concrete factories.
 
static te::xml::AbstractWriter * make ()
 It creates a new XML writer using the dafault implementation.
 
static te::xml::AbstractWriter * make (const std::string &writerType)
 It creates a new XML writer.
 
static void setDefaultWriter (const std::string &writerType)
 It sets the default driver used to create the XML writer objects.
 

Protected Member Functions

 AbstractWriterFactory (const std::string &factoryKey)
 It creates the factory.
 
virtual te::xml::AbstractWriter * build ()=0
 Concrete factories (derived from this one) must implement this method in order to create objects.
 

Protected Attributes

std::string m_factoryKey
 The key that identifies the concrete factory: it will be used for unregistering the factory during destruction.
 

Static Private Attributes

static std::string sm_defaultWriterType
 The type of the writer to be created if no type is informed.
 

Detailed Description

This is the abstract factory for XML writers.

This is an abstract factory, so you will need to call the static method make as follow:

AbstractWriter* writer = AbstractWriterFactory::make("XERCES");
te::xml::AbstractWriterFactory::make
static te::xml::AbstractWriter * make()
It creates a new XML writer using the dafault implementation.
te::xml::AbstractWriter
This class models a XML writer object.
Definition AbstractWriter.h:50

or

// for a default writer
AbstractWriter* writer = AbstractWriterFactory::make();
See also
Writer

Definition at line 64 of file AbstractWriterFactory.h.

Member Typedef Documentation

◆ dictionary_type

typedef FactoryDictionary<AbstractFactory<te::xml::AbstractWriter , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::dictionary_type
inherited

Definition at line 73 of file AbstractFactory.h.

◆ factory_type

typedef AbstractFactory te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::factory_type
inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

◆ ~AbstractWriterFactory()

virtual te::xml::AbstractWriterFactory::~AbstractWriterFactory ( )
inlinevirtual

Virtual destructor.

Note
It will automatically unregister the factory from the dictionary.

Definition at line 96 of file AbstractWriterFactory.h.

◆ AbstractWriterFactory()

te::xml::AbstractWriterFactory::AbstractWriterFactory ( const std::string &  factoryKey)
protected

It creates the factory.

The key of a AbstractWriterFactory is a string.

Parameters
factoryKeyThe key that identifies the factory.

Member Function Documentation

◆ build()

virtual te::xml::AbstractWriter * te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::build ( )
protectedpure virtualinherited

Concrete factories (derived from this one) must implement this method in order to create objects.

Returns
It returns an object created by the concrete factory.

Implemented in te::xerces::WriterFactory.

◆ find()

const AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::factory_type * te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::find ( const std::string &  factoryKey)
inlinestaticinherited

Definition at line 108 of file AbstractFactory.h.

◆ getDictionary()

AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::dictionary_type & te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::getDictionary
inlinestaticinherited

It returns a reference to the internal dictionary of concrete factories.

The dictionary is a singleton.

Returns
A reference to the internal dictionary.

Definition at line 106 of file AbstractFactory.h.

◆ getKey()

const std::string & te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::getKey
inlineinherited

It returns the factory key associated to the concreate factory.

Returns
The factory key associated to the concreate factory.

Definition at line 84 of file AbstractFactory.h.

◆ make() [1/2]

static te::xml::AbstractWriter * te::xml::AbstractWriterFactory::make ( )
static

It creates a new XML writer using the dafault implementation.

Returns
A new XML writer using the dafault implementation.

◆ make() [2/2]

static te::xml::AbstractWriter * te::xml::AbstractWriterFactory::make ( const std::string &  writerType)
static

It creates a new XML writer.

Parameters
writerTypeThe type of XML writer to be created.
Returns
A new XML writer.

◆ setDefaultWriter()

static void te::xml::AbstractWriterFactory::setDefaultWriter ( const std::string &  writerType)
static

It sets the default driver used to create the XML writer objects.

Parameters
writerTypeThe default driver name for creating XML writer objects.

Member Data Documentation

◆ m_factoryKey

std::string te::common::AbstractFactory< te::xml::AbstractWriter , std::string , std::less<std::string > >::m_factoryKey
protectedinherited

The key that identifies the concrete factory: it will be used for unregistering the factory during destruction.

Definition at line 136 of file AbstractFactory.h.

◆ sm_defaultWriterType

std::string te::xml::AbstractWriterFactory::sm_defaultWriterType
staticprivate

The type of the writer to be created if no type is informed.

Definition at line 111 of file AbstractWriterFactory.h.

The documentation for this class was generated from the following file: