Merge pull request #89 from CSC207-2022F-UofT/Anthony's_Branch

Anthony's branch

Author: anthony-chen-ca

.idea/misc.xml

@@ -7,8 +7,8 @@ repositories {
 }
 
 dependencies {
-    implementation 'junit:junit:4.13.1'
-    testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
+    implementation 'junit:junit:4.13.2'
+    testImplementation('org.junit.jupiter:junit-jupiter:5.9.0')
     implementation 'com.formdev:flatlaf:2.6'
 }
 

build.gradle

@@ -4,7 +4,7 @@
 import create_flashcard_use_case.fcCScreens.FcCResponsePresenter;
 import create_flashcard_use_case.fcCScreens.FcCScreen;
 import data_access.*;
-import view.Screen;
+import frameworks_and_drivers.Screen;
 
 import javax.swing.*;
 import java.io.IOException;

src/main/java/create_flashcard_use_case/FcCMain.java

@@ -3,7 +3,7 @@
 import data_access.*;
 import delete_flashcard_use_case.FcRScreens.FcRController;
 import delete_flashcard_use_case.FcRScreens.FcRResponsePresenter;
-import view.Screen;
+import frameworks_and_drivers.Screen;
 
 import javax.swing.*;
 import java.io.IOException;

src/main/java/delete_flashcard_use_case/FcRMain.java

@@ -5,7 +5,7 @@
 import edit_flashcard_set_use_case.screens.FCSetEditorScreen;
 import data_access.DBGateway;
 import data_access.entity_request_models.FlashcardSetDsRequestModel;
-import view.Screen;
+import frameworks_and_drivers.Screen;
 
 public class FCSetEditorMain extends Screen {
     /**

src/main/java/edit_flashcard_set_use_case/FCSetEditorMain.java

@@ -5,7 +5,7 @@
 import edit_flashcard_use_case.screens.FlashcardEditorScreen;
 import data_access.*;
 import data_access.entity_request_models.FlashcardDsRequestModel;
-import view.Screen;
+import frameworks_and_drivers.Screen;
 
 public class FlashcardEditorMain extends Screen {
     /**

src/main/java/edit_flashcard_use_case/FlashcardEditorMain.java

@@ -3,7 +3,7 @@
 import data_access.*;
 import data_access.entity_request_models.FlashcardDsRequestModel;
 import data_access.entity_request_models.FlashcardSetDsRequestModel;
-import view.Screen;
+import frameworks_and_drivers.Screen;
 
 import javax.swing.*;
 import java.io.IOException;

src/main/java/editor_main_page/EditorMainPage.java

@@ -10,14 +10,22 @@
  * @author Anthony
  */
 public class MultipleChoiceQuestion extends QuizQuestion {
+    /* If given term is true, then the term is the initial prompt.
+    If given term is false, then the definition is the initial prompt.
+     */
     private final boolean givenTerm;
 
     private String question;
-    private String[] choices;
+    private final String[] choices;
     private final int numChoices = 4;
 
     private static final Random rand = new Random();
 
+    /**
+     * Constructs a multiple choice question.
+     * @param flashcards the list of flashcards
+     * @param index the index of a specific flashcard
+     */
     public MultipleChoiceQuestion(List<Flashcard> flashcards, int index) {
         this.givenTerm = rand.nextBoolean();
         this.choices = new String[numChoices];
@@ -54,6 +62,10 @@ public void generateQuestion(List<Flashcard> flashcards, int index) {
         }
     }
 
+    /**
+     * Returns the string representation of the multiple choice question.
+     * @return string representation
+     */
     @Override
     public String toString() {
         StringBuilder s = new StringBuilder("Prompt: " + this.question + "\n");
@@ -63,15 +75,26 @@ public String toString() {
         return s.toString();
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the question.
+     * @return the question
+     */
     public String getQuestion() {
         return question;
     }
 
+    /**
+     * Sets the question.
+     * @param question the question
+     */
     public void setQuestion(String question) {
         this.question = question;
     }
 
+    /**
+     * Sets the choices.
+     * @return the choices
+     */
     public String[] getChoices() {
         return choices;
     }

src/main/java/entities/MultipleChoiceQuestion.java

@@ -16,7 +16,7 @@ public class Quiz {
 
     private int score;
 
-    private static final Random rand = new Random();
+    private static final Random rand = new Random(); // used for calculating random numbers
 
     /**
      * Precondition: flashcards contains at least 4 flashcards, and at least 1 question type is enabled in quizSettings.
@@ -37,7 +37,7 @@ public Quiz(QuizSettings quizSettings, List<Flashcard> flashcards) {
     public void generateQuestions() {
         int numQuestions = this.quizSettings.getNumQuestions();
 
-        ArrayList<String> types = new ArrayList<String>();
+        List<String> types = new ArrayList<>();
         if (this.quizSettings.isTrueFalseOn()) {
             types.add("TF");
         }
@@ -72,39 +72,50 @@ public void evaluate() {
         }
     }
 
-    /** GETTERS AND SETTERS **/
-    public ArrayList<String> getUserAnswers() {
-        ArrayList<String> userAnswers = new ArrayList<>();
-        for (QuizQuestion q : this.quizQuestions) {
-            userAnswers.add(q.getUserAnswer());
-        }
-        return userAnswers;
-    }
-
-    public void setUserAnswers(ArrayList<String> userAnswers) {
+    /**
+     * Sets the user answers.
+     * @param userAnswers the user answers
+     */
+    public void setUserAnswers(List<String> userAnswers) {
         for (int i = 0; i < userAnswers.size(); i++) {
             QuizQuestion q = this.quizQuestions.get(i);
             String a = userAnswers.get(i);
             q.setUserAnswer(a);
         }
     }
 
-    public ArrayList<String> getActualAnswers() {
-        ArrayList<String> actualAnswers = new ArrayList<>();
+    /**
+     * Gets the actual answers.
+     * @return the actual answers
+     */
+    public List<String> getActualAnswers() {
+        List<String> actualAnswers = new ArrayList<>();
         for (QuizQuestion q : this.quizQuestions) {
             actualAnswers.add(q.getActualAnswer());
         }
         return actualAnswers;
     }
 
+    /**
+     * Gets the quiz questions.
+     * @return the quiz questions
+     */
     public List<QuizQuestion> getQuizQuestions() {
         return this.quizQuestions;
     }
 
+    /**
+     * Gets the quiz score.
+     * @return the score
+     */
     public int getScore() {
         return this.score;
     }
 
+    /**
+     * Gets the number of questions.
+     * @return the number of questions
+     */
     public int getNumQuestions() {
         return this.quizQuestions.size();
     }

src/main/java/entities/Quiz.java

@@ -27,19 +27,22 @@ public boolean isCorrect(){
         return this.actualAnswer.equalsIgnoreCase(this.userAnswer);
     }
 
-    /** GETTERS AND SETTERS **/
+    /**
+     * Gets the actual answer.
+     * @return the actual answer
+     */
     public String getActualAnswer() {
         return actualAnswer;
     }
 
+    /**
+     * Sets the actual answer.
+     * @param actualAnswer the actual answer
+     */
     public void setActualAnswer(String actualAnswer) {
         this.actualAnswer = actualAnswer;
     }
 
-    public String getUserAnswer() {
-        return userAnswer;
-    }
-
     /**
      * Sets the user answer. If the user answer is null or empty, the user answer should be set to null.
      * @param userAnswer the user answer