DSInfo Class Reference

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.

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

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

private

Get check constraint information.

Parameters

dataSetName

Data Set Name

Returns

CCInfo struct vector

DataSetStruct DSInfo::getDataSetInfo

(

std::string

dataSetName

)

Get specific Data Set information.

Parameters

dataSetName

Data Set Name

Returns

DataSetStruct with the informations

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

(

)

Get all Data Sets names.

Returns

String vector with the Names

std::vector<DataSetStruct> DSInfo::getDataSetsInfo

(

)

Get all Data Sets informations.

Returns

DataSetStruct Vector

DataSourceHeader DSInfo::getDataSourceHeader

(

)

Get the Data Source Header.

Returns

Data Source Header struct

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

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

private

Get foreign keys information.

Parameters

dataSetName

Data Set Name

Returns

FKInfo struct vector

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

private

Get indexes information.

Parameters

dataSetName

Data Set Name

Returns

IdxInfo struct vector

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

private

Get primary key information.

Parameters

dataSetName

Data Set Name

Returns

PKInfo struct

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

private

Get unique keys information.

Parameters

dataSetName

Data Set Name

Returns

UKInfo struct vector

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

Member Data Documentation

std::string DSInfo::m_connStr

private

The Data Source Connection String.

Definition at line 172 of file DSInfo.h.

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

private

The Data Source.

Definition at line 173 of file DSInfo.h.

std::string DSInfo::m_dataSourceType

private

The Data Source Type.

Definition at line 171 of file DSInfo.h.

---

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

• C:/AA_TL5_master/terralib5/src/terralib/tools/dsinfo/core/DSInfo.h