TdkConDescriptor Class Reference
[The Utils Module]

Defines an abstract database descriptor. More...

#include <TdkConDescriptor.h>

Inheritance diagram for TdkConDescriptor:

List of all members.

Public Member Functions
	TdkConDescriptor (const std::string dbmsName)
	Constructor.
	TdkConDescriptor (const std::string hostId, const std::string userName, const std::string userPasswd, const std::string databaseName)
	Constructor.
	TdkConDescriptor (const std::string dbmsName, const std::string hostId, const int portNumber, const std::string userName, const std::string userPasswd, const std::string databaseName)
	Constructor.
	TdkConDescriptor (const TdkConDescriptor &desc)
virtual TdkConDescriptor *	copy () const=0
	Copy constructor.
virtual	~TdkConDescriptor ()
	Destructor.
virtual bool	connect (TeDatabase *db) const
virtual void	createDatabaseModel (TeDatabase *db) const
	Creates the tdk database model.
std::string	getDbmsName () const
	Returns the name of the class.
std::string	getDbKey () const
	Returns the db_key_ property value.
std::string	getDbKeyOut () const
	Returns the db_key_out_ property value.
std::string	getHostID () const
	Returns the host_id_ property value.
int	getPortNumber () const
	Returns the portNumber_ property value.
std::string	getDatabaseName () const
	Returns the database_name_ property value.
std::string	getUser () const
	Returns the name of the class.
std::string	getPassword () const
	Returns the password_ property value.
void	setDbmsName (const std::string dbmsName)
void	setHostID (const std::string hostId)
void	setPortNumber (const int portNumber)
void	setDatabaseName (const std::string databaseName)
void	setUser (const std::string user)
void	setPassword (const std::string password)
virtual TeDatabase *	createDatabaseConnection () const
	Creates a new database driver based on the description.
Static Public Member Functions
static TdkConDescriptor *	createConDescriptor (std::string key)
	Creates a new database descriptor based on the given type and params.
Protected Member Functions
virtual void	setKey ()
	Generates the database secret key.
virtual void	setKeyOut ()
	Generates the database public key.
Protected Attributes
std::string	dbmsName_
std::string	host_
	Host name.
int	portNumber_
	Port number.
std::string	databaseName_
	Database name.
std::string	user_
	User name.
std::string	password_
	User password.
Static Protected Attributes
static const int	_INVALID_PORT_NUMBER = -1
static const int	_TDK_NUMBER_MANDATORY_ACCESSDB_DESCRIPTOR_TOKENS = 2
static const int	_TDK_NUMBER_MANDATORY_DESCRIPTOR_TOKENS = 5
static const int	_TDK_NUMBER_OPTIONAL_DESCRIPTOR_TOKENS = 1
Private Attributes
std::string	dbKey_
	A key that describes the database.
std::string	dbKeyOut_

---

Detailed Description

Defines an abstract database descriptor.

---

Constructor & Destructor Documentation

TdkConDescriptor::TdkConDescriptor

(

const std::string

dbmsName

)

Constructor.

@(#) TdkConDescriptor.cpp

TdkConDescriptor::TdkConDescriptor	(	const std::string	hostId,
		const std::string	userName,
		const std::string	userPasswd,
		const std::string	databaseName
	)

Constructor.

Parameters:

	hostId	Host name.
	userName	User name.
	userPasswd	User password.
	databaseName	Net service identifier.

TdkConDescriptor::TdkConDescriptor	(	const std::string	dbmsName,
		const std::string	hostId,
		const int	portNumber,
		const std::string	userName,
		const std::string	userPasswd,
		const std::string	databaseName
	)

Constructor.

Parameters:

	dbmsName	Database Management System name.
	hostId	Host name.
	userName	User name.
	userPasswd	User password.
	databaseName	Net service identifier.

TdkConDescriptor::TdkConDescriptor

(

const TdkConDescriptor &

desc

)

TdkConDescriptor::~TdkConDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

void TdkConDescriptor::setKey

(

)

[protected, virtual]

Generates the database secret key.

Each derived class must define the setKey method. The key will be the database descriptor attributes concatenated by the character _TDK_DBKEY_SEPARATOR.

void TdkConDescriptor::setKeyOut

(

)

[protected, virtual]

Generates the database public key.

Each derived class must define the setKey method. The key will be the database descriptor attributes concatenated by the character _TDK_DBKEY_SEPARATOR.

virtual TdkConDescriptor* TdkConDescriptor::copy

(

)

const [pure virtual]

Copy constructor.

Implemented in TdkAccessConDescriptor, TdkOracleConDescriptor, TdkSqlServerConDescriptor, TdkMySQLConDescriptor, and TdkPostgreSQLConDescriptor.

bool TdkConDescriptor::connect

(

TeDatabase *

db

)

const [virtual]

Reimplemented in TdkAccessConDescriptor.

void TdkConDescriptor::createDatabaseModel

(

TeDatabase *

db

)

const [virtual]

Creates the tdk database model.

std::string TdkConDescriptor::getDbmsName

(

)

const [inline]

Returns the name of the class.

std::string TdkConDescriptor::getDbKey

(

)

const [inline]

Returns the db_key_ property value.

std::string TdkConDescriptor::getDbKeyOut

(

)

const [inline]

Returns the db_key_out_ property value.

std::string TdkConDescriptor::getHostID

(

)

const [inline]

Returns the host_id_ property value.

int TdkConDescriptor::getPortNumber

(

)

const [inline]

Returns the portNumber_ property value.

std::string TdkConDescriptor::getDatabaseName

(

)

const [inline]

Returns the database_name_ property value.

std::string TdkConDescriptor::getUser

(

)

const [inline]

Returns the name of the class.

std::string TdkConDescriptor::getPassword

(

)

const [inline]

Returns the password_ property value.

void TdkConDescriptor::setDbmsName

(

const std::string

dbmsName

)

[inline]

void TdkConDescriptor::setHostID

(

const std::string

hostId

)

[inline]

void TdkConDescriptor::setPortNumber

(

const int

portNumber

)

[inline]

void TdkConDescriptor::setDatabaseName

(

const std::string

databaseName

)

[inline]

void TdkConDescriptor::setUser

(

const std::string

user

)

[inline]

void TdkConDescriptor::setPassword

(

const std::string

password

)

[inline]

TeDatabase * TdkConDescriptor::createDatabaseConnection

(

)

const [virtual]

Creates a new database driver based on the description.

Reimplemented in TdkPostgreSQLConDescriptor.

TdkConDescriptor * TdkConDescriptor::createConDescriptor

(

std::string

key

)

[static]

Creates a new database descriptor based on the given type and params.

Parameters:

key

The key of the database descriptor.

---

Member Data Documentation

std::string TdkConDescriptor::dbKey_ [private]

A key that describes the database.

std::string TdkConDescriptor::dbKeyOut_ [private]

const int TdkConDescriptor::_INVALID_PORT_NUMBER = -1 [static, protected]

const int TdkConDescriptor::_TDK_NUMBER_MANDATORY_ACCESSDB_DESCRIPTOR_TOKENS = 2 [static, protected]

const int TdkConDescriptor::_TDK_NUMBER_MANDATORY_DESCRIPTOR_TOKENS = 5 [static, protected]

const int TdkConDescriptor::_TDK_NUMBER_OPTIONAL_DESCRIPTOR_TOKENS = 1 [static, protected]

std::string TdkConDescriptor::dbmsName_ [protected]

std::string TdkConDescriptor::host_ [protected]

Host name.

int TdkConDescriptor::portNumber_ [protected]

Port number.

std::string TdkConDescriptor::databaseName_ [protected]

Database name.

std::string TdkConDescriptor::user_ [protected]

User name.

std::string TdkConDescriptor::password_ [protected]

User password.

---

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

• D:/usuarios/rodrigof/svn/tdk/src/peer/components/utils/dbDrivers/TdkConDescriptor.h
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/utils/dbDrivers/TdkConDescriptor.cpp

---