factory class

Author: anthony-chen-ca

src/main/java/quiz_use_case/GUI/QuestionCardFactory.java

@@ -0,0 +1,53 @@
+package quiz_use_case.GUI;
+
+import java.util.ArrayList;
+
+/**
+ * Factory that produces GUI question cards.
+ * Frameworks & Drivers
+ * @author Anthony
+ */
+public class QuestionCardFactory {
+    /**
+     * Creates a question card.
+     * @param type the type of question
+     * @param num the question number
+     * @param outputText the output text
+     * @return the question card
+     */
+    public QuestionCard createQuestionCard(String type, int num, ArrayList<String> outputText) {
+        switch(type) {
+            case "MC":
+                return new MultipleChoiceQuestionCard(num, outputText);
+            case "TE":
+                return new TextEntryQuestionCard(num, outputText);
+            case "TF":
+                return new TrueFalseQuestionCard(num, outputText);
+            default:
+                throw new IllegalArgumentException("Invalid type.");
+        }
+    }
+
+    /**
+     * Creates an answered question card.
+     * @param type the type of question
+     * @param num the question number
+     * @param outputText the output text
+     * @param userAnswer the user answer
+     * @param actualAnswer the actual answer
+     * @return the answered question card
+     */
+    public QuestionCard createAnsweredQuestionCard(String type, int num, ArrayList<String> outputText,
+                                                 String userAnswer, String actualAnswer) {
+        switch(type) {
+            case "MC":
+                return new MultipleChoiceQuestionCard(num, outputText, userAnswer, actualAnswer);
+            case "TE":
+                return new TextEntryQuestionCard(num, outputText, userAnswer, actualAnswer);
+            case "TF":
+                return new TrueFalseQuestionCard(num, outputText, userAnswer, actualAnswer);
+            default:
+                throw new IllegalArgumentException("Invalid type.");
+        }
+    }
+}

src/main/java/quiz_use_case/screens/QuizResultsScreen.java

@@ -15,12 +15,8 @@
  */
 public class QuizResultsScreen extends Screen {
     private final QuizController controller;
-
     private final int flashcardSetID;
 
-    private final ArrayList<QuestionCard> questionCards;
-
-    // actions
     private enum Actions {
         RESTART
     }
@@ -36,7 +32,7 @@ public QuizResultsScreen(QuizController controller, QuizResponseModel response,
 
         this.controller = controller;
         this.flashcardSetID = flashcardSetID;
-        this.questionCards = new ArrayList<>();
+        QuestionCardFactory questionCardFactory = new QuestionCardFactory();
 
         ArrayList<String> types = response.getTypes();
         ArrayList<ArrayList<String>> outputText = response.getOutputText();
@@ -73,25 +69,10 @@ public QuizResultsScreen(QuizController controller, QuizResponseModel response,
         c.fill = GridBagConstraints.BOTH;
 
         for (int i = 0; i < types.size(); i++) {
-            String type = types.get(i);
-            QuestionCard q;
             c.gridy = i;
-            if (type.equals("MC")) {
-                q = new MultipleChoiceQuestionCard(i+1, outputText.get(i),
-                        userAnswers.get(i),actualAnswers.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            } else if (type.equals("TE")) {
-                q = new TextEntryQuestionCard(i+1, outputText.get(i),
-                        userAnswers.get(i), actualAnswers.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            } else if (type.equals("TF")) {
-                q = new TrueFalseQuestionCard(i+1, outputText.get(i),
-                        userAnswers.get(i), actualAnswers.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            }
+            QuestionCard q = questionCardFactory.createAnsweredQuestionCard(types.get(i), i+1, outputText.get(i),
+                    userAnswers.get(i), actualAnswers.get(i));
+            centerPanel.add(q, c);
         }
 
         // SCROLL BAR
@@ -114,6 +95,10 @@ public QuizResultsScreen(QuizController controller, QuizResponseModel response,
         this.setupScreen();
     }
 
+    /**
+     * Restarts back to quiz settings screen on command.
+     * @param e the action event
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
         String command = e.getActionCommand();

src/main/java/quiz_use_case/screens/QuizScreen.java

@@ -15,23 +15,26 @@
  */
 public class QuizScreen extends Screen {
     private final QuizController controller;
-
     private final int flashcardSetID;
-
     private final ArrayList<QuestionCard> questionCards;
 
-    // actions
     private enum Actions {
         RESTART, SUBMIT
     }
 
+    /**
+     * Constructs a quiz screen.
+     * @param controller the quiz controller
+     * @param response the quiz settings response model
+     * @param flashcardSetID the flashcard set ID
+     */
     public QuizScreen(QuizController controller, QuizSettingsResponseModel response, int flashcardSetID) {
         super("Quiz", false);
 
         this.controller = controller;
         this.flashcardSetID = flashcardSetID;
-
         this.questionCards = new ArrayList<>();
+        QuestionCardFactory questionCardFactory = new QuestionCardFactory();
 
         ArrayList<String> types = response.getTypes();
         ArrayList<ArrayList<String>> outputText = response.getOutputText();
@@ -48,22 +51,10 @@ public QuizScreen(QuizController controller, QuizSettingsResponseModel response,
         c.fill = GridBagConstraints.BOTH;
 
         for (int i = 0; i < types.size(); i++) {
-            String type = types.get(i);
-            QuestionCard q;
             c.gridy = i;
-            if (type.equals("MC")) {
-                q = new MultipleChoiceQuestionCard(i+1, outputText.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            } else if (type.equals("TE")) {
-                q = new TextEntryQuestionCard(i+1, outputText.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            } else if (type.equals("TF")) {
-                q = new TrueFalseQuestionCard(i+1, outputText.get(i));
-                this.questionCards.add(q);
-                centerPanel.add(q, c);
-            }
+            QuestionCard q = questionCardFactory.createQuestionCard(types.get(i), i+1, outputText.get(i));
+            this.questionCards.add(q);
+            centerPanel.add(q, c);
         }
 
         // SCROLL BAR
@@ -89,6 +80,11 @@ public QuizScreen(QuizController controller, QuizSettingsResponseModel response,
         this.setupScreen();
     }
 
+    /**
+     * RESTART - the program returns to the quiz settings screen.
+     * SUBMIT - the program collects all user answers and proceeds to the quiz results screen.
+     * @param e the action event
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
         String command = e.getActionCommand();