feat: letter-sound assessment event

pom-dependency-tree.txt

@@ -1,4 +1,4 @@
-ai.elimu:webapp:war:2.6.15-SNAPSHOT
+ai.elimu:webapp:war:2.6.16-SNAPSHOT
 +- ai.elimu:model:jar:model-2.0.97:compile
 |  \- com.google.code.gson:gson:jar:2.13.0:compile
 |     \- com.google.errorprone:error_prone_annotations:jar:2.37.0:compile

src/main/java/ai/elimu/dao/LetterSoundAssessmentEventDao.java

@@ -0,0 +1,8 @@
+package ai.elimu.dao;
+
+import ai.elimu.entity.analytics.LetterSoundAssessmentEvent;
+
+public interface LetterSoundAssessmentEventDao extends GenericDao<LetterSoundAssessmentEvent> {
+
+
+}

src/main/java/ai/elimu/dao/jpa/LetterSoundAssessmentEventDaoJpa.java

@@ -0,0 +1,9 @@
+package ai.elimu.dao.jpa;
+
+import ai.elimu.dao.LetterSoundAssessmentEventDao;
+import ai.elimu.entity.analytics.LetterSoundAssessmentEvent;
+
+public class LetterSoundAssessmentEventDaoJpa extends GenericDaoJpa<LetterSoundAssessmentEvent> implements LetterSoundAssessmentEventDao {
+
+
+}

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

@@ -0,0 +1,54 @@
+package ai.elimu.entity.analytics;
+
+import ai.elimu.entity.BaseEntity;
+import ai.elimu.entity.application.Application;
+import jakarta.persistence.Column;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.MappedSuperclass;
+import jakarta.persistence.Temporal;
+import jakarta.persistence.TemporalType;
+import jakarta.validation.constraints.NotNull;
+import java.util.Calendar;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@MappedSuperclass
+public abstract class AssessmentEvent extends BaseEntity {
+
+  @NotNull
+  @Temporal(TemporalType.TIMESTAMP)
+  private Calendar timestamp;
+
+  /**
+   * See https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID
+   */
+  @NotNull
+  private String androidId;
+
+  /**
+   * The package name of the {@link #application} where the assessment event occurred.
+   * E.g. <code>ai.elimu.soundcards</code>.
+   */
+  @NotNull
+  private String packageName;
+
+  /**
+   * This field will only be populated if a corresponding {@link Application} can be 
+   * found in the database for the {@link #packageName}.
+   */
+  @ManyToOne
+  private Application application;
+
+  /**
+   * Any additional data should be stored in the format of a JSON object.
+   * 
+   * Example:
+   * <pre>
+   * {'word_ids_presented': [1,2,3], 'word_id_selected': 2}
+   * </pre>
+   */
+  @Column(length = 1024)
+  private String additionalData;
+}

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

@@ -0,0 +1,39 @@
+package ai.elimu.entity.analytics;
+
+import jakarta.persistence.Entity;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@Entity
+public class LetterSoundAssessmentEvent extends AssessmentEvent {
+
+    /**
+     * The sequence of letters. E.g. <code>["s", "h"]</code>.
+     */
+    private String[] letterSoundLetters;
+
+    /**
+     * The sequence of sounds (IPA values). E.g. <code>["ʃ"]</code>.
+     */
+    private String [] letterSoundSounds;
+
+    /**
+     * 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 {@link #letterSoundId} will be {@code null}.
+     */
+    private Long letterSoundId;
+
+    /**
+     * A value in the range [0.0, 1.0].
+     */
+    private Float masteryScore;
+
+    /**
+     * The number of milliseconds passed between the student opening the assessment task 
+     * and submitting a response. E.g. <code>15000</code>.
+     */
+    private Long timeSpentMs;
+}

src/main/java/ai/elimu/web/analytics/students/StudentController.java

@@ -1,9 +1,11 @@
 package ai.elimu.web.analytics.students;
 
+import ai.elimu.dao.LetterSoundAssessmentEventDao;
 import ai.elimu.dao.StoryBookLearningEventDao;
 import ai.elimu.dao.StudentDao;
 import ai.elimu.dao.VideoLearningEventDao;
 import ai.elimu.dao.WordLearningEventDao;
+import ai.elimu.entity.analytics.LetterSoundAssessmentEvent;
 import ai.elimu.entity.analytics.StoryBookLearningEvent;
 import ai.elimu.entity.analytics.VideoLearningEvent;
 import ai.elimu.entity.analytics.WordLearningEvent;
@@ -33,6 +35,8 @@ public class StudentController {
 
   private final StudentDao studentDao;
 
+  private final LetterSoundAssessmentEventDao letterSoundAssessmentEventDao;
+
   private final WordLearningEventDao wordLearningEventDao;
 
   private final StoryBookLearningEventDao storyBookLearningEventDao;
@@ -46,6 +50,10 @@ public String handleRequest(@PathVariable Long studentId, Model model) {
     Student student = studentDao.read(studentId);
     log.info("student.getAndroidId(): " + student.getAndroidId());
 
+
+    List<LetterSoundAssessmentEvent> letterSoundAssessmentEvents = letterSoundAssessmentEventDao.readAll();
+    model.addAttribute("letterSoundAssessmentEvents", letterSoundAssessmentEvents);
+
 
     // Prepare chart data - WordLearningEvents
     List<WordLearningEvent> wordLearningEvents = wordLearningEventDao.readAll();

src/main/resources/META-INF/jpa-schema-export.sql

@@ -43,6 +43,8 @@
 
     drop table if exists LetterSound_Sound;
 
+    drop table if exists LetterSoundAssessmentEvent;
+
     drop table if exists LetterSoundContributionEvent;
 
     drop table if exists LetterSoundLearningEvent;
@@ -304,6 +306,21 @@
         primary key (LetterSound_id, sounds_ORDER)
     ) type=MyISAM;
 
+    create table LetterSoundAssessmentEvent (
+       id bigint not null auto_increment,
+        additionalData text,
+        androidId varchar(255),
+        packageName varchar(255),
+        timestamp datetime,
+        letterSoundId bigint,
+        letterSoundLetters varbinary(255),
+        letterSoundSounds varbinary(255),
+        masteryScore float(23),
+        timeSpentMs bigint,
+        application_id bigint,
+        primary key (id)
+    ) type=MyISAM;
+
     create table LetterSoundContributionEvent (
        id bigint not null auto_increment,
         comment text,
@@ -755,6 +772,11 @@
        foreign key (LetterSound_id) 
        references LetterSound (id);
 
+    alter table LetterSoundAssessmentEvent 
+       add constraint FKehf1rjbixnmdjol91didaj4b5 
+       foreign key (application_id) 
+       references Application (id);
+
     alter table LetterSoundContributionEvent 
        add constraint FK5uk320agfa13pvh52v6n6ncbs 
        foreign key (contributor_id) 

src/main/webapp/WEB-INF/spring/applicationContext-jpa.xml

@@ -54,6 +54,7 @@
     <bean id="imageContributionEventDao" class="ai.elimu.dao.jpa.ImageContributionEventDaoJpa" />
     <bean id="letterDao" class="ai.elimu.dao.jpa.LetterDaoJpa" />
     <bean id="letterContributionEventDao" class="ai.elimu.dao.jpa.LetterContributionEventDaoJpa" />
+    <bean id="letterSoundAssessmentEventDao" class="ai.elimu.dao.jpa.LetterSoundAssessmentEventDaoJpa" />
     <bean id="letterSoundContributionEventDao" class="ai.elimu.dao.jpa.LetterSoundContributionEventDaoJpa" />
     <bean id="letterSoundDao" class="ai.elimu.dao.jpa.LetterSoundDaoJpa" />
     <bean id="letterSoundLearningEventDao" class="ai.elimu.dao.jpa.LetterSoundLearningEventDaoJpa" />