ch.agent.crnickl.api

Class DatabaseConfiguration

java.lang.Object

ch.agent.crnickl.api.DatabaseConfiguration

public class DatabaseConfiguration
extends Object

A DatabaseConfiguration is a group of parameters defining a Database. Three parameters are essential: the name and class of the database and the class of the time domain catalog. All other parameters are arbitrary key-value pairs.

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
DatabaseConfiguration(String databaseName, String databaseClassName, String timeDomainCatalogClassName) Construct a database configuration.

Method Summary

Modifier and Type	Method and Description
Class<? extends Database>	getDatabaseClass() Return the class of the database.
String	getName() Return the name of the database.
String	getParameter(String key, boolean mustExist) Return a parameter value given its key.
ch.agent.t2.time.TimeDomainCatalog	getTimeDomainCatalog() Return the time domain catalog.
void	setParameter(String key, String value) Set a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConfiguration

public DatabaseConfiguration(String databaseName,
                             String databaseClassName,
                             String timeDomainCatalogClassName)
                      throws T2DBException

Construct a database configuration. If there is a problem with the database class, an exception is thrown. If the name of the time domain catalog class is null or empty, a default will be used.

Parameters:

databaseName - the name of the database

databaseClassName - the name of a class implementing Database

timeDomainCatalogClassName - the name of a class implementing TimeDomainCatalog or null or empty

Throws:

T2DBException

Method Detail

setParameter

public void setParameter(String key,
                         String value)

Set a parameter.

Parameters:

key - a string

value - a string

getName

public String getName()

Return the name of the database.

Returns:

the name of the database

getDatabaseClass

public Class<? extends Database> getDatabaseClass()

Return the class of the database.

Returns:

a subclass of Database

getTimeDomainCatalog

public ch.agent.t2.time.TimeDomainCatalog getTimeDomainCatalog()

Return the time domain catalog.

Returns:

a time domain catalog

getParameter

public String getParameter(String key,
                           boolean mustExist)
                    throws T2DBException

Return a parameter value given its key. If there is no such parameter, return null or throw an exception, depending on the value of mustExist.

Parameters:

key - a string

mustExist - if true throw an exception when there is no such parameter

Returns:

the value of the parameter with the given key

Throws:

T2DBException