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

Author: anthony-chen-ca

.idea/misc.xml

@@ -1,7 +1,6 @@
 package create_flashcard_set_use_case;
 
 import login_and_signup_use_case.UserLoginResponseModel;
-import view.Screen;
 
 import javax.swing.*;
 import java.awt.*;
@@ -11,13 +10,18 @@
 
 // Frameworks/Drivers (Blue) layer
 
-public class CreationScreen extends Screen implements ActionListener {
+/**
+ * The flashcard set creation screen.
+ *
+ * @author Edward Ishii
+ */
+public class CreationScreen extends JFrame implements ActionListener {
     /**
-     * The title of the flashcard set chosen by the user
+     * The title of the flashcard set chosen by the user.
      */
     JTextField title = new JTextField(15);
     /**
-     * The description of the flashcard set
+     * The description of the flashcard set.
      */
     JTextField description = new JTextField(15);
 //    /**
@@ -26,10 +30,13 @@ public class CreationScreen extends Screen implements ActionListener {
 //    JTextField username = new JTextField(15);
 
     /**
-     * The controller
+     * The controller.
      */
     FlashcardSetController flashcardSetController;
 
+    /**
+     * The user.
+     */
     UserLoginResponseModel user;
 
     private boolean privateSelected;  // for public or private status of flashcard set
@@ -93,10 +100,10 @@ public void actionPerformed(ActionEvent evt) {
             privateSelected = !privateSelected;  // toggle every time clicked
         } else {
             try {
-                flashcardSetController.create(title.getText(), description.getText(),
-                        privateSelected, user.getSignedInUsername());
+                FlashcardSetResponseModel responseModel = flashcardSetController.create(title.getText(),
+                        description.getText(), privateSelected, user.getSignedInUsername());
                 JOptionPane.showMessageDialog(this,
-                        String.format("Flashcard Set: [%s] created.", title.getText()));
+                        String.format("Flashcard Set: [%s] has been created.", responseModel.getFs().getTitle()));
                 this.dispose();  // exit creation screen
             } catch (FlashcardSetCreationFailed e) {
                 JOptionPane.showMessageDialog(this, e.getMessage());

src/main/java/create_flashcard_set_use_case/CreationScreen.java

@@ -3,8 +3,6 @@
 // Use case (Red) layer
 
 import data_access.DBGateway;
-import data_access.IFlashcardDataAccess;
-import data_access.IFlashcardSetDataAccess;
 
 /**
  * [Feature: Deleting a Flashcard Set]
@@ -21,8 +19,7 @@
 public class DelFlashcardSetInteractor implements DelFlashcardSetInputBoundary {
 
     DBGateway dbGateway;
-    IFlashcardSetDataAccess flashcardSetDataAccess;  // for testing
-    IFlashcardDataAccess flashcardDataAccess;  // for testing
+
     DelFlashcardSetOutputBoundary outputBoundary;
 
     public DelFlashcardSetInteractor(DBGateway dbGateway, DelFlashcardSetOutputBoundary outputBoundary) {

src/main/java/delete_flashcard_set_use_case/DelFlashcardSetInteractor.java

@@ -1,9 +1,7 @@
 package delete_flashcard_set_use_case;
 
-
 import data_access.DBGateway;
 import login_and_signup_use_case.UserLoginResponseModel;
-import view.Screen;
 
 import javax.swing.*;
 import java.awt.*;
@@ -13,18 +11,30 @@
 
 // Frameworks/Drivers (Blue) layer
 
-public class DeletionScreen extends Screen implements ActionListener {
+/**
+ * The flashcard set deletion screen.
+ *
+ * @author Edward Ishii
+ */
+public class DeletionScreen extends JFrame implements ActionListener {
     /**
-     * The id of the flashcard set to be deleted
+     * The id of the flashcard set to be deleted.
      */
     int flashcardSetID;
 
+    /**
+     * The user.
+     */
     UserLoginResponseModel user;
 
     /**
-     * The controller
+     * The controller.
      */
     DelFlashcardSetController controller;
+
+    /**
+     * The database gateway.
+     */
     DBGateway gateway;
 
 //    /**
@@ -37,7 +47,7 @@ public class DeletionScreen extends Screen implements ActionListener {
      */
     public DeletionScreen(int flashcardSetID, DelFlashcardSetController controller, UserLoginResponseModel user,
                           DBGateway gateway) {
-        this.user=user;
+        this.user = user;
         this.flashcardSetID = flashcardSetID;
         this.controller = controller;
         this.gateway = gateway;
@@ -78,19 +88,16 @@ public void actionPerformed(ActionEvent evt) {
         // Exit deletion screen if user cancels deletion
         if (Objects.equals(evt.getActionCommand(), "Cancel")) {
             this.dispose();
-        }
-
-        else {  // Delete was pressed
+        } else {  // Delete was pressed
 //            try {
 //                int id = Integer.parseInt(flashcardSetID.getText());  // check input is an integer
 
             // Ask for confirmation
             String title;
             // Admin deletion
-            if (user.getFlashcardSets().get(flashcardSetID) == null){
-                title =  gateway.getFlashcardSet(flashcardSetID).getTitle();
-            }
-            else{
+            if (user.getFlashcardSets().get(flashcardSetID) == null) {
+                title = gateway.getFlashcardSet(flashcardSetID).getTitle();
+            } else {
                 // User deletion
                 title = user.getFlashcardSets().get(flashcardSetID)[0];
             }
@@ -101,8 +108,9 @@ public void actionPerformed(ActionEvent evt) {
                     "Confirmation", JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE);
             if (confirmation == 0) {
                 try {
-                    controller.delete(flashcardSetID);
-                    JOptionPane.showMessageDialog(this, title + " has been deleted.");
+                    DelFlashcardSetResponseModel responseModel = controller.delete(flashcardSetID);
+                    responseModel.setMessage(title + " has been deleted.");
+                    JOptionPane.showMessageDialog(this, responseModel.getMessage());
                     this.dispose();  // exit deletion screen
                 } catch (FlashcardSetNotFound e) {
                     JOptionPane.showMessageDialog(this, e.getMessage());

src/main/java/delete_flashcard_set_use_case/DeletionScreen.java

@@ -69,14 +69,14 @@ else if(event.getActionCommand().equals("Delete Flashcard")){
     @Override
     public void windowOpened(WindowEvent e) {}
     @Override
-    public void windowClosing(WindowEvent e) {}
-    @Override
-    public void windowClosed(WindowEvent e) {
+    public void windowClosing(WindowEvent e) {
         //When observing a window close we refresh the page.
         frame.dispose();
         new EditorMainPage(flashcardSetId);
     }
     @Override
+    public void windowClosed(WindowEvent e) {}
+    @Override
     public void windowIconified(WindowEvent e) {}
     @Override
     public void windowDeiconified(WindowEvent e) {}

src/main/java/editor_main_page/FlashcardDataPanel.java

@@ -33,34 +33,61 @@ public CommonUser(String username, String password, boolean isAdmin){
         this.flashcardSetIds = new ArrayList<>();
     }
 
-    //GETTERS AND SETTERS
+    /**
+     * Gets the username of the user
+     * @return the username of the user
+     */
     @Override
     public String getUsername() {
         return username;
     }
 
+    /**
+     * Sets the username of the user to be as given.
+     * @param username the username of the use
+     */
     public void setUsername(String username) {
         this.username = username;
     }
 
+    /**
+     * Gets the password of the user
+     * @return the password of the user
+     */
     @Override
     public String getPassword() {
         return password;
     }
 
+    /**
+     * Sets the password of the user to be as given.
+     * @param password the username of the use
+     */
     public void setPassword(String password) {
         this.password = password;
     }
 
+    /**
+     * Gets the admin access level of the user
+     * @return whether the user is an admin
+     */
     @Override
     public boolean getIsAdmin() {
         return isAdmin;
     }
 
+    /**
+     * Sets the level of admin access the user has
+     * @param isAdmin whether the user should obtain admin level access
+     */
     public void setIsAdmin(boolean isAdmin){
         this.isAdmin = isAdmin;
     }
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user
+     * @return list of flashcard set ids
+     */
     @Override
     public ArrayList<Integer> getFlashcardSetIds() {
         return flashcardSetIds;
@@ -77,7 +104,7 @@ public boolean passwordIsValid() {
 
     /**
      * Checks whether the admin key entered is similar to the actual admin key in the business rules
-     * @param adminKey the username of the use
+     * @param adminKey the username of the user
      * @return whether the admin is the same as the one stored in the enterprise rules
      */
     @Override

src/main/java/entities/CommonUser.java

@@ -10,20 +10,27 @@
  */
 public interface User {
     String username = null;
-
     String password = null;
     boolean isAdmin = false;
-    String ADMIN_KEY = "BuiltDifferent";
-
-    //Map<Integer, String[]> flashcardSets = null;
-    ArrayList<Integer> flashcardSetIds = null;
 
+    /**
+     * Gets the username belonging to the user
+     */
     String getUsername();
 
+    /**
+     * Gets the password belonging to the user
+     */
     String getPassword();
 
+    /**
+     * Gets whether the user is an admin user
+     */
     boolean getIsAdmin();
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user
+     */
     ArrayList<Integer> getFlashcardSetIds();
 
     /**

src/main/java/entities/User.java

@@ -45,6 +45,7 @@ public UserLoginResponseModel login(UserLoginRequestModel userLoginRequestModel)
         }
 
         UserLoginResponseModel accountResponseModel = new UserLoginResponseModel(tempUser.getUsername(),
+                tempUser.getPassword(),
                 tempUser.getIsAdmin(), flashcardSets);
         return userLoginOutputBoundary.prepareSuccessView(accountResponseModel);
     }

src/main/java/login_and_signup_use_case/UserLoginInteractor.java

@@ -21,12 +21,17 @@ public UserLoginRequestModel(String username, String password) {
     }
 
     /**
-     * GETTERS AND SETTERS
+     * Gets the inputted username of the user
+     * @return the username that the user inputted
      */
     String getUsername() {
         return username;
     }
 
+    /**
+     * Sets the inputted password of the user to be as given.
+     * @return the password that the user inputted
+     */
     String getPassword() {
         return password;
     }

src/main/java/login_and_signup_use_case/UserLoginRequestModel.java

@@ -10,6 +10,8 @@
 public class UserLoginResponseModel {
     String username;
 
+    String password;
+
     boolean isAdmin;
 
     Map<Integer, String[]> flashcardSets;
@@ -21,20 +23,38 @@ public class UserLoginResponseModel {
      * @param flashcardSets the flashcard sets map pertaining to the user obtained by the login interactor, where each id
      *                      pertains to its title and description
      */
-    public UserLoginResponseModel(String loggedInUsername, boolean isAdmin, Map<Integer, String[]> flashcardSets){
+    public UserLoginResponseModel(String loggedInUsername, String password, boolean isAdmin, Map<Integer, String[]> flashcardSets){
         this.username = loggedInUsername;
+        this.password = password;
         this.isAdmin = isAdmin;
         this.flashcardSets = flashcardSets;
     }
 
     /**
-     * GETTERS for the system
+     * Gets the username of the user as saved in the database
+     * @return the username that the user stored
      */
     public String getSignedInUsername() {
         return username;
     }
+
+    /**
+     * Gets the password of the user as saved in the database
+     * @return the password that the user stored
+     */
+    public String getPassword() { return password; }
+
+    /**
+     * Gets whether the user is saved as an admin in the database
+     * @return the admin level access of the user as stored in the database
+     */
     public boolean getIsAdmin(){return isAdmin;}
 
+    /**
+     * Gets the list of flashcard set ids belonging to the user and onverts it into a map with the id as
+     * a key and the title and description of the flashcard set as the value in a string array format
+     * @return map of the flashcard sets belonging to the user
+     */
     public Map<Integer, String[]> getFlashcardSets(){
 
         return flashcardSets;