Loaders and cursors for DBFlow

dbflow-kotlinextensions/src/main/java/com/raizlabs/android/dbflow/kotlinextensions/PropertyExtensions.kt

@@ -2,7 +2,6 @@ package com.raizlabs.android.dbflow.kotlinextensions
 
 import com.raizlabs.android.dbflow.sql.language.property.*
 import com.raizlabs.android.dbflow.sql.queriable.ModelQueriable
-import com.raizlabs.android.dbflow.structure.Model
 
 /**
  * Description: Provides some very nice Property class extensions.

dbflow-kotlinextensions/src/main/java/com/raizlabs/android/dbflow/kotlinextensions/PropertyMethodExtensions.kt

@@ -9,7 +9,6 @@ import com.raizlabs.android.dbflow.structure.Model
 /**
  * Description: Provides property methods in via infix functions.
  */
-
 infix fun <T : Any> Property<T>.eq(value: T) = this.eq(value)
 
 infix fun <T : Any> Property<T>.`is`(value: T) = this.`is`(value)

dbflow-kotlinextensions/src/main/java/com/raizlabs/android/dbflow/kotlinextensions/QueryExtensions.kt

@@ -131,7 +131,6 @@ fun <T : Any> update(modelClass: KClass<T>): Update<T> = SQLite.update(modelClas
 
 infix fun <T : Any> Update<T>.set(sqlCondition: SQLCondition) = set(sqlCondition)
 
-
 // delete
 
 inline fun <reified T : Any> delete() = SQLite.delete(T::class.java)

dbflow-processor/build.gradle

@@ -13,7 +13,6 @@ dependencies {
     compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
     testCompile 'junit:junit:4.12'
-
 }
 
 apply from: '../java-artifacts.gradle'

dbflow-processor/src/main/java/com/raizlabs/android/dbflow/processor/DBFlowProcessor.java

@@ -29,6 +29,14 @@ public class DBFlowProcessor extends AbstractProcessor {
 
     private ProcessorManager manager;
 
+    @Override
+    public Set<String> getSupportedOptions() {
+        Set <String> supportedOptions = new LinkedHashSet<>();
+        supportedOptions.add("targetModuleName");
+
+        return supportedOptions;
+    }
+
     /**
      * If the processor class is annotated with {@link
      * javax.annotation.processing.SupportedAnnotationTypes}, return an unmodifiable set with the

dbflow/build.gradle

@@ -26,8 +26,6 @@ android {
 dependencies {
     compile project("${dbflow_project_prefix}dbflow-core")
     compile "com.android.support:support-annotations:25.0.0"
-
-
 }
 
 apply from: '../android-artifacts.gradle'

dbflow/src/main/java/com/raizlabs/android/dbflow/list/FlowCursorAdapter.java

@@ -0,0 +1,39 @@
+package com.raizlabs.android.dbflow.list;
+
+import android.annotation.TargetApi;
+import android.content.Context;
+import android.database.Cursor;
+import android.widget.CursorAdapter;
+
+import com.raizlabs.android.dbflow.config.FlowManager;
+import com.raizlabs.android.dbflow.structure.Model;
+import com.raizlabs.android.dbflow.structure.ModelAdapter;
+
+/**
+ * Specialization of CursorAdapter for DBFLow models. The getItem() method
+ * returns a model element instead of a Cursor object.
+ *
+ * @param <TModel>
+ */
+public abstract class FlowCursorAdapter <TModel extends Model> extends CursorAdapter {
+    private final ModelAdapter<TModel> modelAdapter;
+
+    public FlowCursorAdapter(Context context, Class<TModel> modelClass, Cursor c, boolean autoRequery) {
+        super(context, c, autoRequery);
+
+        this.modelAdapter = FlowManager.getModelAdapter(modelClass);
+    }
+
+    @TargetApi(11)
+    public FlowCursorAdapter(Context context, Class<TModel> modelClass, Cursor c, int flags) {
+        super(context, c, flags);
+
+        this.modelAdapter = FlowManager.getModelAdapter(modelClass);
+    }
+
+    @Override
+    public TModel getItem(int position) {
+        Cursor cursor = (Cursor) super.getItem(position);
+        return cursor != null ? this.modelAdapter.loadFromCursor(cursor) : null;
+    }
+}

dbflow/src/main/java/com/raizlabs/android/dbflow/list/FlowCursorLoader.java

@@ -0,0 +1,198 @@
+package com.raizlabs.android.dbflow.list;
+
+import android.annotation.TargetApi;
+import android.content.AsyncTaskLoader;
+import android.content.Context;
+import android.database.Cursor;
+import android.net.Uri;
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.raizlabs.android.dbflow.runtime.FlowContentObserver;
+import com.raizlabs.android.dbflow.sql.language.SQLCondition;
+import com.raizlabs.android.dbflow.sql.queriable.Queriable;
+import com.raizlabs.android.dbflow.structure.BaseModel;
+import com.raizlabs.android.dbflow.structure.Model;
+
+import java.util.Collection;
+import java.util.HashSet;
+
+/**
+ * Specialization of AsyncTaskLoader for Cursor objects in DBFlow.
+ */
+@TargetApi(11)
+public class FlowCursorLoader extends AsyncTaskLoader<Cursor> {
+    /// Models to be observed for changes.
+    private final HashSet<Class<? extends Model>> models = new HashSet<>();
+
+    /// Queriable operation that the loader executes.
+    private Queriable queriable;
+
+    /// Cursor for the loader.
+    private Cursor cursor;
+
+    /// The observer that triggers the loader to reload anytime if it receives
+    /// notification of a change.
+    private final ForceLoadContentObserver observer = new ForceLoadContentObserver();
+
+    private boolean listening = false;
+
+    /**
+     * Creates a fully-specified CursorLoader.  See {@link android.content.ContentResolver#query(Uri,
+     * String[], String, String[], String) ContentResolver.query()} for documentation on the meaning
+     * of the parameters.  These will be passed as-is to that call.
+     */
+    public FlowCursorLoader(Context context, Queriable queriable) {
+        super(context);
+
+        this.queriable = queriable;
+    }
+
+    @Override
+    public Cursor loadInBackground() {
+        Cursor cursor = this.queriable.query();
+
+        if (cursor != null) {
+            cursor.getCount();
+        }
+
+        return cursor;
+    }
+
+    @Override
+    public void deliverResult(Cursor cursor) {
+        if (this.isReset()) {
+            // An async query came in while the loader is stopped
+            if (cursor != null) {
+                cursor.close();
+            }
+
+            return;
+        }
+
+        Cursor oldCursor = this.cursor;
+        this.cursor = cursor;
+
+        if (this.isStarted()) {
+            super.deliverResult(cursor);
+        }
+
+        if (oldCursor != null && oldCursor != cursor && !oldCursor.isClosed()) {
+            oldCursor.close();
+        }
+
+        // Now that the result has been delivered, start listening for changes
+        // to the target models. Doing this at anytime earlier runs the risk of
+        // listening for changes while we are still loading content.
+        this.startListeningForChanges();
+    }
+
+    /**
+     * Register the loader for changes to a Flow model. When changes to the model are
+     * detected, then the loader will automatically reload the content.
+     *
+     * @param model
+     */
+    public void registerForContentChanges(Class<? extends Model> model) {
+        if (this.models.contains(model)) {
+            return;
+        }
+
+        this.models.add(model);
+        this.observer.registerForContentChanges(this.getContext(), model);
+    }
+
+    @Override
+    protected void onStartLoading() {
+        if (this.cursor != null) {
+            this.deliverResult(this.cursor);
+        }
+
+        if (this.takeContentChanged() || this.cursor == null) {
+            this.forceLoad();
+        }
+    }
+
+    @Override
+    protected void onStopLoading() {
+        // Make sure the loading has stopped.
+        this.cancelLoad();
+    }
+
+    @Override
+    public void onCanceled(Cursor cursor) {
+        if (cursor != null && !cursor.isClosed()) {
+            cursor.close();
+        }
+
+        this.stopListeningForChanges();
+    }
+
+    @Override
+    protected void onReset() {
+        super.onReset();
+
+        this.startLoading();
+
+        if (cursor != null && !cursor.isClosed()) {
+            cursor.close();
+        }
+
+        cursor = null;
+
+        this.observer.unregisterForContentChanges(this.getContext());
+    }
+
+    private void startListeningForChanges() {
+        if (!this.listening) {
+            this.observer.addModelChangeListener(this.observer);
+            this.listening = true;
+        }
+    }
+
+    private void stopListeningForChanges() {
+        if (this.listening) {
+            this.observer.removeModelChangeListener(this.observer);
+            this.listening = false;
+        }
+    }
+
+    public Collection<Class<? extends Model>> getModels() {
+        return this.models;
+    }
+
+    public FlowContentObserver getContentObserver() {
+        return this.observer;
+    }
+
+    private final class ForceLoadContentObserver extends FlowContentObserver
+        implements FlowContentObserver.OnModelStateChangedListener {
+        private boolean endOfTransaction = false;
+
+        @Override
+        public boolean deliverSelfNotifications() {
+            return false;
+        }
+
+        @Override
+        public void onModelStateChanged(@Nullable Class<?> table, BaseModel.Action action, @NonNull SQLCondition[] primaryKeyValues) {
+            if (!this.endOfTransaction) {
+                if (action == BaseModel.Action.INSERT || action == BaseModel.Action.DELETE || action == BaseModel.Action.UPDATE) {
+                    onContentChanged();
+                }
+            }
+        }
+
+        @Override
+        public void endTransactionAndNotify() {
+            // Mark this as the end of a transactions, and pass control to the base class
+            // to perform the notifications.
+            this.endOfTransaction = true;
+            super.endTransactionAndNotify();
+
+            // Notify the observer the content has changed.
+            this.endOfTransaction = false;
+            onContentChanged();
+        }
+    }
+}

dbflow/src/main/java/com/raizlabs/android/dbflow/list/FlowSimpleCursorAdapter.java

@@ -0,0 +1,36 @@
+package com.raizlabs.android.dbflow.list;
+
+
+import android.annotation.TargetApi;
+import android.content.Context;
+import android.database.Cursor;
+import android.widget.SimpleCursorAdapter;
+
+import com.raizlabs.android.dbflow.config.FlowManager;
+import com.raizlabs.android.dbflow.structure.Model;
+import com.raizlabs.android.dbflow.structure.ModelAdapter;
+
+/**
+ * Specialization of SimpleCursorAdapter designed for DBFlow. The getItem() method
+ * return a model element instead of a Cursor element.
+ *
+ * @param <TModel>
+ */
+public class FlowSimpleCursorAdapter <TModel extends Model> extends SimpleCursorAdapter {
+    private final Class<TModel> mModel;
+    private final ModelAdapter<TModel> mModelAdapter;
+
+    @TargetApi(11)
+    public FlowSimpleCursorAdapter(Context context, Class<TModel> modelClass, int layout, Cursor c, String[] from, int[] to, int flags) {
+        super(context, layout, c, from, to, flags);
+
+        this.mModel = modelClass;
+        this.mModelAdapter = FlowManager.getModelAdapter(modelClass);
+    }
+
+    @Override
+    public TModel getItem(int position) {
+        Cursor cursor = (Cursor) super.getItem(position);
+        return cursor != null ? this.mModelAdapter.loadFromCursor(cursor) : null;
+    }
+}

dbflow/src/main/java/com/raizlabs/android/dbflow/single/FlowModelLoader.java

@@ -0,0 +1,22 @@
+package com.raizlabs.android.dbflow.single;
+
+import android.annotation.TargetApi;
+import android.content.Context;
+
+import com.raizlabs.android.dbflow.config.FlowManager;
+import com.raizlabs.android.dbflow.sql.queriable.Queriable;
+import com.raizlabs.android.dbflow.structure.Model;
+
+/**
+ * Load a single model from the database.
+ *
+ * @param <TModel>
+ */
+@TargetApi(11)
+public class FlowModelLoader <TModel extends Model>
+    extends FlowSingleModelLoader<TModel> {
+
+    public FlowModelLoader(Context context, Class<TModel> model, Queriable queriable) {
+        super(context, model, FlowManager.getModelAdapter(model), queriable);
+    }
+}

dbflow/src/main/java/com/raizlabs/android/dbflow/single/FlowModelViewLoader.java

@@ -0,0 +1,25 @@
+package com.raizlabs.android.dbflow.single;
+
+import android.annotation.TargetApi;
+import android.content.Context;
+
+import com.raizlabs.android.dbflow.config.FlowManager;
+import com.raizlabs.android.dbflow.sql.queriable.Queriable;
+import com.raizlabs.android.dbflow.structure.BaseModelView;
+import com.raizlabs.android.dbflow.structure.InstanceAdapter;
+import com.raizlabs.android.dbflow.structure.Model;
+
+/**
+ * Load a single DBFlow model from a ViewModel.
+ *
+ * @param <TModel>
+ */
+@TargetApi(11)
+public class FlowModelViewLoader <TModel extends Model, TModelView extends BaseModelView>
+    extends FlowSingleModelLoader<TModel> {
+
+    @SuppressWarnings("unchecked")
+    public FlowModelViewLoader(Context context, Class<TModel> model, Class<TModelView> modelView, Queriable queriable) {
+        super(context, model, (InstanceAdapter<TModel>) FlowManager.getModelViewAdapter(modelView), queriable);
+    }
+}