org.researchstack.backbone.storage.database.sqlite

Class DatabaseHelper

java.lang.Object

android.database.sqlite.SQLiteOpenHelper

co.touchlab.squeaky.db.sqlite.SqueakyOpenHelper

org.researchstack.backbone.storage.database.sqlite.DatabaseHelper

All Implemented Interfaces:

co.touchlab.squeaky.db.SQLiteOpenHelper, AppDatabase

public class DatabaseHelper
extends co.touchlab.squeaky.db.sqlite.SqueakyOpenHelper
implements AppDatabase

A simple database implementation of AppDatabase the has no encryption and only has tables for saving TaskResults and StepResults. You can extend this class and override onCreate and onUpgrade to add your own tables to those provided by this implementation.

Uses Squeaky, a simple ORM, which uses annotation processing on the model classes to create the tables and add methods for database operations. If you create a subclass of this database class and add more models, you will need to add the annotation processor to your app's build.gradle file: (See the Sample App for details, but add `apt 'co.touchlab.squeaky:squeaky-processor:0.4.0'` to your dependencies and add android-apt: https://bitbucket.org/hvisser/android-apt)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME
static int	DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
DatabaseHelper(android.content.Context context, java.lang.String name, android.database.sqlite.SQLiteDatabase.CursorFactory factory, int version)

Method Summary

Modifier and Type	Method and Description
TaskResult	loadLatestTaskResult(java.lang.String taskIdentifier) Loads the latest task result for the given task identifier.
java.util.List<StepResult>	loadStepResults(java.lang.String stepIdentifier) Returns a list of all StepResults for the given step identifier.
java.util.List<TaskResult>	loadTaskResults(java.lang.String taskIdentifier) Returns a list of all TaskResults for the given task identifier.
void	onCreate(android.database.sqlite.SQLiteDatabase sqLiteDatabase)
void	onUpgrade(android.database.sqlite.SQLiteDatabase sqLiteDatabase, int i, int i1)
void	saveTaskResult(TaskResult taskResult) Saves the TaskResult to the database, along with its child StepResults
void	setEncryptionKey(java.lang.String key) Sets the encryption key on the database.

Methods inherited from class co.touchlab.squeaky.db.sqlite.SqueakyOpenHelper

close, getDao, getGeneratedTableMapper, getSqueakyContext, getWrappedDatabase

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

Field Detail

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

Constructor Detail

DatabaseHelper

public DatabaseHelper(android.content.Context context,
                      java.lang.String name,
                      android.database.sqlite.SQLiteDatabase.CursorFactory factory,
                      int version)

Method Detail

onCreate

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

Specified by:

onCreate in class android.database.sqlite.SQLiteOpenHelper

onUpgrade

public void onUpgrade(android.database.sqlite.SQLiteDatabase sqLiteDatabase,
                      int i,
                      int i1)

Specified by:

onUpgrade in class android.database.sqlite.SQLiteOpenHelper

saveTaskResult

public void saveTaskResult(TaskResult taskResult)

Description copied from interface: AppDatabase

Saves the TaskResult to the database, along with its child StepResults

Specified by:

saveTaskResult in interface AppDatabase

Parameters:

taskResult - the task result to save

loadLatestTaskResult

public TaskResult loadLatestTaskResult(java.lang.String taskIdentifier)

Description copied from interface: AppDatabase

Loads the latest task result for the given task identifier.

This can be used to see when the user last answered the survey, or to get their most recent answer to a survey question.

Specified by:

loadLatestTaskResult in interface AppDatabase

Parameters:

taskIdentifier - the task identifier

Returns:

the latest TaskResult for the given identifier, or none

loadTaskResults

public java.util.List<TaskResult> loadTaskResults(java.lang.String taskIdentifier)

Description copied from interface: AppDatabase

Returns a list of all TaskResults for the given task identifier.

Specified by:

loadTaskResults in interface AppDatabase

Parameters:

taskIdentifier - the task identifier

Returns:

a list of all TaskResults for the given identifier

loadStepResults

public java.util.List<StepResult> loadStepResults(java.lang.String stepIdentifier)

Description copied from interface: AppDatabase

Returns a list of all StepResults for the given step identifier.

Specified by:

loadStepResults in interface AppDatabase

Parameters:

stepIdentifier - the step identifier

Returns:

a list of all StepResults for the given identifier

setEncryptionKey

public void setEncryptionKey(java.lang.String key)

Description copied from interface: AppDatabase

Sets the encryption key on the database. If your database doesn't support encryption, make this a no-op.

Specified by:

setEncryptionKey in interface AppDatabase

Parameters:

key - a string key to be used to encrypt the database