A DbProfile is a container for access parameters to a database. More...

#include <DbProfile.h>

Inheritance diagram for Isis::DbProfile:

Collaboration diagram for Isis::DbProfile:

Public Member Functions
	DbProfile ()

	DbProfile (const QString &name)

	DbProfile (const DbProfile &prof1, const DbProfile &prof2, const QString &name="")
	Creates a profile from the merging of two a DbProfiles.

	DbProfile (PvlContainer &pvl)
	Creates a DbProfile from a Pvl entity.

virtual	~DbProfile ()
	Destructor ensures everything is cleaned up properly.

bool	isValid () const
	Reports if this is a valid profile.

int	size () const
	Reports the number of keywords in this user profile.

void	setName (const QString &name)
	Set the name of this profile.

QString	Name () const
	Returns the name of this property.

bool	exists (const QString &key) const
	Checks for the existance of a keyword.

void	add (const QString &key, const QString &value="")
	Adds a keyword and value pair to the profile.

void	replace (const QString &key, const QString &value="")
	Adds a keyword and value pair to the profile.

void	remove (const QString &key)
	Removes a keyword from the profile.

int	count (const QString &key) const
	Report number of values in keyword.

QString	key (int nth) const
	Returns the nth key in the profile.

QString	value (const QString &key, int nth=0) const
	Returns the specified value for the given keyword.

QString	operator() (const QString &key, int nth=0) const
	Returns the specified value for the given keyword.

Protected Types
typedef CollectorMap< IString, PvlKeyword, NoCaseStringCompare >	KeyList

Protected Member Functions
void	loadkeys (PvlContainer &pvl)
	Loads DbProfile keys from the given Pvl construct.

const KeyList &	getKeyList () const
	Returns a reference to the key list.

Detailed Description

A DbProfile is a container for access parameters to a database.

This class provides a utility for (keyword) parameter management to access a database system. Profiles can be used to specify all parameters necessary to apply to programatic interfaces to database software such as Qt's SQL Module class, QSqlDatabase.

Using QSqlDatabase as an example, keywords such as User, Host, Port, and Dbname can be stored in this object and retrieved easily.

It can be easily adapted to any database software API by externally managing the contents of a configuration file. See DbAccess for additional details on how this scheme can be utilized.

Author: 2006-11-09 Kris Becker

Member Typedef Documentation

◆ KeyList

typedef CollectorMap<IString, PvlKeyword, NoCaseStringCompare> Isis::DbProfile::KeyList

protected

Constructor & Destructor Documentation

◆ DbProfile() [1/4]

Isis::DbProfile::DbProfile ( )

inline

Referenced by Isis::DbAccess::getProfile(), and Isis::DbAccess::getProfile().

◆ DbProfile() [2/4]

Isis::DbProfile::DbProfile ( const QString & name )

inline

◆ DbProfile() [3/4]

Isis::DbProfile::DbProfile	(	const DbProfile &	prof1,
		const DbProfile &	prof2,
		const QString &	name = "" )

Creates a profile from the merging of two a DbProfiles.

This constructor will create a new DbProfile from two existing DbProfiles. Its intended use is for the merging of keys in an ordered fashion. It is useful when a higher level class inherits this class and a specific implementations calls for the keys to come from both the parent and the child DbProfile.

It should be noted that this is a convenient way to merge high level database access parameters with individual profile access where the last keys take precedence over the first. Thus, in the case where the same keys exist in both the first and second profiles, keys in the second profile take precedence. This is great for defining general database parameters in the top level database configure section and having individual profiles redefine certain access parameters.

Parameters

name	Name of new profile
prof1	First profile to merge
prof2	Second profile to merge

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::add().

◆ DbProfile() [4/4]

Isis::DbProfile::DbProfile ( PvlContainer & pvl )

Creates a DbProfile from a Pvl entity.

This constructor will create a DbProfile by reading keywords from a Pvl container. Pvl Containers can be an Object or a Group, or simply a list of keywords. This PvlContainer is expected to point to the appropriate keywords that the caller has pre-established by normal Isis Pvl methods.

Parameters

pvl	Pvl container of keywords to make a DbProfile from

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::exists(), loadkeys(), and value().

◆ ~DbProfile()

virtual Isis::DbProfile::~DbProfile ( )

inlinevirtual

Destructor ensures everything is cleaned up properly.

Member Function Documentation

◆ add()

void Isis::DbProfile::add	(	const QString &	key,
		const QString &	value = "" )

Adds a keyword and value pair to the profile.

This method adds a keyword and value pair to the profile if it doesn't exist. If the keyword already exists,it appends the value to the existing keyword.

Parameters

key	Keyword to add or ammend
value	Value to add to the keyword

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::add(), Isis::PvlKeyword::addValue(), Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::exists(), Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::get(), key(), and value().

Referenced by Isis::DatabaseFactory::addAccessProfile().

◆ count()

int Isis::DbProfile::count ( const QString & key ) const

Report number of values in keyword.

This method will return the number of values in the specified keyword. If the keyword does not exist, 0 is returned.

Parameters

key	Name of key to get value count for

Returns: int Number values in key, or 0 if the key does not exist

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::exists(), Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::get(), key(), and Isis::PvlKeyword::size().

◆ exists()

bool Isis::DbProfile::exists ( const QString & key ) const

inline

Checks for the existance of a keyword.

Parameters

key	Name of keyword to check

Returns: bool True if it exists, false if it doesn't

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::exists(), and key().

Referenced by Isis::Database::configureAccess(), Isis::DbAccess::getDefaultProfileName(), and Isis::LoadCSV::load().

◆ getKeyList()

const KeyList & Isis::DbProfile::getKeyList ( ) const

inlineprotected

Returns a reference to the key list.

Direct access to the keyword container allows class developers some additional flexibility whilst maintaining integrity through the public interface.

Returns: const KeyList& Reference to keyword list

◆ isValid()

bool Isis::DbProfile::isValid ( ) const

inline

Reports if this is a valid profile.

A valid profile is simply defined to contain keys. If there are no keys defined for the profile, it is deemed invalid.

Returns: bool True if the profile is valid, therefore containing keys

References size().

Referenced by Isis::Database::init(), and Isis::Database::init().

◆ key()

QString Isis::DbProfile::key ( int nth ) const

inline

Returns the nth key in the profile.

This method returns the name of the nth keyword in the profile so one can iterate through all existing keys. Note that database passwords could be vulnerable to exposure via this method.

Keywords in the profile are sorted in alphabetical order and not in the order in which they are read.

Parameters

nth	Specifies the nth key in the profile

Returns: QString Name of nth keyword in the profile.

Exceptions

Out-of-range exception if the nth keyword does not exist

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::key().

Referenced by add(), count(), exists(), loadkeys(), operator()(), remove(), replace(), and value().

◆ loadkeys()

void Isis::DbProfile::loadkeys ( PvlContainer & pvl )

protected

Loads DbProfile keys from the given Pvl construct.

This method iterates through all keywords in the Pvl container and loads them into this property.

Parameters

pvl	Container of keywords that will be loaded

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::add(), and key().

Referenced by DbProfile(), and Isis::DbAccess::load().

◆ Name()

QString Isis::DbProfile::Name ( ) const

inline

Returns the name of this property.

Returns: QString Name of this property

Referenced by Isis::DatabaseFactory::addProfile(), Isis::DbAccess::addProfile(), and Isis::Database::init().

◆ operator()()

QString Isis::DbProfile::operator()	(	const QString &	key,
		int	nth = 0 ) const

Returns the specified value for the given keyword.

This method returns a value from the specified keyword. If the keyword or the specified value does not exist, an exception is thrown.

Parameters

key	Name of keyword to return value for.
nth	Specifies the nth value in the keyword

Returns: QString The requested value in the keyword

References key(), and value().

◆ remove()

void Isis::DbProfile::remove ( const QString & key )

Removes a keyword from the profile.

Parameters

key	Keyword to remove

References key(), and Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::remove().

◆ replace()

void Isis::DbProfile::replace	(	const QString &	key,
		const QString &	value = "" )

Adds a keyword and value pair to the profile.

This method adds a keyword and value pair to the profile if it doesn't exist.

If the keyword already exists, it is deleted and replaced with this new keyword and value.

Parameters

key	Keyword to replace
value	Value to add to the keyword

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::add(), key(), and value().

◆ setName()

void Isis::DbProfile::setName ( const QString & name )

inline

Set the name of this profile.

Parameters

name	QString used to set the name of this profile

◆ size()

int Isis::DbProfile::size ( ) const

inline

Reports the number of keywords in this user profile.

Returns: int Number keywords found in profile

References Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::size().

Referenced by isValid().

◆ value()

QString Isis::DbProfile::value	(	const QString &	key,
		int	nth = 0 ) const

Returns the specified value for the given keyword.

This method returns a value from the specified keyword. If the keyword or the specified value does not exist, an exception is thrown.

Parameters

key	Name of keyword to return value for.
nth	Specifies the nth value in the keyword

Returns: QString The requested value in the keyword

References _FILEINFO_, Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >::get(), key(), and Isis::IException::Programmer.

Referenced by add(), DbProfile(), Isis::DbAccess::getDefaultProfileName(), operator()(), and replace().

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

/Users/astamile/ISIS3/isis/src/database/objs/DbProfile/DbProfile.h
/Users/astamile/ISIS3/isis/src/database/objs/DbProfile/DbProfile.cpp

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ KeyList

Constructor & Destructor Documentation

◆ DbProfile() [1/4]

◆ DbProfile() [2/4]

◆ DbProfile() [3/4]

◆ DbProfile() [4/4]

◆ ~DbProfile()

Member Function Documentation

◆ add()

◆ count()

◆ exists()

◆ getKeyList()

◆ isValid()

◆ key()

◆ loadkeys()

◆ Name()

◆ operator()()

◆ remove()

◆ replace()

◆ setName()

◆ size()

◆ value()