Merge pull request #71 from CSC207-2022F-UofT/main

Undate

Author: Junyu11111

src/main/java/flashcardCreator/FcCController.java

@@ -1,5 +1,11 @@
 package flashcardCreator;
 
+/**
+ * Input boundary for flashcard creator.
+ * Application business rules.
+ * @author Junyu Chen
+ */
+
 public interface FcCInputBoundary {
     FcCResponseModel create(FcCRequestModel requestModel);
 

src/main/java/flashcardCreator/FcCFailure.java

@@ -6,17 +6,32 @@
 import entityRequestModels.FlashcardDsRequestModel;
 
 import java.time.LocalDateTime;
-
-public class FcCInterator implements FcCInputBoundary{
-    FcCPresenter presenter;
+/**
+ * Interactor for flashcard creator.
+ * Application business rules.
+ * @author Junyu Chen
+ */
+public class FcCInteractor implements FcCInputBoundary{
+    FcCOutputBoundary presenter;
     IFlashcardDataAccess fcDataAccess;
     IFlashcardSetDataAccess fcsDataAccess;
 
-    public FcCInterator(DBGateway gateway, FcCPresenter presenter){
+    /**
+     * Create FcCInteractor
+     * @param gateway Database gateway.
+     * @param presenter Presenter for failure or success view.
+     */
+    public FcCInteractor(DBGateway gateway, FcCOutputBoundary presenter){
         this.presenter = presenter;
         this.fcDataAccess = gateway.getFlashcardGateway();
         this.fcsDataAccess = gateway.getFlashcardSetGateway();
     }
+
+    /**
+     * 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.
+     * @return Success or failure view.
+     */
     @Override
     public FcCResponseModel create(FcCRequestModel requestModel) {
         if(requestModel.getDefinition().isEmpty()||requestModel.getTerm().isEmpty()){

src/main/java/flashcardCreator/FcCInputBoundary.java

@@ -1,12 +1,21 @@
 package flashcardCreator;
 
+import flashcardCreator.fcCScreens.FcCController;
+import flashcardCreator.fcCScreens.FcCResponsePresenter;
 import flashcardCreator.fcCScreens.FcCScreen;
 import dataAccess.*;
-
 import javax.swing.*;
 import java.io.IOException;
 
+/**
+ * Main frame for flashcard Creator.
+ * @author Junyu Chen
+ */
 public class FcCMain extends JFrame {
+    /**
+     * Create main frame for the flashcard creator.
+     * @param flashcardSetId id of the flashcard set which flashcard will be stored in.
+     */
     public FcCMain(int flashcardSetId){
         DBGateway gateway;
         try{
@@ -17,8 +26,8 @@ public FcCMain(int flashcardSetId){
         catch (IOException e){
             throw new RuntimeException("Could not access files.");
         }
-        FcCPresenter presenter = new FcCResponseFormatter();
-        FcCInputBoundary interactor = new FcCInterator(gateway,presenter);
+        FcCOutputBoundary presenter = new FcCResponsePresenter();
+        FcCInputBoundary interactor = new FcCInteractor(gateway,presenter);
         FcCController controller = new FcCController(interactor, flashcardSetId);
         FcCScreen fcCScreen= new FcCScreen(controller, this);
         this.add(fcCScreen);

src/main/java/flashcardCreator/FcCInterator.java renamed to src/main/java/flashcardCreator/FcCInteractor.java

@@ -1,6 +1,10 @@
 package flashcardCreator;
-
-public interface FcCPresenter {
+/**
+ * Presenter for flashcard creator.
+ * Application business rules.
+ * @author Junyu Chen
+ */
+public interface FcCOutputBoundary {
     FcCResponseModel prepareSuccessView(FcCResponseModel responseModel);
 
     FcCResponseModel prepareFailView(String error);

src/main/java/flashcardCreator/FcCMain.java

@@ -1,8 +1,21 @@
 package flashcardCreator;
+/**
+ * Request model for flashcard creator.
+ * Application business rules.
+ * @author Junyu Chen
+ */
+
 
 public class FcCRequestModel {
     private int flashcardSetId;
     private String term, definition;
+
+    /**
+     * Create FcCRequestModel
+     * @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
+     */
     public FcCRequestModel(int flashcardSetId, String term, String definition){
         this.definition = definition;
         this.term = term;

src/main/java/flashcardCreator/FcCPresenter.java renamed to src/main/java/flashcardCreator/FcCOutputBoundary.java

@@ -1,11 +1,21 @@
 package flashcardCreator;
 
 import java.time.LocalDateTime;
-
+/**
+ * Response model for flashcard creator.
+ * Application business rules.
+ * @author Junyu Chen
+ */
 public class FcCResponseModel {
-    private LocalDateTime creationDate;
+    private final LocalDateTime creationDate;
     private String term, definition;
 
+    /**
+     * Create FcCResponseModel
+     * @param creationDate date of creation of the flashcard
+     * @param term term of the flashcard
+     * @param definition definition of the flashcard
+     */
     public FcCResponseModel(LocalDateTime creationDate, String term, String definition) {
         this.creationDate = creationDate;
         this.term = term;

src/main/java/flashcardCreator/FcCRequestModel.java

@@ -0,0 +1,29 @@
+package flashcardCreator.fcCScreens;
+
+import flashcardCreator.FcCInputBoundary;
+import flashcardCreator.FcCRequestModel;
+import flashcardCreator.FcCResponseModel;
+
+/**
+ * Controller for flashcard creator.
+ * Interface adaptors.
+ * @author Junyu Chen
+ */
+
+public class FcCController {
+    FcCInputBoundary inputBoundary;
+    int flashcardSetId;
+
+    /**
+     * Create FcCController
+     * @param inputBoundary Interactor for flashcard creator.
+     * @param flashcardSetId Id of flashcard set which new flashcard will be created in.
+     */
+    public FcCController(FcCInputBoundary inputBoundary, int flashcardSetId){
+        this.inputBoundary = inputBoundary;
+        this.flashcardSetId = flashcardSetId;
+    }
+    public FcCResponseModel create(String term, String definition){
+        return inputBoundary.create(new FcCRequestModel(flashcardSetId, term, definition));
+    }
+}

src/main/java/flashcardCreator/FcCResponseModel.java

@@ -0,0 +1,11 @@
+package flashcardCreator.fcCScreens;
+/**
+ * Failure of flashcard creator.
+ * Interface Adaptors.
+ * @author Junyu Chen
+ */
+public class FcCFailure extends RuntimeException{
+    public FcCFailure(String error){
+        super(error);
+    }
+}