Merge pull request #93 from CSC207-2022F-UofT/8-feature-main-home-page

completed java doc for database classes, database interfaces, and home page

Author: jempio

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;
     }

src/main/java/data_access_use_case/entity_request_models/FlashcardSetDsRequestModel.java

@@ -1,6 +1,11 @@
 package data_access_use_case.entity_request_models;
 
 import java.util.List;
+/**
+ * Flashcard Set Request Model.
+ * Application Business Rules
+ * @author Justin Li
+ */
 
 public class FlashcardSetDsRequestModel {
     private String title;
@@ -11,6 +16,14 @@ public class FlashcardSetDsRequestModel {
     private final String ownerUsername;
     private int flashcardSetId;
 
+    /**
+     * Creates a flashcard response model based on the following parameters.
+     * @param title the flashcard set title
+     * @param description the flashcard set description.
+     * @param isPrivate true if the flashcard set is private.
+     * @param flashcardSetId the flashcard set id
+     * @param ownerUsername the id of the user that created the flashcard set.
+     */
     public FlashcardSetDsRequestModel(String title, String description, boolean isPrivate,
                         int flashcardSetId, String ownerUsername,
                         List<Integer> flashcardIds){
@@ -21,38 +34,63 @@ public FlashcardSetDsRequestModel(String title, String description, boolean isPr
         this.ownerUsername = ownerUsername;
         this.flashcardIds = flashcardIds;
     }
+    /**
+     * Gets the flashcard set title.
+     * @return the flashcard set title.
+     */
     public String getTitle() {
         return title;
     }
-
+    /**
+     * Gets the flashcard set description.
+     * @return the flashcard set description.
+     */
     public String getDescription() {
         return description;
     }
-
+    /**
+     * Gets the flashcard privacy.
+     * @return true if the flashcard set is private.
+     */
     public Boolean getIsPrivate() {
         return isPrivate;
     }
-
+    /**
+     * Gets the flashcard set id.
+     * @return the flashcard set id.
+     */
     public int getFlashcardSetId(){
         return flashcardSetId;
     }
-
+    /**
+     * Gets the id of the user who created the flashcard set.
+     * @return the if of the user who created the flashcard set.
+     */
     public String getOwnerUsername(){
         return ownerUsername;
     }
-
+    /**
+     * Gets a list of all the flashcards in the flashcard set.
+     * @return a list of all the flashcards in the flashcard set.
+     */
     public List<Integer> getFlashcardIds(){
         return flashcardIds;
     }
-
+    /**
+     * Sets the flashcard set title.
+     */
     public void setTitle(String title) {
         this.title = title;
     }
-
+    /**
+     * Sets the flashcard set description.
+     */
     public void setDescription(String description) {
         this.description = description;
     }
-
+    /**
+     * Sets the flashcard set id.
+     */
     public void setFlashcardSetId(int flashcardSetId) {
         this.flashcardSetId = flashcardSetId;
     }

src/main/java/frameworks_and_drivers/components/FlashcardSetDataPanel.java

@@ -22,30 +22,53 @@
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
 
+/**
+ * Abstract class that represents a panel for an individual flashcard set.
+ * This panel includes buttons for study, edit, test, and delete.
+ * Frameworks & Drivers
+ * @author Justin Li
+ */
 public class FlashcardSetDataPanel extends JPanel implements WindowListener {
+    /**
+     * The main JFrame that the flashcard set data panel will lie in.
+     */
     HomeScreen home;
+
+    /**
+     * Creates a FlashcardSetDataPanel object that includes the title, description, flashcardSetId, gateway,
+     * user, and home.
+     * @param title the title of the flashcard set.
+     * @param description the description of the flashcard set.
+     * @param flashcardSetId the flashcard set id.
+     * @param gateway the gateway to reach the flashcard set.
+     * @param user the user that owns that flashcard set.
+     * @param home the home screen containing the flashcard set panel.
+     */
     public FlashcardSetDataPanel(String title, String description,
                                  int flashcardSetId, DBGateway gateway,
                                  UserLoginResponseModel user, HomeScreen home) {
+        // Panel Construction
         Border border = BorderFactory.createTitledBorder(title);
 
-
         JLabel descriptionLabel = new JLabel(description);
         this.add(descriptionLabel);
         this.home = home;
+
+        // Button Construction
         JPanel buttons = new JPanel();
 
         JButton study = new JButton("Study");
         buttons.add(study);
+
         JButton test = new JButton("Test");
         buttons.add(test);
+
         JButton edit = new JButton("Edit");
         JButton delete = new JButton("Delete");
-
-
         buttons.add(edit);
         buttons.add(delete);
 
+        // Action listeners for edit, study, test, and delete buttons.
         edit.addActionListener((e) -> {
             EditorMainScreen editor = new EditorMainScreen(flashcardSetId);
             editor.addWindowListener(this);
@@ -77,39 +100,21 @@ public FlashcardSetDataPanel(String title, String description,
         this.setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
     }
 
-
     @Override
-    public void windowOpened(WindowEvent e) {
-
-    }
-
+    public void windowOpened(WindowEvent e) {}
     @Override
-    public void windowClosing(WindowEvent e) {
-    }
-
+    public void windowClosing(WindowEvent e) {}
     @Override
     public void windowClosed(WindowEvent e) {
+        // When a window is closed the page will be refreshed.
         home.refresh();
-
     }
-
     @Override
-    public void windowIconified(WindowEvent e) {
-
-    }
-
+    public void windowIconified(WindowEvent e) {}
     @Override
-    public void windowDeiconified(WindowEvent e) {
-
-    }
-
+    public void windowDeiconified(WindowEvent e) {}
     @Override
-    public void windowActivated(WindowEvent e) {
-
-    }
-
+    public void windowActivated(WindowEvent e) {}
     @Override
-    public void windowDeactivated(WindowEvent e) {
-
-    }
+    public void windowDeactivated(WindowEvent e) {}
 }