Skip to content

Commit

Permalink
escalated some methods in SQLUtils. Added hasCachingId() method, updated
Browse files Browse the repository at this point in the history 
readme with the change
  • Loading branch information
Andrew Grosner committed Jul 2, 2015
1 parent 345dac5 commit 897720f
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 41 deletions.
8 changes: 8 additions & 0 deletions ...Compiler/src/main/java/com/raizlabs/android/dbflow/processor/writer/LoadCursorWriter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,14 @@ public void write(JavaWriter javaWriter) throws IOException {
final TableDefinition tableDefinition = ((TableDefinition) baseTableDefinition);

if (tableDefinition.hasCachingId) {

WriterUtils.emitOverriddenMethod(javaWriter, new FlowWriter() {
@Override
public void write(JavaWriter javaWriter) throws IOException {
javaWriter.emitStatement("return true");
}
}, "boolean", "hasCachingId", Sets.newHashSet(Modifier.PUBLIC));

String[] params2 = new String[2];
params2[0] = ModelUtils.getParameter(isModelContainerDefinition, tableDefinition.getModelClassName());
params2[1] = ModelUtils.getVariable(isModelContainerDefinition);
Expand Down
131 changes: 90 additions & 41 deletions DBFlow/src/main/java/com/raizlabs/android/dbflow/sql/SqlUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,38 @@
import com.raizlabs.android.dbflow.annotation.ConflictAction;
import com.raizlabs.android.dbflow.config.BaseDatabaseDefinition;
import com.raizlabs.android.dbflow.config.FlowManager;
import com.raizlabs.android.dbflow.runtime.DBTransactionQueue;
import com.raizlabs.android.dbflow.runtime.FlowContentObserver;
import com.raizlabs.android.dbflow.sql.language.Delete;
import com.raizlabs.android.dbflow.structure.BaseModel;
import com.raizlabs.android.dbflow.structure.BaseModel.Action;
import com.raizlabs.android.dbflow.structure.InstanceAdapter;
import com.raizlabs.android.dbflow.structure.InternalAdapter;
import com.raizlabs.android.dbflow.structure.Model;
import com.raizlabs.android.dbflow.structure.ModelAdapter;
import com.raizlabs.android.dbflow.structure.RetrievalAdapter;
import com.raizlabs.android.dbflow.structure.cache.BaseCacheableModel;
import com.raizlabs.android.dbflow.structure.cache.ModelCache;
import com.raizlabs.android.dbflow.structure.container.ModelContainer;
import com.raizlabs.android.dbflow.structure.container.ModelContainerAdapter;

import java.util.ArrayList;
import java.util.List;

/**
* Description: Provides some handy methods for dealing with SQL statements. It's purpose is to move the
* methods away from the {@link com.raizlabs.android.dbflow.structure.Model} class and let any class use these.
* methods away from the {@link Model} class and let any class use these.
*/
public class SqlUtils {

/**
* Queries the DB for a {@link android.database.Cursor} and converts it into a list.
* Queries the DB for a {@link Cursor} and converts it into a list.
*
* @param modelClass The class to construct the data from the DB into
* @param sql The SQL command to perform, must not be ; terminated.
* @param args You may include ?s in where clause in the query,
* which will be replaced by the values from selectionArgs. The
* values will be bound as Strings.
* @param <ModelClass> The class implements {@link com.raizlabs.android.dbflow.structure.Model}
* @param <ModelClass> The class implements {@link Model}
* @return a list of {@link ModelClass}
*/
@SuppressWarnings("unchecked")
Expand All @@ -55,19 +59,35 @@ public static <ModelClass extends Model> List<ModelClass> queryList(Class<ModelC
return list;
}

private static <CacheableClass extends BaseCacheableModel> List<CacheableClass> convertToCacheableList(
Class<CacheableClass> modelClass, Cursor cursor) {
/**
* Loops through a {@link Cursor} and builds a list of {@link CacheableClass} objects. If an item
* with the same id exists within the cache for that model, the cached object for that class is used.
*
* @param modelClass The class to convert the cursor into {@link CacheableClass}
* @param cursor The cursor from a query.
* @param modelCache The model cache to use when retrieving {@link CacheableClass}.
* @param <CacheableClass> The class that extends {@link BaseCacheableModel}
* @return A {@link List} of {@link CacheableClass}.
*/
public static <CacheableClass extends BaseCacheableModel> List<CacheableClass> convertToCacheableList(
Class<CacheableClass> modelClass, Cursor cursor, ModelCache<CacheableClass, ?> modelCache) {
final List<CacheableClass> entities = new ArrayList<>();
ModelAdapter<CacheableClass> instanceAdapter = FlowManager.getModelAdapter(modelClass);
if (instanceAdapter != null) {
if (!instanceAdapter.hasCachingId()) {
throw new IllegalArgumentException("You cannot call this method for a table that has no caching id. Either" +
"use one Primary Key or call convertToList()");
} else if (modelCache == null) {
throw new IllegalArgumentException("ModelCache specified in convertToCacheableList() must not be null.");
}
synchronized (cursor) {
// Ensure that we aren't iterating over this cursor concurrently from different threads
if (cursor.moveToFirst()) {
do {
long id = cursor.getLong(cursor.getColumnIndex(instanceAdapter.getCachingColumnName()));

// if it exists in cache no matter the query we will use that one
CacheableClass cacheable = BaseCacheableModel.getCache(modelClass).get(id);
CacheableClass cacheable = modelCache.get(id);
if (cacheable != null) {
entities.add(cacheable);
} else {
Expand All @@ -82,6 +102,20 @@ private static <CacheableClass extends BaseCacheableModel> List<CacheableClass>
return entities;
}

/**
* Loops through a {@link Cursor} and builds a list of {@link CacheableClass} objects. If an item
* with the same id exists within the cache for that model, the cached object for that class is used.
*
* @param modelClass The class to convert the cursor into {@link CacheableClass}
* @param cursor The cursor from a query.
* @param <CacheableClass> The class that extends {@link BaseCacheableModel}
* @return A {@link List} of {@link CacheableClass}.
*/
public static <CacheableClass extends BaseCacheableModel> List<CacheableClass> convertToCacheableList(
Class<CacheableClass> modelClass, Cursor cursor) {
return convertToCacheableList(modelClass, cursor, BaseCacheableModel.getCache(modelClass));
}

/**
* Loops through a cursor and builds a list of {@link ModelClass} objects.
*
Expand Down Expand Up @@ -117,8 +151,8 @@ public static <ModelClass extends Model> List<ModelClass> convertToList(Class<Mo
* @param dontMoveToFirst If it's a list or at a specific position, do not reset the cursor
* @param table The model class that we convert the cursor data into.
* @param cursor The cursor from the DB
* @param <ModelClass> The class that implements {@link com.raizlabs.android.dbflow.structure.Model}
* @return A model transformed from the {@link android.database.Cursor}
* @param <ModelClass> The class that implements {@link Model}
* @return A model transformed from the {@link Cursor}
*/
@SuppressWarnings("unchecked")
public static <ModelClass extends Model> ModelClass convertToModel(boolean dontMoveToFirst, Class<ModelClass> table,
Expand All @@ -142,8 +176,8 @@ public static <ModelClass extends Model> ModelClass convertToModel(boolean dontM
* @param dontMoveToFirst If it's a list or at a specific position, do not reset the cursor
* @param table The model class that we convert the cursor data into.
* @param cursor The cursor from the DB
* @param <CacheableClass> The class that implements {@link com.raizlabs.android.dbflow.structure.Model}
* @return A model transformed from the {@link android.database.Cursor}
* @param <CacheableClass> The class that implements {@link Model}
* @return A model transformed from the {@link Cursor}
*/
@SuppressWarnings("unchecked")
public static <CacheableClass extends BaseCacheableModel> CacheableClass convertToCacheableModel(
Expand All @@ -167,15 +201,15 @@ public static <CacheableClass extends BaseCacheableModel> CacheableClass convert
}

/**
* Queries the DB and returns the first {@link com.raizlabs.android.dbflow.structure.Model} it finds. Note:
* Queries the DB and returns the first {@link Model} it finds. Note:
* this may return more than one object, but only will return the first item in the list.
*
* @param modelClass The class to construct the data from the DB into
* @param sql The SQL command to perform, must not be ; terminated.
* @param args You may include ?s in where clause in the query,
* which will be replaced by the values from selectionArgs. The
* values will be bound as Strings.
* @param <ModelClass> The class implements {@link com.raizlabs.android.dbflow.structure.Model}
* @param <ModelClass> The class implements {@link Model}
* @return a single {@link ModelClass}
*/
@SuppressWarnings("unchecked")
Expand All @@ -194,13 +228,13 @@ public static <ModelClass extends Model> ModelClass querySingle(Class<ModelClass
}

/**
* Checks whether the SQL query returns a {@link android.database.Cursor} with a count of at least 1. This
* means that the query was successful. It is commonly used when checking if a {@link com.raizlabs.android.dbflow.structure.Model} exists.
* Checks whether the SQL query returns a {@link Cursor} with a count of at least 1. This
* means that the query was successful. It is commonly used when checking if a {@link Model} exists.
*
* @param table The table to check
* @param sql The SQL command to perform, must not be ; terminated.
* @param args The optional string arguments when we use "?" in the sql
* @param <ModelClass> The class that implements {@link com.raizlabs.android.dbflow.structure.Model}
* @param <ModelClass> The class that implements {@link Model}
* @return
*/
public static <ModelClass extends Model> boolean hasData(Class<ModelClass> table, String sql, String... args) {
Expand Down Expand Up @@ -234,10 +268,7 @@ void save(TableClass model, AdapterClass adapter, ModelAdapter<ModelClass> model
insert(model, adapter, modelAdapter);
}

if (FlowContentObserver.shouldNotify()) {
notifyModelChanged(modelAdapter.getModelClass(), BaseModel.Action.SAVE, modelAdapter.getCachingColumnName(),
adapter.getCachingId(model));
}
notifyModelChanged(model, adapter, modelAdapter, Action.SAVE);
}

/**
Expand All @@ -246,7 +277,7 @@ void save(TableClass model, AdapterClass adapter, ModelAdapter<ModelClass> model
* @param model The model to update
* @param modelAdapter The adapter to use
* @return true if model was inserted, false if not. Also false could mean that it is placed on the
* {@link com.raizlabs.android.dbflow.runtime.DBTransactionQueue} using async to true.
* {@link DBTransactionQueue} using async to true.
*/
@SuppressWarnings("unchecked")
public static <ModelClass extends Model, TableClass extends Model, AdapterClass extends RetrievalAdapter & InternalAdapter>
Expand All @@ -263,15 +294,14 @@ boolean update(TableClass model, AdapterClass adapter, ModelAdapter<ModelClass>
if (!exists) {
// insert
insert(model, adapter, modelAdapter);
} else if (FlowContentObserver.shouldNotify()) {
notifyModelChanged(modelAdapter.getModelClass(), BaseModel.Action.UPDATE,
modelAdapter.getCachingColumnName(), adapter.getCachingId(model));
} else {
notifyModelChanged(model, adapter, modelAdapter, Action.UPDATE);
}
return exists;
}

/**
* Will attempt to insert the {@link com.raizlabs.android.dbflow.structure.container.ModelContainer} into the DB.
* Will attempt to insert the {@link ModelContainer} into the DB.
*
* @param model The model to insert.
* @param modelAdapter The adapter to use.
Expand All @@ -283,15 +313,12 @@ void insert(TableClass model, AdapterClass adapter, ModelAdapter<ModelClass> mod
adapter.bindToStatement(insertStatement, model);
long id = insertStatement.executeInsert();
adapter.updateAutoIncrement(model, id);
if (FlowContentObserver.shouldNotify()) {
notifyModelChanged(modelAdapter.getModelClass(), BaseModel.Action.INSERT,
modelAdapter.getCachingColumnName(), adapter.getCachingId(model));
}
notifyModelChanged(model, adapter, modelAdapter, Action.INSERT);
}


/**
* Deletes {@link com.raizlabs.android.dbflow.structure.Model} from the database using the specfied {@link com.raizlabs.android.dbflow.config.FlowManager}
* Deletes {@link Model} from the database using the specfied {@link FlowManager}
*
* @param model The model to delete
*/
Expand All @@ -301,29 +328,51 @@ void delete(final TableClass model, AdapterClass adapter, ModelAdapter<ModelClas
new Delete().from((Class<TableClass>) adapter.getModelClass()).where(
adapter.getPrimaryModelWhere(model)).query();
adapter.updateAutoIncrement(model, 0);
if (FlowContentObserver.shouldNotify()) {
notifyModelChanged(modelAdapter.getModelClass(), BaseModel.Action.DELETE,
modelAdapter.getCachingColumnName(), adapter.getCachingId(model));
}
notifyModelChanged(model, adapter, modelAdapter, Action.DELETE);
}

/**
* Notifies the {@link android.database.ContentObserver} that the model has changed.
*
* @param action The {@link com.raizlabs.android.dbflow.structure.BaseModel.Action} enum
* @param action The {@link Action} enum
* @param table The table of the model
*/
public static void notifyModelChanged(Class<? extends Model> table, BaseModel.Action action, String notifyKey, Object notifyValue) {
public static void notifyModelChanged(Class<? extends Model> table, Action action, String notifyKey, Object notifyValue) {
FlowManager.getContext().getContentResolver().notifyChange(getNotificationUri(table, action, notifyKey, notifyValue), null, true);
}

/**
* Performs necessary logic to notify of {@link Model} changes.
*
* @param model The model to use to notify (if a caching id exists for that model).
* @param adapter The adapter to use thats either a {@link ModelAdapter} or {@link ModelContainerAdapter}
* to handle interactions.
* @param modelAdapter The actual {@link ModelAdapter} associated with the {@link ModelClass}/
* @param action The {@link Action} that occured.
* @param <ModelClass> The original model class.
* @param <TableClass> The class of the adapter that we use the model from.
* @param <AdapterClass> The class of the adapter, which is either a {@link ModelAdapter} or {@link ModelContainerAdapter}
*/
@SuppressWarnings("unchecked")
private static <ModelClass extends Model, TableClass extends Model, AdapterClass extends RetrievalAdapter & InternalAdapter>
void notifyModelChanged(TableClass model, AdapterClass adapter, ModelAdapter<ModelClass> modelAdapter, Action action) {
if (FlowContentObserver.shouldNotify()) {
if (modelAdapter.hasCachingId()) {
notifyModelChanged(modelAdapter.getModelClass(), action,
modelAdapter.getCachingColumnName(), adapter.getCachingId(model));
} else {
notifyModelChanged(modelAdapter.getModelClass(), action, null, null);
}
}
}

/**
* Returns the uri for notifications from model changes
*
* @param modelClass
* @return
*/
public static Uri getNotificationUri(Class<? extends Model> modelClass, BaseModel.Action action, String notifyKey, Object notifyValue) {
public static Uri getNotificationUri(Class<? extends Model> modelClass, Action action, String notifyKey, Object notifyValue) {
Uri.Builder uriBuilder = new Uri.Builder().scheme("dbflow")
.authority(FlowManager.getTableName(modelClass));
if (action != null) {
Expand All @@ -337,10 +386,10 @@ public static Uri getNotificationUri(Class<? extends Model> modelClass, BaseMode

/**
* @param modelClass The model class to use.
* @param action The {@link BaseModel.Action} to use.
* @param action The {@link Action} to use.
* @return The uri for updates to {@link Model}, meant for general changes.
*/
public static Uri getNotificationUri(Class<? extends Model> modelClass, BaseModel.Action action) {
public static Uri getNotificationUri(Class<? extends Model> modelClass, Action action) {
return getNotificationUri(modelClass, action, null, null);
}

Expand All @@ -350,7 +399,7 @@ public static Uri getNotificationUri(Class<? extends Model> modelClass, BaseMode
*
* @param mOnTable The table that this trigger runs on
* @param triggerName The name of the trigger
* @param <ModelClass> The class that implements {@link com.raizlabs.android.dbflow.structure.Model}
* @param <ModelClass> The class that implements {@link Model}
*/
public static <ModelClass extends Model> void dropTrigger(Class<ModelClass> mOnTable, String triggerName) {
QueryBuilder queryBuilder = new QueryBuilder("DROP TRIGGER IF EXISTS ")
Expand All @@ -363,7 +412,7 @@ public static <ModelClass extends Model> void dropTrigger(Class<ModelClass> mOnT
*
* @param mOnTable The table that this index runs on
* @param indexName The name of the index.
* @param <ModelClass> The class that implements {@link com.raizlabs.android.dbflow.structure.Model}
* @param <ModelClass> The class that implements {@link Model}
*/
public static <ModelClass extends Model> void dropIndex(Class<ModelClass> mOnTable, String indexName) {
QueryBuilder queryBuilder = new QueryBuilder("DROP INDEX IF EXISTS ")
Expand Down
5 changes: 5 additions & 0 deletions DBFlow/src/main/java/com/raizlabs/android/dbflow/structure/InternalAdapter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,9 @@ public interface InternalAdapter<TableClass extends Model, ModelClass extends Mo
* @return The id that comes from the model. This is generated by subclasses of this adapter.
*/
Object getCachingId(ModelClass model);

/**
* @return true if the {@link InternalAdapter} can be cached.
*/
boolean hasCachingId();
}
5 changes: 5 additions & 0 deletions DBFlow/src/main/java/com/raizlabs/android/dbflow/structure/ModelAdapter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,11 @@ public Object getCachingIdFromCursorIndex(Cursor cursor, int columnIndex) {
return cursor.getLong(columnIndex);
}

@Override
public boolean hasCachingId() {
return false;
}

/**
* @return Only created once if doesn't exist, the extended class will return the builder to use.
*/
Expand Down
5 changes: 5 additions & 0 deletions .../src/main/java/com/raizlabs/android/dbflow/structure/container/ModelContainerAdapter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ public Object getCachingId(ModelContainer<ModelClass, ?> model) {
return getAutoIncrementingId(model);
}

@Override
public boolean hasCachingId() {
return false;
}

/**
* Returns the type of the column for this model container. It's useful for when we do not know the exact class of the column
* when in a {@link com.raizlabs.android.dbflow.structure.container.ModelContainer}
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ with a "best practices" section.
8. Fixes bugs with the [Getting Started](https://github.com/Raizlabs/DBFlow/blob/master/usage/GettingStarted.md) section implementation. `OneToMany.Method.SAVE` now actually works on `insert`, `update`, and `save` methods.
9. Adds a `OnProgressProcessChangeListener` to listen for the total progress while
looping through saving models in a `ProcessModelTransaction`.
10. Escalated `convertToCacheableList()` to `public` and now can query to know if
a `Model` has a valid caching id. Also some more public methods added to `SqlUtils`!


#### 2.1.0
Expand Down

0 comments on commit 897720f

Please sign in to comment.