nl.qbusict.cupboard

Class ProviderCompartment

java.lang.Object

nl.qbusict.cupboard.ProviderCompartment

public class ProviderCompartment
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Cupboard	mCupboard

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProviderCompartment(Cupboard cupboard, android.content.Context context)

Method Summary

Modifier and Type	Method and Description
int	delete(android.net.Uri uri, java.lang.String selection, java.lang.String... selectionArgs) Delete by selection.
<T> int	delete(android.net.Uri uri, T entity) Delete an entity
<T> T	get(android.net.Uri uri, java.lang.Class<T> entityClass) Get an entity from a content provider
<T> T	get(android.net.Uri uri, T entity) Get an entity by example, the id of the entity must be set.
protected <T> EntityConverter<T>	getConverter(java.lang.Class<T> clz)
<T> int	put(android.net.Uri uri, java.lang.Class<T> entityClass, java.util.Collection<T> entities) Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])
<T> int	put(android.net.Uri uri, java.lang.Class<T> entityClass, T... entities) Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])
<T> android.net.Uri	put(android.net.Uri uri, T entity) Put (insert) an object to a content uri.
<T> ProviderCompartment.QueryBuilder<T>	query(android.net.Uri uri, java.lang.Class<T> entityClass) Query for entities
int	update(android.net.Uri uri, android.content.ContentValues values) Update entities using the update method of ContentResolver.
int	update(android.net.Uri uri, android.content.ContentValues values, java.lang.String selection, java.lang.String... selectionArgs) Update entities using the update method of ContentResolver.

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

ProviderCompartment

protected ProviderCompartment(Cupboard cupboard,
                              android.content.Context context)

Method Detail

get

public <T> T get(android.net.Uri uri,
                 java.lang.Class<T> entityClass)

Get an entity from a content provider

Parameters:

uri - the uri to get from

entityClass - the entity class

Returns:

the first result (if any) returned by the content provider

put

public <T> android.net.Uri put(android.net.Uri uri,
                               T entity)

Put (insert) an object to a content uri.

Parameters:

uri - the uri to insert to

entity - the entity. If the entity has it's id field set, then this id will be appended to the uri as per ContentUris.appendId(android.net.Uri.Builder, long)

Returns:

the uri as returned by the content provider

put

public <T> int put(android.net.Uri uri,
                   java.lang.Class<T> entityClass,
                   T... entities)

Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])

Parameters:

uri - the uri to call

entityClass - the type of the entities

entities - the entities

Returns:

the result of ContentProvider.bulkInsert(Uri, ContentValues[])

put

public <T> int put(android.net.Uri uri,
                   java.lang.Class<T> entityClass,
                   java.util.Collection<T> entities)

Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])

Parameters:

uri - the uri to call

entityClass - the type of the entities

entities - the collection of entities

Returns:

the result of ContentProvider.bulkInsert(Uri, ContentValues[])

delete

public <T> int delete(android.net.Uri uri,
                      T entity)

Delete an entity

Parameters:

uri - the uri to call. The object id will be appended to this uri as per ContentUris.appendId(android.net.Uri.Builder, long). Calling delete on an entity without an id set is a no op.

entity - the entity to delete

Returns:

the number of entities deleted

delete

public int delete(android.net.Uri uri,
                  java.lang.String selection,
                  java.lang.String... selectionArgs)

Delete by selection. This function is equivalent to ContentResolver.delete(android.net.Uri, String, String[])

Parameters:

uri - the uri to call

selection - the selection for this delete

selectionArgs - selection arguments

Returns:

the number of entities deleted

update

public int update(android.net.Uri uri,
                  android.content.ContentValues values)

Update entities using the update method of ContentResolver. Useful for 'partial' updates to an entity, or multiple entities. For updating 'complete' entities in bulk, use put(android.net.Uri, Class, Object[]) or put(android.net.Uri, Class, java.util.Collection)

Parameters:

values - the content values. If it contains a BaseColumns._ID then the id will be appended to the URI and the selection "_id = <entity id>" will be passed to the underlying ContentProvider

Returns:

the number of entities updated

update

public int update(android.net.Uri uri,
                  android.content.ContentValues values,
                  java.lang.String selection,
                  java.lang.String... selectionArgs)

Update entities using the update method of ContentResolver. Useful for 'partial' updates to an entity, or multiple entities.

Parameters:

values - content values

selection - where clause

selectionArgs - selection arguments

Returns:

the number of entities updated

query

public <T> ProviderCompartment.QueryBuilder<T> query(android.net.Uri uri,
                                                     java.lang.Class<T> entityClass)

Query for entities

Parameters:

uri - the uri to query

entityClass - the entity class

Returns:

a ProviderCompartment.QueryBuilder for chaining

get

public <T> T get(android.net.Uri uri,
                 T entity)

Get an entity by example, the id of the entity must be set. This is useful when an entity is retrieved that has references to other entities. Those references will only have their id set. This function can then be used to "swap out" the entity stubs with the real entities.

Parameters:

uri - The base uri of the entity, the id will be appended

entity - the entity to get

Returns:

the entity or null if not found

Throws:

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

getConverter

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