This is a singleton for managing all the data source catalog instances available in the system. More...

#include <DataSourceCatalogManager.h>

Inheritance diagram for te::da::DataSourceCatalogManager:

Public Types
typedef std::map< DataSourcePtr, DataSourceCatalogPtr >::const_iterator	const_iterator

typedef std::map< DataSourcePtr, DataSourceCatalogPtr >::iterator	iterator

typedef ObjectLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockRead

typedef ObjectLevelLockingPolicy< ::boost::lock_guard< ::boost::recursive_mutex > >	LockWrite

typedef volatile DataSourceCatalogManager	VolatileType

Public Member Functions
iterator	begin ()
	It returns an iterator to the beginning of the container. More...

const_iterator	begin () const
	It returns an iterator to the beginning of the container. More...

DataSourceCatalogPtr	create (DataSourcePtr ds)
	It creates a catalog for the given data source, loads their sequences and the information about the schemas of the datasets contained in the data source. The catalog created is registered into the manager and it is returned to the caller. More...

DataSourceCatalogPtr	detach (const DataSourcePtr &ds)
	It changes the ownership of the data source catalog associated to the given data source. More...

void	detach (DataSourceCatalogPtr catalog)
	It changes the ownership of the data source catalog to the caller. More...

void	detachAll ()
	All the catalogs are detached from the manager. More...

void	detachAll (const std::string &dsType)
	All the catalogs whose data sources are of the specified type are detached from the manager. More...

iterator	end ()
	It returns an iterator to the end of the container. More...

const_iterator	end () const
	It returns an iterator to the end of the container. More...

bool	find (const DataSourcePtr &ds) const
	It tries to find the catalog associated to the given data source. More...

DataSourceCatalogPtr	get (DataSourcePtr ds)
	It gets the catalog associated to the given data source. If there is no catalog registered in the manager, a catalog is created and registered in the manager. More...

void	insert (const DataSourceCatalogPtr &catalog)
	It inserts the data source catalog into the manager. The catalog must have a data source in order to be inserted. More...

std::size_t	size () const
	It returns the number of data source catalogs that the manager are keeping track of. More...

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

Protected Member Functions
	DataSourceCatalogManager ()
	It initializes the singleton instance of the data source catalog manager. More...

	~DataSourceCatalogManager ()
	Singleton destructor. More...

Private Attributes
std::map< DataSourcePtr, DataSourceCatalogPtr >	m_catalogs
	The catalogs registered in the manager. More...

::boost::recursive_mutex	m_mtx
	The mutex used to control the object lock. More...

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

Detailed Description

This is a singleton for managing all the data source catalog instances available in the system.

See also: DataSource, DataSourceCatalog, te::common::Singleton

Definition at line 53 of file DataSourceCatalogManager.h.

Member Typedef Documentation

◆ const_iterator

typedef std::map<DataSourcePtr,DataSourceCatalogPtr>::const_iterator te::da::DataSourceCatalogManager::const_iterator

Definition at line 63 of file DataSourceCatalogManager.h.

◆ iterator

typedef std::map<DataSourcePtr,DataSourceCatalogPtr>::iterator te::da::DataSourceCatalogManager::iterator

Definition at line 64 of file DataSourceCatalogManager.h.

◆ LockRead

typedef ObjectLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ObjectLevelLockable< DataSourceCatalogManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockRead

inherited

Definition at line 205 of file ThreadingPolicies.h.

◆ LockWrite

typedef ObjectLevelLockingPolicy<::boost::lock_guard< ::boost::recursive_mutex > > te::common::ObjectLevelLockable< DataSourceCatalogManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::LockWrite

inherited

Definition at line 206 of file ThreadingPolicies.h.

◆ VolatileType

typedef volatile DataSourceCatalogManager te::common::ObjectLevelLockable< DataSourceCatalogManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::VolatileType

inherited

Definition at line 204 of file ThreadingPolicies.h.

Constructor & Destructor Documentation

◆ DataSourceCatalogManager()

te::da::DataSourceCatalogManager::DataSourceCatalogManager ( )

protected

It initializes the singleton instance of the data source catalog manager.

◆ ~DataSourceCatalogManager()

te::da::DataSourceCatalogManager::~DataSourceCatalogManager ( )

protected

Singleton destructor.

Member Function Documentation

◆ begin() [1/2]

DataSourceCatalogManager::iterator te::da::DataSourceCatalogManager::begin ( )

inline

It returns an iterator to the beginning of the container.

Returns: An iterator to the beginning of the container.

Definition at line 214 of file DataSourceCatalogManager.h.

References m_catalogs.

◆ begin() [2/2]

DataSourceCatalogManager::const_iterator te::da::DataSourceCatalogManager::begin ( ) const

inline

It returns an iterator to the beginning of the container.

Returns: A constant iterator to the beginning of the container.

Definition at line 209 of file DataSourceCatalogManager.h.

References m_catalogs.

◆ create()

DataSourceCatalogPtr te::da::DataSourceCatalogManager::create ( DataSourcePtr ds )

It creates a catalog for the given data source, loads their sequences and the information about the schemas of the datasets contained in the data source. The catalog created is registered into the manager and it is returned to the caller.

Parameters

ds	The data source whose catalog will be created.

Returns: A pointer to the new data source catalog.

Exceptions

Exception It throws an exception if there is already a catalog to the given data source.

Note: Thread-safe!

◆ detach() [1/2]

DataSourceCatalogPtr te::da::DataSourceCatalogManager::detach ( const DataSourcePtr & ds )

It changes the ownership of the data source catalog associated to the given data source.

Parameters

ds	The data source.

Returns: The catalog associated to the given data source. The caller will take the ownership of this catalog.

Note: Thread-safe!

◆ detach() [2/2]

void te::da::DataSourceCatalogManager::detach ( DataSourceCatalogPtr catalog )

It changes the ownership of the data source catalog to the caller.

   The memory used by the given data source catalog will NOT BE released.
   In other words, you will take the ownership of the data source catalog.

Parameters

ds	The data source catalog to be detached.

Note: Thread-safe!

◆ detachAll() [1/2]

void te::da::DataSourceCatalogManager::detachAll ( )

All the catalogs are detached from the manager.

Note: Thread-safe!

◆ detachAll() [2/2]

void te::da::DataSourceCatalogManager::detachAll ( const std::string & dsType )

All the catalogs whose data sources are of the specified type are detached from the manager.

Note: Thread-safe!

◆ end() [1/2]

DataSourceCatalogManager::iterator te::da::DataSourceCatalogManager::end ( )

inline

It returns an iterator to the end of the container.

Returns: An iterator to the beginning of the container.

Definition at line 224 of file DataSourceCatalogManager.h.

References m_catalogs.

◆ end() [2/2]

DataSourceCatalogManager::const_iterator te::da::DataSourceCatalogManager::end ( ) const

inline

It returns an iterator to the end of the container.

Returns: An iterator to the beginning of the container.

Definition at line 219 of file DataSourceCatalogManager.h.

References m_catalogs.

◆ find()

bool te::da::DataSourceCatalogManager::find ( const DataSourcePtr & ds ) const

It tries to find the catalog associated to the given data source.

Parameters

ds	The data source whose catalog is to be found.

Returns: True, if the catalog associated to the data source is found; otherwise, it returns false.

Note: Thread-safe!

◆ get()

DataSourceCatalogPtr te::da::DataSourceCatalogManager::get ( DataSourcePtr ds )

It gets the catalog associated to the given data source. If there is no catalog registered in the manager, a catalog is created and registered in the manager.

Parameters

ds	The data source whose catalog is to be retrieved.

Returns: The catalog associated to the data source.

Note: Thread-safe!

◆ getInstance()

DataSourceCatalogManager & te::common::Singleton< DataSourceCatalogManager >::getInstance

inlinestaticinherited

It returns a reference to the singleton instance.

Returns: A reference to the singleton instance.

Definition at line 109 of file Singleton.h.

◆ insert()

void te::da::DataSourceCatalogManager::insert ( const DataSourceCatalogPtr & catalog )

It inserts the data source catalog into the manager. The catalog must have a data source in order to be inserted.

Parameters

catalog The catalog to be inserted into the manager.

Note: The manager will take the ownership of the catalog.

Exceptions

Exception It throws an exception, if already exists a catalog for the data source of the given catalog.

Note: Thread-safe!

◆ size()

std::size_t te::da::DataSourceCatalogManager::size ( ) const

inline

It returns the number of data source catalogs that the manager are keeping track of.

Returns: The number of tracked data source catalogs.

Definition at line 204 of file DataSourceCatalogManager.h.

References m_catalogs.

Friends And Related Function Documentation

◆ te::common::Singleton< DataSourceCatalogManager >

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

friend

Definition at line 224 of file DataSourceCatalogManager.h.

Member Data Documentation

◆ m_catalogs

std::map<DataSourcePtr, DataSourceCatalogPtr> te::da::DataSourceCatalogManager::m_catalogs

private

The catalogs registered in the manager.

Definition at line 201 of file DataSourceCatalogManager.h.

Referenced by begin(), end(), and size().

◆ m_mtx

::boost::recursive_mutex te::common::ObjectLevelLockable< DataSourceCatalogManager , ::boost::recursive_mutex , ::boost::lock_guard< ::boost::recursive_mutex > , ::boost::lock_guard< ::boost::recursive_mutex > >::m_mtx

mutableprivateinherited

The mutex used to control the object lock.

Definition at line 232 of file ThreadingPolicies.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/dataaccess/datasource/DataSourceCatalogManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ LockRead

◆ LockWrite

◆ VolatileType

Constructor & Destructor Documentation

◆ DataSourceCatalogManager()

◆ ~DataSourceCatalogManager()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ create()

◆ detach() [1/2]

◆ detach() [2/2]

◆ detachAll() [1/2]

◆ detachAll() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ find()

◆ get()

◆ getInstance()

◆ insert()

◆ size()

Friends And Related Function Documentation

◆ te::common::Singleton< DataSourceCatalogManager >

Member Data Documentation

◆ m_catalogs

◆ m_mtx