Package ch.supertomcat.supertomcatutils.database.sqlite

Class SQLiteDB<T>

java.lang.Object

ch.supertomcat.supertomcatutils.database.sqlite.SQLiteDB<T>

Type Parameters:

T - Object Type

public abstract class SQLiteDB<T>
extends Object

Class for Sqlite Database Connections

Field Summary

Fields

Modifier and Type	Field	Description
protected String	databaseFile	Database File
protected org.slf4j.Logger	logger	Logger for this class
protected String	tableName	Table Name

Constructor Summary

Constructors

Constructor	Description
SQLiteDB(String databaseFile, String tableName, boolean backupDatabaseOnStart, boolean defragDatabaseOnStart, long defragMinFileSize)	Constructor

Method Summary

Modifier and Type	Method	Description
void	closeAllDatabaseConnections()	Closes all open database connections
protected abstract T	convertResultSetToObject(ResultSet result)	Converts the entry, which the ResultSet currently points to, to an object
protected abstract boolean	createDatabaseIfNotExist()	Creates the database and tables if it does not exist
abstract boolean	deleteEntries(List<T> entries)	Deletes the given entries from the database
abstract boolean	deleteEntry(T entry)	Deletes the given entry from the database
abstract List<T>	getAllEntries()	Returns all entries from the database
protected Connection	getDatabaseConnection()	Returns a connection to the database
String	getDatabaseFile()	Returns the databaseFile
abstract T	getEntry(int id)	Returns the entry with given ID or null if the entry was not found or an error occurred
String	getTableName()	Returns the tableName
abstract boolean	insertEntries(List<T> entries)	Inserts the given entries into the database
abstract boolean	insertEntry(T entry)	Inserts the given entry into the database
abstract boolean	updateEntries(List<T> entries)	Updates the given entries in the database
abstract boolean	updateEntry(T entry)	Updates the given entry in the database

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

Logger for this class

databaseFile

protected final String databaseFile

Database File

tableName

protected final String tableName

Table Name

Constructor Detail

SQLiteDB

public SQLiteDB(String databaseFile,
                String tableName,
                boolean backupDatabaseOnStart,
                boolean defragDatabaseOnStart,
                long defragMinFileSize)

Constructor

Parameters:

databaseFile - Path to the database File

tableName - Table Name

backupDatabaseOnStart - True if database should be backed up on start, false otherwise

defragDatabaseOnStart - True if database should be deframented on start, false otherwise

defragMinFileSize - Minimum filesize for decision if database is actually defragmented or not

Method Detail

getDatabaseFile

public String getDatabaseFile()

Returns the databaseFile

Returns:

databaseFile

getTableName

public String getTableName()

Returns the tableName

Returns:

tableName

closeAllDatabaseConnections

public void closeAllDatabaseConnections()

Closes all open database connections

getDatabaseConnection

protected Connection getDatabaseConnection()
                                    throws ClassNotFoundException,
                                           SQLException

Returns a connection to the database

Returns:

Connection to the database

Throws:

ClassNotFoundException

SQLException

createDatabaseIfNotExist

protected abstract boolean createDatabaseIfNotExist()

Creates the database and tables if it does not exist

Returns:

True if successful, false otherwise

convertResultSetToObject

protected abstract T convertResultSetToObject(ResultSet result)
                                       throws SQLException,
                                              javax.xml.bind.JAXBException

Converts the entry, which the ResultSet currently points to, to an object

Parameters:

result - Result

Returns:

Object

Throws:

SQLException

javax.xml.bind.JAXBException

getAllEntries

public abstract List<T> getAllEntries()

Returns all entries from the database

Returns:

All entries

getEntry

public abstract T getEntry(int id)

Returns the entry with given ID or null if the entry was not found or an error occurred

Parameters:

id - ID in database

Returns:

Entry or null if no entry with the ID found or an error occurred

insertEntry

public abstract boolean insertEntry(T entry)

Inserts the given entry into the database

Parameters:

entry - Entry

Returns:

True if successful, false otherwise

insertEntries

public abstract boolean insertEntries(List<T> entries)

Inserts the given entries into the database

Parameters:

entries - Entries

Returns:

True if successful, false otherwise

updateEntry

public abstract boolean updateEntry(T entry)

Updates the given entry in the database

Parameters:

entry - Entry

Returns:

True if successful, false otherwise

updateEntries

public abstract boolean updateEntries(List<T> entries)

Updates the given entries in the database

Parameters:

entries - Entries

Returns:

True if successful, false otherwise

deleteEntry

public abstract boolean deleteEntry(T entry)

Deletes the given entry from the database

Parameters:

entry - Entry

Returns:

True if successful, false otherwise

deleteEntries

public abstract boolean deleteEntries(List<T> entries)

Deletes the given entries from the database

Parameters:

entries - Entries

Returns:

True if successful, false otherwise