com.pushtorefresh.storio.sqlite.impl

Class DefaultStorIOSQLite.LowLevelImpl

java.lang.Object

com.pushtorefresh.storio.sqlite.StorIOSQLite.LowLevel

com.pushtorefresh.storio.sqlite.StorIOSQLite.Internal

com.pushtorefresh.storio.sqlite.impl.DefaultStorIOSQLite.LowLevelImpl

Direct Known Subclasses:

DefaultStorIOSQLite.InternalImpl

Enclosing class:

DefaultStorIOSQLite

protected class DefaultStorIOSQLite.LowLevelImpl
extends StorIOSQLite.Internal

API for low level operations with StorIOSQLite, we made it separate to make StorIOSQLite API clean and easy to understand.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LowLevelImpl(TypeMappingFinder typeMappingFinder)

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Begins a transaction in EXCLUSIVE mode.
int	delete(DeleteQuery deleteQuery) Deletes one or multiple rows in the database.
void	endTransaction() Ends a transaction.
void	executeSQL(RawQuery rawQuery) Executes a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE on the database.
long	insert(InsertQuery insertQuery, android.content.ContentValues contentValues) Inserts a row into the database.
long	insertWithOnConflict(InsertQuery insertQuery, android.content.ContentValues contentValues, int conflictAlgorithm) Inserts a row into the database.
void	notifyAboutChanges(Changes changes) Notifies subscribers about changes happened in StorIOSQLite.
android.database.Cursor	query(Query query) Executes query on the database and returns Cursor over the result set.
android.database.Cursor	rawQuery(RawQuery rawQuery) Executes raw query on the database and returns Cursor over the result set.
void	setTransactionSuccessful() Marks the current transaction as successful.
android.database.sqlite.SQLiteOpenHelper	sqliteOpenHelper() Returns SQLiteOpenHelper for the direct access to underlining database.
<T> SQLiteTypeMapping<T>	typeMapping(java.lang.Class<T> type) Gets type mapping for required type.
int	update(UpdateQuery updateQuery, android.content.ContentValues contentValues) Updates one or multiple rows in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

LowLevelImpl

protected LowLevelImpl(@NonNull
                       TypeMappingFinder typeMappingFinder)

Method Detail

typeMapping

@Nullable
public <T> SQLiteTypeMapping<T> typeMapping(@NonNull
                                                      java.lang.Class<T> type)

Gets type mapping for required type.

This implementation can handle subclasses of types, that registered its type mapping. For example: You've added type mapping for User.class, and you have UserFromServiceA.class which extends User.class, and you didn't add type mapping for UserFromServiceA.class because they have same fields and you just want to have multiple classes. This implementation will find type mapping of User.class and use it as type mapping for UserFromServiceA.class.

Specified by:

typeMapping in class StorIOSQLite.LowLevel

Type Parameters:

T - type.

Parameters:

type - type.

Returns:

direct or indirect type mapping for passed type, or null.

executeSQL

@WorkerThread
public void executeSQL(@NonNull
                                     RawQuery rawQuery)

Executes a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE on the database.

Specified by:

executeSQL in class StorIOSQLite.LowLevel

Parameters:

rawQuery - sql query.

rawQuery

@WorkerThread
 @NonNull
public android.database.Cursor rawQuery(@NonNull
                                                                RawQuery rawQuery)

Executes raw query on the database and returns Cursor over the result set.

Specified by:

rawQuery in class StorIOSQLite.LowLevel

Parameters:

rawQuery - sql query

Returns:

A Cursor object, which is positioned before the first entry. Note that Cursors are not synchronized, see the documentation for more details.

query

@WorkerThread
 @NonNull
public android.database.Cursor query(@NonNull
                                                             Query query)

Executes query on the database and returns Cursor over the result set.

Specified by:

query in class StorIOSQLite.LowLevel

Parameters:

query - sql query.

Returns:

A Cursor object, which is positioned before the first entry. Note that Cursors are not synchronized, see the documentation for more details.

insert

@WorkerThread
public long insert(@NonNull
                                 InsertQuery insertQuery,
                                 @NonNull
                                 android.content.ContentValues contentValues)

Inserts a row into the database.

Specified by:

insert in class StorIOSQLite.LowLevel

Parameters:

insertQuery - query.

contentValues - map that contains the initial column values for the row. The keys should be the column names and the values the column values.

Returns:

id of inserted row.

insertWithOnConflict

@WorkerThread
public long insertWithOnConflict(@NonNull
                                               InsertQuery insertQuery,
                                               @NonNull
                                               android.content.ContentValues contentValues,
                                               int conflictAlgorithm)

Inserts a row into the database.

Specified by:

insertWithOnConflict in class StorIOSQLite.LowLevel

Parameters:

insertQuery - query.

contentValues - map that contains the initial column values for the row. The keys should be the column names and the values the column values.

conflictAlgorithm - for insert conflict resolver.

Returns:

the row ID of the newly inserted row OR the primary key of the existing row if the input param 'conflictAlgorithm' = SQLiteDatabase.CONFLICT_IGNORE OR -1 if any error.

See Also:

SQLiteDatabase.insertWithOnConflict(String, String, ContentValues, int), SQLiteDatabase.CONFLICT_REPLACE, SQLiteDatabase.CONFLICT_ABORT, SQLiteDatabase.CONFLICT_FAIL, SQLiteDatabase.CONFLICT_ROLLBACK, SQLiteDatabase.CONFLICT_IGNORE

update

@WorkerThread
public int update(@NonNull
                                UpdateQuery updateQuery,
                                @NonNull
                                android.content.ContentValues contentValues)

Updates one or multiple rows in the database.

Specified by:

update in class StorIOSQLite.LowLevel

Parameters:

updateQuery - query.

contentValues - a map from column names to new column values. null is a valid value that will be translated to NULL.

Returns:

the number of rows affected.

delete

@WorkerThread
public int delete(@NonNull
                                DeleteQuery deleteQuery)

Deletes one or multiple rows in the database.

Specified by:

delete in class StorIOSQLite.LowLevel

Parameters:

deleteQuery - query.

Returns:

the number of rows deleted.

notifyAboutChanges

public void notifyAboutChanges(@NonNull
                               Changes changes)

Notifies subscribers about changes happened in StorIOSQLite. Operations can be executed in transaction or one operation can affect multiple tables, so to reduce number of notifications you can call this method once and provide aggregated Changes object.

Specified by:

notifyAboutChanges in class StorIOSQLite.LowLevel

Parameters:

changes - changes happened in StorIOSQLite.

beginTransaction

public void beginTransaction()

Begins a transaction in EXCLUSIVE mode.

Thread will be blocked on call to this method if another thread already in transaction, as soon as first thread will end its transaction this thread will be unblocked.

Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

   db.beginTransaction();
   try {
     ...
     db.setTransactionSuccessful();
   } finally {
     db.endTransaction();
   }
 

Specified by:

beginTransaction in class StorIOSQLite.LowLevel

setTransactionSuccessful

public void setTransactionSuccessful()

Marks the current transaction as successful. Do not do any more database work between calling this and calling endTransaction. Do as little non-database work as possible in that situation too. If any errors are encountered between this and endTransaction the transaction will still be committed.

Specified by:

setTransactionSuccessful in class StorIOSQLite.LowLevel

endTransaction

public void endTransaction()

Ends a transaction. See StorIOSQLite.LowLevel.beginTransaction() for notes about how to use this and when transactions are committed and rolled back.

Specified by:

endTransaction in class StorIOSQLite.LowLevel

sqliteOpenHelper

@NonNull
public android.database.sqlite.SQLiteOpenHelper sqliteOpenHelper()

Returns SQLiteOpenHelper for the direct access to underlining database. It can be used in cases when StorIOSQLite APIs are not enough.

Notice: Database changes through the direct access to the SQLiteOpenHelper will not trigger notifications. If it possible you should use StorIOSQLite methods instead or call StorIOSQLite.LowLevel.notifyAboutChanges(Changes) manually.

Specified by:

sqliteOpenHelper in class StorIOSQLite.LowLevel

Returns:

SQLiteOpenHelper.