Merge branch 'main' of https://github.com/CSC207-2022F-UofT/course-project-team-bbq into Anthony's_Branch

Author: anthony-chen-ca

README.md

@@ -16,6 +16,15 @@ This is a flashcard study application inspired by Quizlet.
 - If the user selects the "Log In" option from the welcome screen the user may input their respective username and password, if the username does not match an existing username from the database or incorrect password they shall be warned.
 
 ### 2. Create a flashcard or a flashcard set.
+- Flashcard Set:
+  - The user can create a flashcard set by clicking the "Add Flashcard Set" button located on the main page
+  - Once the button is clicked, the user is taken to the flashcard set creation screen
+  - The user can then enter a title and description for the flashcard set
+  - If the user clicks on "Create" with either the title or description missing, the user is alerted to include them
+  - The user can also make the flashcard set Public (unchecked box) or Private (checked box)
+  - Note: public flashcard sets are searchable by other users, while private ones are not (unless those users are Admins)
+  - If the user wishes to cancel the creation, they can do so by clicking "Cancel"
+  - Upon successful creation, the user is notified that their flashcard set has been created
 
 ### 3a. Edit a flashcard set.
  - If there are no flashcard sets on the main page, then we cannot edit a flashcard set.
@@ -29,6 +38,14 @@ This is a flashcard study application inspired by Quizlet.
    - If there are flashcards, the user can choose which flashcard to edit by clicking the "Edit Flashcard" button. When clicked a window pops up with Term and Definition text prompts for the user to edit. The user cannot change the Term to an empty term.
 
 ### 4. Delete a flashcard or a flashcard set.
+- Flashcard Set:
+  - The user can delete a flashcard set by clicking the "Delete" button located inside a flashcard set's options box on the main page
+  - When the button is clicked, the user is then taken to the flashcard set deletion screen
+  - On this screen, user can cancel the deletion at any time by clicking the "Cancel" button
+  - If the user clicks on "Delete", the user is presented with a confirmation dialog box
+  - Selecting "No" cancels the deletion and selecting "Yes" commences the deletion process 
+  - Note: deleting a flashcard set would also delete all flashcards contained within that set
+  - Upon successful deletion, the user is notified that their flashcard set has been deleted
 
 ### 5. Search for a public flashcard set.
 - If the user selects the search button from the main page the user can search through the public community database for flashcard sets

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/data_access_use_case/entity_request_models/CommonUserDsRequestModel.java

@@ -1,32 +1,58 @@
 package data_access_use_case.entity_request_models;
 
 import java.util.List;
+/**
+ * Common User Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public class CommonUserDsRequestModel {
     private final String username;
     private final String password;
     private final boolean isAdmin;
     private final List<Integer> flashcardSetIds;
 
+    /**
+     * Creates a flashcard response model based on the following parameters.
+     * @param username the user's username.
+     * @param password the user's password.
+     * @param isAdmin true if the user is an admin user.
+     * @param flashcardSetIds the list of flashcard set ids created by the user.
+     */
     public CommonUserDsRequestModel(String username, String password, boolean isAdmin, List<Integer> flashcardSetIds){
         this.username = username;
         this.password = password;
         this.isAdmin = isAdmin;
         this.flashcardSetIds = flashcardSetIds;
     }
+
+    /**
+     * Gets the username of the user
+     * @return the username of the user
+     */
     public String getUsername(){
         return username;
     }
-
+    /**
+     * Gets the password of the user
+     * @return the password of the user
+     */
     public String getPassword(){
         return password;
     }
-
+    /**
+     * Gets if the user is an admin user
+     * @return true if the user is an admin user.
+     */
     public boolean getIsAdmin(){
         return isAdmin;
     }
-
+    /**
+     * Gets the list of flashcard set ids created by the user
+     * @return the list of flashcard set ids created by the user
+     */
     public List<Integer> getFlashcardSetIds(){
-        return flashcardSetIds  ;
+        return flashcardSetIds;
     }
 }

src/main/java/data_access_use_case/entity_request_models/FlashcardDsRequestModel.java

@@ -1,7 +1,11 @@
 package data_access_use_case.entity_request_models;
-// use case layer
 
 import java.time.LocalDateTime;
+/**
+ * Flashcard Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public class FlashcardDsRequestModel {
     private String term;
@@ -10,6 +14,14 @@ public class FlashcardDsRequestModel {
     private int flashcardId;
     private final int belongsToId;
 
+    /**
+     * Creates a flashcard response model based on the following parameters.
+     * @param term the flashcard term
+     * @param definition the flashcard definition for the term
+     * @param creationDate the time the flashcard is created (time formatted in LocalDateTime)
+     * @param flashcardId the flashcard id
+     * @param belongsToId the id of the flashcard set that the flashcard is in.
+     */
     public FlashcardDsRequestModel(String term, String definition, LocalDateTime creationDate,
                                    int flashcardId, int belongsToId){
         this.term = term;
@@ -18,33 +30,54 @@ public FlashcardDsRequestModel(String term, String definition, LocalDateTime cre
         this.flashcardId = flashcardId;
         this.belongsToId = belongsToId;
     }
+    /**
+     * Gets the flashcard term.
+     * @return the flashcard term
+     */
     public String getTerm() {
         return term;
     }
-
+    /**
+     * Gets the flashcard definition.
+     * @return the flashcard definition.
+     */
     public String getDefinition() {
         return definition;
     }
-
+    /**
+     * Gets the flashcard creation date.
+     * @return the flashcard creation date in LocalDateTime formatting.
+     */
     public LocalDateTime getCreationDate() {
         return creationDate;
     }
-
+    /**
+     * Gets the flashcard id.
+     * @return the flashcard id.
+     */
     public int getFlashcardId(){
         return flashcardId;
     }
-
+    /**
+     * Gets the id of the flashcard set that the flashcard belongs to.
+     * @return the id of the flashcard set that the flashcard belongs to.
+     */
     public int getBelongsToId(){
         return belongsToId;
     }
-    public void setTerm(String term) {
-        this.term = term;
-    }
-
+    /**
+     * Sets the term.
+     */
+    public void setTerm(String term) {this.term = term;}
+    /**
+     * Sets the definition.
+     */
     public void setDefinition(String definition) {
         this.definition = definition;
     }
-
+    /**
+     * Sets the flashcard id.
+     */
     public void setFlashcardId(int flashcardId) {
         this.flashcardId = flashcardId;
     }