Merge pull request #92 from CSC207-2022F-UofT/feature-5-flashcard-creator-and-remover

Resolve the problem of creating duplicate flashcards with the same term.

Author: Junyu11111

src/main/java/create_flashcard_use_case/CreateFlashcardInputBoundary.java

@@ -8,5 +8,7 @@
 
 public interface CreateFlashcardInputBoundary {
     CreateFlashcardResponseModel create(CreateFlashcardRequestModel requestModel);
+    CreateFlashcardResponseModel create(CreateFlashcardRequestModel requestModel, int flashcardId);
+
 
 }

src/main/java/create_flashcard_use_case/CreateFlashcardInteractor.java

@@ -1,8 +1,5 @@
 package create_flashcard_use_case;
-
 import frameworks_and_drivers.database.DBGateway;
-import data_access_use_case.IFlashcardDataAccess;
-import data_access_use_case.IFlashcardSetDataAccess;
 import data_access_use_case.entity_request_models.FlashcardDsRequestModel;
 
 import java.time.LocalDateTime;
@@ -13,40 +10,70 @@
  */
 public class CreateFlashcardInteractor implements CreateFlashcardInputBoundary {
     CreateFlashcardOutputBoundary presenter;
-    IFlashcardDataAccess fcDataAccess;
-    IFlashcardSetDataAccess fcsDataAccess;
+    DBGateway gateway;
 
     /**
-     * Create FcCInteractor
+     * Create CreateFlashcardInteractor
      * @param gateway Database gateway.
      * @param presenter Presenter for failure or success view.
      */
     public CreateFlashcardInteractor(DBGateway gateway, CreateFlashcardOutputBoundary presenter){
         this.presenter = presenter;
-        this.fcDataAccess = gateway.getFlashcardGateway();
-        this.fcsDataAccess = gateway.getFlashcardSetGateway();
+        this.gateway = gateway;
     }
 
     /**
-     * Create flashcard with given term, definition in the given flashcard set recording the date of creation.
-     * If term or definition is empty flashcard set does not exist, returns the corresponding error.
+     * Try to create a flashcard with the given term and definition in the given flashcard set, recording the date of creation.
+     * If the term or definition is empty flashcard set does not exist, return the corresponding error.
+     * If there is already a flashcard with the same term, return the response model representing the existing flashcard.
      * @return Success or failure view.
      */
     @Override
     public CreateFlashcardResponseModel create(CreateFlashcardRequestModel requestModel) {
-        if(requestModel.getDefinition().isEmpty()||requestModel.getTerm().isEmpty()){
+        String term = requestModel.getTerm().replace("\n", " ").trim();
+        String definition = requestModel.getDefinition().replace("\n", " ").trim();
+        if(term.isEmpty() || definition.isEmpty()){
             return presenter.prepareFailView("Term or definition is empty.");
-        } else if (fcsDataAccess.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
+        }
+        else if (gateway.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
             return presenter.prepareFailView("Flashcard set does not exist.");
         }
+        for (int flashcardId : gateway.getFlashcardSet(requestModel.getFlashcardSetId()).getFlashcardIds()){
+            if (gateway.getFlashcard(flashcardId).getTerm().equals(term)){
+                return presenter.prepareDuplicateView(new CreateFlashcardResponseModel(LocalDateTime.now(), requestModel.getTerm(),
+                        gateway.getFlashcard(flashcardId).getDefinition(), flashcardId, true));
+            }
+        }
         LocalDateTime creationDate = LocalDateTime.now();
-        FlashcardDsRequestModel flashcard = new FlashcardDsRequestModel(
-                requestModel.getTerm().replace("\n", " "),
-                requestModel.getDefinition().replace("\n", " "), creationDate,-1, requestModel.getFlashcardSetId());
-        int flashcardId = fcDataAccess.saveFlashcard(flashcard);
-        fcsDataAccess.saveFlashcardID(requestModel.getFlashcardSetId(), flashcardId);
+        int flashcardId = gateway.saveFlashcard(new FlashcardDsRequestModel(term, definition, creationDate, -1,
+                requestModel.getFlashcardSetId()));
+        return presenter.prepareSuccessView(new
+                CreateFlashcardResponseModel(creationDate, term, definition, flashcardId, false));
 
-        return presenter.prepareSuccessView(new CreateFlashcardResponseModel(creationDate, requestModel.getTerm(),
-                requestModel.getDefinition()));
+    }
+
+
+    /**
+     * Try to create a flashcard with the given term and definition in the given flashcard set,
+     * overwrite the flashcard at flashcardId.
+     * If the term or definition is empty flashcard set does not exist, return the corresponding error.
+     * If there is already a flashcard with the same term, return the response model representing the existing flashcard.
+     * @param requestModel request model
+     * @param flashcardId flashcardId for the method to overwrite
+     * @return success or failure view
+     */
+    public CreateFlashcardResponseModel create(CreateFlashcardRequestModel requestModel, int flashcardId){
+        String term = requestModel.getTerm().replace("\n", " ").trim();
+        String definition = requestModel.getDefinition().replace("\n", " ").trim();
+        if(term.isEmpty() || definition.isEmpty()){
+            return presenter.prepareFailView("Term or definition is empty.");
+        }
+        else if (gateway.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
+            return presenter.prepareFailView("Flashcard set does not exist.");
+        }
+        LocalDateTime creationDate = LocalDateTime.now();
+        gateway.editFlashcard(new FlashcardDsRequestModel(term, definition, creationDate, flashcardId,
+                requestModel.getFlashcardSetId()));
+        return new CreateFlashcardResponseModel(creationDate, term, definition, flashcardId,false);
     }
 }

src/main/java/create_flashcard_use_case/CreateFlashcardOutputBoundary.java

@@ -6,6 +6,6 @@
  */
 public interface CreateFlashcardOutputBoundary {
     CreateFlashcardResponseModel prepareSuccessView(CreateFlashcardResponseModel responseModel);
-
     CreateFlashcardResponseModel prepareFailView(String error);
+    CreateFlashcardResponseModel prepareDuplicateView(CreateFlashcardResponseModel responseModel);
 }

src/main/java/create_flashcard_use_case/CreateFlashcardRequestModel.java

@@ -11,7 +11,7 @@ public class CreateFlashcardRequestModel {
     private String term, definition;
 
     /**
-     * Create FcCRequestModel
+     * Create CreateFlashcardRequestModel
      * @param flashcardSetId id of flashcard set which new flashcard will be added to
      * @param term term of the flashcard
      * @param definition definition of the flashcard

src/main/java/create_flashcard_use_case/CreateFlashcardResponseModel.java

@@ -9,17 +9,24 @@
 public class CreateFlashcardResponseModel {
     private final LocalDateTime creationDate;
     private String term, definition;
+    private int flashcardId;
+    private final Boolean existsDuplicate;
 
     /**
-     * Create FcCResponseModel
-     * @param creationDate date of creation of the flashcard
+     *Create CreateFlashcardResponseModel for flashcard creation
+     * @param creationDate date of creation
      * @param term term of the flashcard
      * @param definition definition of the flashcard
+     * @param flashcardId flashcard id of the flashcard
+     * @param existsDuplicate if there is a duplicate flashcard currently
      */
-    public CreateFlashcardResponseModel(LocalDateTime creationDate, String term, String definition) {
+    public CreateFlashcardResponseModel(LocalDateTime creationDate, String term, String definition, int flashcardId, Boolean existsDuplicate) {
         this.creationDate = creationDate;
         this.term = term;
         this.definition = definition;
+        this.flashcardId = flashcardId;
+        this.existsDuplicate = existsDuplicate;
+
     }
 
     public void setDefinition(String definition) {
@@ -30,6 +37,10 @@ public void setTerm(String term) {
         this.term = term;
     }
 
+    public void setFlashcardId(int flashcardId) {
+        this.flashcardId = flashcardId;
+    }
+
     public String getDefinition() {
         return definition;
     }
@@ -41,4 +52,12 @@ public String getTerm() {
     public LocalDateTime getCreationDate() {
         return creationDate;
     }
+
+    public int getFlashcardId() {
+        return flashcardId;
+    }
+
+    public Boolean existsDuplicate() {
+        return existsDuplicate;
+    }
 }

src/main/java/delete_flashcard_use_case/DeleteFlashcardInteractor.java

@@ -14,7 +14,7 @@ public class DeleteFlashcardInteractor implements DeleteFlashcardInputBoundary {
     DBGateway gateway;
 
     /**
-     * Create FcRInteractor.
+     * Create DeleteFlashcardInteractor.
      * @param gateway Database gateway.
      * @param presenter presenter that prepares success or failure view.
      */

src/main/java/frameworks_and_drivers/components/CreateFlashcardPanel.java

@@ -7,24 +7,26 @@
 import java.awt.*;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.time.format.DateTimeFormatter;
 
 /**
  * Panel for flashcard creator.
  * @author Junyu Chen
  */
 public class CreateFlashcardPanel extends JPanel implements ActionListener {
     CreateFlashcardController controller;
-    JTextArea term_text;
-    JTextArea definition_text;
+    JTextArea term_text, definition_text;
+    JLabel existing_term, existing_definition;
     JFrame fcCMain;
-    public CreateFlashcardPanel(CreateFlashcardController controller, JFrame fcCMain){
+
+    public CreateFlashcardPanel(CreateFlashcardController controller, JFrame fcCMain) {
         //Initiating all the sub panels.
         this.fcCMain = fcCMain;
         this.controller = controller;
         this.setLayout(new BorderLayout());
         JPanel buttonPanel = new JPanel(new FlowLayout());
-        JPanel labelPanel = new JPanel(new GridLayout(1,2));
-        JPanel textPanel = new JPanel(new GridLayout(1,2));
+        JPanel labelPanel = new JPanel(new GridLayout(1, 2));
+        JPanel textPanel = new JPanel(new GridLayout(2, 2));
 
         //Creating the button panel.
         JButton confirm = new JButton("confirm");
@@ -34,6 +36,7 @@ public CreateFlashcardPanel(CreateFlashcardController controller, JFrame fcCMain
         buttonPanel.add(confirm);
         buttonPanel.add(cancel);
 
+        //Creating the label panel.
         JLabel term_label = new JLabel("term");
         JLabel definition_label = new JLabel("definition");
         labelPanel.add(term_label);
@@ -44,48 +47,85 @@ public CreateFlashcardPanel(CreateFlashcardController controller, JFrame fcCMain
         definition_text = new JTextArea();
         term_text.setLineWrap(true);
         definition_text.setLineWrap(true);
+        existing_term = new JLabel("");
+        existing_definition = new JLabel("");
         textPanel.add(term_text);
         textPanel.add(definition_text);
+        textPanel.add(existing_term);
+        textPanel.add(existing_definition);
 
-        //Creating the label panel.
+        //Showing the sub panel.
         this.add(labelPanel, BorderLayout.NORTH);
         this.add(textPanel);
         this.add(buttonPanel, BorderLayout.SOUTH);
-        this.setSize(1000,500);
+        this.setSize(1000, 500);
         this.setVisible(true);
 
 
-
     }
 
     /**
      * Response based on creation success or failure.
+     *
      * @param e the event to be processed
      */
     @Override
     public void actionPerformed(ActionEvent e) {
-        try{
+        try {
             //Success view.
-            CreateFlashcardResponseModel responseModel = controller.create(term_text.getText().replace("\n", " "),
-                    definition_text.getText().replace("\n", " "));
-            int action = JOptionPane.showConfirmDialog(this,
-                    "Card created:\n"+responseModel.getTerm()+ "\n" + responseModel.getDefinition()
-                            +"\ncreate another card?");
-            if(action == JOptionPane.YES_OPTION){
-                term_text.setText("");
-                definition_text.setText("");
-            }else {
-                fcCMain.dispose();
+            CreateFlashcardResponseModel responseModel = controller.create(term_text.getText(),
+                    definition_text.getText(), -1);
+            if (! responseModel.existsDuplicate()) {
+                successView(responseModel);
+            } else {
+                duplicateView(responseModel);
             }
-        }catch (RuntimeException error){
+        } catch (RuntimeException error) {
             //Failure view.
-            int action = JOptionPane.showConfirmDialog(this,
-                    error + "\nRecreate?");
-            if(action == JOptionPane.YES_OPTION){
-                term_text.setText("");
-            }else {
+            Object[] options = {"re_edit", "back to flashcard set"};
+            int action = JOptionPane.showOptionDialog(this,
+                    error.getMessage(),
+                    "Failure", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE,
+                    null, options, options[0]);
+            if (action == JOptionPane.NO_OPTION) {
                 fcCMain.dispose();
             }
         }
     }
+
+    private void successView(CreateFlashcardResponseModel responseModel){
+        Object[] options = {"create another card", "back to flashcard set"};
+        int action = JOptionPane.showOptionDialog(this,
+                "Card created at "+ responseModel.getCreationDate().format(DateTimeFormatter.
+                        ofPattern("yyyy-MM-dd HH:mm")) + "\nTerm: " + responseModel.getTerm() + "\nDefinition: " +
+                        responseModel.getDefinition() + "\nid: " + responseModel.getFlashcardId(),
+                "Success", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE,
+                null, options, options[0]);
+        if (action == JOptionPane.YES_OPTION) {
+            term_text.setText("");
+            definition_text.setText("");
+        } else {
+            fcCMain.dispose();
+        }
+    }
+    private void duplicateView(CreateFlashcardResponseModel responseModel){
+        Object[] options = {"re-edit current card", "overwrite", "back to flashcard set"};
+        int action = JOptionPane.showOptionDialog(this,
+                "Term already exist:\n" + responseModel.getTerm() + "\n" + responseModel.getDefinition()
+                        + "\ncurrent card:\n"+ term_text.getText() + "\n" + definition_text.getText(),
+                "conflict", JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE,
+                null, options, options[0]);
+        if (action == JOptionPane.YES_OPTION) {
+            existing_definition.setText("<html>existing definition :<br>" + responseModel.getDefinition() +
+                    "</html>");
+            existing_term.setText("<html>existing term :<br>" + responseModel.getTerm() +
+                    "</html>");
+        } else if (action == JOptionPane.NO_OPTION) {
+            responseModel = controller.create(term_text.getText().replace("\n", " "),
+                    definition_text.getText().replace("\n", " "), responseModel.getFlashcardId());
+            successView(responseModel);
+        } else {
+            fcCMain.dispose();
+        }
+    }
 }

src/main/java/frameworks_and_drivers/components/DeleteFlashcardPanel.java

@@ -0,0 +1,61 @@
+package frameworks_and_drivers.components;
+import interface_adapters.controllers.DeleteFlashcardController;
+
+import javax.swing.*;
+import java.awt.*;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+public class DeleteFlashcardPanel extends JPanel implements ActionListener {
+    DeleteFlashcardController controller;
+    JFrame deleteScreen;
+    int flashcardId, flashcardSetId;
+
+    public DeleteFlashcardPanel(DeleteFlashcardController controller, JFrame DeleteScreen, int flashcardId, int flashcardSetId) {
+        //Initiating all the sub panels.
+        this.deleteScreen = DeleteScreen;
+        this.controller = controller;
+        this.flashcardId = flashcardId;
+        this.flashcardSetId = flashcardSetId;
+        this.setLayout(new BorderLayout());
+        JPanel buttonPanel = new JPanel(new FlowLayout());
+
+
+        //Creating the button panel.
+        JButton confirm = new JButton("confirm");
+        JButton cancel = new JButton("cancel");
+        confirm.addActionListener(this);
+        cancel.addActionListener(e -> this.deleteScreen.dispose());
+        buttonPanel.add(confirm);
+        buttonPanel.add(cancel);
+        JLabel message = new JLabel("Do you wish to delete " +  flashcardId);
+
+
+        //Creating the showing the sub panel.
+        this.add(message);
+        this.add(buttonPanel, BorderLayout.SOUTH);
+        this.setSize(1000, 500);
+        this.setVisible(true);
+
+
+    }
+
+    /**
+     * Response based on creation success or failure.
+     *
+     * @param e the event to be processed
+     */
+    @Override
+    public void actionPerformed(ActionEvent e) {
+        try {
+            //Success view.
+            controller.delete(flashcardSetId, flashcardId);
+            JOptionPane.showMessageDialog(this, "Flashcard deleted.");
+            deleteScreen.dispose();
+        } catch (RuntimeException error) {
+            //Failure view.
+            JOptionPane.showMessageDialog(this, error.getMessage());
+            deleteScreen.dispose();
+            }
+        }
+}