Merge pull request #395 from elimu-ai/379-move-masteryscore-and-timespentms-to-parent-class

refactor: move masteryscore and timespentms to parent class

Author: jo-elimu

app/src/main/java/ai/elimu/analytics/entity/AssessmentEvent.kt

@@ -16,6 +16,17 @@ abstract class AssessmentEvent : BaseEntity() {
 
     lateinit var time: Calendar
 
+    /**
+     * A value in the range [0.0, 1.0].
+     */
+    var masteryScore: Float = -1f
+
+    /**
+     * The number of milliseconds passed between the student opening the assessment task
+     * and submitting a response. E.g. `15000`.
+     */
+    var timeSpentMs: Long = 0L
+
     /**
      * Any additional data should be stored in the format of a JSON object.
      *

app/src/main/java/ai/elimu/analytics/entity/LetterSoundAssessmentEvent.kt

@@ -18,20 +18,8 @@ class LetterSoundAssessmentEvent : AssessmentEvent() {
     lateinit var letterSoundSounds: String
 
     /**
-     * This field might not be included, e.g. if the assessment task was done in a
-     * 3rd-party app that did not load the content from the elimu.ai Content Provider.
-     * In this case, the `letterSoundId` will be `null`.
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
      */
     var letterSoundId: Long? = null
-
-    /**
-     * A value in the range [0.0, 1.0].
-     */
-    var masteryScore: Float = 0f
-
-    /**
-     * The number of milliseconds passed between the student opening the assessment task
-     * and submitting a response. E.g. `15000`.
-     */
-    var timeSpentMs: Long = 0L
 }

app/src/main/java/ai/elimu/analytics/entity/LetterSoundLearningEvent.kt

@@ -7,9 +7,13 @@ import androidx.room.Entity
  */
 @Entity
 class LetterSoundLearningEvent : LearningEvent() {
-    var letterSoundId: Long? = null
-
     lateinit var letterSoundLetterTexts: Array<String>
 
     lateinit var letterSoundSoundValuesIpa: Array<String>
+
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
+    var letterSoundId: Long? = null
 }

app/src/main/java/ai/elimu/analytics/entity/NumberAssessmentEvent.kt

@@ -7,13 +7,13 @@ import androidx.room.Entity
  */
 @Entity
 class NumberAssessmentEvent : AssessmentEvent() {
-    var masteryScore: Float = -1f
-
-    var timeSpentMs: Long = 0
-
     var numberValue: Int = Int.MIN_VALUE
 
     // TODO: numberSymbol
 
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var numberId: Long? = null
 }

app/src/main/java/ai/elimu/analytics/entity/NumberLearningEvent.kt

@@ -12,6 +12,10 @@ class NumberLearningEvent (val numberValue: Int) : LearningEvent() {
 
     var numberSymbol: String? = null
 
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var numberId: Long? = null
 
     @Deprecated("Will be replaced by `additionalData`")

app/src/main/java/ai/elimu/analytics/entity/StoryBookLearningEvent.kt

@@ -10,6 +10,10 @@ import androidx.room.Entity
 class StoryBookLearningEvent : LearningEvent() {
     lateinit var storyBookTitle: String
 
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var storyBookId: Long = 0L
 
     @Deprecated("Will be replaced by `additionalData`")

app/src/main/java/ai/elimu/analytics/entity/VideoLearningEvent.kt

@@ -10,6 +10,10 @@ import androidx.room.Entity
 class VideoLearningEvent : LearningEvent() {
     lateinit var videoTitle: String
 
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var videoId: Long? = null
 
     @Deprecated("Will be replaced by `additionalData`")

app/src/main/java/ai/elimu/analytics/entity/WordAssessmentEvent.kt

@@ -9,9 +9,9 @@ import androidx.room.Entity
 class WordAssessmentEvent : AssessmentEvent() {
     lateinit var wordText: String
 
+    /**
+     * This field might not be included, e.g. if the event occurred in a 3rd-party app that did not
+     * load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var wordId: Long? = null
-
-    var masteryScore: Float = 0f
-
-    var timeSpentMs: Long = 0L
 }

app/src/main/java/ai/elimu/analytics/entity/WordLearningEvent.kt

@@ -10,6 +10,10 @@ import androidx.room.Entity
 class WordLearningEvent : LearningEvent() {
     lateinit var wordText: String
 
+    /**
+     * This field might not be included, e.g. if the learning was done in a 3rd-party app that did
+     * not load the content from the elimu.ai Content Provider. In that case, this field will be {@code null}.
+     */
     var wordId: Long? = null
 
     @Deprecated("Will be replaced by `additionalData`")