Calculate new "marks" field for question attempts in the database

src/main/java/uk/ac/cam/cl/dtg/isaac/api/managers/GameManager.java

@@ -149,7 +149,7 @@ public GameManager(final GitContentManager contentManager,
      *            list of question categories (i.e. problem_solving, book) to include in filtered results
      * @param boardOwner
      *            The user that should be marked as the creator of the gameBoard.
-     * @return a gameboard if possible that satisifies the conditions provided by the parameters. Will return null if no
+     * @return a gameboard if possible that satisfies the conditions provided by the parameters. Will return null if no
      *         questions can be provided.
      * @throws SegueDatabaseException
      *             - if there is an error contacting the database.

src/main/java/uk/ac/cam/cl/dtg/isaac/dao/PgQuizQuestionAttemptPersistenceManager.java

@@ -59,8 +59,8 @@ public PgQuizQuestionAttemptPersistenceManager(final PostgresSqlDb database, fin
     @Override
     public void registerQuestionAttempt(Long quizAttemptId, QuestionValidationResponse questionResponse) throws SegueDatabaseException {
 
-        String query = "INSERT INTO quiz_question_attempts(quiz_attempt_id, question_id, question_attempt, correct, \"timestamp\")" +
-                " VALUES (?, ?, ?::text::jsonb, ?, ?);";
+        String query = "INSERT INTO quiz_question_attempts(quiz_attempt_id, question_id, question_attempt, correct, marks, \"timestamp\")" +
+                " VALUES (?, ?, ?::text::jsonb, ?, ?, ?);";
         try (Connection conn = database.getDatabaseConnection();
             PreparedStatement pst = conn.prepareStatement(query, Statement.RETURN_GENERATED_KEYS);
         ) {
@@ -73,7 +73,14 @@ public void registerQuestionAttempt(Long quizAttemptId, QuestionValidationRespon
             } else {
                 pst.setNull(4, Types.BOOLEAN);
             }
-            pst.setTimestamp(5, new java.sql.Timestamp(questionResponse.getDateAttempted().getTime()));
+
+            if (questionResponse.getMarks() != null) {
+                pst.setInt(5, questionResponse.getMarks());
+            } else {
+                pst.setInt(5, java.sql.Types.NULL);
+            }
+
+            pst.setTimestamp(6, new java.sql.Timestamp(questionResponse.getDateAttempted().getTime()));
 
             if (pst.executeUpdate() == 0) {
                 throw new SegueDatabaseException("Unable to save quiz question attempt.");

src/main/java/uk/ac/cam/cl/dtg/isaac/dos/LLMFreeTextQuestionValidationResponse.java

@@ -1,5 +1,6 @@
 package uk.ac.cam.cl.dtg.isaac.dos;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import uk.ac.cam.cl.dtg.isaac.dos.content.Choice;
 import uk.ac.cam.cl.dtg.isaac.dos.content.Content;
 import uk.ac.cam.cl.dtg.isaac.dos.content.DTOMapping;
@@ -9,9 +10,9 @@
 import java.util.Date;
 import java.util.List;
 
+@JsonIgnoreProperties({ "marksAwarded" })
 @DTOMapping(LLMFreeTextQuestionValidationResponseDTO.class)
 public class LLMFreeTextQuestionValidationResponse extends QuestionValidationResponse {
-    private Integer marksAwarded;
     private List<LLMFreeTextMarkSchemeEntry> markBreakdown;
 
     public LLMFreeTextQuestionValidationResponse() {
@@ -23,13 +24,6 @@ public LLMFreeTextQuestionValidationResponse(final String questionId, final Choi
         super(questionId, answer, correct, explanation, dateAttempted);
     }
 
-    public Integer getMarksAwarded() {
-        return marksAwarded;
-    }
-    public void setMarksAwarded(Integer marksAwarded) {
-        this.marksAwarded = marksAwarded;
-    }
-
     public List<LLMFreeTextMarkSchemeEntry> getMarkBreakdown() {
         return markBreakdown;
     }

src/main/java/uk/ac/cam/cl/dtg/isaac/dos/LightweightQuestionValidationResponse.java

@@ -10,6 +10,7 @@ public class LightweightQuestionValidationResponse {
     private String questionId;
     private Boolean correct;
     private Date dateAttempted;
+    private Integer marks;
 
     /**
      * Default Constructor for mappers.
@@ -25,13 +26,34 @@ public LightweightQuestionValidationResponse() {
      *            -
      * @param correct
      *            -
+     * @param marks
+     *            -
+     * @param dateAttempted
+     *            -
+     */
+    public LightweightQuestionValidationResponse(final String questionId, final Boolean correct,
+                                                 final Integer marks, final Date dateAttempted) {
+        this.questionId = questionId;
+        this.correct = correct;
+        this.marks = marks;
+        this.dateAttempted = dateAttempted;
+    }
+
+    /**
+     * Constructor without specifying marks (instead derived from 'correct')
+     *
+     * @param questionId
+     *            -
+     * @param correct
+     *            -
      * @param dateAttempted
      *            -
      */
     public LightweightQuestionValidationResponse(final String questionId, final Boolean correct,
                                                  final Date dateAttempted) {
         this.questionId = questionId;
         this.correct = correct;
+        this.marks = (correct != null && correct) ? 1 : 0;
         this.dateAttempted = dateAttempted;
     }
 
@@ -73,6 +95,25 @@ public final void setCorrect(final Boolean correct) {
         this.correct = correct;
     }
 
+    /**
+     * Gets the marks.
+     *
+     * @return the marks
+     */
+    public Integer getMarks() {
+        return marks;
+    }
+
+    /**
+     * Sets the marks.
+     *
+     * @param marks
+     *            the marks to set
+     */
+    public void setMarks(final Integer marks) {
+        this.marks = marks;
+    }
+
     /**
      * Gets the dateAttempted.
      *
@@ -95,6 +136,6 @@ public void setDateAttempted(final Date dateAttempted) {
     @Override
     public String toString() {
         return "QuestionValidationResponse [questionId=" + questionId + ", correct=" + correct +
-                ", dateAttempted=" + dateAttempted + "]";
+                ", marks=" + marks + ", dateAttempted=" + dateAttempted + "]";
     }
 }

src/main/java/uk/ac/cam/cl/dtg/isaac/dos/QuestionValidationResponse.java

@@ -47,6 +47,29 @@ public QuestionValidationResponse() {
      *            -
      * @param correct
      *            -
+     * @param marks
+     *            -
+     * @param explanation
+     *            -
+     * @param dateAttempted
+     *            -
+     */
+    public QuestionValidationResponse(final String questionId, final Choice answer, final Boolean correct,
+            final Integer marks, final Content explanation, final Date dateAttempted) {
+        super(questionId, correct, marks, dateAttempted);
+        this.answer = answer;
+        this.explanation = explanation;
+    }
+
+    /**
+     * Constructor without specifying marks (instead derived from 'correct')
+     *
+     * @param questionId
+     *            -
+     * @param answer
+     *            -
+     * @param correct
+     *            -
      * @param explanation
      *            -
      * @param dateAttempted
@@ -101,7 +124,7 @@ public final void setExplanation(final Content explanation) {
     public String toString() {
         return "QuestionValidationResponse [questionId=" + super.getQuestionId() + ", answer=" + answer +
                 ", correct=" + super.isCorrect() + ", explanation=" + explanation +
-                ", dateAttempted=" + super.getDateAttempted() + "]";
+                ", marks=" + super.getMarks() + ", dateAttempted=" + super.getDateAttempted() + "]";
     }
 
 }

src/main/java/uk/ac/cam/cl/dtg/isaac/dto/LLMFreeTextQuestionValidationResponseDTO.java

@@ -1,23 +1,17 @@
 package uk.ac.cam.cl.dtg.isaac.dto;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import uk.ac.cam.cl.dtg.isaac.dto.content.LLMFreeTextMarkSchemeEntryDTO;
 
 import java.util.List;
 
+@JsonIgnoreProperties({ "marksAwarded" })
 public class LLMFreeTextQuestionValidationResponseDTO extends QuestionValidationResponseDTO {
-    private Integer marksAwarded;
     private List<LLMFreeTextMarkSchemeEntryDTO> markBreakdown;
 
     public LLMFreeTextQuestionValidationResponseDTO() {
     }
 
-    public Integer getMarksAwarded() {
-        return marksAwarded;
-    }
-    public void setMarksAwarded(Integer marksAwarded) {
-        this.marksAwarded = marksAwarded;
-    }
-
     public List<LLMFreeTextMarkSchemeEntryDTO> getMarkBreakdown() {
         return markBreakdown;
     }

src/main/java/uk/ac/cam/cl/dtg/isaac/dto/QuestionValidationResponseDTO.java

@@ -17,6 +17,8 @@
 
 import java.util.Date;
 
+import uk.ac.cam.cl.dtg.isaac.dos.content.Choice;
+import uk.ac.cam.cl.dtg.isaac.dos.content.Content;
 import uk.ac.cam.cl.dtg.isaac.dto.content.ChoiceDTO;
 import uk.ac.cam.cl.dtg.isaac.dto.content.ContentDTO;
 
@@ -28,6 +30,7 @@ public class QuestionValidationResponseDTO {
     private String questionId;
     private ChoiceDTO answer;
     private Boolean correct;
+    private Integer marks;
     private ContentDTO explanation;
     private Date dateAttempted;
 
@@ -47,20 +50,48 @@ public QuestionValidationResponseDTO() {
      *            -
      * @param correct
      *            -
+     * @param marks
+     *            -
+     * @param explanation
+     *            -
+     * @param dateAttempted
+     *            -
+     */
+    public QuestionValidationResponseDTO(final String questionId, final ChoiceDTO answer, final Boolean correct,
+            final Integer marks, final ContentDTO explanation, final Date dateAttempted) {
+        this.questionId = questionId;
+        this.answer = answer;
+        this.correct = correct;
+        this.marks = marks;
+        this.explanation = explanation;
+        this.dateAttempted = dateAttempted;
+    }
+
+    /**
+     * Constructor without specifying marks (instead derived from 'correct')
+     *
+     * @param questionId
+     *            -
+     * @param answer
+     *            -
+     * @param correct
+     *            -
      * @param explanation
      *            -
      * @param dateAttempted
      *            -
      */
     public QuestionValidationResponseDTO(final String questionId, final ChoiceDTO answer, final Boolean correct,
-            final ContentDTO explanation, final Date dateAttempted) {
+                                      final ContentDTO explanation, final Date dateAttempted) {
         this.questionId = questionId;
         this.answer = answer;
         this.correct = correct;
+        this.marks = (correct != null && correct) ? 1 : 0;
         this.explanation = explanation;
         this.dateAttempted = dateAttempted;
     }
 
+
     /**
      * Gets the questionId.
      * 
@@ -118,6 +149,25 @@ public final void setCorrect(final Boolean correct) {
         this.correct = correct;
     }
 
+    /**
+     * Gets the marks.
+     *
+     * @return the marks
+     */
+    public Integer getMarks() {
+        return marks;
+    }
+
+    /**
+     * Sets the marks.
+     *
+     * @param marks
+     *            the marks to set
+     */
+    public void setMarks(final Integer marks) {
+        this.marks = marks;
+    }
+
     /**
      * Gets the explanation.
      * 
@@ -159,6 +209,6 @@ public void setDateAttempted(final Date dateAttempted) {
     @Override
     public String toString() {
         return "QuestionValidationResponseDTO [questionId=" + questionId + ", answer=" + answer + ", correct="
-                + correct + ", explanation=" + explanation + ", dateAttempted=" + dateAttempted + "]";
+                + correct + ", marks=" + marks + ", explanation=" + explanation + ", dateAttempted=" + dateAttempted + "]";
     }
 }

src/main/java/uk/ac/cam/cl/dtg/isaac/quiz/IsaacLLMFreeTextValidator.java

@@ -276,6 +276,7 @@ private int evaluateMarkTotal(final IsaacLLMFreeTextQuestion question, final Map
      * @param question the question being marked so that we can return the mark scheme.
      * @param answer the user's attempt at the question.
      * @param awardedMarks the marks awarded for each field in the mark scheme according to the LLM response.
+     * @param markTotal the calculated mark value based on which individual marks were awarded
      * @return a response to the user's attempt at the question.
      */
     private LLMFreeTextQuestionValidationResponse generateQuestionValidationResponse(
@@ -294,7 +295,7 @@ private LLMFreeTextQuestionValidationResponse generateQuestionValidationResponse
 
         LLMFreeTextQuestionValidationResponse validationResponse = new LLMFreeTextQuestionValidationResponse(
                 question.getId(), answer, isConsideredCorrect, null, new Date());
-        validationResponse.setMarksAwarded(markTotal);
+        validationResponse.setMarks(markTotal);
         validationResponse.setMarkBreakdown(markBreakdown);
         return validationResponse;
     }

src/main/java/uk/ac/cam/cl/dtg/isaac/quiz/PgQuestionAttempts.java

@@ -186,8 +186,8 @@ public Map<String, Map<String, List<QuestionValidationResponse>>> getAnonymousQu
     public void registerQuestionAttempt(final Long userId, final String questionPageId, final String fullQuestionId,
             final QuestionValidationResponse questionAttempt) throws SegueDatabaseException {
 
-        String query = "INSERT INTO question_attempts(user_id, page_id, question_id, question_attempt, correct, \"timestamp\")"
-                + " VALUES (?, ?, ?, ?::text::jsonb, ?, ?);";
+        String query = "INSERT INTO question_attempts(user_id, page_id, question_id, question_attempt, correct, marks, \"timestamp\")"
+                + " VALUES (?, ?, ?, ?::text::jsonb, ?, ?, ?);";
         try (Connection conn = database.getDatabaseConnection();
              PreparedStatement pst = conn.prepareStatement(query, Statement.RETURN_GENERATED_KEYS);
         ) {
@@ -201,7 +201,14 @@ public void registerQuestionAttempt(final Long userId, final String questionPage
             } else {
                 pst.setNull(5, java.sql.Types.NULL);
             }
-            pst.setTimestamp(6, new java.sql.Timestamp(questionAttempt.getDateAttempted().getTime()));
+
+            if (questionAttempt.getMarks() != null) {
+                pst.setInt(6, questionAttempt.getMarks());
+            } else {
+                pst.setInt(6, java.sql.Types.NULL);
+            }
+
+            pst.setTimestamp(7, new java.sql.Timestamp(questionAttempt.getDateAttempted().getTime()));
 
             if (pst.executeUpdate() == 0) {
                 throw new SegueDatabaseException("Unable to save question attempt.");
@@ -260,7 +267,7 @@ public Map<Long, Map<String, Map<String, List<LightweightQuestionValidationRespo
             return Collections.emptyMap();
         }
 
-        String query = "SELECT id, user_id, question_id, correct, timestamp FROM question_attempts"
+        String query = "SELECT id, user_id, question_id, correct, marks, timestamp FROM question_attempts"
                      + " WHERE user_id = ANY(?) ORDER BY \"timestamp\" ASC";
 
         Map<Long, Map<String, Map<String, List<LightweightQuestionValidationResponse>>>> mapToReturn
@@ -307,7 +314,7 @@ public Map<String, Map<String, List<LightweightQuestionValidationResponse>>> get
                 = userIds.stream().collect(Collectors.toMap(Function.identity(), k -> Maps.newHashMap()));;
 
         try (Connection conn = database.getDatabaseConnection()) {
-            String query = "SELECT id, user_id, question_id, correct, timestamp FROM question_attempts"
+            String query = "SELECT id, user_id, question_id, correct, marks, timestamp FROM question_attempts"
                          + " WHERE user_id = ANY(?) AND page_id = ANY(?)"
                          + " ORDER BY \"timestamp\" ASC";
 
@@ -441,6 +448,12 @@ private LightweightQuestionValidationResponse resultsToLightweightValidationResp
         partialQuestionAttempt.setCorrect(results.getBoolean("correct"));
         partialQuestionAttempt.setQuestionId(results.getString("question_id"));
         partialQuestionAttempt.setDateAttempted(results.getTimestamp("timestamp"));
+        int marks = results.getInt("marks");
+        if (results.wasNull()) {
+            partialQuestionAttempt.setMarks(0);
+        } else {
+            partialQuestionAttempt.setMarks(marks);
+        }
 
         return partialQuestionAttempt;
     }