org.jboss.aerogear.android.store.sql

Class SQLStore<T>

java.lang.Object

android.database.sqlite.SQLiteOpenHelper

org.jboss.aerogear.android.store.sql.SQLStore<T>

All Implemented Interfaces:

Store<T>

public class SQLStore<T>
extends android.database.sqlite.SQLiteOpenHelper
implements Store<T>

Constructor Summary

Constructors

Constructor and Description
SQLStore(Class<T> klass, android.content.Context context)
SQLStore(Class<T> klass, android.content.Context context, com.google.gson.GsonBuilder builder, IdGenerator generator)
SQLStore(Class<T> klass, android.content.Context context, com.google.gson.GsonBuilder builder, IdGenerator generator, String databaseName)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isEmpty() Checks if the storage system contains no stored elements.
void	onCreate(android.database.sqlite.SQLiteDatabase db)
void	onUpgrade(android.database.sqlite.SQLiteDatabase db, int oldVersion, int newVersion)
void	open(org.jboss.aerogear.android.core.Callback<SQLStore<T>> onReady)
void	openSync()
T	read(Serializable id) Reads a specific object/record from the underlying storage system.
Collection<T>	readAll() Reads all the data from the underlying storage system.
List<T>	readWithFilter(org.jboss.aerogear.android.core.ReadFilter filter) Search for objects/records from the underlying storage system.
void	remove(Serializable id) Removes a specific object/record from the underlying storage system.
void	reset() Resets the entire storage system.
void	save(Collection<T> items) Saves the given objects in the underlying storage system.
void	save(T item) Saves the given object in the underlying storage system.

Methods inherited from class android.database.sqlite.SQLiteOpenHelper

getDatabaseName, getReadableDatabase, getWritableDatabase, onConfigure, onDowngrade, onOpen, setWriteAheadLoggingEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLStore

public SQLStore(Class<T> klass,
                android.content.Context context)

SQLStore

public SQLStore(Class<T> klass,
                android.content.Context context,
                com.google.gson.GsonBuilder builder,
                IdGenerator generator)

SQLStore

public SQLStore(Class<T> klass,
                android.content.Context context,
                com.google.gson.GsonBuilder builder,
                IdGenerator generator,
                String databaseName)

Method Detail

readAll

public Collection<T> readAll()
                      throws StoreNotOpenException

Reads all the data from the underlying storage system.

Specified by:

readAll in interface Store<T>

Returns:

List of T

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

read

public T read(Serializable id)
       throws StoreNotOpenException

Reads a specific object/record from the underlying storage system.

Specified by:

read in interface Store<T>

Parameters:

id - id from the desired object

Returns:

T

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

readWithFilter

public List<T> readWithFilter(org.jboss.aerogear.android.core.ReadFilter filter)
                       throws StoreNotOpenException

Search for objects/records from the underlying storage system.

Specified by:

readWithFilter in interface Store<T>

Parameters:

filter - a filter to use to fetch an object

Returns:

a list of elements, should not be null.

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

save

public void save(T item)
          throws StoreNotOpenException

Saves the given object in the underlying storage system.

Specified by:

save in interface Store<T>

Parameters:

item - Object to save

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

save

public void save(Collection<T> items)
          throws StoreNotOpenException

Saves the given objects in the underlying storage system.

Specified by:

save in interface Store<T>

Parameters:

items - List of objects to save

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

reset

public void reset()
           throws StoreNotOpenException

Resets the entire storage system.

Specified by:

reset in interface Store<T>

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

isEmpty

public boolean isEmpty()
                throws StoreNotOpenException

Checks if the storage system contains no stored elements.

Specified by:

isEmpty in interface Store<T>

Returns:

true if the storage is empty, otherwise false.

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

remove

public void remove(Serializable id)
            throws StoreNotOpenException

Removes a specific object/record from the underlying storage system.

Specified by:

remove in interface Store<T>

Parameters:

id - Id of item to remote

Throws:

StoreNotOpenException - Will occur if this method is called before opening the database

onCreate

public void onCreate(android.database.sqlite.SQLiteDatabase db)

Specified by:

onCreate in class android.database.sqlite.SQLiteOpenHelper

onUpgrade

public void onUpgrade(android.database.sqlite.SQLiteDatabase db,
                      int oldVersion,
                      int newVersion)

Specified by:

onUpgrade in class android.database.sqlite.SQLiteOpenHelper

open

public void open(org.jboss.aerogear.android.core.Callback<SQLStore<T>> onReady)

openSync

public void openSync()

close

public void close()

Overrides:

close in class android.database.sqlite.SQLiteOpenHelper