Isis 3 Programmer Reference
DatabaseFactory.h
1 #ifndef DatabaseFactory_h
2 #define DatabaseFactory_h
3 
10 /* SPDX-License-Identifier: CC0-1.0 */
11 
12 #include <string>
13 #include <vector>
14 #include <iostream>
15 
16 #include <QSqlDatabase>
17 
18 #include "CollectorMap.h"
19 #include "IException.h"
20 
21 namespace Isis {
22 
23  class DbAccess;
24  class DbProfile;
25 
245  public:
246  static DatabaseFactory *getInstance();
247 
258  void setDefault(const QString &name) {
259  _defDatabase = name;
260  }
261 
271  QString getDefault() const {
272  return (_defDatabase);
273  }
274 
275  bool addAccessProfile(const QString &profileFile);
276  void addProfile(const DbProfile &profile);
277  std::vector<QString> getProfileList() const;
278  DbProfile getProfile(const QString &name = "") const;
279 
289  QString getDefaultProfileName() const {
290  return (_defProfName);
291  }
292 
304  bool setDefaultProfileName(const QString &name) {
305  _defProfName = name;
306  return (_profiles.exists(name));
307  }
308 
309  std::vector<QString> available() const;
310  bool isDriverAvailable(const QString &driver) const;
311  bool isAvailable(const QString &dbname = "") const;
312  bool isConnected(const QString &dbname) const;
313  bool isPersistant(const QString &name) const;
314 
315  QSqlDatabase create(const QString &driver, const QString &dbname);
316  QSqlDatabase create(const QString &name);
317  void add(const QSqlDatabase &db, const QString &name,
318  bool setAsDefault = false);
319  void remove(const QString &dbname);
320  void destroy(const QString &dbname);
321 
322  private:
323  // Gain access through Singleton interface
324  DatabaseFactory();
326 
327  static void DieAtExit();
328 
330 
337 
338  QString _defProfName;
340  QString _defDatabase;
342 
343  void init();
344  void initPreferences();
345  void loadDrivers();
346  Drivers getResourceList(bool drivers, bool connections) const;
347  void selfDestruct();
348 
349  };
350 }
351 #endif
Isis::DatabaseFactory::isConnected
bool isConnected(const QString &dbname) const
Determines if the database resource is connected.
Definition: DatabaseFactory.cpp:315
Isis::DatabaseFactory::DatabaseFactory
DatabaseFactory()
Constructor establishing the startup state of this singleton.
Definition: DatabaseFactory.cpp:57
Isis::DatabaseFactory::create
QSqlDatabase create(const QString &driver, const QString &dbname)
Create a database using the named driver.
Definition: DatabaseFactory.cpp:358
Isis::DatabaseFactory::setDefault
void setDefault(const QString &name)
Sets the default name of the database.
Definition: DatabaseFactory.h:258
Isis::DatabaseFactory::getProfileList
std::vector< QString > getProfileList() const
Return list of names of currently available profiles.
Definition: DatabaseFactory.cpp:207
QSqlDatabase
Isis::DatabaseFactory::getProfile
DbProfile getProfile(const QString &name="") const
Get the specified database access profile.
Definition: DatabaseFactory.cpp:235
Isis::DatabaseFactory::init
void init()
Initializes this object upon instantiation.
Definition: DatabaseFactory.cpp:467
Isis::DatabaseFactory::_defDatabase
QString _defDatabase
Name of default database.
Definition: DatabaseFactory.h:340
Isis::DatabaseFactory::remove
void remove(const QString &dbname)
Removes the database from the connection pool.
Definition: DatabaseFactory.cpp:450
Isis::DatabaseFactory::setDefaultProfileName
bool setDefaultProfileName(const QString &name)
Sets the default profile to the name provided.
Definition: DatabaseFactory.h:304
Isis::DatabaseFactory::getDefaultProfileName
QString getDefaultProfileName() const
Returns the name of the default profile.
Definition: DatabaseFactory.h:289
Isis::DatabaseFactory::available
std::vector< QString > available() const
Determine what database drivers are available.
Definition: DatabaseFactory.cpp:260
Isis::DatabaseFactory::Profiles
CollectorMap< IString, DbProfile, NoCaseStringCompare > Profiles
Define list of Profiles.
Definition: DatabaseFactory.h:334
Isis::DatabaseFactory::isDriverAvailable
bool isDriverAvailable(const QString &driver) const
Check for the existance of a specific database driver.
Definition: DatabaseFactory.cpp:279
Isis::DatabaseFactory::addProfile
void addProfile(const DbProfile &profile)
Adds a database access profile to the list of profiles.
Definition: DatabaseFactory.cpp:194
Isis::DatabaseFactory::isPersistant
bool isPersistant(const QString &name) const
Checks if the database resource is persistant.
Definition: DatabaseFactory.cpp:335
Isis::DatabaseFactory::destroy
void destroy(const QString &dbname)
Removes the database from the connection pool and destroys it.
Definition: DatabaseFactory.cpp:435
Isis::DatabaseFactory::isAvailable
bool isAvailable(const QString &dbname="") const
Check for availablity of a database connection resource.
Definition: DatabaseFactory.cpp:297
Isis::DatabaseFactory::add
void add(const QSqlDatabase &db, const QString &name, bool setAsDefault=false)
Adds the database to the connection pool making it persistant.
Definition: DatabaseFactory.cpp:415
Isis::CollectorMap::exists
bool exists(const K &key) const
Checks the existance of a particular key in the list.
Definition: CollectorMap.h:551
Isis::DatabaseFactory::Databases
CollectorMap< IString, QSqlDatabase, NoCaseStringCompare > Databases
Define active database maintainer.
Definition: DatabaseFactory.h:336
Isis::DatabaseFactory::selfDestruct
void selfDestruct()
Destroy all elements associated with this object.
Definition: DatabaseFactory.cpp:576
Isis::DatabaseFactory::loadDrivers
void loadDrivers()
Load any drivers explicity.
Definition: DatabaseFactory.cpp:562
Isis::DatabaseFactory::_factory
static DatabaseFactory * _factory
Pointer to self (singleton)
Definition: DatabaseFactory.h:329
Isis::DatabaseFactory::addAccessProfile
bool addAccessProfile(const QString &profileFile)
Establishes an access profile for subsequent database connections.
Definition: DatabaseFactory.cpp:152
Isis::DatabaseFactory::_dbList
Databases _dbList
Maintains active databases.
Definition: DatabaseFactory.h:341
Isis::DbProfile
A DbProfile is a container for access parameters to a database.
Definition: DbProfile.h:51
Isis::DatabaseFactory
Create database interfaces using access profiles or generic drivers.
Definition: DatabaseFactory.h:244
Isis::DatabaseFactory::getInstance
static DatabaseFactory * getInstance()
Returns and instance of this DatabaseFactory singleton.
Definition: DatabaseFactory.cpp:124
Isis::DatabaseFactory::Drivers
CollectorMap< IString, QString, NoCaseStringCompare > Drivers
Define list of drivers and/or databases
Definition: DatabaseFactory.h:332
Isis::CollectorMap
Collector/container for arbitrary items.
Definition: CollectorMap.h:419
Isis::DatabaseFactory::getResourceList
Drivers getResourceList(bool drivers, bool connections) const
Get a list of available database drivers and connections.
Definition: DatabaseFactory.cpp:516
Isis::DatabaseFactory::DieAtExit
static void DieAtExit()
Exit termination routine.
Definition: DatabaseFactory.cpp:107
Isis::DatabaseFactory::getDefault
QString getDefault() const
Returns the name of the default database.
Definition: DatabaseFactory.h:271
Isis::DatabaseFactory::~DatabaseFactory
~DatabaseFactory()
Destructor implements self-destruction of this object.
Definition: DatabaseFactory.cpp:90
Isis::DatabaseFactory::_defProfName
QString _defProfName
Default profile name.
Definition: DatabaseFactory.h:338
Isis::DatabaseFactory::initPreferences
void initPreferences()
Initializes user database preferences.
Definition: DatabaseFactory.cpp:486
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::DatabaseFactory::_profiles
Profiles _profiles
Maintain list of profiles.
Definition: DatabaseFactory.h:339