com.humandevice.android.database.dao

Class AbstractDao<DbObject>

java.lang.Object

com.humandevice.android.database.dao.AbstractDao<DbObject>

Direct Known Subclasses:

ReflectDao

public abstract class AbstractDao<DbObject>
extends java.lang.Object

By Mikołaj Styś on 07/2015. Provides simple CRUD for DAO. Bases on "_id" column in DbEntity model - if you want to change it - write own methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
protected DatabaseTransformer<DbObject>	mTransformer
protected static DatabaseHelper	sDatabaseHelper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDao(DatabaseTransformer<DbObject> transformer)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.util.Collection<DbObject> entities)
boolean	add(DbObject entity)
boolean	add(DbObject[] entities)
boolean	addOrReplace(java.util.Collection<DbObject> entities)
boolean	addOrReplace(DbObject entity)
boolean	addOrReplace(DbObject[] entities)
static void	cancelTransaction() Cancels transaction
static void	closeDatabase()
protected java.util.List<DbObject>	convertCursor(SqlCursor dbResult) Converts multiple results into list
long	count(java.lang.String whereClause, java.lang.String... parameters) Counts rows
boolean	delete(DbObject entity) Removes entity from database if implements LocalIdentifiable
protected int	delete(java.lang.String whereClause, java.lang.String... arguments)
int	deleteAll() Clears table
static void	endTransaction() If wasn't called, it will succeed
java.util.List<DbObject>	getAll()
DbObject	getById(long entityId) Returns entity that contains this key
protected java.util.List<DbObject>	getList(java.lang.String selection, java.lang.String... selectionArguments) Abstract list query that helps create queries
protected DbObject	getOneResult(java.lang.String selection, java.lang.String... selectionArguments) Abstract one result query
abstract java.lang.String	getTableName()
void	onPostCreate(android.database.sqlite.SQLiteDatabase db) Invoked after all onTableCreate(SQLiteDatabase) methods are invoked
abstract void	onTableCreate(android.database.sqlite.SQLiteDatabase db) Method is used to create necessary tables for this dao.
protected android.content.ContentValues	prepareValues(DbObject entity)
static void	setDatabaseConfiguration(android.app.Application context, DatabaseConfiguration configuration)
static void	startTransaction() Applies to ALL database operations - invariant to used DAO
protected int	update(android.content.ContentValues values, java.lang.String whereClause, java.lang.String... arguments)
boolean	update(DbObject entity) Updates entity in database

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

sDatabaseHelper

protected static DatabaseHelper sDatabaseHelper

mTransformer

protected DatabaseTransformer<DbObject> mTransformer

Constructor Detail

AbstractDao

protected AbstractDao(DatabaseTransformer<DbObject> transformer)

Method Detail

setDatabaseConfiguration

public static void setDatabaseConfiguration(android.app.Application context,
                                            DatabaseConfiguration configuration)

closeDatabase

public static void closeDatabase()

getTableName

public abstract java.lang.String getTableName()

onTableCreate

public abstract void onTableCreate(android.database.sqlite.SQLiteDatabase db)

Method is used to create necessary tables for this dao.

onPostCreate

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

Invoked after all onTableCreate(SQLiteDatabase) methods are invoked

getById

public DbObject getById(long entityId)

Returns entity that contains this key

Parameters:

entityId - key to find entity

Returns:

entity or null if Object do not have id column

add

public boolean add(DbObject entity)

add

public boolean add(DbObject[] entities)

add

public boolean add(java.util.Collection<DbObject> entities)

addOrReplace

public boolean addOrReplace(DbObject entity)

addOrReplace

public boolean addOrReplace(DbObject[] entities)

addOrReplace

public boolean addOrReplace(java.util.Collection<DbObject> entities)

prepareValues

protected android.content.ContentValues prepareValues(DbObject entity)

update

public boolean update(DbObject entity)

Updates entity in database

Parameters:

entity - objects that implements LocalIdentifiable

Returns:

true if entity was updated

update

protected int update(android.content.ContentValues values,
                     java.lang.String whereClause,
                     java.lang.String... arguments)

Returns:

the number of rows affected

delete

public boolean delete(DbObject entity)

Removes entity from database if implements LocalIdentifiable

Parameters:

entity - objects that implements LocalIdentifiable

Returns:

true if something was deleted

delete

protected int delete(java.lang.String whereClause,
                     java.lang.String... arguments)

Returns:

the number of rows affected if a whereClause is passed in, 0 otherwise. To remove all rows and get a count pass "1" as the whereClause

getAll

public java.util.List<DbObject> getAll()

Returns:

all results in table

deleteAll

public int deleteAll()

Clears table

count

public long count(java.lang.String whereClause,
                  java.lang.String... parameters)

Counts rows

Returns:

the number of rows returned

startTransaction

public static void startTransaction()

Applies to ALL database operations - invariant to used DAO

cancelTransaction

public static void cancelTransaction()

Cancels transaction

endTransaction

public static void endTransaction()

If wasn't called, it will succeed

getOneResult

protected DbObject getOneResult(java.lang.String selection,
                                java.lang.String... selectionArguments)

Abstract one result query

Parameters:

selection - WHERE clause excluding WHERE keyword

selectionArguments - parameters to be bind

Returns:

list with result

getList

protected java.util.List<DbObject> getList(java.lang.String selection,
                                           java.lang.String... selectionArguments)

Abstract list query that helps create queries

Parameters:

selection - WHERE clause excluding WHERE keyword. Pass null for all rows

selectionArguments - parameters to be bound

Returns:

list with result

convertCursor

protected java.util.List<DbObject> convertCursor(SqlCursor dbResult)

Converts multiple results into list