te::xml::ReaderFactory Class Reference

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

#include <ReaderFactory.h>

Inheritance diagram for te::xml::ReaderFactory:

Public Types
typedef FactoryDictionary< AbstractFactory< te::xml::Reader, 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. More...
virtual	~ReaderFactory ()
	Virtual destructor. More...

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. More...
static te::xml::Reader *	make ()
	It creates a new XML reader using the dafault implementation. More...
static te::xml::Reader *	make (const std::string &readerType)
	It creates a new XML reader. More...
static void	setDefaultReader (const std::string &readerType)
	It sets the default driver used to create the XML reader objects. More...

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

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

Static Private Attributes
static std::string	sm_defaultReaderType
	The type of the reader to be created if no type is informed. More...

Detailed Description

This is the abstract factory for XML readers.

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

Reader* reader = ReaderFactory::make("XERCES");

or

// for a default reader
Reader* reader = ReaderFactory::make();

See also

Reader

Definition at line 61 of file ReaderFactory.h.

Member Typedef Documentation

dictionary_type

typedef FactoryDictionary<AbstractFactory<te::xml::Reader , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< te::xml::Reader , 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::Reader , std::string , std::less<std::string > >::factory_type

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

~ReaderFactory()

virtual te::xml::ReaderFactory::~ReaderFactory ( )

inlinevirtual

Virtual destructor.

Note

It will automatically unregister the factory from the dictionary.

Reimplemented in te::xerces::ReaderFactory.

Definition at line 93 of file ReaderFactory.h.

ReaderFactory()

te::xml::ReaderFactory::ReaderFactory ( const std::string &  factoryKey )

protected

It creates the factory.

The key of a ReaderFactory is a string.

Parameters

factoryKey

The key that identifies the factory.

Member Function Documentation

build()

virtual te::xml::Reader * te::common::AbstractFactory< te::xml::Reader , 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::ReaderFactory.

find()

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

inlinestaticinherited

Definition at line 164 of file AbstractFactory.h.

getDictionary()

AbstractFactory< te::xml::Reader , std::string , std::less<std::string > >::dictionary_type & te::common::AbstractFactory< te::xml::Reader , 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 157 of file AbstractFactory.h.

getKey()

const std::string & te::common::AbstractFactory< te::xml::Reader , std::string , std::less<std::string > >::getKey ( ) const

inlineinherited

It returns the factory key associated to the concreate factory.

Returns

The factory key associated to the concreate factory.

Definition at line 140 of file AbstractFactory.h.

make() [1/2]

static te::xml::Reader* te::xml::ReaderFactory::make ( )

static

It creates a new XML reader using the dafault implementation.

Returns

A new XML reader using the dafault implementation.

make() [2/2]

static te::xml::Reader* te::xml::ReaderFactory::make ( const std::string &  readerType )

static

It creates a new XML reader.

Parameters

readerType

The type of XML reader to be created.

Returns

A new XML reader.

setDefaultReader()

static void te::xml::ReaderFactory::setDefaultReader ( const std::string &  readerType )

static

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

Parameters

readerType

The default driver name for creating XML reader objects.

Member Data Documentation

m_factoryKey

std::string te::common::AbstractFactory< te::xml::Reader , 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_defaultReaderType

std::string te::xml::ReaderFactory::sm_defaultReaderType

staticprivate

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

Definition at line 108 of file ReaderFactory.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/xml/ReaderFactory.h