te::da::FunctionCatalogManager Class Reference

A FunctionCatalogManager is a singleton that can be used to manage function catalogs of data source implementations. More...

#include <FunctionCatalogManager.h>

Inheritance diagram for te::da::FunctionCatalogManager:

Public Member Functions
FunctionCatalog *	find (const std::string &dsType)
	It finds the function catalog with the given data source type. More...
void	insert (const std::string &dsType, FunctionCatalog *fcatalog)
	It inserts the function catalog associated to the given data source type. More...
	~FunctionCatalogManager ()
	Destructor. More...

Static Public Member Functions
static FunctionCatalogManager &	getInstance ()
	It returns a reference to the singleton instance. More...

Protected Member Functions
	FunctionCatalogManager ()
	No constructor available for clients. More...

Private Attributes
std::map< std::string, FunctionCatalog * >	m_fcatalogMap
	Function map: datasource-type -> FunctionCatalog*. More...

Friends
class	te::common::Singleton< FunctionCatalogManager >

Detailed Description

A FunctionCatalogManager is a singleton that can be used to manage function catalogs of data source implementations.

Each data source implementation must register its function catalog in this singleton. This can be achieved by providing the data source identification token (a string) and its catalog.

See also

FunctionCatalog

Definition at line 55 of file FunctionCatalogManager.h.

Constructor & Destructor Documentation

te::da::FunctionCatalogManager::~FunctionCatalogManager

(

)

Destructor.

te::da::FunctionCatalogManager::FunctionCatalogManager ( )

inlineprotected

No constructor available for clients.

Definition at line 88 of file FunctionCatalogManager.h.

Member Function Documentation

FunctionCatalog* te::da::FunctionCatalogManager::find

(

const std::string &

dsType

)

It finds the function catalog with the given data source type.

Parameters

dsType

The data source type.

Returns

The catalog fr the given data source type.

Note

Don't delete the returned pointer, it belongs to the manager!

static FunctionCatalogManager & te::common::Singleton< FunctionCatalogManager >::getInstance ( )

staticinherited

It returns a reference to the singleton instance.

Returns

A reference to the singleton instance.

void te::da::FunctionCatalogManager::insert	(	const std::string &	dsType,
		FunctionCatalog *	fcatalog
	)

It inserts the function catalog associated to the given data source type.

Parameters

dsType	The type of data source.
fcatalog	The function catalog. The manager will take the ownership of the given function catalog.

Exceptions

Exception

It throws an exception if a catalog is already registered for the given data source type.

Friends And Related Function Documentation

friend class te::common::Singleton< FunctionCatalogManager >

friend

Definition at line 57 of file FunctionCatalogManager.h.

Member Data Documentation

std::map<std::string, FunctionCatalog*> te::da::FunctionCatalogManager::m_fcatalogMap

private

Function map: datasource-type -> FunctionCatalog*.

Definition at line 92 of file FunctionCatalogManager.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/dataaccess/query/FunctionCatalogManager.h