org.droitateddb

Class DbCreator

java.lang.Object

android.database.sqlite.SQLiteOpenHelper

org.droitateddb.DbCreator

public class DbCreator
extends android.database.sqlite.SQLiteOpenHelper

Handles db creation and updates.

Author:

Falk Appel, Alexander Frank

Field Summary

Fields

Modifier and Type	Field and Description
protected static android.database.sqlite.SQLiteDatabase	dbConnection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DbCreator(android.content.Context context, org.droitateddb.PersistenceDefinition persistence)

Method Summary

Modifier and Type	Method and Description
void	consumeDatabase(DbConsumer dbConsumer) Execute an action on the database.
<T> T	functionOnDatabase(DbFunction<T> dbFunction) Execute a function on the database, to return some values.
android.database.sqlite.SQLiteDatabase	getDatabaseConnection() Gives you a database connection you can access the database with.
static DbCreator	getInstance(android.content.Context context)
android.database.sqlite.SQLiteDatabase	getReadableDatabase() Deprecated. Don't use this method any more. Use getDatabaseConnection.
android.database.sqlite.SQLiteDatabase	getWritableDatabase() Deprecated. Don't use this method any more. Use getDatabaseConnection.
void	onCreate(android.database.sqlite.SQLiteDatabase db)
void	onUpgrade(android.database.sqlite.SQLiteDatabase db, int oldVersion, int newVersion)
android.database.Cursor	query(java.lang.String table, java.lang.String[] columns, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String groupBy, java.lang.String having, java.lang.String orderBy) Executes a query on the database.
android.database.Cursor	rawQuery(java.lang.String sql) Executes a raw query on the database.
void	reduceDatabaseConnection() Reduce the connection opened.

Methods inherited from class android.database.sqlite.SQLiteOpenHelper

close, getDatabaseName, onDowngrade, onOpen

Methods inherited from class java.lang.Object

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

Field Detail

dbConnection

protected static volatile android.database.sqlite.SQLiteDatabase dbConnection

Constructor Detail

DbCreator

protected DbCreator(android.content.Context context,
                    org.droitateddb.PersistenceDefinition persistence)

Method Detail

getInstance

public static DbCreator getInstance(android.content.Context context)

getDatabaseConnection

public android.database.sqlite.SQLiteDatabase getDatabaseConnection()

Gives you a database connection you can access the database with.
Don't forget to call reduceDatabaseConnection when you are done with the connection.

Returns:

Connection to the local SQLite database

reduceDatabaseConnection

public void reduceDatabaseConnection()

Reduce the connection opened. This should always be called after calling getDatabaseConnection and only after that.

functionOnDatabase

public <T> T functionOnDatabase(DbFunction<T> dbFunction)

Execute a function on the database, to return some values. The opening and closing of the database connection is handled for you.
Note if you want to query a cursor from the database consider using the DbCreator#query or DbCreator#rawQuery method.
This can be useful when working with CursorAdapter

Type Parameters:

T - Resulting type

Parameters:

dbFunction - Function you want to execute on the database

Returns:

The result of the function call

consumeDatabase

public void consumeDatabase(DbConsumer dbConsumer)

Execute an action on the database. The opening and closing of the database connection is handled for you.

Parameters:

dbConsumer - Action you want to execute on the database

query

public android.database.Cursor query(java.lang.String table,
                                     java.lang.String[] columns,
                                     java.lang.String selection,
                                     java.lang.String[] selectionArgs,
                                     java.lang.String groupBy,
                                     java.lang.String having,
                                     java.lang.String orderBy)

Executes a query on the database. Note that when calling close on the returned cursor the database connection count is reduces as well.

Parameters:

table - Name of the table

columns - Used columns of the queried table

selection - Selection statement

selectionArgs - Selection arguments

groupBy - SQL group by

having - SQL having

orderBy - SQL order by

Returns:

A Cursor containing the result, which reduces the database connection count when closed

rawQuery

public android.database.Cursor rawQuery(java.lang.String sql)

Executes a raw query on the database. Note that when calling close on the returned cursor the database connection count is reduces as well.

Parameters:

sql - Raw SQL statement

Returns:

A Cursor containing the result, which reduces the database connection count when closed

getReadableDatabase

@Deprecated
public android.database.sqlite.SQLiteDatabase getReadableDatabase()

Deprecated. Don't use this method any more. Use getDatabaseConnection.

This method is not supported with this helper. You have to use getDatabaseConnection and reduceDatabaseConnection

Overrides:

getReadableDatabase in class android.database.sqlite.SQLiteOpenHelper

Throws:

java.lang.UnsupportedOperationException - Use the getDatabaseConnection method and the reduceDatabaseConnection method to access the SQLiteDatabase

getWritableDatabase

@Deprecated
public android.database.sqlite.SQLiteDatabase getWritableDatabase()

Deprecated. Don't use this method any more. Use getDatabaseConnection.

This method is not supported with this helper. You have to use getDatabaseConnection and reduceDatabaseConnection

Overrides:

getWritableDatabase in class android.database.sqlite.SQLiteOpenHelper

Throws:

java.lang.UnsupportedOperationException - Use the getDatabaseConnection method and the reduceDatabaseConnection method to access the SQLiteDatabase

onCreate

public void onCreate(android.database.sqlite.SQLiteDatabase db)

Specified by:

onCreate in class android.database.sqlite.SQLiteOpenHelper

onUpgrade

public void onUpgrade(android.database.sqlite.SQLiteDatabase db,
                      int oldVersion,
                      int newVersion)

Specified by:

onUpgrade in class android.database.sqlite.SQLiteOpenHelper