This is the concrete factory for the commung Graph type. More...

#include <GraphFactory.h>

Inheritance diagram for te::graph::GraphFactory:

Public Types
typedef FactoryDictionary< AbstractFactory< AbstractGraph, std::string, std::less< std::string > >, std::string, std::less< std::string > >	dictionary_type

typedef AbstractFactory	factory_type

Public Member Functions
void	getCreationalParameters (std::vector< std::pair< std::string, std::string > > &params) const
	It returns the list of parameters accepted as graph info. More...

const std::string &	getKey () const
	It returns the factory key associated to the concreate factory. More...

const std::string &	getType () const
	Returns the type (name) of this factory. More...

	~GraphFactory ()
	Destructor. More...

Static Public Member Functions
static void	finalize ()
	It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the abstract factory ... More...

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 void	initialize ()
	It initializes the factory: the singleton instance will be registered in the abstract factory ... More...

static AbstractGraph *	make ()
	It creates and returns an empty graph with default graph type. More...

static AbstractGraph *	make (const std::string &gType)
	It creates an empty graph with the proper type. More...

static AbstractGraph *	make (const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	It creates a graph with the given parameters using the default graph type. More...

static AbstractGraph *	make (const std::string &gType, const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	It creates a graph with the given parameters using the default graph type. More...

static AbstractGraph *	open (const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	It opens a graph with the given parameters and default graph type. More...

static AbstractGraph *	open (const std::string &gType, const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	It creates a graph with the given parameters. More...

Protected Member Functions
te::graph::AbstractGraph *	build ()
	Builder Function used to create the class object. More...

te::graph::AbstractGraph *	create (const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	This method must be implemented by subclasses (graph types). More...

	GraphFactory ()
	Constructor. More...

te::graph::AbstractGraph *	iOpen (const std::string &, const std::map< std::string, std::string > &gInfo)
	This method must be re-implemented by subclasses in order to have a finner control for the graph object instantiation. More...

Static Protected Member Functions
static te::graph::AbstractCachePolicy *	getCachePolicy (const std::map< std::string, std::string > &gInfo)
	This method is a auxiliar function used to get the cache policy pointer. More...

static int	getId (const std::map< std::string, std::string > &gInfo)
	This method is a auxiliar function used to get the graph id. More...

static te::graph::AbstractGraphLoaderStrategy *	getLoaderStrategy (const std::map< std::string, std::string > &gInfo, te::graph::GraphMetadata *metadata)
	This method is a auxiliar function used to get the loader strategy pointer. More...

static te::graph::GraphMetadata *	getMetadata (const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)
	This method is a auxiliar function used to get the metadata pointer. More...

static void	setMetadataInformation (const std::map< std::string, std::string > &gInfo, te::graph::GraphMetadata *metadata)

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 GraphFactory *	sm_factory
	Static instance used to register the factory. More...

Detailed Description

This is the concrete factory for the commung Graph type.

See also: te::graph::AbstractGraphFactory

Definition at line 44 of file GraphFactory.h.

Member Typedef Documentation

◆ dictionary_type

typedef FactoryDictionary<AbstractFactory<AbstractGraph , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< AbstractGraph , std::string , std::less<std::string > >::dictionary_type

inherited

Definition at line 73 of file AbstractFactory.h.

◆ factory_type

typedef AbstractFactory te::common::AbstractFactory< AbstractGraph , std::string , std::less<std::string > >::factory_type

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

◆ ~GraphFactory()

te::graph::GraphFactory::~GraphFactory ( )

inline

Destructor.

Definition at line 49 of file GraphFactory.h.

◆ GraphFactory()

te::graph::GraphFactory::GraphFactory ( )

protected

Constructor.

Member Function Documentation

◆ build()

te::graph::AbstractGraph* te::graph::GraphFactory::build ( )

protectedvirtual

Builder Function used to create the class object.

Implements te::common::AbstractFactory< AbstractGraph, std::string >.

◆ create()

te::graph::AbstractGraph* te::graph::GraphFactory::create	(	const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

protectedvirtual

This method must be implemented by subclasses (graph types).

Parameters

dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: The new graph.

Note: The caller will take the ownership of the returned pointer.

Implements te::graph::AbstractGraphFactory.

◆ finalize()

static void te::graph::GraphFactory::finalize ( )

static

It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the abstract factory ...

◆ find()

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

inlinestaticinherited

Definition at line 164 of file AbstractFactory.h.

◆ getCachePolicy()

static te::graph::AbstractCachePolicy* te::graph::AbstractGraphFactory::getCachePolicy ( const std::map< std::string, std::string > & gInfo )

staticprotectedinherited

This method is a auxiliar function used to get the cache policy pointer.

Parameters

gInfo The necessary information to create the graph.

Returns: The graph cache policy pointer.

Note: The caller will take the ownership of the returned pointer.

◆ getCreationalParameters()

void te::graph::GraphFactory::getCreationalParameters ( std::vector< std::pair< std::string, std::string > > & params ) const

virtual

It returns the list of parameters accepted as graph info.

Implements te::graph::AbstractGraphFactory.

◆ getDictionary()

AbstractFactory< AbstractGraph , std::string , std::less<std::string > >::dictionary_type & te::common::AbstractFactory< AbstractGraph , 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.

◆ getId()

static int te::graph::AbstractGraphFactory::getId ( const std::map< std::string, std::string > & gInfo )

staticprotectedinherited

This method is a auxiliar function used to get the graph id.

Parameters

gInfo The necessary information to create the graph.

Returns: The graph id.

◆ getKey()

const std::string & te::common::AbstractFactory< AbstractGraph , 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.

◆ getLoaderStrategy()

static te::graph::AbstractGraphLoaderStrategy* te::graph::AbstractGraphFactory::getLoaderStrategy	(	const std::map< std::string, std::string > &	gInfo,
		te::graph::GraphMetadata *	metadata
	)

staticprotectedinherited

This method is a auxiliar function used to get the loader strategy pointer.

Parameters

gInfo	The necessary information to create the graph.
metadata	The graph metadata pointer.

Returns: The graph loader strategy pointer.

Note: The caller will take the ownership of the returned pointer.

◆ getMetadata()

static te::graph::GraphMetadata* te::graph::AbstractGraphFactory::getMetadata	(	const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

staticprotectedinherited

This method is a auxiliar function used to get the metadata pointer.

Parameters

dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: The graph metadata pointer.

Note: The caller will take the ownership of the returned pointer.

◆ getType()

const std::string& te::graph::GraphFactory::getType ( ) const

virtual

Returns the type (name) of this factory.

Implements te::graph::AbstractGraphFactory.

◆ initialize()

static void te::graph::GraphFactory::initialize ( )

static

It initializes the factory: the singleton instance will be registered in the abstract factory ...

◆ iOpen()

te::graph::AbstractGraph* te::graph::GraphFactory::iOpen	(	const std::string &	,
		const std::map< std::string, std::string > &	gInfo
	)

protectedvirtual

This method must be re-implemented by subclasses in order to have a finner control for the graph object instantiation.

Parameters

dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: A graph.

Note: The caller will take the ownership of the returned pointer.

Implements te::graph::AbstractGraphFactory.

◆ make() [1/4]

static AbstractGraph* te::graph::AbstractGraphFactory::make ( )

staticinherited

It creates and returns an empty graph with default graph type.

Returns: An empty graph.

Note: The caller will take the ownership of the returned pointer.

◆ make() [2/4]

static AbstractGraph* te::graph::AbstractGraphFactory::make ( const std::string & gType )

staticinherited

It creates an empty graph with the proper type.

Parameters

gType The name of the specific graph type to be used to create the graph.

Returns: An empty graph.

Note: The caller will take the ownership of the returned pointer.

◆ make() [3/4]

static AbstractGraph* te::graph::AbstractGraphFactory::make	(	const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

staticinherited

It creates a graph with the given parameters using the default graph type.

Parameters

dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: A new graph.

Note: The caller will take the ownership of the returned pointer.

◆ make() [4/4]

static AbstractGraph* te::graph::AbstractGraphFactory::make	(	const std::string &	gType,
		const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

staticinherited

It creates a graph with the given parameters using the default graph type.

Parameters

gType	The name of the specific driver to create the raster.
dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: A new graph.

Note: The caller will take the ownership of the returned pointer.

◆ open() [1/2]

static AbstractGraph* te::graph::AbstractGraphFactory::open	(	const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

staticinherited

It opens a graph with the given parameters and default graph type.

Parameters

dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: The opened graph.

Note: The caller will take the ownership of the returned pointer.

◆ open() [2/2]

static AbstractGraph* te::graph::AbstractGraphFactory::open	(	const std::string &	gType,
		const std::string &	dsInfo,
		const std::map< std::string, std::string > &	gInfo
	)

staticinherited

It creates a graph with the given parameters.

Parameters

gType	The name of the specific graph type to create the graph.
dsInfo	The necessary information to access the data source.
gInfo	The necessary information to create the graph.

Returns: The opened graph.

Note: The caller will take the ownership of the returned pointer.

◆ setMetadataInformation()

static void te::graph::AbstractGraphFactory::setMetadataInformation	(	const std::map< std::string, std::string > &	gInfo,
		te::graph::GraphMetadata *	metadata
	)

staticprotectedinherited

Member Data Documentation

◆ m_factoryKey

std::string te::common::AbstractFactory< AbstractGraph , 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_factory

GraphFactory* te::graph::GraphFactory::sm_factory

staticprivate

Static instance used to register the factory.

Definition at line 101 of file GraphFactory.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/graph/graphs/GraphFactory.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ dictionary_type

◆ factory_type

Constructor & Destructor Documentation

◆ ~GraphFactory()

◆ GraphFactory()

Member Function Documentation

◆ build()

◆ create()

◆ finalize()

◆ find()

◆ getCachePolicy()

◆ getCreationalParameters()

◆ getDictionary()

◆ getId()

◆ getKey()

◆ getLoaderStrategy()

◆ getMetadata()

◆ getType()

◆ initialize()

◆ iOpen()

◆ make() [1/4]

◆ make() [2/4]

◆ make() [3/4]

◆ make() [4/4]

◆ open() [1/2]

◆ open() [2/2]

◆ setMetadataInformation()

Member Data Documentation

◆ m_factoryKey

◆ sm_factory