#4 Download Images from REST API (v2)

- Added Image entity to Room - Added REST integration
elimu-ai · Mar 28, 2020 · fd52b6a · fd52b6a
1 parent 30276d3
commit fd52b6a
Show file tree

Hide file tree

Showing 15 changed files with 348 additions and 75 deletions.
diff --git a/app/build.gradle b/app/build.gradle
@@ -7,8 +7,8 @@ android {
         applicationId "ai.elimu.content_provider"
         minSdkVersion 24
         targetSdkVersion 29
-        versionCode 1000000
-        versionName "1.0.0-SNAPSHOT"
+        versionCode 1000001
+        versionName "1.0.1-SNAPSHOT"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         javaCompileOptions {
             annotationProcessorOptions {

diff --git a/app/schemas/ai.elimu.content_provider.room.db.RoomDb/1.json b/app/schemas/ai.elimu.content_provider.room.db.RoomDb/1.json
@@ -0,0 +1,84 @@
+{
+  "formatVersion": 1,
+  "database": {
+    "version": 1,
+    "identityHash": "2344eeef50e1c72dc29a552f597f8c6a",
+    "entities": [
+      {
+        "tableName": "Image",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`title` TEXT NOT NULL, `revisionNumber` INTEGER NOT NULL, `id` INTEGER, PRIMARY KEY(`id`))",
+        "fields": [
+          {
+            "fieldPath": "title",
+            "columnName": "title",
+            "affinity": "TEXT",
+            "notNull": true
+          },
+          {
+            "fieldPath": "revisionNumber",
+            "columnName": "revisionNumber",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
+          {
+            "fieldPath": "id",
+            "columnName": "id",
+            "affinity": "INTEGER",
+            "notNull": false
+          }
+        ],
+        "primaryKey": {
+          "columnNames": [
+            "id"
+          ],
+          "autoGenerate": false
+        },
+        "indices": [],
+        "foreignKeys": []
+      },
+      {
+        "tableName": "StoryBook",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`title` TEXT NOT NULL, `description` TEXT, `revisionNumber` INTEGER NOT NULL, `id` INTEGER, PRIMARY KEY(`id`))",
+        "fields": [
+          {
+            "fieldPath": "title",
+            "columnName": "title",
+            "affinity": "TEXT",
+            "notNull": true
+          },
+          {
+            "fieldPath": "description",
+            "columnName": "description",
+            "affinity": "TEXT",
+            "notNull": false
+          },
+          {
+            "fieldPath": "revisionNumber",
+            "columnName": "revisionNumber",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
+          {
+            "fieldPath": "id",
+            "columnName": "id",
+            "affinity": "INTEGER",
+            "notNull": false
+          }
+        ],
+        "primaryKey": {
+          "columnNames": [
+            "id"
+          ],
+          "autoGenerate": false
+        },
+        "indices": [],
+        "foreignKeys": []
+      }
+    ],
+    "views": [],
+    "setupQueries": [
+      "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '2344eeef50e1c72dc29a552f597f8c6a')"
+    ]
+  }
+}
diff --git a/app/schemas/ai.elimu.content_provider.room.db.RoomDb/1000000.json b/app/schemas/ai.elimu.content_provider.room.db.RoomDb/1000000.json
diff --git a/app/src/main/java/ai/elimu/content_provider/rest/ImagesService.java b/app/src/main/java/ai/elimu/content_provider/rest/ImagesService.java
@@ -0,0 +1,11 @@
+package ai.elimu.content_provider.rest;
+
+import okhttp3.ResponseBody;
+import retrofit2.Call;
+import retrofit2.http.GET;
+
+public interface ImagesService {
+
+    @GET("content/images")
+    Call<ResponseBody> listImages();
+}
diff --git a/app/src/main/java/ai/elimu/content_provider/room/GsonToRoomConverter.java b/app/src/main/java/ai/elimu/content_provider/room/GsonToRoomConverter.java
@@ -1,18 +1,44 @@
 package ai.elimu.content_provider.room;
 
+import ai.elimu.content_provider.room.entity.Image;
 import ai.elimu.content_provider.room.entity.StoryBook;
 import ai.elimu.model.gson.content.StoryBookGson;
+import ai.elimu.model.gson.content.multimedia.ImageGson;
 
 public class GsonToRoomConverter {
 
+    public static Image getImage(ImageGson imageGson) {
+        if (imageGson == null) {
+            return null;
+        } else {
+            Image image = new Image();
+
+            // BaseEntity
+            image.setId(imageGson.getId());
+
+            // Content
+            image.setRevisionNumber(imageGson.getRevisionNumber());
+
+            // Image
+            image.setTitle(imageGson.getTitle());
+
+            return image;
+        }
+    }
+
     public static StoryBook getStoryBook(StoryBookGson storyBookGson) {
         if (storyBookGson == null) {
             return null;
         } else {
             StoryBook storyBook = new StoryBook();
 
+            // BaseEntity
             storyBook.setId(storyBookGson.getId());
 
+            // Content
+            storyBook.setRevisionNumber(storyBookGson.getRevisionNumber());
+
+            // StoryBook
             storyBook.setTitle(storyBookGson.getTitle());
             storyBook.setDescription(storyBookGson.getDescription());
 

diff --git a/app/src/main/java/ai/elimu/content_provider/room/dao/ImageDao.java b/app/src/main/java/ai/elimu/content_provider/room/dao/ImageDao.java
@@ -0,0 +1,26 @@
+package ai.elimu.content_provider.room.dao;
+
+import androidx.room.Dao;
+import androidx.room.Insert;
+import androidx.room.Query;
+import androidx.room.Update;
+
+import java.util.List;
+
+import ai.elimu.content_provider.room.entity.Image;
+
+@Dao
+public interface ImageDao {
+
+    @Insert
+    void insert(Image image);
+
+    @Query("SELECT * FROM Image i WHERE i.id = :id")
+    Image load(Long id);
+
+    @Query("SELECT * FROM Image")
+    List<Image> loadAll();
+
+    @Update
+    void update(Image image);
+}
diff --git a/app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java b/app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java
@@ -9,13 +9,16 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
-import ai.elimu.content_provider.BuildConfig;
+import ai.elimu.content_provider.room.dao.ImageDao;
 import ai.elimu.content_provider.room.dao.StoryBookDao;
+import ai.elimu.content_provider.room.entity.Image;
 import ai.elimu.content_provider.room.entity.StoryBook;
 
-@Database(entities = {StoryBook.class}, version = BuildConfig.VERSION_CODE)
+@Database(entities = {Image.class, StoryBook.class}, version = 1)
 public abstract class RoomDb extends RoomDatabase {
 
+    public abstract ImageDao imageDao();
+
     public abstract StoryBookDao storyBookDao();
 
     private static volatile RoomDb INSTANCE;
@@ -33,7 +36,7 @@ public static RoomDb getDatabase(final Context context) {
                                     "content_provider_db"
                             )
 //                            .addMigrations(
-//                                    MIGRATION_1000000_1000001
+//                                    MIGRATION_1_2
 //                            )
                             .build();
                 }
@@ -42,10 +45,10 @@ public static RoomDb getDatabase(final Context context) {
         return INSTANCE;
     }
 
-//    private static final Migration MIGRATION_1000000_1000001 = new Migration(1000000, 1000001) {
+//    private static final Migration MIGRATION_1_2 = new Migration(1, 2) {
 //        @Override
 //        public void migrate(@NonNull SupportSQLiteDatabase database) {
-//            Log.i(getClass().getName(), "migrate (1000000 --> 1000001)");
+//            Log.i(getClass().getName(), "migrate (1 --> 2)");
 //            Calendar timestamp = Calendar.getInstance();
 //            String sql = "ALTER TABLE StoryBookLearningEvent ADD COLUMN timestamp INTEGER NOT NULL DEFAULT " + timestamp.getTimeInMillis();
 //            Log.i(getClass().getName(), "sql: " + sql);

diff --git a/app/src/main/java/ai/elimu/content_provider/room/entity/BaseEntity.java b/app/src/main/java/ai/elimu/content_provider/room/entity/BaseEntity.java
@@ -0,0 +1,24 @@
+package ai.elimu.content_provider.room.entity;
+
+import androidx.room.PrimaryKey;
+
+/**
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ */
+public class BaseEntity {
+
+    /**
+     * Reflects the ID stored in the backend webapp's database. Therefore, {@code @PrimaryKey(autoGenerate = true)} is
+     * not used.
+     */
+    @PrimaryKey
+    private Long id;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+}
diff --git a/app/src/main/java/ai/elimu/content_provider/room/entity/Content.java b/app/src/main/java/ai/elimu/content_provider/room/entity/Content.java
@@ -0,0 +1,20 @@
+package ai.elimu.content_provider.room.entity;
+
+import androidx.annotation.NonNull;
+
+/**
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ */
+public class Content extends BaseEntity {
+
+    @NonNull
+    private Integer revisionNumber;
+
+    public Integer getRevisionNumber() {
+        return revisionNumber;
+    }
+
+    public void setRevisionNumber(Integer revisionNumber) {
+        this.revisionNumber = revisionNumber;
+    }
+}
diff --git a/app/src/main/java/ai/elimu/content_provider/room/entity/Image.java b/app/src/main/java/ai/elimu/content_provider/room/entity/Image.java
@@ -0,0 +1,22 @@
+package ai.elimu.content_provider.room.entity;
+
+import androidx.annotation.NonNull;
+import androidx.room.Entity;
+
+/**
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ */
+@Entity
+public class Image extends Content {
+
+    @NonNull
+    private String title;
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+}
diff --git a/app/src/main/java/ai/elimu/content_provider/room/entity/StoryBook.java b/app/src/main/java/ai/elimu/content_provider/room/entity/StoryBook.java
@@ -2,40 +2,23 @@
 
 import androidx.annotation.NonNull;
 import androidx.room.Entity;
-import androidx.room.PrimaryKey;
 
 /**
  * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
  */
 @Entity
-public class StoryBook {
-
-    /**
-     * The ID reflects the ID stored in the backend database. Therefore, {@code @PrimaryKey(autoGenerate = true)} is
-     * not used.
-     */
-    @PrimaryKey
-    private Long id;
+public class StoryBook extends Content {
 
     @NonNull
     private String title;
 
     private String description;
 
-    public Long getId() {
-        return id;
-    }
-
-    public void setId(Long id) {
-        this.id = id;
-    }
-
-    @NonNull
     public String getTitle() {
         return title;
     }
 
-    public void setTitle(@NonNull String title) {
+    public void setTitle(String title) {
         this.title = title;
     }