com.ihr.xbrl.db

Class AppDatabase

java.lang.Object

com.ihr.xbrl.db.AppDatabase

public class AppDatabase
extends java.lang.Object

This class provides access to a database that will be used to store application information. The class instance can be obtained from the getInstance() method. It is a singleton and no new instances can be created. Every database is described as a super class of the Database class

Author:

Ignacio

See Also:

Database

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	getConnection(Database db) Obtains a connection to the database.
static AppDatabase	getInstance() Gets the single instance of AppDatabase.
static void	shutdown() shutdown all opened databases.
void	shutdown(Database db) Shutdowns a database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

shutdown

public static void shutdown()

shutdown all opened databases. Used internally by the API there shall be no need to call this method from applications

getInstance

public static AppDatabase getInstance()

Gets the single instance of AppDatabase.

Returns:

single instance of AppDatabase

getConnection

public java.sql.Connection getConnection(Database db)

Obtains a connection to the database. Database instances shall extend the Database class and shall also be singletons

Remember to close the database connection in the same method where the connection is obtained

Parameters:

db - the database to open a connection with

Returns:

database connection.

shutdown

public void shutdown(Database db)

Shutdowns a database. It should not be needed to call this method because the getConnection caches opened databases and installs a JVM shutdown hook to shutdown the database connections at the end

Parameters:

db - the db