com.absio.database

Class DatabaseWrapper

java.lang.Object

com.absio.database.DatabaseWrapper

public class DatabaseWrapper
extends Object

This class wraps a SQL Database. It manages the connection and provides several helper method for executing queries and updates. When dealing with parameters the helper methods use SqlParameter to represent a generic parameter (name and value).

Method Summary

Modifier and Type	Method and Description
void	close() If the database is open this will close the JDBC Connection.
Statement	createStatement() Creates a Statement using the JDBC Connection.
void	destroy() This will close the JDBC Connection and then delete the database file.
void	dropTable(String tableName) This will drop the table from the database.
long	executeCountQuery(String countSql) This will execute the count query and return the result.
long	executeCountQueryWithParameters(ParameterizedSql parameterizedSql) This will execute the count query with the given parameters and return the result.
long	executeCountQueryWithParameters(String countSql, SqlParameter... parameters) This will execute the count query with the given parameters and return the result.
int	executeUpdate(String sql) The will execute the given sql as an update (insert, update, delete, etc).
int	executeUpdateWithParameters(ParameterizedSql parameterizedSql) The will execute the given sql as an update with the given parameters (insert, update, delete, etc).
int	executeUpdateWithParameters(String sql, SqlParameter... parameters) The will execute the given sql as an update with the given parameters (insert, update, delete, etc).
static org.threeten.bp.ZonedDateTime	fetchLocalTime(ResultSet resultSet, String columnName) Fetches and converts a Long into a ZonedDateTime from the ResultSet based on a column name.
static UUID	fetchUUID(ResultSet resultSet, String columnName) Fetches and converts a String into a UUID from the ResultSet based on a column name.
void	fillStatement(PreparedStatement statement, SqlParameter... parameters) This is a utility method to help fill PreparedStatements (by calling SqlParameter.fillStatement(int, PreparedStatement).
List<String>	getColumnNames(String tableName) Gets the names of all the columns of a table.
String	getLocation() Get the file location of the database.
int	getVersion() Get the version of the database.
boolean	isOpen() Get if the database is open.
DatabaseOpenState	openOrCreate() Opens a database for operation.
PreparedStatement	prepareStatement(ParameterizedSql parameterizedSql) Create a PreparedStatement for the given sql and fill the parameters.
PreparedStatement	prepareStatement(String sql, SqlParameter... parameters) Create a PreparedStatement for the given sql and fill the parameters.
void	setVersion(int version) Set the version of the database.
boolean	tableExists(String tableName) Check if a table exists in the database.
static org.threeten.bp.ZonedDateTime	toLocalTime(long secondsSinceEpoch) This will take the passed in time (assumed seconds since Epoch in the UTC time zone) and convert to the local time zone.
static long	toUTCTimeAsLong(org.threeten.bp.ZonedDateTime dateTime) Get the time represented as a long (seconds since Epoch) and in the UTC time zone.

Methods inherited from class java.lang.Object

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

Method Detail

fetchLocalTime

public static org.threeten.bp.ZonedDateTime fetchLocalTime(ResultSet resultSet,
                                                           String columnName)
                                                    throws SQLException

Fetches and converts a Long into a ZonedDateTime from the ResultSet based on a column name.

NOTE: See toLocalTime(long)

Parameters:

resultSet - the result set from the DatabaseWrapper

columnName - the column name to fetch

Returns:

the converted ZonedDateTime or null

Throws:

SQLException - thrown if an error occurs accessing the ResultSet

fetchUUID

public static UUID fetchUUID(ResultSet resultSet,
                             String columnName)
                      throws SQLException

Fetches and converts a String into a UUID from the ResultSet based on a column name.

NOTE: See UUID.fromString(String)

Parameters:

resultSet - the result set from the DatabaseWrapper

columnName - the column name to fetch

Returns:

the converted UUID or null

Throws:

SQLException - thrown if an error occurs accessing the ResultSet

toLocalTime

public static org.threeten.bp.ZonedDateTime toLocalTime(long secondsSinceEpoch)

This will take the passed in time (assumed seconds since Epoch in the UTC time zone) and convert to the local time zone.

Parameters:

secondsSinceEpoch - the seconds since Epoch in the UTC time zone to convert to local time

Returns:

the local time

toUTCTimeAsLong

public static long toUTCTimeAsLong(org.threeten.bp.ZonedDateTime dateTime)

Get the time represented as a long (seconds since Epoch) and in the UTC time zone.

Parameters:

dateTime - the time to convert to a long in UTC

Returns:

the time represented as a long

close

public void close()
           throws SQLException

If the database is open this will close the JDBC Connection.

Throws:

SQLException - thrown if there was an issue closing the Connection

createStatement

public Statement createStatement()
                          throws SQLException

Creates a Statement using the JDBC Connection.

NOTE: the database must be open before you call this method.

Returns:

the Statement

Throws:

SQLException - thrown if there was an issue creating the Statement

destroy

public void destroy()
             throws IOException,
                    SQLException

This will close the JDBC Connection and then delete the database file.

NOTE: the database file will be deleted and cannot be recovered!

Throws:

IOException - thrown if there was an issue deleting the database file

SQLException - thrown if there was an issue closing the Connection

dropTable

public void dropTable(String tableName)
               throws SQLException

This will drop the table from the database.

NOTE: the database must be open before you call this method.

Parameters:

tableName - the name of the table to drop

Throws:

SQLException - thrown if there was an issue dropping the table

executeCountQuery

public long executeCountQuery(String countSql)
                       throws SQLException

This will execute the count query and return the result.

NOTE: the database must be open before you call this method.

Parameters:

countSql - the count query to run

Returns:

the count

Throws:

SQLException - thrown if there was an issue executing the count query

executeCountQueryWithParameters

public long executeCountQueryWithParameters(ParameterizedSql parameterizedSql)
                                     throws SQLException

This will execute the count query with the given parameters and return the result.

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the count query to run and the parameters for the query

Returns:

the count

Throws:

SQLException - thrown if there was an issue executing the count query

executeCountQueryWithParameters

public long executeCountQueryWithParameters(String countSql,
                                            SqlParameter... parameters)
                                     throws SQLException

This will execute the count query with the given parameters and return the result.

NOTE: the database must be open before you call this method.

Parameters:

countSql - the count query to run

parameters - the parameters for the query

Returns:

the count

Throws:

SQLException - thrown if there was an issue executing the count query

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException

The will execute the given sql as an update (insert, update, delete, etc).

NOTE: the database must be open before you call this method.

Parameters:

sql - the update sql to execute

Returns:

the number of rows affected by the execution

Throws:

SQLException - thrown if there is an issue executing the update

executeUpdateWithParameters

public int executeUpdateWithParameters(ParameterizedSql parameterizedSql)
                                throws SQLException

The will execute the given sql as an update with the given parameters (insert, update, delete, etc).

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the update sql to execute and the parameters to use in the execution

Returns:

the number of rows affected by the execution

Throws:

SQLException - thrown if there is an issue executing the update

executeUpdateWithParameters

public int executeUpdateWithParameters(String sql,
                                       SqlParameter... parameters)
                                throws SQLException

The will execute the given sql as an update with the given parameters (insert, update, delete, etc).

NOTE: the database must be open before you call this method.

Parameters:

sql - the update sql to execute

parameters - the parameters to use in the execution

Returns:

the number of rows affected by the execution

Throws:

SQLException - thrown if there is an issue executing the update

fillStatement

public void fillStatement(PreparedStatement statement,
                          SqlParameter... parameters)
                   throws SQLException

This is a utility method to help fill PreparedStatements (by calling SqlParameter.fillStatement(int, PreparedStatement). This assumes the passed in parameters are in same the order as they are in the PreparedStatement.

Parameters:

statement - the statement to fill

parameters - the parameters to fill the statement with

Throws:

SQLException - thrown if an error occurs filling the statement

getColumnNames

public List<String> getColumnNames(String tableName)
                            throws SQLException

Gets the names of all the columns of a table.

NOTE: the database must be open before you call this method.

Parameters:

tableName - the table in question

Returns:

the column names for the table

Throws:

SQLException - thrown if there was an issue getting the names of the columns in the database

getLocation

public String getLocation()

Get the file location of the database.

Returns:

the file location of the database

getVersion

public int getVersion()
               throws SQLException

Get the version of the database.

NOTE: the database must be open before you call this method.

Returns:

the version of the database

Throws:

SQLException - thrown if there was an issue querying the version of the database

setVersion

public void setVersion(int version)
                throws SQLException

Set the version of the database.

NOTE: the database must be open before you call this method.

Parameters:

version - the version of the database

Throws:

SQLException - thrown if there was an issue setting the version of the database

isOpen

public boolean isOpen()

Get if the database is open.

Returns:

true if the database is open

openOrCreate

public DatabaseOpenState openOrCreate()
                               throws SQLException,
                                      IOException

Opens a database for operation. If the database file does not exist, it will be created. This will use location for database file and hexEncodedAes256Key as the AES256 HEX encoded key for the database.

NOTE: the database must be open before you call this method.

Returns:

whether the database was newly created (DatabaseOpenState.NEW) or already existed (DatabaseOpenState.EXISTING)

Throws:

SQLException - thrown if there was an issue creating or opening the database

IOException - thrown if there was an issue with the database location

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          SqlParameter... parameters)
                                   throws SQLException

Create a PreparedStatement for the given sql and fill the parameters.

NOTE: the database must be open before you call this method.

Parameters:

sql - the sql to create a PreparedStatement with

parameters - the parameters to fill the statement with

Returns:

the PreparedStatement

Throws:

SQLException - thrown if there was an issue creating the PreparedStatement

prepareStatement

public PreparedStatement prepareStatement(ParameterizedSql parameterizedSql)
                                   throws SQLException

Create a PreparedStatement for the given sql and fill the parameters.

NOTE: the database must be open before you call this method.

Parameters:

parameterizedSql - the sql to create a PreparedStatement with and the parameters to fill the statement with

Returns:

the PreparedStatement

Throws:

SQLException - thrown if there was an issue creating the PreparedStatement

tableExists

public boolean tableExists(String tableName)
                    throws SQLException

Check if a table exists in the database.

NOTE: the database must be open before you call this method.

Parameters:

tableName - the name of the table

Returns:

true if the table exists in the database

Throws:

SQLException - thrown if there was an issue checking if the table exists