au.com.cybersearch2.classydb

Class DatabaseSupportBase

java.lang.Object

au.com.cybersearch2.classydb.DatabaseSupportBase

All Implemented Interfaces:

ConnectionSourceFactory, DatabaseSupport

Direct Known Subclasses:

H2DatabaseSupport, SQLiteDatabaseSupport

public abstract class DatabaseSupportBase
extends Object
implements DatabaseSupport, ConnectionSourceFactory

DatabaseSupportBase

Author:

Andrew Bowley 16 May 2015

Nested Class Summary

Nested classes/interfaces inherited from interface au.com.cybersearch2.classydb.DatabaseSupport

DatabaseSupport.ConnectionType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATABASE_INFO_NAME Table to hold database version

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildQueryString(String tables, String[] columns, String where, String groupBy, String having, String orderBy, String limit) Build an SQL query string from the given clauses.
void	close() Perform any clean up required on database shutdown
com.j256.ormlite.support.ConnectionSource	getConnectionSource(String databaseName, Properties properties) Returns ConnectionSource object
com.j256.ormlite.db.DatabaseType	getDatabaseType() Returns database type
List<OpenHelperCallbacks>	getOpenHelperCallbacksList()
List<Object>	getResultList(com.j256.ormlite.support.ConnectionSource connectionSource, QueryInfo queryInfo, int startPosition, int maxResults) Returns list result of native query in Android SQLite API format
Object	getSingleResult(com.j256.ormlite.support.ConnectionSource connectionSource, QueryInfo queryInfo) Returns single result of native query in Android SQLite API format
int	getVersion(com.j256.ormlite.support.ConnectionSource connectionSource) Gets the database version.
void	initialize() Perform any inititialization required prior to creating first database connection
void	registerOpenHelperCallbacks(OpenHelperCallbacks openHelperCallbacks)
void	setVersion(int version, com.j256.ormlite.support.ConnectionSource connectionSource) Sets the database version.

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_INFO_NAME

public static final String DATABASE_INFO_NAME

Table to hold database version

See Also:

Constant Field Values

Method Detail

initialize

public void initialize()

Perform any inititialization required prior to creating first database connection

Specified by:

initialize in interface DatabaseSupport

getConnectionSource

public com.j256.ormlite.support.ConnectionSource getConnectionSource(String databaseName,
                                                            Properties properties)

Returns ConnectionSource object

Specified by:

getConnectionSource in interface ConnectionSourceFactory

Parameters:

databaseName -

properties - Properties defined in persistence.xml

Returns:

ConnectionSource

close

public void close()

Perform any clean up required on database shutdown

Specified by:

close in interface DatabaseSupport

getDatabaseType

public com.j256.ormlite.db.DatabaseType getDatabaseType()

Returns database type

Specified by:

getDatabaseType in interface DatabaseSupport

Returns:

DatabaseType

registerOpenHelperCallbacks

public void registerOpenHelperCallbacks(OpenHelperCallbacks openHelperCallbacks)

Specified by:

registerOpenHelperCallbacks in interface DatabaseSupport

getOpenHelperCallbacksList

public List<OpenHelperCallbacks> getOpenHelperCallbacksList()

Specified by:

getOpenHelperCallbacksList in interface DatabaseSupport

getVersion

public int getVersion(com.j256.ormlite.support.ConnectionSource connectionSource)

Gets the database version.

Specified by:

getVersion in interface DatabaseSupport

Parameters:

connectionSource - Open ConnectionSource object of database.

Returns:

the database version

setVersion

public void setVersion(int version,
              com.j256.ormlite.support.ConnectionSource connectionSource)

Sets the database version.

Specified by:

setVersion in interface DatabaseSupport

Parameters:

connectionSource - Open ConnectionSource object of database. Can be null for Android SQLite.

version - the new database version

getResultList

public List<Object> getResultList(com.j256.ormlite.support.ConnectionSource connectionSource,
                         QueryInfo queryInfo,
                         int startPosition,
                         int maxResults)

Returns list result of native query in Android SQLite API format

Specified by:

getResultList in interface DatabaseSupport

Parameters:

connectionSource - Open ConnectionSource object

queryInfo - QueryInfo

startPosition - int

maxResults - int

Returns:

List of Objects

getSingleResult

public Object getSingleResult(com.j256.ormlite.support.ConnectionSource connectionSource,
                     QueryInfo queryInfo)

Returns single result of native query in Android SQLite API format

Specified by:

getSingleResult in interface DatabaseSupport

Parameters:

connectionSource - Open ConnectionSource object

queryInfo - QueryInfo

Returns:

Object

buildQueryString

public static String buildQueryString(String tables,
                      String[] columns,
                      String where,
                      String groupBy,
                      String having,
                      String orderBy,
                      String limit)

Build an SQL query string from the given clauses.

Parameters:

tables - The table names to compile the query against.

columns - A list of which columns to return. Passing null will return all columns, which is discouraged to prevent reading data from storage that isn't going to be used.

where - A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). Passing null will return all rows for the given URL.

groupBy - A filter declaring how to group rows, formatted as an SQL GROUP BY clause (excluding the GROUP BY itself). Passing null will cause the rows to not be grouped.

having - A filter declare which row groups to include in the results, if row grouping is being used, formatted as an SQL HAVING clause (excluding the HAVING itself). Passing null will cause all row groups to be included, and is required when row grouping is not being used.

orderBy - How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Passing null will use the default sort order, which may be unordered.

limit - Limits the number of rows returned by the query, formatted as LIMIT clause. Passing null denotes no LIMIT clause.

Returns:

the SQL query string