ch.agent.crnickl.api

Class DatabaseFactory

java.lang.Object

ch.agent.crnickl.api.DatabaseFactory

public class DatabaseFactory
extends Object

DatabaseFactory is the object which manages one or more Databases. It creates a database using parameters specified in a DatabaseConfiguration. Databases are accessed by name from the factory.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
void	addDatabase(DatabaseConfiguration configuration) Add a database to the factory.
Database	getDatabase(String name) Return the database with the given name.
Collection<String>	getDatabaseNames() Return the names of all databases.
Database	getDefaultDatabase() Return the default database.
static DatabaseFactory	getInstance() Return the DatabaseFactory instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DatabaseFactory getInstance()

Return the DatabaseFactory instance.

Returns:

the DatabaseFactory instance

addDatabase

public void addDatabase(DatabaseConfiguration configuration)
                 throws T2DBException

Add a database to the factory.

Parameters:

configuration - the configuration of the database

Throws:

T2DBException

getDefaultDatabase

public Database getDefaultDatabase()
                            throws T2DBException

Return the default database. This is simply the database available from the factory when there is one and only one database.

Returns:

the default database

Throws:

T2DBException

getDatabaseNames

public Collection<String> getDatabaseNames()

Return the names of all databases.

Returns:

the names of all databases in the factory

getDatabase

public Database getDatabase(String name)
                     throws T2DBException

Return the database with the given name.

Parameters:

name - a string

Returns:

a database

Throws:

T2DBException