This is the abstract factory for Graphs. More...

#include <AbstractGraphFactory.h>

Inheritance diagram for te::graph::AbstractGraphFactory:

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
virtual void	getCreationalParameters (std::vector< std::pair< std::string, std::string > > &params) const =0
	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...

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

virtual	~AbstractGraphFactory ()
	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 AbstractGraph *	make ()
	It creates and returns an empty graph with default graph 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 &factoryKey)
	It creates an object with the appropriated factory. More...

static AbstractGraph *	make (const std::string &gType)
	It creates an empty graph with the proper 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
	AbstractGraphFactory (const std::string &factoryKey)
	Constructor. More...

virtual AbstractGraph *	build ()=0
	Concrete factories (derived from this one) must implement this method in order to create objects. More...

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

virtual AbstractGraph *	iOpen (const std::string &dsInfo, const std::map< std::string, std::string > &gInfo)=0
	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...

Detailed Description

This is the abstract factory for Graphs.

See also: AbstractGraph

Definition at line 51 of file AbstractGraphFactory.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

◆ ~AbstractGraphFactory()

virtual te::graph::AbstractGraphFactory::~AbstractGraphFactory ( )

inlinevirtual

Destructor.

Definition at line 129 of file AbstractGraphFactory.h.

◆ AbstractGraphFactory()

te::graph::AbstractGraphFactory::AbstractGraphFactory ( const std::string & factoryKey )

protected

Constructor.

Parameters

factoryKey The key that identifies the factory.

Member Function Documentation

◆ build()

virtual AbstractGraph * te::common::AbstractFactory< AbstractGraph , 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::graph::UndirectedGraphFactory, te::graph::GraphFactory, te::graph::DirectedGraphFactory, and te::graph::BidirectionalGraphFactory.

◆ create()

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

protectedpure virtual

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.

Implemented in te::graph::UndirectedGraphFactory, te::graph::GraphFactory, te::graph::DirectedGraphFactory, and te::graph::BidirectionalGraphFactory.

◆ 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 108 of file AbstractFactory.h.

◆ getCachePolicy()

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

staticprotected

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()

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

pure virtual

It returns the list of parameters accepted as graph info.

Implemented in te::graph::UndirectedGraphFactory, te::graph::GraphFactory, te::graph::DirectedGraphFactory, and te::graph::BidirectionalGraphFactory.

◆ 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 106 of file AbstractFactory.h.

◆ getId()

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

staticprotected

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

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.

◆ getLoaderStrategy()

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

staticprotected

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
	)

staticprotected

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()

virtual const std::string& te::graph::AbstractGraphFactory::getType ( ) const

pure virtual

Returns the type (name) of this factory.

Implemented in te::graph::UndirectedGraphFactory, te::graph::GraphFactory, te::graph::DirectedGraphFactory, and te::graph::BidirectionalGraphFactory.

◆ iOpen()

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

protectedpure virtual

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.

Implemented in te::graph::UndirectedGraphFactory, te::graph::DirectedGraphFactory, te::graph::BidirectionalGraphFactory, and te::graph::GraphFactory.

◆ make() [1/5]

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

static

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/5]

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

static

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() [3/5]

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

inlinestaticinherited

It creates an object with the appropriated factory.

Parameters

factoryKey A key that identifies the factory used to build the object.

Returns: It returns a new object created by the given factory.

Exceptions

Exception If the concrete factory is not specified or the object can not be built for any reason this methiod may throws an exception.

Note: The caller of this method will take the ownership of the returned object.

Definition at line 97 of file AbstractFactory.h.

◆ make() [4/5]

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

static

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() [5/5]

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

static

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
	)

static

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
	)

static

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
	)

staticprotected

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.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/graph/core/AbstractGraphFactory.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ dictionary_type

◆ factory_type

Constructor & Destructor Documentation

◆ ~AbstractGraphFactory()

◆ AbstractGraphFactory()

Member Function Documentation

◆ build()

◆ create()

◆ find()

◆ getCachePolicy()

◆ getCreationalParameters()

◆ getDictionary()

◆ getId()

◆ getKey()

◆ getLoaderStrategy()

◆ getMetadata()

◆ getType()

◆ iOpen()

◆ make() [1/5]

◆ make() [2/5]

◆ make() [3/5]

◆ make() [4/5]

◆ make() [5/5]

◆ open() [1/2]

◆ open() [2/2]

◆ setMetadataInformation()

Member Data Documentation

◆ m_factoryKey