Package ece.ing3.java.projet.database

Class Database

java.lang.Object

ece.ing3.java.projet.database.Database

public class Database
extends Object

Database helper.

Offers utility functions to manage a database. Database configuration is loaded automatically.

Author:

Virgile, Nicolas, Louis-Félix

Constructor Summary

Constructors

Constructor	Description
Database()

Method Summary

Modifier and Type	Method	Description
static void	close()	Closes the database.
static void	connect()	Connects to the database.
static ResultSet	execute(String query)	Execute a SQL query on the database.
static void	fillWithExamples()	Fill the database with example data.
static Connection	get()	Gets the current connection.
static DataSource	getDataSource()	Gets the data source.
static String	getEmbeddedUserDatabaseUrl()	Gets the embedded user database JDBC URL.
static void	init()	Initialize the database with required schema.
static PreparedStatement	preparedStatement(String query)	Create a new prepared statement on the opened database, using the provided SQL query.
static Statement	statement()	Create a new statement on the opened database.
static boolean	validate()	Validates the database's schema schema.

Methods inherited from class java.lang.Object

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

Constructor Details

Database

public Database()

Method Details

connect

public static void connect()
                    throws ConfigurationException,
DatabaseException

Connects to the database.

Throws:

DatabaseException - Database error

ConfigurationException - Invalid configuration

validate

public static boolean validate()
                        throws DatabaseException

Validates the database's schema schema.

Returns:

true if the schema is correct

Throws:

DatabaseException

init

public static void init()
                 throws DatabaseException

Initialize the database with required schema.

Throws:

DatabaseException - Database error

fillWithExamples

public static void fillWithExamples()
                             throws DatabaseException

Fill the database with example data.

Throws:

DatabaseException - Database error

getDataSource

public static DataSource getDataSource()

Gets the data source.

Returns:

Data source

get

public static Connection get()

Gets the current connection.

Returns:

Connection

statement

public static Statement statement()
                           throws DatabaseException

Create a new statement on the opened database.

Returns:

Created blank statement

Throws:

DatabaseException - Database error

preparedStatement

public static PreparedStatement preparedStatement(String query)
                                           throws DatabaseException

Create a new prepared statement on the opened database, using the provided SQL query.

Parameters:

query - SQL query

Returns:

Prepared statement

Throws:

DatabaseException - Database error

execute

public static ResultSet execute(String query)
                         throws DatabaseException

Execute a SQL query on the database.

Parameters:

query - SQL query to execute

Returns:

Query result

Throws:

DatabaseException - Database error

close

public static void close()
                  throws DatabaseException

Closes the database.

Throws:

DatabaseException - Database error

getEmbeddedUserDatabaseUrl

public static String getEmbeddedUserDatabaseUrl()

Gets the embedded user database JDBC URL. For usage with the appropriate driver.

Returns:

Embedded user database JDBC URL or null on error