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

Author: anthony-chen-ca

src/main/java/create_flashcard_set_use_case/FlashcardSetController.java

@@ -2,18 +2,37 @@
 
 // Interface adapters (Green) layer
 
+/**
+ * The controller for flashcard set creation.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetController {
 
-    FlashcardSetInputBoundary userInput;
+    FlashcardSetInputBoundary interactor;
 
-    public FlashcardSetController(FlashcardSetInputBoundary userInput) {
-        this.userInput = userInput;
+    /**
+     * Constructs a new FlashcardSetController.
+     *
+     * @param interactor the use case interactor for creating flashcard sets.
+     */
+    public FlashcardSetController(FlashcardSetInputBoundary interactor) {
+        this.interactor = interactor;
     }
 
+    /**
+     * Creates a new flashcard set and stores it into the database.
+     *
+     * @param title       the title of the flashcard set.
+     * @param description the description of the flashcard set.
+     * @param isPrivate   the privacy of the flashcard set.
+     * @param username    the owner's username of the flashcard set.
+     * @return the response model containing the newly created flashcard set data.
+     */
     FlashcardSetResponseModel create(String title, String description, boolean isPrivate, String username) {
         FlashcardSetRequestModel requestModel = new FlashcardSetRequestModel(title, description,
                 isPrivate, username);
 
-        return userInput.create(requestModel);
+        return interactor.create(requestModel);
     }
 }

src/main/java/create_flashcard_set_use_case/FlashcardSetCreationFailed.java

@@ -1,6 +1,17 @@
 package create_flashcard_set_use_case;
 
+/**
+ * An exception class for when flashcard set creation fails.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetCreationFailed extends RuntimeException {
+
+    /**
+     * Throws a FlashcardSetCreationFailed error.
+     *
+     * @param error message of the error.
+     */
     public FlashcardSetCreationFailed(String error) {
         super(error);
     }

src/main/java/create_flashcard_set_use_case/FlashcardSetInputBoundary.java

@@ -2,6 +2,19 @@
 
 // Use case (Red) layer
 
+/**
+ * The input boundary interface for creating flashcard sets.
+ *
+ * @author Edward Ishii
+ */
+
 public interface FlashcardSetInputBoundary {
+
+    /**
+     * Create a new flashcard set and store it into the database.
+     *
+     * @param requestModel the request model required for flashcard set creation.
+     * @return the response model containing the newly created flashcard set data.
+     */
     FlashcardSetResponseModel create(FlashcardSetRequestModel requestModel) throws FlashcardSetCreationFailed;
 }

src/main/java/create_flashcard_set_use_case/FlashcardSetInteractor.java

@@ -2,9 +2,9 @@
 
 import data_access.DBGateway;
 import data_access.IFlashcardSetDataAccess;
+import data_access.entity_request_models.FlashcardSetDsRequestModel;
 import entities.FlashcardSet;
 import entities.FlashcardSetFactory;
-import data_access.entity_request_models.FlashcardSetDsRequestModel;
 
 import java.util.ArrayList;
 import java.util.Objects;
@@ -22,23 +22,36 @@
  * - check that the flashcard set contains a title, description, and owner's username (if not, alert user)
  * - create and store newly created flashcard set
  * - notify successful creation of flashcard set to user
+ *
+ * @author Edward Ishii
  */
-
 public class FlashcardSetInteractor implements FlashcardSetInputBoundary {
     DBGateway dbGateway;
     IFlashcardSetDataAccess flashcardSetDataAccess;  // for testing
     FlashcardSetOutputBoundary flashcardSetOutputBoundary;
     FlashcardSetFactory flashcardSetFactory;
 
-
+    /**
+     * Constructs the use case interactor.
+     *
+     * @param dbGateway                  the database to store the flashcard set in.
+     * @param flashcardSetOutputBoundary the output boundary for preparing success/fail view of saving flashcard sets.
+     * @param flashcardSetFactory        the factory that creates flashcard sets.
+     */
     public FlashcardSetInteractor(DBGateway dbGateway, FlashcardSetOutputBoundary flashcardSetOutputBoundary,
                                   FlashcardSetFactory flashcardSetFactory) {
         this.dbGateway = dbGateway;
         this.flashcardSetOutputBoundary = flashcardSetOutputBoundary;
         this.flashcardSetFactory = flashcardSetFactory;
     }
 
-    // Alternative construction for testing purposes
+    /**
+     * Alternative constructor for testing purposes.
+     *
+     * @param flashcardSetDataAccess     the flashcard set database.
+     * @param flashcardSetOutputBoundary the output boundary for preparing success/fail view.
+     * @param flashcardSetFactory        the factory creating flashcard sets.
+     */
     public FlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
                                   FlashcardSetOutputBoundary flashcardSetOutputBoundary,
                                   FlashcardSetFactory flashcardSetFactory) {
@@ -47,6 +60,13 @@ public FlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
         this.flashcardSetFactory = flashcardSetFactory;
     }
 
+    /**
+     * Creates a flashcard set and stores it into the database.
+     *
+     * @param inputData the request model containing data required for creating flashcard sets.
+     * @return the response model containing the newly created flashcard set data.
+     * @throws FlashcardSetCreationFailed the error thrown if flashcard set creation fails.
+     */
     @Override
     public FlashcardSetResponseModel create(FlashcardSetRequestModel inputData) throws FlashcardSetCreationFailed {
 
@@ -70,21 +90,24 @@ public FlashcardSetResponseModel create(FlashcardSetRequestModel inputData) thro
                 inputData.isPrivate(), tempFlashcardSetId, inputData.getUsername());
 
         // store the flashcard set into database
-        ArrayList<Integer> flashcardIds = new ArrayList<>();  // set starts with empty list of flashcard ids for database
+        ArrayList<Integer> flashcardIds = new ArrayList<>();  // set starts with empty list of flashcard ids
         FlashcardSetDsRequestModel dsRequestModel = new FlashcardSetDsRequestModel(fs.getTitle(), fs.getDescription(),
                 fs.getIsPrivate(), tempFlashcardSetId, fs.getOwnerUsername(), flashcardIds);
 
         try {
-            dbGateway.saveFlashcardSet(dsRequestModel);
-            FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(fs);
+            int savedFlashcardSetId = dbGateway.saveFlashcardSet(dsRequestModel);
+
+            // create the saved flashcard set with its proper id
+            FlashcardSet savedFs = factory.create(inputData.getTitle(), inputData.getDescription(),
+                    inputData.isPrivate(), savedFlashcardSetId, inputData.getUsername());
+
+            FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(savedFs);
+
             return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
-        } catch (Exception e) {
+        } catch (NullPointerException e) {
             return null;
         }
-//        dbGateway.saveFlashcardSet(dsRequestModel);
-//        FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(fs);
 
-//        return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
     }
 
 

src/main/java/create_flashcard_set_use_case/FlashcardSetOutputBoundary.java

@@ -2,8 +2,27 @@
 
 // Use case (Red) layer
 
+/**
+ * The output boundary interface that updates the view when creating a flashcard set succeeds or fails.
+ *
+ * @author Edward Ishii
+ */
+
 public interface FlashcardSetOutputBoundary {
+    /**
+     * Prepares the success view when a flashcard set is created and saved.
+     *
+     * @param fs the flashcard set that has been created.
+     * @return the response model containing the saved flashcard set data.
+     */
     FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs);
 
+    /**
+     * Prepares the fail view when a flashcard set cannot be created or saved.
+     *
+     * @param error the failure message.
+     * @return the response model containing the failure message.
+     * @throws FlashcardSetCreationFailed the error thrown when flashcard set creation fails.
+     */
     FlashcardSetResponseModel prepareFailView(String error) throws FlashcardSetCreationFailed;
 }

src/main/java/create_flashcard_set_use_case/FlashcardSetPresenter.java

@@ -2,12 +2,30 @@
 
 // Interface adapters (Green) layer
 
+/**
+ * The presenter that updates the view when creating a flashcard set succeeds or fails.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetPresenter implements FlashcardSetOutputBoundary {
+
+    /**
+     * Prepares the success view when a flashcard set is created and saved.
+     *
+     * @param fs the flashcard set that has been created.
+     * @return the response model containing the saved flashcard set data.
+     */
     @Override
     public FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs) {
         return fs;
     }
 
+    /**
+     * Prepares the fail view when a flashcard set cannot be created or saved.
+     *
+     * @param error the failure message.
+     * @return the response model containing the failure message.
+     */
     @Override
     public FlashcardSetResponseModel prepareFailView(String error) {
         throw new FlashcardSetCreationFailed(error);

src/main/java/create_flashcard_set_use_case/FlashcardSetRequestModel.java

@@ -2,47 +2,100 @@
 
 // Use case (Red) layer
 
+/**
+ * The request model required for creating a flashcard set.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetRequestModel {
     private String title;
     private String description;
     private boolean isPrivate;
     private String username;
 
+    /**
+     * Constructs the request model.
+     *
+     * @param title       the title of the flashcard set.
+     * @param description the description of the flashcard set.
+     * @param isPrivate   the privacy of the flashcard set.
+     * @param username    the owner's username of the flashcard set.
+     */
     public FlashcardSetRequestModel(String title, String description, boolean isPrivate, String username) {
         this.title = title;
         this.description = description;
         this.isPrivate = isPrivate;
         this.username = username;
     }
 
+    /**
+     * Getter for the flashcard set title.
+     *
+     * @return the title of this flashcard set.
+     */
     public String getTitle() {
         return title;
     }
 
+    /**
+     * Setter for the flashcard set title.
+     *
+     * @param title the new title for this flashcard set.
+     */
     public void setTitle(String title) {
         this.title = title;
     }
 
+    /**
+     * Getter for the description of the flashcard set.
+     *
+     * @return the description of this flashcard set.
+     */
     public String getDescription() {
         return description;
     }
 
+    /**
+     * Setter for the description of the flashcard set.
+     *
+     * @param description the new description for this flashcard set.
+     */
     public void setDescription(String description) {
         this.description = description;
     }
 
+    /**
+     * Getter for the privacy of the flashcard set.
+     *
+     * @return the privacy of this flashcard set.
+     */
     public boolean isPrivate() {
         return isPrivate;
     }
 
+    /**
+     * Setter for the privacy of the flashcard set.
+     *
+     * @param aPrivate the new privacy status for this flashcard set.
+     */
     public void setPrivate(boolean aPrivate) {
         isPrivate = aPrivate;
     }
 
+    /**
+     * Getter for the owner's username of the flashcard set.
+     *
+     * @return the owner's username of this flashcard set.
+     */
     public String getUsername() {
         return username;
     }
 
+    /**
+     * Setter for the owner's username of the flashcard set.
+     *
+     * @param username the new owner's username of this flashcard set.
+     */
     public void setUsername(String username) {
         this.username = username;
     }

src/main/java/create_flashcard_set_use_case/FlashcardSetResponseModel.java

@@ -1,18 +1,32 @@
 package create_flashcard_set_use_case;
 
-// Use case (Red) layer
-
 import entities.FlashcardSet;
 
+// Use case (Red) layer
+
+/**
+ * The response model containing data from the newly created flashcard set.
+ *
+ * @author Edward Ishii
+ */
 public class FlashcardSetResponseModel {
     private final FlashcardSet fs;
 
+    /**
+     * Constructs a FlashcardSetResponseModel.
+     *
+     * @param fs the flashcard set.
+     */
     public FlashcardSetResponseModel(FlashcardSet fs) {
         this.fs = fs;
     }
 
+    /**
+     * Getter for the flashcard set.
+     *
+     * @return the flashcard set.
+     */
     public FlashcardSet getFs() {
         return fs;
     }
-
 }