Package com.plotsquared.core.database

Class Database

java.lang.Object

com.plotsquared.core.database.Database

Direct Known Subclasses:

MySQL, SQLite

public abstract class Database
extends Object

Abstract Database class, serves as a base for any connection method (MySQL, SQLite, etc.)

Constructor Summary

Constructors

Constructor	Description
Database()

Method Summary

Modifier and Type	Method	Description
abstract boolean	checkConnection()	Checks if a connection is open with the database.
abstract boolean	closeConnection()	Closes the connection with the database.
abstract Connection	forceConnection()
abstract Connection	getConnection()	Gets the connection with the database.
abstract Connection	openConnection()	Opens a connection with the database.
abstract ResultSet	querySQL(String query)	Executes a SQL Query.
abstract int	updateSQL(String query)	Executes an Update SQL Query.

Methods inherited from class java.lang.Object

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

Constructor Details

Database

public Database()

Method Details

forceConnection

public abstract Connection forceConnection()
                                    throws SQLException,
ClassNotFoundException

Throws:

SQLException

ClassNotFoundException

openConnection

public abstract Connection openConnection()
                                   throws SQLException,
ClassNotFoundException

Opens a connection with the database.

Returns:

Opened connection

Throws:

SQLException - if the connection can not be opened

ClassNotFoundException - if the driver cannot be found

checkConnection

public abstract boolean checkConnection()
                                 throws SQLException

Checks if a connection is open with the database.

Returns:

true if the connection is open

Throws:

SQLException - if the connection cannot be checked

getConnection

public abstract Connection getConnection()

Gets the connection with the database.

Returns:

Connection with the database, null if none

closeConnection

public abstract boolean closeConnection()
                                 throws SQLException

Closes the connection with the database.

Returns:

true if successful

Throws:

SQLException - if the connection cannot be closed

querySQL

public abstract ResultSet querySQL(String query)
                            throws SQLException,
ClassNotFoundException

Executes a SQL Query. If the connection is closed, it will be opened.

Parameters:

query - Query to be run

Returns:

the results of the query

Throws:

SQLException - If the query cannot be executed

ClassNotFoundException - If the driver cannot be found; see openConnection()

updateSQL

public abstract int updateSQL(String query)
                       throws SQLException,
ClassNotFoundException

Executes an Update SQL Query. See Statement.executeUpdate(String). If the connection is closed, it will be opened.

Parameters:

query - Query to be run

Returns:

Result Code, see Statement.executeUpdate(String)

Throws:

SQLException - If the query cannot be executed

ClassNotFoundException - If the driver cannot be found; see openConnection()