net.zer0bandwidth.android.lib.database.sqlitehouse.content

Class SQLiteHouseKeeper<H extends SQLiteHouse>

java.lang.Object

android.content.BroadcastReceiver

net.zer0bandwidth.android.lib.database.sqlitehouse.content.SQLiteHouseKeeper<H>

Type Parameters:

H - the SQLiteHouse implementation to which this provider is bound

public class SQLiteHouseKeeper<H extends SQLiteHouse>
extends android.content.BroadcastReceiver

A class which is bound to a SQLiteHouse implementation and receives intents that request queries from the underlying database. This class fills the role of a ContentProvider without implementing that class's API, since the prototypes of the ContentProvider's methods don't fit with the workflow of a SQLiteHouse.

Since:

zer0bandwidth-net/android 0.1.7 (#50)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SQLiteHouseKeeper.DefaultSignals A default implementation of SQLiteHouseSignalAPI for this keeper class.

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

android.content.BroadcastReceiver.PendingResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOG_TAG
protected SQLiteHouseSignalAPI	m_api A reference for the contract under which the keeper was registered.
protected java.lang.Class<H>	m_cls A persistent handle on the SQLiteHouse implementation class.
protected android.content.Context	m_ctx The context in which the keeper will operate.
protected H	m_house A persistent reference to the database helper instance.

Constructor Summary

Constructors

Constructor and Description
SQLiteHouseKeeper(android.content.Context ctx, java.lang.Class<H> cls, H dbh) Constructs an instance, but does not register it.

Method Summary

Modifier and Type	Method and Description
protected <SC extends SQLightable> android.content.Intent	buildResultBroadcast(java.lang.Class<SC> cls, java.util.List<SC> aoResults) Builds the intent that would be sent by sendSelectionResults(java.lang.Class<SC>, java.util.List<SC>).
protected <SC extends SQLightable> int	delete(android.content.Intent sig) Handles a request to delete a record in the underlying database.
protected void	handleCustomAction(android.content.Context ctx, android.content.Intent sig, java.lang.String sToken) Override this method to handle custom actions not covered by the standard set defined in SQLiteHouseSignalAPI.
protected <SC extends SQLightable> long	insert(android.content.Intent sig) Handles a request to insert data into the underlying database.
protected <SC extends SQLightable> void	notifyDeleted(java.lang.Class<SC> cls, int nRows) Notifies the relay that rows have been deleted.
protected void	notifyDeleteFailed(java.lang.String sClass) Notifies the relay that a deletion failed.
protected <SC extends SQLightable> void	notifyInserted(long nRowID, java.lang.Class<SC> cls, SC row) Notifies the relay that an insertion succeeded.
protected void	notifyInsertFailed(java.lang.String sClass) Notifies the relay that an insertion failed.
protected void	notifySelectionFailed(java.lang.String sClass) Notifies the relay that a selection failed.
protected <SC extends SQLightable> void	notifyUpdated(java.lang.Class<SC> cls, int nRows) Notifies the relay that an update operation succeeded.
protected void	notifyUpdateFailed(java.lang.String sClass) Notifies the relay that an update failed.
void	onReceive(android.content.Context ctx, android.content.Intent sig)
protected <SC extends SQLightable> SelectionBuilder	parseSelectionSpec(java.lang.Class<SC> cls, android.os.Bundle bndl) Prepares a SelectionBuilder with query specifications received in a signal from the relay.
SQLiteHouseKeeper<H>	register() Registers the keeper instance as a BroadcastReceiver in its context, using the canonical name of the underlying SQLiteHouse implementation class as the contractual "authority".
SQLiteHouseKeeper<H>	register(SQLiteHouseSignalAPI api) Registers the keeper instance as a BroadcastReceiver in its context.
protected <SC extends SQLightable> void	select(android.content.Intent sig) Handles a request to select records from the underlying database.
protected <SC extends SQLightable> void	sendSelectionResults(java.lang.Class<SC> cls, java.util.List<SC> aoResults) Broadcasts a result set to the relay.
SQLiteHouseKeeper<H>	unregister() Unregisters the keeper in its context.
protected <SC extends SQLightable> int	update(android.content.Intent sig) Handles a request to update a record in the underlying database.

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

m_ctx

protected android.content.Context m_ctx

The context in which the keeper will operate.

m_cls

protected java.lang.Class<H extends SQLiteHouse> m_cls

A persistent handle on the SQLiteHouse implementation class.

m_house

protected H extends SQLiteHouse m_house

A persistent reference to the database helper instance.

m_api

protected SQLiteHouseSignalAPI m_api

A reference for the contract under which the keeper was registered.

Constructor Detail

SQLiteHouseKeeper

public SQLiteHouseKeeper(android.content.Context ctx,
                         java.lang.Class<H> cls,
                         H dbh)

Constructs an instance, but does not register it.

Parameters:

ctx - the context in which the keeper will operate

cls - the SQLiteHouse implementation class

dbh - the SQLiteHouse implementation instance to which the keeper is bound

Method Detail

register

public SQLiteHouseKeeper<H> register()

Registers the keeper instance as a BroadcastReceiver in its context, using the canonical name of the underlying SQLiteHouse implementation class as the contractual "authority".

Returns:

(fluid)

See Also:

SQLiteHouseKeeper.DefaultSignals, SQLiteHouseSignalAPI

register

public SQLiteHouseKeeper<H> register(SQLiteHouseSignalAPI api)

Registers the keeper instance as a BroadcastReceiver in its context.

Parameters:

api - the signal contract between the keeper and its relays; if null, then the keeper will be unregistered instead!

Returns:

(fluid)

unregister

public SQLiteHouseKeeper<H> unregister()

Unregisters the keeper in its context.

Returns:

(fluid)

onReceive

public final void onReceive(android.content.Context ctx,
                            android.content.Intent sig)

Specified by:

onReceive in class android.content.BroadcastReceiver

handleCustomAction

protected void handleCustomAction(android.content.Context ctx,
                                  android.content.Intent sig,
                                  java.lang.String sToken)

Override this method to handle custom actions not covered by the standard set defined in SQLiteHouseSignalAPI. The default implementation writes an information log stating that the action is unrecognized.

Parameters:

ctx - the context from which the signal originated

sig - the received signal

sToken - the action token parsed from the signal

insert

protected <SC extends SQLightable> long insert(android.content.Intent sig)

Handles a request to insert data into the underlying database.

Type Parameters:

SC - the schematic class that is discovered along the way

Parameters:

sig - the received signal

Returns:

the inserted row ID

update

protected <SC extends SQLightable> int update(android.content.Intent sig)

Handles a request to update a record in the underlying database.

Type Parameters:

SC - the schematic class of the row to be updated

Parameters:

sig - the received signal

Returns:

the number of updated rows (probably 0, 1, or -1)

delete

protected <SC extends SQLightable> int delete(android.content.Intent sig)

Handles a request to delete a record in the underlying database.

Type Parameters:

SC - the schematic class of the row to be deleted

Parameters:

sig - the received signal

Returns:

the number of deleted rows (probably 0, 1, or -1)

select

protected <SC extends SQLightable> void select(android.content.Intent sig)

Handles a request to select records from the underlying database.

Type Parameters:

SC - the schematic class of the rows to be selected

Parameters:

sig - the received signal

parseSelectionSpec

protected <SC extends SQLightable> SelectionBuilder parseSelectionSpec(java.lang.Class<SC> cls,
                                                                       android.os.Bundle bndl)

Prepares a SelectionBuilder with query specifications received in a signal from the relay.

Type Parameters:

SC - the schematic class

Parameters:

cls - the schematic class that would contain the rows

bndl - a selection query specification

Returns:

a selection builder bound to the underlying database

See Also:

SelectionBuilder.toBundle()

notifyInserted

protected <SC extends SQLightable> void notifyInserted(long nRowID,
                                                       java.lang.Class<SC> cls,
                                                       SC row)

Notifies the relay that an insertion succeeded.

Type Parameters:

SC - the schematic class of the inserted data

Parameters:

cls - the schematic class of the inserted data

nRowID - the ID of the inserted row

notifyInsertFailed

protected void notifyInsertFailed(java.lang.String sClass)

Notifies the relay that an insertion failed.

Parameters:

sClass - the name of the class that would have been inserted

notifyUpdated

protected <SC extends SQLightable> void notifyUpdated(java.lang.Class<SC> cls,
                                                      int nRows)

Notifies the relay that an update operation succeeded.

Type Parameters:

SC - the schematic class of the updated data

Parameters:

cls - the schematic class of the updated data

nRows - the number of rows that were updated

notifyUpdateFailed

protected void notifyUpdateFailed(java.lang.String sClass)

Notifies the relay that an update failed.

Parameters:

sClass - the name of the class that would have been updated

notifyDeleted

protected <SC extends SQLightable> void notifyDeleted(java.lang.Class<SC> cls,
                                                      int nRows)

Notifies the relay that rows have been deleted.

Type Parameters:

SC - the schematic class of the updated data

Parameters:

cls - the schematic class of the deleted data

nRows - the number of rows that were updated

notifyDeleteFailed

protected void notifyDeleteFailed(java.lang.String sClass)

Notifies the relay that a deletion failed.

Parameters:

sClass - the name of the class that would have had rows deleted

sendSelectionResults

protected <SC extends SQLightable> void sendSelectionResults(java.lang.Class<SC> cls,
                                                             java.util.List<SC> aoResults)

Broadcasts a result set to the relay.

Type Parameters:

SC - the schematic class

Parameters:

cls - the schematic class that would contain the rows

aoResults - the result set

buildResultBroadcast

protected <SC extends SQLightable> android.content.Intent buildResultBroadcast(java.lang.Class<SC> cls,
                                                                               java.util.List<SC> aoResults)

Builds the intent that would be sent by sendSelectionResults(java.lang.Class<SC>, java.util.List<SC>).

Type Parameters:

SC - the schematic class

Parameters:

cls - the schematic class that would contain the rows

aoResults - the result set

Returns:

the intent to be sent by sendSelectionResults(java.lang.Class<SC>, java.util.List<SC>)

notifySelectionFailed

protected void notifySelectionFailed(java.lang.String sClass)

Notifies the relay that a selection failed.

Parameters:

sClass - the name of the class that would have had rows selected