refactor(dao) : LetterSound #1677

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

@@ -1,6 +1,6 @@
 package ai.elimu.dao;
 
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.contributor.Contributor;
 import ai.elimu.model.contributor.LetterSoundContributionEvent;
 import java.util.List;
@@ -10,7 +10,7 @@ public interface LetterSoundContributionEventDao extends GenericDao<LetterSoundC
 
     List<LetterSoundContributionEvent> readAllOrderedByTimeDesc() throws DataAccessException;
 
-    List<LetterSoundContributionEvent> readAll(LetterSoundCorrespondence letterSound) throws DataAccessException;
+    List<LetterSoundContributionEvent> readAll(LetterSound letterSound) throws DataAccessException;
 
     List<LetterSoundContributionEvent> readAll(Contributor contributor) throws DataAccessException;
 

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

@@ -2,16 +2,16 @@
 
 import ai.elimu.model.content.Sound;
 import ai.elimu.model.content.Letter;
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import java.util.List;
 
 import org.springframework.dao.DataAccessException;
 
-public interface LetterSoundDao extends GenericDao<LetterSoundCorrespondence> {
+public interface LetterSoundDao extends GenericDao<LetterSound> {
 
-    LetterSoundCorrespondence read(List<Letter> letters, List<Sound> sounds) throws DataAccessException;
+    LetterSound read(List<Letter> letters, List<Sound> sounds) throws DataAccessException;
 
-    List<LetterSoundCorrespondence> readAllOrderedByUsage() throws DataAccessException;
+    List<LetterSound> readAllOrderedByUsage() throws DataAccessException;
 
-    List<LetterSoundCorrespondence> readAllOrderedByLettersLength() throws DataAccessException;
+    List<LetterSound> readAllOrderedByLettersLength() throws DataAccessException;
 }

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

@@ -1,6 +1,7 @@
 package ai.elimu.dao;
 
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.contributor.Contributor;
 import ai.elimu.model.contributor.LetterSoundContributionEvent;
 import ai.elimu.model.contributor.LetterSoundPeerReviewEvent;
@@ -11,7 +12,7 @@ public interface LetterSoundPeerReviewEventDao extends GenericDao<LetterSoundPee
 
     List<LetterSoundPeerReviewEvent> readAll(LetterSoundContributionEvent letterSoundContributionEvent, Contributor contributor) throws DataAccessException;
 
-    List<LetterSoundPeerReviewEvent> readAll(LetterSoundCorrespondence letterSoundCorrespondence) throws DataAccessException;
+    List<LetterSoundPeerReviewEvent> readAll(LetterSound letterSound) throws DataAccessException;
 
     List<LetterSoundPeerReviewEvent> readAll(Contributor contributor) throws DataAccessException;
 

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

@@ -1,7 +1,7 @@
 package ai.elimu.dao.jpa;
 
 import ai.elimu.dao.LetterSoundContributionEventDao;
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.contributor.Contributor;
 import java.util.List;
 
@@ -20,7 +20,7 @@ public List<LetterSoundContributionEvent> readAllOrderedByTimeDesc() throws Data
     }
 
     @Override
-    public List<LetterSoundContributionEvent> readAll(LetterSoundCorrespondence letterSound) throws DataAccessException {
+    public List<LetterSoundContributionEvent> readAll(LetterSound letterSound) throws DataAccessException {
         return em.createQuery(
             "SELECT e " + 
             "FROM LetterSoundContributionEvent e " +

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

@@ -2,45 +2,45 @@
 
 import ai.elimu.model.content.Sound;
 import ai.elimu.model.content.Letter;
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import java.util.List;
 import java.util.stream.Collectors;
 import org.springframework.dao.DataAccessException;
 import ai.elimu.dao.LetterSoundDao;
 
-public class LetterSoundDaoJpa extends GenericDaoJpa<LetterSoundCorrespondence> implements LetterSoundDao {
+public class LetterSoundDaoJpa extends GenericDaoJpa<LetterSound> implements LetterSoundDao {
 
     @Override
-    public LetterSoundCorrespondence read(List<Letter> letters, List<Sound> sounds) throws DataAccessException {
+    public LetterSound read(List<Letter> letters, List<Sound> sounds) throws DataAccessException {
         // TODO: implement usage of CriteriaQuery/CriteriaQuery
 
-        String letterSoundCorrespondenceLetters = letters.stream().map(Letter::getText).collect(Collectors.joining());
-        String letterSoundCorrespondenceSounds = sounds.stream().map(Sound::getValueIpa).collect(Collectors.joining());
-        for (LetterSoundCorrespondence letterSoundCorrespondence : readAllOrderedByUsage()) {
-            String lettersAsString = letterSoundCorrespondence.getLetters().stream().map(Letter::getText).collect(Collectors.joining());
-            String soundsAsString = letterSoundCorrespondence.getSounds().stream().map(Sound::getValueIpa).collect(Collectors.joining());
-            if (lettersAsString.equals(letterSoundCorrespondenceLetters) && soundsAsString.equals(letterSoundCorrespondenceSounds)) {
-                return letterSoundCorrespondence;
+        String letterSoundLetters = letters.stream().map(Letter::getText).collect(Collectors.joining());
+        String letterSoundSounds = sounds.stream().map(Sound::getValueIpa).collect(Collectors.joining());
+        for (LetterSound letterSound : readAllOrderedByUsage()) {
+            String lettersAsString = letterSound.getLetters().stream().map(Letter::getText).collect(Collectors.joining());
+            String soundsAsString = letterSound.getSounds().stream().map(Sound::getValueIpa).collect(Collectors.joining());
+            if (lettersAsString.equals(letterSoundLetters) && soundsAsString.equals(letterSoundSounds)) {
+                return letterSound;
             }
         }
 
         return null;
     }
 
     @Override
-    public List<LetterSoundCorrespondence> readAllOrderedByUsage() throws DataAccessException {
+    public List<LetterSound> readAllOrderedByUsage() throws DataAccessException {
         return em.createQuery(
             "SELECT lsc " +
-            "FROM LetterSoundCorrespondence lsc " +
+            "FROM LetterSound lsc " +
             "ORDER BY lsc.usageCount DESC")
             .getResultList();
     }
 
     @Override
-    public List<LetterSoundCorrespondence> readAllOrderedByLettersLength() throws DataAccessException {
+    public List<LetterSound> readAllOrderedByLettersLength() throws DataAccessException {
         return em.createQuery(
             "SELECT lsc " +
-            "FROM LetterSoundCorrespondence lsc " +
+            "FROM LetterSound lsc " +
             "ORDER BY lsc.letters.size DESC, lsc.usageCount DESC")
             .getResultList();
     }

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

@@ -1,7 +1,7 @@
 package ai.elimu.dao.jpa;
 
 import ai.elimu.dao.LetterSoundPeerReviewEventDao;
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.contributor.Contributor;
 import ai.elimu.model.contributor.LetterSoundContributionEvent;
 import ai.elimu.model.contributor.LetterSoundPeerReviewEvent;
@@ -24,7 +24,7 @@ public List<LetterSoundPeerReviewEvent> readAll(LetterSoundContributionEvent let
     }
 
     @Override
-    public List<LetterSoundPeerReviewEvent> readAll(LetterSoundCorrespondence letterSound) throws DataAccessException {
+    public List<LetterSoundPeerReviewEvent> readAll(LetterSound letterSound) throws DataAccessException {
         return em.createQuery(
             "SELECT event " + 
             "FROM LetterSoundPeerReviewEvent event " +

src/main/java/ai/elimu/logic/converters/StringToLetterSoundConverter.java

@@ -0,0 +1,26 @@
+package ai.elimu.logic.converters;
+
+import org.apache.commons.lang.StringUtils;
+import ai.elimu.model.content.LetterSound;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.convert.converter.Converter;
+import ai.elimu.dao.LetterSoundDao;
+
+public class StringToLetterSoundConverter implements Converter<String, LetterSound> {
+
+    @Autowired
+    private LetterSoundDao letterSoundDao;
+
+    /**
+     * Convert LetterSound id to LetterSound entity
+     */
+    public LetterSound convert(String id) {
+        if (StringUtils.isBlank(id)) {
+            return null;
+        } else {
+            Long letterSoundId = Long.parseLong(id);
+            LetterSound letterSound = letterSoundDao.read(letterSoundId);
+            return letterSound;
+        }
+    }
+}

src/main/java/ai/elimu/model/content/LetterSoundCorrespondence.java → src/main/java/ai/elimu/model/content/LetterSound.java

@@ -11,7 +11,7 @@
  * Contains information about the various sounds a letter (or letter combination) can represent.
  */
 @Entity
-public class LetterSoundCorrespondence extends Content {
+public class LetterSound extends Content {
 
 //    @NotEmpty
     @OrderColumn

src/main/java/ai/elimu/model/content/Word.java

@@ -16,14 +16,14 @@
 @Entity
 public class Word extends Content {
 
-    @Deprecated // TODO: replace with list of LetterSoundCorrespondences
+    @Deprecated // TODO: replace with list of letterSounds
     @NotNull
     private String text;
 
     @NotEmpty
     @OrderColumn
     @ManyToMany(fetch = FetchType.EAGER)
-    private List<LetterSoundCorrespondence> letterSounds;
+    private List<LetterSound> letterSounds;
 
     /**
      * As an example, the verb "reading" will be linked to the root verb "read".
@@ -48,11 +48,11 @@ public void setText(String text) {
         this.text = text;
     }
 
-    public List<LetterSoundCorrespondence> getLetterSounds() {
+    public List<LetterSound> getLetterSounds() {
         return letterSounds;
     }
 
-    public void setLetterSounds(List<LetterSoundCorrespondence> letterSounds) {
+    public void setLetterSounds(List<LetterSound> letterSounds) {
         this.letterSounds = letterSounds;
     }
 

src/main/java/ai/elimu/model/contributor/LetterSoundContributionEvent.java

@@ -1,6 +1,6 @@
 package ai.elimu.model.contributor;
 
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import javax.persistence.Entity;
 import javax.persistence.ManyToOne;
 import javax.validation.constraints.NotNull;
@@ -10,13 +10,13 @@ public class LetterSoundContributionEvent extends ContributionEvent {
 
     @NotNull
     @ManyToOne
-    private LetterSoundCorrespondence letterSound;
+    private LetterSound letterSound;
 
-    public LetterSoundCorrespondence getLetterSound() {
+    public LetterSound getLetterSound() {
         return letterSound;
     }
 
-    public void setLetterSound(LetterSoundCorrespondence letterSound) {
+    public void setLetterSound(LetterSound letterSound) {
         this.letterSound = letterSound;
     }
 }

src/main/java/ai/elimu/model/contributor/LetterSoundPeerReviewEvent.java

@@ -4,7 +4,7 @@
 import javax.validation.constraints.NotNull;
 
 /**
- * An event where a {@link Contributor} peer-reviews a {@link LetterSoundCorrespondence} which 
+ * An event where a {@link Contributor} peer-reviews a {@link LetterSound} which
  * was added/edited by another {@link Contributor}.
  */
 @Entity

src/main/java/ai/elimu/rest/v2/JpaToGsonConverter.java

@@ -5,7 +5,7 @@
 import ai.elimu.model.content.Sound;
 import ai.elimu.model.content.Emoji;
 import ai.elimu.model.content.Letter;
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.content.StoryBook;
 import ai.elimu.model.content.StoryBookChapter;
 import ai.elimu.model.content.StoryBookParagraph;
@@ -82,7 +82,7 @@ public static SoundGson getSoundGson(Sound sound) {
         }
     }
 
-    public static LetterSoundGson getLetterSoundGson(LetterSoundCorrespondence letterSound) {
+    public static LetterSoundGson getLetterSoundGson(LetterSound letterSound) {
         if (letterSound == null) {
             return null;
         } else {
@@ -129,7 +129,7 @@ public static WordGson getWordGson(Word word) {
             // Word
             wordGson.setText(word.getText());
             List<LetterSoundGson> letterSounds = new ArrayList<>();
-            for (LetterSoundCorrespondence letterSound : word.getLetterSounds()) {
+            for (LetterSound letterSound : word.getLetterSounds()) {
                 LetterSoundGson letterSoundGson = getLetterSoundGson(letterSound);
                 letterSounds.add(letterSoundGson);
             }

src/main/java/ai/elimu/rest/v2/content/LetterSoundsRestController.java

@@ -1,6 +1,6 @@
 package ai.elimu.rest.v2.content;
 
-import ai.elimu.model.content.LetterSoundCorrespondence;
+import ai.elimu.model.content.LetterSound;
 import ai.elimu.model.v2.gson.content.LetterSoundGson;
 import ai.elimu.rest.v2.JpaToGsonConverter;
 import com.google.gson.Gson;
@@ -29,7 +29,7 @@ public String handleGetRequest() {
         logger.info("handleGetRequest");
 
         JSONArray letterSoundsJsonArray = new JSONArray();
-        for (LetterSoundCorrespondence letterSound : letterSoundDao.readAllOrderedByUsage()) {
+        for (LetterSound letterSound : letterSoundDao.readAllOrderedByUsage()) {
             LetterSoundGson letterSoundGson = JpaToGsonConverter.getLetterSoundGson(letterSound);
             String json = new Gson().toJson(letterSoundGson);
             letterSoundsJsonArray.put(new JSONObject(json));