org.melati
Class LogicalDatabase

java.lang.Object
  org.melati.LogicalDatabase

public final class LogicalDatabase
extends Object

An object which knows how to connect to a database.

Method Summary

static org.melati.poem.Database	getDatabase(String name) Retrieve a database by name.
static Vector<String>	getInitialisedDatabaseNames() Retrieve the names of the databases which have completed initialisation.
static String	getPropertiesName() The name used with getResourceAsStream to get the file and the properties within it.
static Vector<org.melati.poem.Database>	initialisedDatabases() Retrieve the databases which have completed initialisation.
static void	setDatabaseDefs(Properties databaseDefsIn) Set the databaseDefs.

Methods inherited from class java.lang.Object

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

Method Detail

initialisedDatabases

public static Vector<org.melati.poem.Database> initialisedDatabases()

Retrieve the databases which have completed initialisation.

Returns:

a Vector of the initialised databases

getInitialisedDatabaseNames

public static Vector<String> getInitialisedDatabaseNames()

Retrieve the names of the databases which have completed initialisation. Note that a database which has not been used will not have been initialised.

Returns:

a Vector of the initialised database names

getDatabase

public static org.melati.poem.Database getDatabase(String name)
                                            throws org.melati.util.DatabaseInitException

Retrieve a database by name.

Parameters:

name - the name of the database

Returns:

a Database with the name specified

Throws:

org.melati.util.DatabaseInitException - if any Exception is trapped

setDatabaseDefs

public static void setDatabaseDefs(Properties databaseDefsIn)

Set the databaseDefs.

getPropertiesName

public static String getPropertiesName()

The name used with getResourceAsStream to get the file and the properties within it.

Returns:

Returns the defaultPropertiesName.