nl.qbusict.cupboard

Class DatabaseCompartment

java.lang.Object

nl.qbusict.cupboard.DatabaseCompartment

public class DatabaseCompartment
extends java.lang.Object

Operate on a CupboardDatabase. A DatabaseCompartment is created from Cupboard.withDatabase(SQLiteDatabase) or Cupboard.withDatabase(CupboardDatabase)

Example

 SQLiteDatabase db = ...
 // get the book with id 1
 Book book = cupboard().withDatabase(db).get(Book.class, 1L);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseCompartment.QueryBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Cupboard	mCupboard

Constructor Summary

Constructors

Constructor and Description
DatabaseCompartment(Cupboard cupboard, android.database.sqlite.SQLiteDatabase database)

Method Summary

Modifier and Type	Method and Description
void	createTables() Create tables for the classes registered with Cupboard.register(Class).
boolean	delete(java.lang.Class<?> entityClass, long id) Delete an entity by id
int	delete(java.lang.Class<?> entityClass, java.lang.String selection, java.lang.String... selectionArgs) Delete entities
<T> boolean	delete(T entity) Delete an entity
void	dropAllIndices() Remove all indices for the classes registered with Cupboard.register(Class), including any indices not added by Cupboard.
void	dropAllTables() Drop all tables for the classes registered with Cupboard.register(Class)
<T> T	get(java.lang.Class<T> entityClass, long id) Get an entity by id
<T> T	get(T object) Get an entity by the id set on an example entity
protected <T> EntityConverter<T>	getConverter(java.lang.Class<T> clz)
long	put(java.lang.Class<?> entityClass, android.content.ContentValues values) Put an entity from a ContentValues object.
void	put(java.util.Collection<?> entities) Put multiple entities in a single transaction.
void	put(java.lang.Object... entities) Put multiple entities in a single transaction.
<T> long	put(T entity) Put a single entity.
<T> DatabaseCompartment.QueryBuilder<T>	query(java.lang.Class<T> entityClass) Query entities
int	update(java.lang.Class<?> entityClass, android.content.ContentValues values) Update entities
int	update(java.lang.Class<?> entityClass, android.content.ContentValues values, java.lang.String selection, java.lang.String... selectionArgs) Update entities
void	upgradeTables() Upgrade and / or create tables for the classes registered with Cupboard.register(Class) This is useful in SQLiteOpenHelper.onUpgrade(SQLiteDatabase, int, int)

Methods inherited from class java.lang.Object

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

Field Detail

mCupboard

protected final Cupboard mCupboard

Constructor Detail

DatabaseCompartment

public DatabaseCompartment(Cupboard cupboard,
                           android.database.sqlite.SQLiteDatabase database)

Method Detail

createTables

public void createTables()

Create tables for the classes registered with Cupboard.register(Class). This is useful in SQLiteOpenHelper.onCreate(SQLiteDatabase)

upgradeTables

public void upgradeTables()

Upgrade and / or create tables for the classes registered with Cupboard.register(Class) This is useful in SQLiteOpenHelper.onUpgrade(SQLiteDatabase, int, int)

dropAllTables

public void dropAllTables()

Drop all tables for the classes registered with Cupboard.register(Class)

dropAllIndices

public void dropAllIndices()

Remove all indices for the classes registered with Cupboard.register(Class), including any indices not added by Cupboard. Typically called before upgrading tables.

get

public <T> T get(java.lang.Class<T> entityClass,
                 long id)

Get an entity by id

Parameters:

entityClass - the entity class

id - the id of the entity

Returns:

the entity or null if not found

get

public <T> T get(T object)
          throws java.lang.IllegalArgumentException

Get an entity by the id set on an example entity

Parameters:

object - the entity

Returns:

the entity, or null if not found

Throws:

java.lang.IllegalArgumentException - if the entity id is not set

query

public <T> DatabaseCompartment.QueryBuilder<T> query(java.lang.Class<T> entityClass)

Query entities

Parameters:

entityClass - the entity to query for

Returns:

a DatabaseCompartment.QueryBuilder for chaining

put

public void put(java.lang.Object... entities)

Put multiple entities in a single transaction.

Parameters:

entities - the entities

put

public void put(java.util.Collection<?> entities)

Put multiple entities in a single transaction.

Parameters:

entities - the entities

put

public <T> long put(T entity)

Put a single entity. If an entity of this type with this id already exists it will be replaced.

Parameters:

entity - the entity

Returns:

the entity id (also set on the passed in entity)

put

public long put(java.lang.Class<?> entityClass,
                android.content.ContentValues values)

Put an entity from a ContentValues object. If the content values contain a BaseColumns._ID then this id will be used and an existing entity will be replaced.

Parameters:

entityClass - the entity class

values - the content values

Returns:

the id of the entity

update

public int update(java.lang.Class<?> entityClass,
                  android.content.ContentValues values)

Update entities

Parameters:

entityClass - the entity class

values - the content values. If it contains a BaseColumns._ID then only the entity with the given id will be updated (if any)

Returns:

the number of entities updated

update

public int update(java.lang.Class<?> entityClass,
                  android.content.ContentValues values,
                  java.lang.String selection,
                  java.lang.String... selectionArgs)

Update entities

Parameters:

entityClass - entity class

values - content values

selection - where clause

selectionArgs - selection arguments

Returns:

the number of entities updated

delete

public <T> boolean delete(T entity)

Delete an entity

Parameters:

entity - the entity to delete.

Returns:

true if the entity was deleted, false if no entity with the given id was found.

delete

public boolean delete(java.lang.Class<?> entityClass,
                      long id)

Delete an entity by id

Parameters:

entityClass - the entity class

id - the entity id

Returns:

true if the entity was deleted, false if no entity with the given id was found

delete

public int delete(java.lang.Class<?> entityClass,
                  java.lang.String selection,
                  java.lang.String... selectionArgs)

Delete entities

Parameters:

entityClass - the entity class

selection - where clause

selectionArgs - selection arguments

Returns:

the number of deleted entities

getConverter

protected <T> EntityConverter<T> getConverter(java.lang.Class<T> clz)