org.droitateddb

Class BaseContentProvider

java.lang.Object

android.content.ContentProvider

org.droitateddb.BaseContentProvider

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public abstract class BaseContentProvider
extends android.content.ContentProvider

The BaseContentProvider is the base class of all generated ContentProvider for Entity classes.

For each Entity which allows ContentProvider generation a separate ContentProvider will be generated. The generated ContentProvider is also referenced in the AndroidManifest.xml to use an own Implementation remove the attribute droitateddb:generated="true" in the provider element of the AndroidManifest.xml
The authority of the ContentProvider is therefore defined within the Entity annotation.

The base Uri for calling the ContentProvider is build following this schema: content://[authority]/[ getEntityURIPart()].
If not overridden getEntityURIPart() returns entity

For easier use the BaseContentProvider provides the methods uri(String) and uriForItem(String, long). These methods allow getting the Uri referencing the Provider with the table name of the Entity and the primary key.

uri(String): Returns a Uri for accessing multiple Entity elements.

uriForItem(String, long): Returns a Uri for accessing a specific Entity element

Author:

Falk Appel, Alexander Frank

Nested Class Summary

Nested classes/interfaces inherited from class android.content.ContentProvider

android.content.ContentProvider.PipeDataWriter<T>

Field Summary

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseContentProvider()

Method Summary

Modifier and Type	Method and Description
int	delete(android.net.Uri uri, java.lang.String selection, java.lang.String[] selectionArgs)
protected abstract java.lang.String	getAuthority() Has to return the authority to be used for this ContentProvider.
protected abstract EntityInfo	getEntityInfo() Has to return metadata of the Entity this ContentProvider is for.
protected java.lang.String	getEntityURIPart()
protected abstract AbstractAttribute	getIdAttribute() Has to return the attribute describing the primary key of the Entity.
java.lang.String	getType(android.net.Uri uri)
android.net.Uri	insert(android.net.Uri uri, android.content.ContentValues values)
boolean	onCreate()
android.database.Cursor	query(android.net.Uri uri, java.lang.String[] projection, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String sortOrder)
int	update(android.net.Uri uri, android.content.ContentValues values, java.lang.String selection, java.lang.String[] selectionArgs)
static android.net.Uri	uri(java.lang.String tableName) Returns a Uri for the using it with a ContentResolver to access this ContentProvider.
static android.net.Uri	uriForItem(java.lang.String tableName, long id) Returns a Uri for the using it with a ContentResolver to access this ContentProvider.

Methods inherited from class android.content.ContentProvider

applyBatch, attachInfo, bulkInsert, call, getContext, getPathPermissions, getReadPermission, getStreamTypes, getWritePermission, isTemporary, onConfigurationChanged, onLowMemory, onTrimMemory, openAssetFile, openFile, openFileHelper, openPipeHelper, openTypedAssetFile, setPathPermissions, setReadPermission, setWritePermission, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseContentProvider

protected BaseContentProvider()

Method Detail

uri

public static android.net.Uri uri(java.lang.String tableName)

Returns a Uri for the using it with a ContentResolver to access this ContentProvider. The Uri allows CRUD operations on multiple Entity elements.

Parameters:

tableName - Name of the Table (simple Entity name) the data should be retrieved from.

Returns:

Uri to access the tables data

uriForItem

public static android.net.Uri uriForItem(java.lang.String tableName,
                                         long id)

Returns a Uri for the using it with a ContentResolver to access this ContentProvider. The Uri allows CRUD operations on a single Entity element, qualified by its primary key.

Parameters:

tableName - Name of the Table (simple Entity name) the data should be retrieved from.

id - Primary key of the Entity to be accessed

Returns:

Uri to access the specific item in the table

getAuthority

protected abstract java.lang.String getAuthority()

Has to return the authority to be used for this ContentProvider.
If generated this is the authority defined in the Entity class

Returns:

The authority used for the ContentProvider

getIdAttribute

protected abstract AbstractAttribute getIdAttribute()

Has to return the attribute describing the primary key of the Entity.
Id generated this is the PrimaryKey annotated Column.

Returns:

The description of the primary key of the table access by this ContentProvider

getEntityInfo

protected abstract EntityInfo getEntityInfo()

Has to return metadata of the Entity this ContentProvider is for.

Returns:

Metadata to the Entity being accessed

getEntityURIPart

protected java.lang.String getEntityURIPart()

onCreate

public boolean onCreate()

Specified by:

onCreate in class android.content.ContentProvider

getType

public java.lang.String getType(android.net.Uri uri)

Specified by:

getType in class android.content.ContentProvider

insert

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

Specified by:

insert in class android.content.ContentProvider

query

public android.database.Cursor query(android.net.Uri uri,
                                     java.lang.String[] projection,
                                     java.lang.String selection,
                                     java.lang.String[] selectionArgs,
                                     java.lang.String sortOrder)

Specified by:

query in class android.content.ContentProvider

update

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

Specified by:

update in class android.content.ContentProvider

delete

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

Specified by:

delete in class android.content.ContentProvider