Add sort by all field in the favourite internship list and add corres…

…ponding change in UG and DG for SortCommand

docs/DeveloperGuide.md

@@ -190,27 +190,32 @@ The `SortCommand` class is responsible for sorting the internship listings based
    - `"deadline"`: Sorts internships by deadline.
    - `"skills"`: Sorts internships by the first skill in the skills list alphabetically.
    - `"status"`: Sorts internships by status alphabetically.
+   - `"role in favourite"`: Sorts internships in favourite by role alphabetically.
+   - `"duration in favourite"`: Sorts internships in favourite by duration (start and end dates).
+   - `"deadline in favourite"`: Sorts internships in favourite by deadline.
+   - `"skills in favourite"`: Sorts internships in favourite by the first skill in the skills list alphabetically.
+   - `"status in favourite"`: Sorts internships in favourite by status alphabetically.
 - If the user provides an invalid sort option, the command returns an error and defaults to listing internships by ID.
 - **`getUsage()`**: Returns a string showing the correct usage of the `sort` command, including valid options like "alphabet", "deadline", "duration", "skills", and "status".
 
 #### Example Usage Scenario:
-1. The user enters `sort alphabet`, and the `execute` method sorts the internships by role.
+1. The user enters `sort role`, and the `execute` method sorts the internships by role.
 2. The user enters `sort duration`, and the internships are sorted by their start and end dates.
 3. The user enters `sort skills`, and the internships are sorted by the first skill alphabetically.
 4. The user enters `sort status`, and the internships are sorted by their status alphabetically.
 5. The user enters `sort deadline`, and the internships are sorted by each of their earliest deadline.
-5. If the user enters an invalid sort option, the command returns an error and lists the internships by ID.
+6. The user enters `sort role in favourite`, and the `execute` method sorts the internships in favourite by role.
+7. The user enters `sort duration  in favourite`, and the internships in favourite are sorted by their start and end dates.
+8. The user enters `sort skills in favourite`, and the internships in favourite are sorted by the first skill alphabetically.
+9. The user enters `sort status in favourite`, and the internships in favourite are sorted by their status alphabetically.
+10. The user enters `sort deadline in favourite`, and the internships in favourite are sorted by each of their earliest deadline.
+11. If the user enters an invalid sort option, the command returns an error and lists the internships by ID.
 
 #### Sequence Diagram:
 The following sequence diagram shows how the `SortCommand` is executed:
-![](UML/loadFromFile.png)
+![](UML/SortCommand_Sequence_Diagram.png)
+
 
-```plaintext
-User -> System: sort alphabet
-System -> SortCommand: execute("alphabet")
-SortCommand -> InternshipList: listInternshipsSortedByRole()
-InternshipList -> UI: showSortedInternshipsByRole()
-```
 ### Filter Command Implementation
 
 #### Overview:

docs/UserGuide.md

@@ -159,21 +159,29 @@ __________________________________________________
 __________________________________________________
 Sorted internships by start date (year first), then end date.
 __________________________________________________
-ID: 02
-Role: Software Engineer Intern
-Company: Google
-Duration: 05/23 to 08/25
-Skills: Not Stated
+ID: 3	Status: Accepted
+Role: IT support Intern
+Company: Microsoft
+Duration: 03/24 to 08/24
+Skills: Java 
 Deadlines:
-online assessment: 11/11/24
+	certificate submit: 15/04/24
 __________________________________________________
-ID: 01
+ID: 1	Status: Rejected
 Role: Embedded Software Engineer Intern
 Company: Continental
-Duration: 05/24 to 08/24
-Skills: Not Stated
+Duration: 05/25 to 08/25
+Skills: C++ 
 Deadlines:
-    interview: 25/11/24
+	online interview: 12/06/24
+__________________________________________________
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
+Company: Google
+Duration: 05/25 to 09/25
+Skills: Python SQL 
+Deadlines:
+	interview reply: 12/04/24
 __________________________________________________
 __________________________________________________
 ```
@@ -185,22 +193,29 @@ __________________________________________________
 __________________________________________________
 Sorted internships by role alphabetically (case-insensitive).
 __________________________________________________
-ID: 01
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
+Company: Google
+Duration: 05/25 to 09/25
+Skills: Python SQL 
+Deadlines:
+	interview reply: 12/04/24
+__________________________________________________
+ID: 1	Status: Rejected
 Role: Embedded Software Engineer Intern
 Company: Continental
 Duration: 05/25 to 08/25
-Skills: Not Stated
+Skills: C++ 
 Deadlines:
-    interview: 25/11/24
-
-
-ID: 02
-Role: Software Engineer Intern
-Company: Google
-Duration: Not Stated
-Skills: Not Stated
+	online interview: 12/06/24
+__________________________________________________
+ID: 3	Status: Accepted
+Role: IT support Intern
+Company: Microsoft
+Duration: 03/24 to 08/24
+Skills: Java 
 Deadlines:
-    online assessment: 11/11/24
+	certificate submit: 15/04/24
 __________________________________________________
 __________________________________________________
 ```
@@ -212,21 +227,29 @@ __________________________________________________
 __________________________________________________
 Sorted internships by deadline.
 __________________________________________________
-ID: 02
-Role: Software Engineer Intern
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
 Company: Google
-Duration: 05/23 to 08/25
-Skills: Not Stated
+Duration: 05/25 to 09/25
+Skills: Python SQL 
 Deadlines:
-    online assessment: 11/11/24
-
-ID: 01
+	interview reply: 12/04/24
+__________________________________________________
+ID: 3	Status: Accepted
+Role: IT support Intern
+Company: Microsoft
+Duration: 03/24 to 08/24
+Skills: Java 
+Deadlines:
+	certificate submit: 15/04/24
+__________________________________________________
+ID: 1	Status: Rejected
 Role: Embedded Software Engineer Intern
 Company: Continental
-Duration: 05/24 to 08/24
-Skills: Not Stated
+Duration: 05/25 to 08/25
+Skills: C++ 
 Deadlines:
-    interview: 25/11/24
+	online interview: 12/06/24
 __________________________________________________
 __________________________________________________
 ```
@@ -238,46 +261,89 @@ __________________________________________________
 __________________________________________________
 Sorted internships by skills.
 __________________________________________________
-ID: 1	Status: Application Completed
+ID: 1	Status: Rejected
 Role: Embedded Software Engineer Intern
-Company: Google
-Duration: 02/23 to 05/24
-Skills: No Skills Entered 
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: C++ 
 Deadlines:
-    interview: 25/11/24
+	online interview: 12/06/24
 __________________________________________________
-ID: 2	Status: Accepted
-Role: Marketing sales
-Company: Castify
-Duration: 05/23 to 05/24
-Skills: No Skills Entered 
+ID: 3	Status: Accepted
+Role: IT support Intern
+Company: Microsoft
+Duration: 03/24 to 08/24
+Skills: Java 
 Deadlines:
-    online assessment: 11/11/24
+	certificate submit: 15/04/24
+__________________________________________________
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
+Company: Google
+Duration: 05/25 to 09/25
+Skills: Python SQL 
+Deadlines:
+	interview reply: 12/04/24
 __________________________________________________
 __________________________________________________
 ```
+
 `sort -status`
 
 ```
 __________________________________________________
 __________________________________________________
 Sorted internships by status.
 __________________________________________________
-ID: 2	Status: Accepted
-Role: Marketing sales
-Company: Castify
-Duration: 05/23 to 05/24
-Skills: No Skills Entered 
+ID: 3	Status: Accepted
+Role: IT support Intern
+Company: Microsoft
+Duration: 03/24 to 08/24
+Skills: Java 
 Deadlines:
-    online assessment: 11/11/24
+	certificate submit: 15/04/24
 __________________________________________________
-ID: 1	Status: Application Completed
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
+Company: Google
+Duration: 05/25 to 09/25
+Skills: Python SQL 
+Deadlines:
+	interview reply: 12/04/24
+__________________________________________________
+ID: 1	Status: Rejected
 Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: C++ 
+Deadlines:
+	online interview: 12/06/24
+__________________________________________________
+__________________________________________________
+```
+
+`sort -role in favourite`
+
+```
+__________________________________________________
+__________________________________________________
+Sorted internships in favourite by role in favourite.
+__________________________________________________
+ID: 2	Status: Application Completed
+Role: Customer Service Intern
 Company: Google
-Duration: 02/23 to 05/24
-Skills: No Skills Entered 
+Duration: 05/25 to 09/25
+Skills: Python SQL 
+Deadlines:
+	interview reply: 12/04/24
+__________________________________________________
+ID: 1	Status: Rejected
+Role: Embedded Software Engineer Intern
+Company: Continental
+Duration: 05/25 to 08/25
+Skills: C++ 
 Deadlines:
-    interview: 25/11/24
+	online interview: 12/06/24
 __________________________________________________
 __________________________________________________
 ```

src/main/java/seedu/commands/SortCommand.java

@@ -49,6 +49,21 @@ public void execute(ArrayList<String> args) {
         case "status":
             internships.listInternshipsSortedByStatus();  // Sort by status alphabetically
             break;
+        case "role in favourite":
+            internships.listFavouriteInternshipsSortedByRole();  // Sort by role alphabetically (case-insensitive)
+            break;
+        case "duration in favourite":
+            internships.listFavouriteInternshipsSortedByDuration();  // Sort by start date, then end date (year first)
+            break;
+        case "deadline in favourite":
+            internships.listFavouriteInternshipsSortedByDeadline();
+            break;
+        case "skills in favourite":
+            internships.listFavouriteInternshipsSortedByFirstSkill();  // Sort by first skill alphabetically
+            break;
+        case "status in favourite":
+            internships.listFavouriteInternshipsSortedByStatus();  // Sort by status alphabetically
+            break;
         default:
             // Handle invalid sorting options
             internships.listInternshipsInvalidFlag(sortOption);
@@ -59,13 +74,20 @@ public void execute(ArrayList<String> args) {
     public String getUsage() {
         return """
                 sort
-                Usage: sort [role | deadline | duration | skills | status]
+                Usage: sort [role | duration | deadline | skills | status | role in favourite
+                            | duration in favourite | deadline in favourite
+                            | skills in favourite | status in favourite ]
 
                 role: Sort internships alphabetically by role (case-insensitive).
                 deadline: Sort internships by start date (year first), then end date.
                 duration: Sort internships by internship duration.
                 skills: Sort internships by the first skill alphabetically.
                 status: Sort internships by status alphabetically.
+                role in favourite: Sort internships in favourite alphabetically by role (case-insensitive).
+                deadline in favourite: Sort internships in favourite by start date (year first), then end date.
+                duration in favourite: Sort internships in favourite by internship duration.
+                skills in favourite: Sort internships in favourite by the first skill alphabetically.
+                status in favourite: Sort internships in favourite by status alphabetically.
                 """;
     }
-}
+}

src/main/java/seedu/duke/InternshipList.java

@@ -153,21 +153,29 @@ public int getSize() {
     }
 
     //@@author Toby-Yu
-    // Method to list all internships in sorted order by role (case-insensitive)
+
+    /**
+     * List all internships in sorted order by role alphabetically (case-insensitive)
+     */
     public void listInternshipsSortedByRole() {
-        ArrayList<Internship> sortedList = new ArrayList<>(internships);
+        ArrayList<Internship> sortedInternships = new ArrayList<>(internships);
 
         // Sort roles alphabetically, ignoring case sensitivity
-        Collections.sort(sortedList, Comparator.comparing(internship -> internship.getRole().toLowerCase()));
-
-        // Display the sorted list without changing IDs
-        ui.showInternships(sortedList, "role");
+        Collections.sort(sortedInternships, Comparator.comparing(internship -> internship.getRole().toLowerCase()));
+        ui.showInternships(sortedInternships, "role");
     }
 
-    // Method to list all internships sorted by start date (year first), then end date
+    /**
+     * List all internships sorted by duration (year first, then month) in start date first, then end date
+     */
     public void listInternshipsSortedByDuration() {
         ArrayList<Internship> sortedInternships = new ArrayList<>(internships);
 
+        sortedByDurationFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "duration");
+    }
+
+    private void sortedByDurationFunction(ArrayList<Internship> sortedInternships) {
         Collections.sort(sortedInternships, (i1, i2) -> {
             // First compare start dates (year then month)
             int startComparison = compareYearMonth(i1.getStartDate(), i2.getStartDate());
@@ -177,9 +185,6 @@ public void listInternshipsSortedByDuration() {
             // If start dates are equal, compare end dates (year then month)
             return compareYearMonth(i1.getEndDate(), i2.getEndDate());
         });
-
-        // Display the sorted list without changing IDs
-        ui.showInternships(sortedInternships, "duration");
     }
 
     // Helper method to compare YearMonth strings in "MM/yy" format (year first, then month)
@@ -198,11 +203,17 @@ private int compareYearMonth(String date1, String date2) {
         return Integer.compare(month1, month2);
     }
 
-
-    // Method to list all internships sorted by start date (year first), then end date
+    /**
+     * List all internships sorted by the earliest deadline
+     */
     public void listInternshipsSortedByDeadline() {
         ArrayList<Internship> sortedInternships = new ArrayList<>(internships);
 
+        SortedByDeadlineFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "deadline");
+    }
+
+    private void SortedByDeadlineFunction(ArrayList<Internship> sortedInternships) {
         sortedInternships.sort((i1, i2) -> {
             Deadline earliestDeadline1 = i1.getEarliestDeadline();
             Deadline earliestDeadline2 = i2.getEarliestDeadline();
@@ -217,38 +228,84 @@ public void listInternshipsSortedByDeadline() {
             }
             return compareYearMonth(earliestDeadline1.getDate(), earliestDeadline2.getDate());
         });
-        ui.showInternships(sortedInternships, "deadline");
     }
 
     /**
      * Lists internships sorted by the first skill alphabetically (case-insensitive).
      */
     public void listInternshipsSortedByFirstSkill() {
-        ArrayList<Internship> sortedList = new ArrayList<>(internships);
+        ArrayList<Internship> sortedInternships = new ArrayList<>(internships);
+
+        SortedByFirstSkillFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "skills");
+    }
 
+    private static void SortedByFirstSkillFunction(ArrayList<Internship> sortedList) {
         // Sort by the first skill alphabetically
         Collections.sort(sortedList, Comparator.comparing(internship -> {
             String firstSkill = internship.getFirstSkill();
             return firstSkill.isEmpty() ? "No skills" : firstSkill.toLowerCase();// Sort internships with no skills last
         }));
-
-        // Display the sorted list without changing IDs
-        ui.showInternships(sortedList, "skills");
     }
 
     /**
      * Lists internships sorted by status alphabetically (case-insensitive).
      */
     public void listInternshipsSortedByStatus() {
-        ArrayList<Internship> sortedList = new ArrayList<>(internships);
+        ArrayList<Internship> sortedInternships = new ArrayList<>(internships);
 
-        // Sort by status alphabetically
-        Collections.sort(sortedList, Comparator.comparing(internship -> internship.getStatus().toLowerCase()));
+        Collections.sort(sortedInternships, Comparator.comparing(internship -> internship.getStatus().toLowerCase()));
+        ui.showInternships(sortedInternships, "status");
+    }
+
+    /**
+     * List all favourite internships in sorted order by role alphabetically (case-insensitive)
+     */
+    public void listFavouriteInternshipsSortedByRole() {
+        ArrayList<Internship> sortedInternships = new ArrayList<>(favouriteInternships);
+        Collections.sort(sortedInternships, Comparator.comparing(internship -> internship.getRole().toLowerCase()));
+        ui.showInternships(sortedInternships, "role in favourite");
+    }
+
+    /**
+     * List all internships sorted by duration (year first), then end date
+     */
+    public void listFavouriteInternshipsSortedByDuration() {
+        ArrayList<Internship> sortedInternships = new ArrayList<>(favouriteInternships);
+        sortedByDurationFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "duration in favourite");
+    }
+
+    /**
+     * List all favourite internships sorted by the earliest deadline
+     */
+    public void listFavouriteInternshipsSortedByDeadline() {
+        ArrayList<Internship> sortedInternships = new ArrayList<>(favouriteInternships);
+
+        SortedByDeadlineFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "deadline in favourite");
+    }
+
+    /**
+     * Lists all favourite internships sorted by the first skill alphabetically (case-insensitive).
+     */
+    public void listFavouriteInternshipsSortedByFirstSkill() {
+        ArrayList<Internship> sortedInternships= new ArrayList<>(favouriteInternships);
 
-        // Display the sorted list without changing IDs
-        ui.showInternships(sortedList, "status");
+        SortedByFirstSkillFunction(sortedInternships);
+        ui.showInternships(sortedInternships, "skills in favourite");
     }
 
+    /**
+     * Lists all favourite internships sorted by status alphabetically (case-insensitive).
+     */
+    public void listFavouriteInternshipsSortedByStatus() {
+        ArrayList<Internship> sortedList = new ArrayList<>(favouriteInternships);
+        Collections.sort(sortedList, Comparator.comparing(internship -> internship.getStatus().toLowerCase()));
+        ui.showInternships(sortedList, "status in favourite");
+    }
+
+
     public void listInternshipsNotSorted() {
         ui.showInternships(internships, "none");
     }

src/main/java/seedu/ui/UiInternshipList.java

@@ -39,22 +39,33 @@ public void showInternships(ArrayList<Internship> internships, String field) {
      * @param field Criteria that internships are sorted by.
      */
     public String getSortField(String field) {
-        String message = "Sorted internships by ";
+        String messageForNormalInternships = "Sorted internships by ";
+        String messageForInternshipsInFavourite = "Sorted internships in favourite by ";
         switch (field) {
         case "list":
             return "";
         case "none":
             return "No sorting option provided. Listing internships by ID.";
         case "role":
-            return message + "role alphabetically (case-insensitive).";
+            return messageForNormalInternships + "role alphabetically (case-insensitive).";
         case "duration":
-            return message + "start date (year first), then end date.";
+            return messageForNormalInternships + "start date (year first), then end date.";
         case "deadline":
-            return message + "deadline.";
+            return messageForNormalInternships + "deadline.";
         case "skills":
-            return message + "skills.";
+            return messageForNormalInternships + "skills.";
         case "status":
-            return message + "status.";
+            return messageForNormalInternships + "status.";
+        case "role in favourite":
+            return messageForInternshipsInFavourite + "role alphabetically (case-insensitive).";
+        case "duration in favourite":
+            return messageForInternshipsInFavourite + "start date (year first), then end date.";
+        case "deadline in favourite":
+            return messageForInternshipsInFavourite + "deadline.";
+        case "skills in favourite":
+            return messageForInternshipsInFavourite + "skills.";
+        case "status in favourite":
+            return messageForInternshipsInFavourite + "status.";
         default:
             // Handling invalid sorting options
             return "Unknown flag: " + field + "\n Use \"help\" to view valid flags.";