stanford.androidlib.data

Class SimpleDatabase

java.lang.Object

stanford.androidlib.data.SimpleDatabase

public class SimpleDatabase
extends Object

This class provides methods to help make it easier to query local SQLite databases. Some methods require the context of a SimpleActivity, so you must call SimpleDatabase.with(yourActivity) first.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleDatabase.QueryProgressListener An interface for listening to progress on a long query.

Method Summary

Modifier and Type	Method and Description
SQLiteDatabase	create(String databaseName) Creates a database with the given name, if it doesn't exist.
boolean	delete(String databaseName) Deletes the database with the given name, if it exists.
String	escape(String s) Escapes/quotes a string for use as a parameter in an SQL query.
SimpleDatabase	executeSqlFile(SQLiteDatabase db, int id) Reads the .sql file with the given resource ID and executes all SQL statements inside it using the given database.
SimpleDatabase	executeSqlFile(SQLiteDatabase db, int id, SimpleDatabase.QueryProgressListener listener) Reads the .sql file with the given resource ID and executes all SQL statements inside it using the given database.
SimpleDatabase	executeSqlFile(String filename) Reads the .sql file with the given name and executes all SQL statements inside it, placing them into a database with the same name as the file.
SimpleDatabase	executeSqlFile(String filename, SimpleDatabase.QueryProgressListener listener) Reads the .sql file with the given name and executes all SQL statements inside it, placing them into a database with the same name as the file.
SimpleDatabase	executeSqlFile(String dbName, String filename, SimpleDatabase.QueryProgressListener listener) Reads the .sql file with the given name and executes all SQL statements inside it, placing them into the database with the given name.
boolean	exists(String databaseName) Returns true if a database with the given name exists.
String[]	getColumnNames(Cursor cr) Returns the names of all columns in the given query's cursor as an array.
String[]	getColumnNames(SQLiteDatabase db, String tableName) Returns the names of all columns in the given database table as an array.
String[]	getColumnNames(String databaseName, String tableName) Returns the names of all columns in the given database table as an array.
String[]	getDatabaseNames() Returns an array of the names of all databases in this app.
String[]	getTableNames(SQLiteDatabase db) Returns the names of all tables in the given database as an array.
String[]	getTableNames(String databaseName) Returns the names of all tables in the given database as an array.
SQLiteDatabase	open(String databaseName) Opens the database with the given name, or creates it if it doesn't exist.
SimpleCursor	query(SQLiteDatabase db, String query) Performs the given database query on the given database and returns a view of the results.
SimpleCursor	query(String databaseName, String query) Performs the given database query on the database with the given name and returns a view of the results.
void	queryTransaction(SQLiteDatabase db, SimpleDatabase.QueryProgressListener listener, String... queries) Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully.
void	queryTransaction(SQLiteDatabase db, String... queries) Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully.
void	queryTransaction(String databaseName, SimpleDatabase.QueryProgressListener listener, String... queries) Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully.
void	queryTransaction(String databaseName, String... queries) Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully.
static SimpleCursor	rows(Cursor cursor) Returns an object that can be used to iterate over the rows of a given query cursor.
SimpleDatabase	setLogging(boolean logging) Sets whether Log.d statements should print as queries are run.
JSONObject	toJson(SQLiteDatabase db) Returns a JSONObject representing all of the data from the given database.
JSONObject	toJson(SQLiteDatabase db, String tableName) Returns a JSONObject representing all of the data from the given table from the given database.
JSONObject	toJson(String databaseName) Returns a JSONObject representing all of the data from the given database.
JSONObject	toJson(String databaseName, String tableName) Returns a JSONObject representing all of the data from the given table from the given database.
static SimpleDatabase	with(SimpleActivity context) Returns a singleton SimpleDatabase instance bound to the given context.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static SimpleDatabase with(SimpleActivity context)

Returns a singleton SimpleDatabase instance bound to the given context.

create

public SQLiteDatabase create(String databaseName)

Creates a database with the given name, if it doesn't exist. If it does already exist, simply opens it and returns it. Equivalent to openOrCreateDatabase on an activity.

delete

public boolean delete(String databaseName)

Deletes the database with the given name, if it exists. Returns whether the database was deleted successfully.

escape

public String escape(String s)

Escapes/quotes a string for use as a parameter in an SQL query.

executeSqlFile

public SimpleDatabase executeSqlFile(String filename)

Reads the .sql file with the given name and executes all SQL statements inside it, placing them into a database with the same name as the file. For example, if you pass "foo", reads/executes file resource R.raw.foo and uses it to create/populate a database named foo.

executeSqlFile

public SimpleDatabase executeSqlFile(String filename,
                                     SimpleDatabase.QueryProgressListener listener)

Reads the .sql file with the given name and executes all SQL statements inside it, placing them into a database with the same name as the file. For example, if you pass "foo", reads/executes file resource R.raw.foo and uses it to create/populate a database named foo.

executeSqlFile

public SimpleDatabase executeSqlFile(String dbName,
                                     String filename,
                                     SimpleDatabase.QueryProgressListener listener)

Reads the .sql file with the given name and executes all SQL statements inside it, placing them into the database with the given name. For example, if you pass "foo" and "bar", reads/executes file resource R.raw.bar and uses it to create/populate a database named foo.

executeSqlFile

public SimpleDatabase executeSqlFile(SQLiteDatabase db,
                                     @RawRes
                                     int id)

Reads the .sql file with the given resource ID and executes all SQL statements inside it using the given database.

executeSqlFile

public SimpleDatabase executeSqlFile(SQLiteDatabase db,
                                     @RawRes
                                     int id,
                                     SimpleDatabase.QueryProgressListener listener)

Reads the .sql file with the given resource ID and executes all SQL statements inside it using the given database.

exists

public boolean exists(String databaseName)

Returns true if a database with the given name exists.

getColumnNames

public String[] getColumnNames(Cursor cr)

Returns the names of all columns in the given query's cursor as an array. The column names will appear in the array in their natural order in which they occur in the internal ordering of the query.

getColumnNames

public String[] getColumnNames(String databaseName,
                               String tableName)

Returns the names of all columns in the given database table as an array. The column names will appear in the array in their natural order in which they occur in the internal ordering of the database.

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

getColumnNames

public String[] getColumnNames(SQLiteDatabase db,
                               String tableName)

Returns the names of all columns in the given database table as an array. The column names will appear in the array in their natural order in which they occur in the internal ordering of the database.

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

SQLiteException - if the given table does not exist

getDatabaseNames

public String[] getDatabaseNames()

Returns an array of the names of all databases in this app.

getTableNames

public String[] getTableNames(String databaseName)

Returns the names of all tables in the given database as an array. The table names will appear in the array in their natural order in which they occur in the internal ordering of the database. (Omits the private SQLite/Android table names like android_metadata.) Reference: http://stackoverflow.com/questions/15383847/how-to-get-all-table-names-in-android-sqlite-database

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

getTableNames

public String[] getTableNames(SQLiteDatabase db)

Returns the names of all tables in the given database as an array. The table names will appear in the array in their natural order in which they occur in the internal ordering of the database. (Omits the private SQLite/Android table names like android_metadata.) Reference: http://stackoverflow.com/questions/15383847/how-to-get-all-table-names-in-android-sqlite-database

open

public SQLiteDatabase open(String databaseName)

Opens the database with the given name, or creates it if it doesn't exist. Equivalent to openOrCreateDatabase on an activity.

query

public SimpleCursor query(SQLiteDatabase db,
                          String query)

Performs the given database query on the given database and returns a view of the results. Intended usage:

 for (SimpleRow row : SimpleDatabase.with(this).query(db, myQuery)) { ... }
 

query

public SimpleCursor query(String databaseName,
                          String query)

Performs the given database query on the database with the given name and returns a view of the results. Intended usage:

 for (SimpleRow row : SimpleDatabase.with(this).query(db, myQuery)) { ... }
 

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

queryTransaction

public void queryTransaction(SQLiteDatabase db,
                             String... queries)

Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully. Intended usage:

 SimpleDatabase.with(this).queryTransaction(db, query1, query2, query3));
 

queryTransaction

public void queryTransaction(String databaseName,
                             String... queries)

Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully. Intended usage:

 SimpleDatabase.with(this).queryTransaction(db, query1, query2, query3));
 

queryTransaction

public void queryTransaction(SQLiteDatabase db,
                             SimpleDatabase.QueryProgressListener listener,
                             String... queries)

Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully. Contacts the given listener after each individual query to notify it of the overall progress. (If the listener is null, it is ignored.) Intended usage:

 SimpleDatabase.with(this).queryTransaction(db, listener, query1, query2, query3));
 

queryTransaction

public void queryTransaction(String databaseName,
                             SimpleDatabase.QueryProgressListener listener,
                             String... queries)

Performs all of the given database queries on the given database as a transaction to speed them up as well as making sure that all of them are completed successfully. Contacts the given listener after each individual query to notify it of the overall progress. (If the listener is null, it is ignored.) Intended usage:

 SimpleDatabase.with(this).queryTransaction(db, listener, query1, query2, query3));
 

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

rows

public static SimpleCursor rows(Cursor cursor)

Returns an object that can be used to iterate over the rows of a given query cursor.

 for (SimpleRow row : SimpleDatabase.rows(myCursor)) { ... }
 

setLogging

public SimpleDatabase setLogging(boolean logging)

Sets whether Log.d statements should print as queries are run.

toJson

public JSONObject toJson(String databaseName)

Returns a JSONObject representing all of the data from the given database. The JSON object will store each table of data using its name as its key. The data of each table will be represented as described in tableToJson.

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

toJson

public JSONObject toJson(SQLiteDatabase db)

Returns a JSONObject representing all of the data from the given database. The JSON object will store each table of data using its name as its key. The data of each table will be represented as described in tableToJson.

Throws:

IllegalStateException - if JSON data cannot be converted

toJson

public JSONObject toJson(String databaseName,
                         String tableName)

Returns a JSONObject representing all of the data from the given table from the given database. The JSON object will store each row of data using its "id" column as its key, or if there is no "id" column, by ascending integer indexes.

Throws:

SQLiteCantOpenDatabaseException - if the given database does not exist

SQLiteException - if the given table does not exist in the given database

toJson

public JSONObject toJson(SQLiteDatabase db,
                         String tableName)

Returns a JSONObject representing all of the data from the given table from the given database. The JSON object will store each row of data using its "id" column as its key, or if there is no "id" column, by ascending integer indexes.

Throws:

SQLiteException - if the given table does not exist in the given database

IllegalStateException - if JSON data cannot be converted