ptdb.common.util

Class DBConnectorFactory

java.lang.Object

ptdb.common.util.DBConnectorFactory

public class DBConnectorFactory
extends java.lang.Object

A factory class that creates different types of XML database connections.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ashwini Bijwe

Pt.AcceptedRating:

Red (abijwe)

Pt.ProposedRating:

Red (abijwe)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_CACHE_CONTAINER_NAME Name for the property for PtolemyDB cache container name in the config/ptdb-properties file.
static java.lang.String	_DB_CLASS_NAME Name for the property for XML database class in the config/ptdb-properties file.
static java.lang.String	_DB_URL Name for the property for XML database URL/Location in the config/ptdb-properties file.
static java.lang.String	_PROPERTIES_FILE_PATH Path to the configuration file.
static java.lang.String	_XMLDB_CONTAINER_NAME Name for the property for XML database container name in the config/ptdb-properties file.

Constructor Summary

Constructors

Constructor and Description
DBConnectorFactory()

Method Summary

Modifier and Type	Method and Description
static DBConnection	getAsyncConnection() Get an asynchronous connection to the database.
static DBConnection	getCacheConnection(boolean isTransactionRequired) Get a synchronous connection to the cache database.
static DBConnectionParameters	getDBConnectionParameters() Return the database connection parameters.
static java.lang.String	getParametersString() Return the parameters set as a concatenated string.
static SetupParameters	getSetupParameters() create a setup parameter object that contains the database setup parameters and return that setup parameter object to the caller.
static DBConnection	getSyncConnection(boolean isTransactionRequired) This API is used to get a synchronous connection to the database.
static DBConnection	getSyncConnection(DBConnectionParameters dbConnectionParameters) This API is used to get a synchronous connection to the database.
static boolean	isSetupDone() Return true if the database setup is completed.
static void	loadDBProperties() Load the properties from config/ptdb.properties and set them for use during creating connections to the XML database.

Methods inherited from class java.lang.Object

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

Field Detail

_DB_CLASS_NAME

public static final java.lang.String _DB_CLASS_NAME

Name for the property for XML database class in the config/ptdb-properties file.

See Also:

Constant Field Values

_DB_URL

public static final java.lang.String _DB_URL

Name for the property for XML database URL/Location in the config/ptdb-properties file.

See Also:

Constant Field Values

_XMLDB_CONTAINER_NAME

public static final java.lang.String _XMLDB_CONTAINER_NAME

Name for the property for XML database container name in the config/ptdb-properties file.

See Also:

Constant Field Values

_CACHE_CONTAINER_NAME

public static final java.lang.String _CACHE_CONTAINER_NAME

Name for the property for PtolemyDB cache container name in the config/ptdb-properties file.

See Also:

Constant Field Values

_PROPERTIES_FILE_PATH

public static final java.lang.String _PROPERTIES_FILE_PATH

Path to the configuration file.

See Also:

Constant Field Values

Constructor Detail

DBConnectorFactory

public DBConnectorFactory()

Method Detail

getSetupParameters

public static SetupParameters getSetupParameters()

create a setup parameter object that contains the database setup parameters and return that setup parameter object to the caller.

Returns:

The setup parameter object.

getSyncConnection

public static DBConnection getSyncConnection(boolean isTransactionRequired)
                                      throws DBConnectionException

This API is used to get a synchronous connection to the database. A synchronous connection is a connection that executes the query as soon as the executeQuery is called on the connection. A synchronous connection supports both execution of queries with transaction and without transactions.

Parameters:

isTransactionRequired - - Boolean to specify whether this connection needs a transaction or not.

Returns:

DBConnection - The executes queries as and when the execute query is called.

Throws:

DBConnectionException - - Whenever we face a problem while creating a database connection. These problems could be that configured connection class does not exist, the path for the database is not found, the container name is incorrect, the connection to the database could not be established etc.

getSyncConnection

public static DBConnection getSyncConnection(DBConnectionParameters dbConnectionParameters)
                                      throws DBConnectionException

This API is used to get a synchronous connection to the database. A synchronous connection is a connection that executes the query as soon as the executeQuery is called on the connection. A synchronous connection supports both execution of queries with transaction and without transactions.

Parameters:

dbConnectionParameters - Connection parameters for creating the connection.

Returns:

DBConnection To execute queries as and when the execute query is called.

Throws:

DBConnectionException - Whenever we face a problem while creating a database connection. These problems could be that configured connection class does not exist, the path for the database is not found, the container name is incorrect, the connection to the database could not be established etc.

getAsyncConnection

public static DBConnection getAsyncConnection()
                                       throws DBConnectionException

Get an asynchronous connection to the database. An asynchronous connection is a connection that enqueues the query as soon as the executeQuery is called on the connection and executes them asynchronously. An asynchronous connection should be used for the execution of queries that require a transaction and do not return data from the database.

Returns:

DBConnection - That enqueues queries as and when the execute query is called and executes them asynchronously.

Throws:

DBConnectionException - - Whenever we face a problem while creating a database connection. These problems could be that configured connection class does not exist, the path for the database is not found, the container name is incorrect, the connection to the database could not be established etc.

getCacheConnection

public static DBConnection getCacheConnection(boolean isTransactionRequired)
                                       throws DBConnectionException

Get a synchronous connection to the cache database. A synchronous connection is a connection that executes the query as soon as the executeQuery is called on the connection. A synchronous connection supports both execution of queries with transaction and without transactions.

Parameters:

isTransactionRequired - - Boolean to specify whether this connection needs a transaction or not.

Returns:

DBConnection - That executes queries as and when the execute query is called.

Throws:

DBConnectionException - - Whenever we face a problem while creating a database connection. These problems could be that configured connection class does not exist, the path for the database is not found, the container name is incorrect, the connection to the database could not be established etc.

getDBConnectionParameters

public static DBConnectionParameters getDBConnectionParameters()

Return the database connection parameters.

Returns:

Database connection parameters like URL and container name.

isSetupDone

public static boolean isSetupDone()

Return true if the database setup is completed.

Returns:

True if setup is completed; false otherwise.

loadDBProperties

public static void loadDBProperties()

Load the properties from config/ptdb.properties and set them for use during creating connections to the XML database.

Ascertain if the database setup has been done and if the properties for the database have been set.

Throw an exception if the config/ptdb.properties file is not found.

getParametersString

public static java.lang.String getParametersString()

Return the parameters set as a concatenated string.

Returns:

Concatenated String of database parameters - class name, URL, container name.