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, TKEYCOMPARE >, std::string, TKEYCOMPARE >	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 &gType)
	It creates an empty graph with the proper type. More...

static AbstractGraph *	make (const std::map< std::string, 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::map< std::string, 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::map< std::string, 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::map< std::string, 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::map< std::string, 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::map< std::string, 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 > &dsInfo, 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::map< std::string, 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

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

inherited

Definition at line 73 of file AbstractFactory.h.

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

inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

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

inlinevirtual

Destructor.

Definition at line 129 of file AbstractGraphFactory.h.

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

protected

Constructor.

Parameters

factoryKey The key that identifies the factory.

Definition at line 100 of file AbstractGraphFactory.cpp.

Member Function Documentation

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

virtual AbstractGraph* te::graph::AbstractGraphFactory::create	(	const std::map< std::string, 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::BidirectionalGraphFactory, te::graph::DirectedGraphFactory, te::graph::GraphFactory, and te::graph::UndirectedGraphFactory.

Referenced by make().

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

staticinherited

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.

Definition at line 156 of file AbstractGraphFactory.cpp.

References te::graph::AbstractCachePolicyFactory::make().

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::BidirectionalGraphFactory, te::graph::DirectedGraphFactory, te::graph::GraphFactory, and te::graph::UndirectedGraphFactory.

static dictionary_type& te::common::AbstractFactory< AbstractGraph , std::string , TKEYCOMPARE >::getDictionary ( )

staticinherited

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

The dictionary is a singleton.

Returns: A reference to the internal dictionary.

int te::graph::AbstractGraphFactory::getId	(	const std::map< std::string, std::string > &	dsInfo,
		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.

Definition at line 143 of file AbstractGraphFactory.cpp.

const std::string & te::common::AbstractFactory< AbstractGraph , std::string , TKEYCOMPARE >::getKey ( ) const

inherited

It returns the factory key associated to the concreate factory.

Returns: The factory key associated to the concreate factory.

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.

Definition at line 172 of file AbstractGraphFactory.cpp.

References te::graph::AbstractGraphLoaderStrategyFactory::make().

te::graph::GraphMetadata * te::graph::AbstractGraphFactory::getMetadata	(	const std::map< std::string, 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.

Definition at line 105 of file AbstractGraphFactory.cpp.

References te::graph::GraphMetadata::m_memoryGraph, and te::da::DataSourceFactory::make().

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

pure virtual

Returns the type (name) of this factory.

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

virtual AbstractGraph* te::graph::AbstractGraphFactory::iOpen	(	const std::map< std::string, 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::BidirectionalGraphFactory, te::graph::DirectedGraphFactory, te::graph::GraphFactory, and te::graph::UndirectedGraphFactory.

Referenced by open().

te::graph::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.

Definition at line 42 of file AbstractGraphFactory.cpp.

References te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::make(), and TE_DEFAULT_GRAPH_TYPE.

Referenced by te::graph::QueryGraphBuilder::build(), te::graph::RAGGraphBuilder::build(), te::graph::LDDGraphBuilder::build(), te::graph::FlowGraphBuilder::build(), te::sa::MinimumSpanningTree::createGraph(), te::sa::SpatialWeightsExchanger::importFromGAL(), te::sa::SpatialWeightsExchanger::importFromGWT(), and te::sa::GPMBuilder::setGPMInfo().

te::graph::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.

Definition at line 47 of file AbstractGraphFactory.cpp.

References te::common::Convert2UCase(), and te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::make().

te::graph::AbstractGraph * te::graph::AbstractGraphFactory::make	(	const std::map< std::string, 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.

Definition at line 54 of file AbstractGraphFactory.cpp.

References TE_DEFAULT_GRAPH_TYPE.

te::graph::AbstractGraph * te::graph::AbstractGraphFactory::make	(	const std::string &	gType,
		const std::map< std::string, 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.

Definition at line 59 of file AbstractGraphFactory.cpp.

References te::common::Convert2UCase(), create(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::find(), te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::getDictionary(), te::graph::AbstractGraph::getMetadata(), te::graph::GraphMetadata::setType(), and TE_TR.

te::graph::AbstractGraph * te::graph::AbstractGraphFactory::open	(	const std::map< std::string, 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.

Definition at line 77 of file AbstractGraphFactory.cpp.

References TE_DEFAULT_GRAPH_TYPE.

te::graph::AbstractGraph * te::graph::AbstractGraphFactory::open	(	const std::string &	gType,
		const std::map< std::string, 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.

Definition at line 82 of file AbstractGraphFactory.cpp.

References te::common::Convert2UCase(), te::common::FactoryDictionary< TFACTORY, TFACTORYKEY, TKEYCOMPARE >::find(), te::common::AbstractFactory< TPRODUCT, TFACTORYKEY, TKEYCOMPARE >::getDictionary(), te::graph::AbstractGraph::getMetadata(), iOpen(), te::graph::GraphMetadata::setType(), and TE_TR.

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

staticprotected

Definition at line 188 of file AbstractGraphFactory.cpp.

References te::graph::Edge_List, te::graph::GraphMetadata::setDescription(), te::graph::GraphMetadata::setName(), te::graph::GraphMetadata::setStorageMode(), TE_GRAPH_STORAGE_MODE_BY_EDGE, TE_GRAPH_STORAGE_MODE_BY_VERTEX, and te::graph::Vertex_List.

Member Data Documentation

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

C:/TL5_2015_release/terralib5/src/terralib/graph/core/AbstractGraphFactory.h
C:/TL5_2015_release/terralib5/src/terralib/graph/core/AbstractGraphFactory.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation