Merge remote-tracking branch 'origin/feature-5-flashcard-creator-and-remover' into feature-5-flashcard-creator-and-remover

Author: Junyu11111

README.md

@@ -4,7 +4,16 @@ This is a flashcard study application inspired by Quizlet.
 
 # Main Features
 
-### 1. Log in or sign up for the application.
+### 1a. Sign Up For The Application.
+- If the user selects the "Sign Up" option from the welcome screen the user has an option of Signing up as a user with or without admin level access 
+  - The user must select a username that does not previously exist in the database, if the user inputs a previously existing username they shall be warned with a failure in registration and must choose another username.
+  - The password needs to be greater than or equal to 5 characters in length and not blank.
+  - The repeat password must match the password entered to ensure coherency and surety.
+  - If the user does not require admin level they can leave the Admin Key field blank and they shall be registered as a common user that can access teh program.
+  - If the user does require admin level access they can input the Admin Key in the field, if there is an error in the inputting of the key the user shall be warned accordingly.
+
+### 1b. Log In For The Application.
+- 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.
 

src/main/java/login_and_signup_use_case/UserRegisterRequestModel.java

@@ -47,11 +47,6 @@ public String getRepeatPassword() {
     public String getAdminKeyEntered() {
         return adminKeyEntered;
     }
-//    public void setAdmin(boolean isAdmin) {
-//        this.isAdmin = isAdmin;
-//    }
-
-
 
 }
 

src/main/java/login_and_signup_use_case/login_and_signup_use_case_screens/UserDataMapper.java

@@ -1,6 +1,5 @@
 package login_and_signup_use_case.login_and_signup_use_case_screens;
 
-import java.time.LocalDateTime;
 import java.util.ArrayList;
 
 /**
@@ -25,7 +24,7 @@ class UserDataMapper {
     public UserDataMapper() {
     }
 
-    public UserDataMapper(String name, String password, boolean isAdmin, ArrayList<Integer> flashcardSetIds, LocalDateTime creationTime) {
+    public UserDataMapper(String name, String password, boolean isAdmin, ArrayList<Integer> flashcardSetIds) {
         super();
         this.name = name;
         this.password = password;
@@ -37,10 +36,6 @@ public String getName() {
         return name;
     }
 
-    public void setName(String name) {
-        this.name = name;
-    }
-
     public String getPassword() {
         return password;
     }
@@ -53,9 +48,5 @@ public void setPassword(String password) {
 
     public void setIsAdmin(boolean isAdmin){this.isAdmin = isAdmin;}
 
-    public ArrayList<Integer> getFlashcardSetIds(){
-        return flashcardSetIds;
-    }
-
 }
 

src/main/java/search_use_case/ResultsScreen.java

@@ -36,7 +36,7 @@ public ResultsScreen(SearchResponseModel responseModel, DBGateway gateway, UserL
         JPanel result_panel = new JPanel();
         result_panel.setLayout(new BoxLayout(result_panel, BoxLayout.Y_AXIS));
 
-        // scrollbar if results dont fit on screen
+        // scrollbar if results don't fit on screen
         JScrollPane scrPane = new JScrollPane(result_panel);
         scrPane.setPreferredSize(new Dimension(350, 500));
         scrPane.getVerticalScrollBar().setUnitIncrement(16);

src/main/java/search_use_case/SearchController.java

@@ -1,6 +1,5 @@
 package search_use_case;
 
-import java.io.IOException;
 /**
  * Search Controller
  * <p>
@@ -23,7 +22,7 @@ public SearchController(SearchInputBoundary userInput){
      * @param requestModel the request model with search input, tags, and current user
      * @return  a response model with the result set
      */
-    public SearchResponseModel create(SearchRequestModel requestModel) throws IOException {
+    public SearchResponseModel create(SearchRequestModel requestModel) {
         return userInput.create(requestModel);
     }
 }

src/main/java/search_use_case/SearchInputBoundary.java

@@ -1,6 +1,5 @@
 package search_use_case;
 
-import java.io.IOException;
 /**
  * The search input boundary.
  * <p>
@@ -14,5 +13,5 @@ public interface SearchInputBoundary {
      * @param requestModel a data-structure containing the user input, search tags, and current user
      * @return a data structure with the data required to set up the resultsScreen
      */
-    SearchResponseModel create(SearchRequestModel requestModel) throws IOException;
+    SearchResponseModel create(SearchRequestModel requestModel);
 }

src/main/java/search_use_case/SearchInteractor.java

@@ -5,7 +5,6 @@
 import data_access.entity_request_models.FlashcardSetDsRequestModel;
 import login_and_signup_use_case.UserLoginResponseModel;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collection;
 
@@ -37,7 +36,7 @@ public SearchInteractor(SearchOutputBoundary presenter, DBGateway gateway){
      * @return SearchResponseModel that contains the result set of FlashcardSets from the user search
      */
     @Override
-    public SearchResponseModel create(SearchRequestModel requestModel) throws IOException {
+    public SearchResponseModel create(SearchRequestModel requestModel) {
 
         ArrayList<FlashcardSetDsRequestModel> result_set = new ArrayList<>();
         ArrayList<Integer> flashcard_set_ids = new ArrayList<>();
@@ -87,8 +86,8 @@ public SearchResponseModel create(SearchRequestModel requestModel) throws IOExce
 
         // Return results if there is at least 1 result
         if (result_set.size() > 0){
-            SearchResponseModel searchResponseModel = new SearchResponseModel(result_set);
-            return presenter.prepareSuccessView(searchResponseModel);
+//            SearchResponseModel searchResponseModel = new SearchResponseModel(result_set);
+            return presenter.prepareSuccessView(result_set);
         }
         if (tags.size() > 0 && !input.equals("")){
             return presenter.prepareFailView("There are currently no FlashcardSets in the database.");

src/main/java/search_use_case/SearchOutputBoundary.java

@@ -1,4 +1,9 @@
 package search_use_case;
+
+import data_access.entity_request_models.FlashcardSetDsRequestModel;
+
+import java.util.ArrayList;
+
 /**
  * The search Output Boundary.
  * <p>
@@ -9,10 +14,10 @@ public interface SearchOutputBoundary {
 
     /**
      * return a Response Model with the results if there are results
-     * @param results SearchResponseModel containing the result set
+     * @param result_set the result set of flashcard sets
      * @return SearchResponseModel with changes as needed.
      */
-    SearchResponseModel prepareSuccessView(SearchResponseModel results);
+    SearchResponseModel prepareSuccessView(ArrayList<FlashcardSetDsRequestModel> result_set);
 
     /**
      * display an error if the search was unsuccessful

src/main/java/search_use_case/SearchPresenter.java

@@ -1,4 +1,9 @@
 package search_use_case;
+
+import data_access.entity_request_models.FlashcardSetDsRequestModel;
+
+import java.util.ArrayList;
+
 /**
  * The search presenter.
  * <p>
@@ -8,8 +13,8 @@
 public class SearchPresenter implements SearchOutputBoundary {
 
     @Override
-    public SearchResponseModel prepareSuccessView(SearchResponseModel results) {
-        return results;
+    public SearchResponseModel prepareSuccessView(ArrayList<FlashcardSetDsRequestModel> result_set) {
+        return new SearchResponseModel(result_set);
     }
 
     @Override

src/main/java/search_use_case/SearchResponseModel.java

@@ -12,7 +12,7 @@
  * @author Winston Chieng
  */
 public class SearchResponseModel {
-    ArrayList<FlashcardSetDsRequestModel> result_set;
+    final ArrayList<FlashcardSetDsRequestModel> result_set;
 
     /**
      * Create a SearchResponseModel