| java.lang.Object
 com.mckoi.database.control.DBController
| DBController | | final public class DBController (Code) | | An object that provides methods for creating and controlling database
systems in the current JVM.
author:
Tobias Downer |
| Constructor Summary | |
| | DBController()
This object can not be constructed outside of this package. |
| Method Summary | |
| public DBSystem | createDatabase(DBConfig config, String admin_user, String admin_pass)
Creates a database in the local JVM (and filesystem) given the
configuration in DBConfig and returns a DBSystem object. | | public boolean | databaseExists(DBConfig config)
Returns true if a Mckoi database exists in the given directory of the
file system, otherwise returns false if the path doesn't contain a
database.
The path string must be formatted using Unix '/' deliminators as
directory separators.
Parameters:
config - the configuration of the database to check the existenceof. | | public static DBController | getDefault()
Returns the static controller for this JVM. | | public DBSystem | startDatabase(DBConfig config)
Starts a database in the local JVM given the configuration in DBConfig
and returns a DBSystem object. |
| DBController | | DBController()(Code) | | This object can not be constructed outside of this package.
|
| createDatabase | | public DBSystem createDatabase(DBConfig config, String admin_user, String admin_pass)(Code) | | Creates a database in the local JVM (and filesystem) given the
configuration in DBConfig and returns a DBSystem object. When this
method returns, the database created will be up and running providing
there was no failure during the database creation process.
A failure might happen because the database path does not exist.
Parameters:
admin_user - the username of the administrator for the new database.
Parameters:
admin_pass - the password of the administrator for the new database.
Parameters:
config - the configuration of the database to create and start in thelocal JVM. the DBSystem object used to access the database created. |
| databaseExists | | public boolean databaseExists(DBConfig config)(Code) | | Returns true if a Mckoi database exists in the given directory of the
file system, otherwise returns false if the path doesn't contain a
database.
The path string must be formatted using Unix '/' deliminators as
directory separators.
Parameters:
config - the configuration of the database to check the existenceof. true if a database exists at the given path, false otherwise. |
| getDefault | | public static DBController getDefault()(Code) | | Returns the static controller for this JVM.
|
| startDatabase | | public DBSystem startDatabase(DBConfig config)(Code) | | Starts a database in the local JVM given the configuration in DBConfig
and returns a DBSystem object. When this method returns, the database
will be up and running providing there was no failure to initialize the
database.
A failure might happen if the database does not exist in the path given
in the configuration.
Parameters:
config - the configuration of the database to start in the localJVM. the DBSystem object used to access the database started. |
|
|