Class with methods to manage the application. More...

#include <DSInfo.h>

Public Member Functions
	DSInfo ()
	Class Constructor. More...

std::map< std::string, std::string >	getCapabilities ()
	Get the Data Source Capabilities. More...

DataSetStruct	getDataSetInfo (std::string dataSetName)
	Get specific Data Set information. More...

std::vector< std::string * >	getDataSetNameList ()
	Get all Data Sets names. More...

std::vector< DataSetStruct >	getDataSetsInfo ()
	Get all Data Sets informations. More...

DataSourceHeader	getDataSourceHeader ()
	Get the Data Source Header. More...

std::map< std::string, std::vector< std::string > >	getDataSourceParameters (std::string dataSourceType)
	Get Data Source Types connection parameters. More...

bool	init (std::string dstype, std::string connstr)
	Init the application. More...

Private Member Functions
std::vector< CCInfo >	getCheckConstraintInfo (std::string dataSetName)
	Get check constraint information. More...

std::vector< FKInfo >	getForeignKeyInfo (std::string dataSetName)
	Get foreign keys information. More...

std::vector< IdxInfo >	getIndexesKeyInfo (std::string dataSetName)
	Get indexes information. More...

PKInfo	getPrimaryKeyInfo (std::string dataSetName)
	Get primary key information. More...

std::vector< UKInfo >	getUniqueKeyInfo (std::string dataSetName)
	Get unique keys information. More...

Private Attributes
std::string	m_connStr
	The Data Source Connection String. More...

te::da::DataSource *	m_dataSource
	The Data Source. More...

std::string	m_dataSourceType
	The Data Source Type. More...

Detailed Description

Class with methods to manage the application.

Definition at line 58 of file DSInfo.h.

Constructor & Destructor Documentation

DSInfo::DSInfo ( )

Class Constructor.

Definition at line 4 of file DSInfo.cpp.

References m_connStr, m_dataSource, and m_dataSourceType.

Member Function Documentation

std::map< std::string, std::string > DSInfo::getCapabilities ( )

Get the Data Source Capabilities.

Returns: String/String Map with the Data Source Capabilities

Definition at line 266 of file DSInfo.cpp.

References te::da::DataSource::getCapabilities(), and m_dataSource.

Referenced by PrintManager::printCapabilities().

std::vector< CCInfo > DSInfo::getCheckConstraintInfo ( std::string dataSetName )

private

Get check constraint information.

Parameters

dataSetName Data Set Name

Returns: CCInfo struct vector

Definition at line 155 of file DSInfo.cpp.

References CCInfo::expression, te::da::DataSetType::getCheckConstraint(), te::da::CheckConstraint::getExpression(), te::da::Constraint::getName(), te::da::DataSetType::getNumberOfCheckConstraints(), te::da::DataSource::getTransactor(), m_dataSource, and CCInfo::name.

Referenced by getDataSetInfo().

DataSetStruct DSInfo::getDataSetInfo ( std::string dataSetName )

Get specific Data Set information.

Parameters

dataSetName Data Set Name

Returns: DataSetStruct with the informations

Definition at line 183 of file DSInfo.cpp.

References getCheckConstraintInfo(), Utils::getDataSet(), getForeignKeyInfo(), getIndexesKeyInfo(), getPrimaryKeyInfo(), getUniqueKeyInfo(), DataSetStruct::hasPk, m_dataSource, PKInfo::name, DataSetStruct::name, DataSetStruct::pkInfo, DataSetStruct::vecCcInfo, DataSetStruct::vecFkInfo, DataSetStruct::vecIdxInfo, and DataSetStruct::vecUkInfo.

Referenced by getDataSetsInfo(), and PrintManager::printDataSetInfo().

std::vector< std::string * > DSInfo::getDataSetNameList ( )

Get all Data Sets names.

Returns: String vector with the Names

Definition at line 209 of file DSInfo.cpp.

References te::da::DataSource::getTransactor(), and m_dataSource.

Referenced by PrintManager::printCatalog(), and PrintManager::printDataSetNameList().

std::vector< DataSetStruct > DSInfo::getDataSetsInfo ( )

Get all Data Sets informations.

Returns: DataSetStruct Vector

Definition at line 225 of file DSInfo.cpp.

References getDataSetInfo(), te::da::DataSource::getTransactor(), and m_dataSource.

DataSourceHeader DSInfo::getDataSourceHeader ( )

Get the Data Source Header.

Returns: Data Source Header struct

Definition at line 252 of file DSInfo.cpp.

References te::da::DataSource::getConnectionInfo(), te::da::DataSource::getType(), m_dataSource, DataSourceHeader::name, and DataSourceHeader::type.

Referenced by PrintManager::printHeader().

std::map< std::string, std::vector< std::string > > DSInfo::getDataSourceParameters ( std::string dataSourceType )

Get Data Source Types connection parameters.

Parameters

dataSourceType Data Source Type, if passed by the user

Returns: String/String Vector Map with the Data Source Types connection parameters

Definition at line 278 of file DSInfo.cpp.

References te::common::Convert2UCase(), and Utils::loadModules().

Referenced by PrintManager::printDataSourceParameters().

std::vector< FKInfo > DSInfo::getForeignKeyInfo ( std::string dataSetName )

private

Get foreign keys information.

Parameters

dataSetName Data Set Name

Returns: FKInfo struct vector

Definition at line 70 of file DSInfo.cpp.

References Utils::getFKPropertiesNames(), te::da::DataSetType::getForeignKey(), te::da::Constraint::getName(), te::da::DataSetType::getNumberOfForeignKeys(), te::da::DataSource::getTransactor(), m_dataSource, FKInfo::name, and FKInfo::porperties.

Referenced by getDataSetInfo().

std::vector< IdxInfo > DSInfo::getIndexesKeyInfo ( std::string dataSetName )

private

Get indexes information.

Parameters

dataSetName Data Set Name

Returns: IdxInfo struct vector

Definition at line 126 of file DSInfo.cpp.

References Utils::getIdxPropertiesNames(), Utils::getIdxTypeName(), te::da::DataSetType::getIndex(), te::da::Index::getIndexType(), te::da::Index::getName(), te::da::DataSetType::getNumberOfIndexes(), te::da::DataSource::getTransactor(), m_dataSource, IdxInfo::name, IdxInfo::porperties, and IdxInfo::type.

Referenced by getDataSetInfo().

PKInfo DSInfo::getPrimaryKeyInfo ( std::string dataSetName )

private

Get primary key information.

Parameters

dataSetName Data Set Name

Returns: PKInfo struct

Definition at line 42 of file DSInfo.cpp.

References te::da::Constraint::getName(), Utils::getPKPropertiesNames(), te::da::DataSetType::getPrimaryKey(), te::da::DataSource::getTransactor(), m_dataSource, PKInfo::name, and PKInfo::porperties.

Referenced by getDataSetInfo().

std::vector< UKInfo > DSInfo::getUniqueKeyInfo ( std::string dataSetName )

private

Get unique keys information.

Parameters

dataSetName Data Set Name

Returns: UKInfo struct vector

Definition at line 98 of file DSInfo.cpp.

References te::da::Constraint::getName(), te::da::DataSetType::getNumberOfUniqueKeys(), te::da::DataSource::getTransactor(), Utils::getUKPropertiesNames(), te::da::DataSetType::getUniqueKey(), m_dataSource, UKInfo::name, and UKInfo::porperties.

Referenced by getDataSetInfo().

bool DSInfo::init	(	std::string	dstype,
		std::string	connstr
	)

Init the application.

Parameters

dstype	Data Source Type
connstr	Data Source Connection String

Returns: True if successfully

Definition at line 11 of file DSInfo.cpp.

References te::common::Convert2UCase(), Utils::getDataSource(), Utils::loadModules(), m_connStr, m_dataSource, and m_dataSourceType.

Referenced by PrintManager::init().

Member Data Documentation

std::string DSInfo::m_connStr

private

The Data Source Connection String.

Definition at line 172 of file DSInfo.h.

Referenced by DSInfo(), and init().

te::da::DataSource* DSInfo::m_dataSource

private

The Data Source.

Definition at line 173 of file DSInfo.h.

Referenced by DSInfo(), getCapabilities(), getCheckConstraintInfo(), getDataSetInfo(), getDataSetNameList(), getDataSetsInfo(), getDataSourceHeader(), getForeignKeyInfo(), getIndexesKeyInfo(), getPrimaryKeyInfo(), getUniqueKeyInfo(), and init().

std::string DSInfo::m_dataSourceType

private

The Data Source Type.

Definition at line 171 of file DSInfo.h.

Referenced by DSInfo(), and init().

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/tools/dsinfo/core/DSInfo.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/tools/dsinfo/core/DSInfo.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation