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

Class SQLiteHouseRelay

java.lang.Object

android.content.BroadcastReceiver

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

public class SQLiteHouseRelay
extends android.content.BroadcastReceiver

A class which can send requests to, and receive notifications from, a SQLiteHouseKeeper. This class fills the role of a ContentResolver without implementing that class's API, since the prototypes of the ContentResolver's methods don't fit with the workflow of a SQLiteHouse. If an app uses an implementation of SQLiteHouse to marshal data to/from a SQLite database, then it should provide a library which includes the schematic classes and an implementation of this class. Since the implementation class is expected to be provided in a library that is separate from the SQLiteHouse implementation, its declaration must not depend on the ability to import that implementation (e.g. as part of a generic template parameter on the class).

Since:

zer0bandwidth-net/android 0.1.7 (#50)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SQLiteHouseRelay.Listener Methods that must be implemented by any class that wants to process the information received in signals from a SQLiteHouseKeeper.

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 relay is registered.
protected android.content.Context	m_ctx The context in which the relay will operate.
protected java.util.Vector<SQLiteHouseRelay.Listener>	m_vListeners The set of active listeners.

Constructor Summary

Constructors

Constructor and Description
SQLiteHouseRelay(android.content.Context ctx) Constructs an instance, but does not register it.

Method Summary

Modifier and Type	Method and Description
SQLiteHouseRelay	addListener(SQLiteHouseRelay.Listener l) Registers a listener.
protected <SC extends SQLightable> android.content.Intent	buildDeleteSignal(SC o) Constructs the Intent to be sent by delete(SC).
protected <SC extends SQLightable> android.content.Intent	buildInsertSignal(SC o) Constructs the Intent to be sent by insert(SC).
protected <SC extends SQLightable> android.content.Intent	buildSelectionSignal(java.lang.Class<SC> cls, SelectionBuilder q) Constructs the Intent to be sent by select(java.lang.Class<SC>, net.zer0bandwidth.android.lib.content.querybuilder.SelectionBuilder).
protected <SC extends SQLightable> android.content.Intent	buildUpdateSignal(SC o) Constructs the Intent to be sent by update(SC).
<SC extends SQLightable> SQLiteHouseRelay	delete(SC o) Requests deletion of a particular row in the keeper's database, corresponding to the schematic class instance supplied.
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.
<SC extends SQLightable> SQLiteHouseRelay	insert(SC o) Requests insertion of a schematic class instance into the keeper's database.
protected void	onDeleteFailed(android.content.Intent sig) Handles a signal from the keeper that a row deletion failed.
protected void	onInsertFailed(android.content.Intent sig) Handles a signal from the keeper that a row insertion has failed.
void	onReceive(android.content.Context ctx, android.content.Intent sig)
protected void	onRowInserted(android.content.Intent sig) Handles a signal from the keeper that a row was inserted.
protected void	onRowsDeleted(android.content.Intent sig) Handles a signal from the keeper that some rows were deleted.
protected <SC extends SQLightable> void	onRowsSelected(android.content.Intent sig) Handles a signal payload from the keeper, containing a set of selected rows from the database.
protected void	onRowsUpdated(android.content.Intent sig) Handles a signal from the keeper that some rows were updated.
protected void	onSelectFailed(android.content.Intent sig) Handles a signal from the keeper that a row selection failed.
protected void	onUpdateFailed(android.content.Intent sig) Handles a signal from the keeper that a table update has failed.
SQLiteHouseRelay	register(SQLiteHouseSignalAPI api) Registers the relay instance as a BroadcastReceiver in its context.
SQLiteHouseRelay	removeListener(SQLiteHouseRelay.Listener l) Unregisters a listener.
<SC extends SQLightable> SQLiteHouseRelay	select(java.lang.Class<SC> cls, SelectionBuilder q) Requests the selection of a set of rows from the keeper's database.
SQLiteHouseRelay	unregister() Unregisters the relay in its context.
<SC extends SQLightable> SQLiteHouseRelay	update(SC o) Requests an update of a particular row in the keeper's database, corresponding to the schematic class instance supplied.

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 relay will operate.

m_api

protected SQLiteHouseSignalAPI m_api

A reference for the contract under which the relay is registered.

m_vListeners

protected java.util.Vector<SQLiteHouseRelay.Listener> m_vListeners

The set of active listeners.

Constructor Detail

SQLiteHouseRelay

public SQLiteHouseRelay(android.content.Context ctx)

Constructs an instance, but does not register it.

Parameters:

ctx - the context in which the relay will operate

Method Detail

register

public SQLiteHouseRelay register(SQLiteHouseSignalAPI api)

Registers the relay instance as a BroadcastReceiver in its context.

Parameters:

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

Returns:

(fluid)

unregister

public SQLiteHouseRelay unregister()

Unregisters the relay 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

addListener

public SQLiteHouseRelay addListener(SQLiteHouseRelay.Listener l)

Registers a listener. The method is idempotent; if the same listener is passed multiple times, then it will be added only if it is not already present.

Parameters:

l - the listener to be registered

Returns:

(fluid)

removeListener

public SQLiteHouseRelay removeListener(SQLiteHouseRelay.Listener l)

Unregisters a listener. The method is idempotent; if the same listener is passed multiple times, then it will be removed only if it is still present.

Parameters:

l - the listener to be removed

Returns:

(fluid)

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

onRowInserted

protected void onRowInserted(android.content.Intent sig)

Handles a signal from the keeper that a row was inserted.

Parameters:

sig - the received signal

onInsertFailed

protected void onInsertFailed(android.content.Intent sig)

Handles a signal from the keeper that a row insertion has failed.

Parameters:

sig - the received signal

onRowsUpdated

protected void onRowsUpdated(android.content.Intent sig)

Handles a signal from the keeper that some rows were updated.

Parameters:

sig - the received signal

onUpdateFailed

protected void onUpdateFailed(android.content.Intent sig)

Handles a signal from the keeper that a table update has failed.

Parameters:

sig - the received signal

onRowsDeleted

protected void onRowsDeleted(android.content.Intent sig)

Handles a signal from the keeper that some rows were deleted.

Parameters:

sig - the received signal

onDeleteFailed

protected void onDeleteFailed(android.content.Intent sig)

Handles a signal from the keeper that a row deletion failed.

Parameters:

sig - the received signal

onRowsSelected

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

Handles a signal payload from the keeper, containing a set of selected rows from the database.

Type Parameters:

SC - the schematic class

Parameters:

sig - the received signal

onSelectFailed

protected void onSelectFailed(android.content.Intent sig)

Handles a signal from the keeper that a row selection failed.

Parameters:

sig - the received signal

insert

public <SC extends SQLightable> SQLiteHouseRelay insert(SC o)

Requests insertion of a schematic class instance into the keeper's database.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class

Returns:

(fluid)

buildInsertSignal

protected <SC extends SQLightable> android.content.Intent buildInsertSignal(SC o)

Constructs the Intent to be sent by insert(SC). This is a separate method only so that it can be unit-tested.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class to be inserted

Returns:

the intent to be sent by @insert

update

public <SC extends SQLightable> SQLiteHouseRelay update(SC o)

Requests an update of a particular row in the keeper's database, corresponding to the schematic class instance supplied.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class

Returns:

(fluid)

buildUpdateSignal

protected <SC extends SQLightable> android.content.Intent buildUpdateSignal(SC o)

Constructs the Intent to be sent by update(SC). This is a separate method only so that it can be unit-tested.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class to be used as update input

Returns:

the intent to be sent by update(SC)

delete

public <SC extends SQLightable> SQLiteHouseRelay delete(SC o)

Requests deletion of a particular row in the keeper's database, corresponding to the schematic class instance supplied.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class

Returns:

(fluid)

buildDeleteSignal

protected <SC extends SQLightable> android.content.Intent buildDeleteSignal(SC o)

Constructs the Intent to be sent by delete(SC). This is a separate method only so that it can be unit-tested.

Type Parameters:

SC - the schematic class

Parameters:

o - an instance of the schematic class to be deleted

Returns:

the intent to be sent by delete(SC)

select

public <SC extends SQLightable> SQLiteHouseRelay select(java.lang.Class<SC> cls,
                                                        SelectionBuilder q)

Requests the selection of a set of rows from the keeper's database.

Type Parameters:

SC - the schematic class

Parameters:

cls - the schematic class that would contain the rows

q - a query against that data set

Returns:

(fluid)

buildSelectionSignal

protected <SC extends SQLightable> android.content.Intent buildSelectionSignal(java.lang.Class<SC> cls,
                                                                               SelectionBuilder q)

Constructs the Intent to be sent by select(java.lang.Class<SC>, net.zer0bandwidth.android.lib.content.querybuilder.SelectionBuilder). This is a separate method only so that it can be unit-tested.

Type Parameters:

SC - the schematic class

Parameters:

cls - the schematic class that would contain the rows

q - a query against that data set

Returns:

the intent to be sent by select(java.lang.Class<SC>, net.zer0bandwidth.android.lib.content.querybuilder.SelectionBuilder)