Merge branch 'main' of https://github.com/RIT-SWEN-262/designproject-design-6 into statistic-dev

10 files changed, 285 insertions, 2 deletions

diff --git a/src/main/java/design/model/Course.java b/src/main/java/design/model/Course.java
index 5f8c43d..8dfecd8 100644
--- a/src/main/java/design/model/Course.java
+++ b/src/main/java/design/model/Course.java
@@ -2,7 +2,7 @@ package design.model;
 
 import java.util.List;
 
-public class Course {
+public class Course implements ICourse {
     private final String name;
     private final int difficultyRating;
     private final String location;
@@ -23,7 +23,7 @@ public class Course {
         return name;
     }
 
-    public int getDifficultyRating() {
+    public float getDifficultyRating() {
         return difficultyRating;
     }
 
diff --git a/src/main/java/design/model/ICourse.java b/src/main/java/design/model/ICourse.java
new file mode 100644
index 0000000..fd171d3
--- /dev/null
+++ b/src/main/java/design/model/ICourse.java
@@ -0,0 +1,16 @@
+package design.model;
+
+import java.util.List;
+
+/*
+ * Defines the interface for courses to implement 
+ * Willem Dalton
+ */
+public interface ICourse {
+    String getName();
+    float getDifficultyRating();
+    String getLocation();
+    List<Hole> getHoles();
+    int getHoleCount();
+    int getTotalPar();
+}
diff --git a/src/main/java/design/model/course_search/CourseList.java b/src/main/java/design/model/course_search/CourseList.java
new file mode 100644
index 0000000..82648c2
--- /dev/null
+++ b/src/main/java/design/model/course_search/CourseList.java
@@ -0,0 +1,89 @@
+package design.model.course_search;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import design.model.*;
+
+/*
+ * Defines a list of courses that can be sorted, added to or removed from.
+ * Willem Dalton
+ */
+public class CourseList implements ICourse {
+    private CourseSorter sorter;
+    private List<ICourse> courses;
+
+    public CourseList()
+    {
+        courses = new ArrayList<>();
+    }
+
+    /*
+     * Grab the list of courses
+     */
+    public List<ICourse> getCourses()
+    {
+        return courses;
+    }
+
+    /*
+     * Set the list of courses equal to an existing list
+     */
+    public void setCourses(List<ICourse> courses)
+    {
+        this.courses = courses;
+    }
+
+    /*
+    * set the chosen sorting algorithm for the given list.
+    */
+    public void setSorter(CourseSorter courseSorter)
+    {
+        sorter = courseSorter;
+    }
+
+    /*
+     * Add a new course to the list.
+     */
+    public void add(ICourse course)
+    {
+        courses.add(course);
+    }
+
+    /*
+     * Remove a course from the list. 
+     */
+    public void remove(ICourse course)
+    {
+        courses.remove(course);
+    }
+
+    /*
+     * Sort the list.
+     */
+    public void sort()
+    {
+        sorter.sortCourses(courses);
+    }
+
+    /*
+     * All overrides of the ICourse class. This is a drawback of the composite pattern, but it's pretty negligible here. return some dummy values.
+     */
+    @Override
+    public String getName() { return "Course List"; }
+    
+    @Override
+    public float getDifficultyRating() { return 0; }
+
+    @Override
+    public String getLocation() { return ""; }
+    
+    @Override
+    public int getTotalPar() { return 0; }
+
+    @Override
+    public int getHoleCount() { return 0; }
+
+    @Override
+    public List<Hole> getHoles() { return null; }
+}
diff --git a/src/main/java/design/model/course_search/CourseSorter.java b/src/main/java/design/model/course_search/CourseSorter.java
new file mode 100644
index 0000000..a3d1186
--- /dev/null
+++ b/src/main/java/design/model/course_search/CourseSorter.java
@@ -0,0 +1,12 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+
+/*
+ * Defines an interface that concrete strategies will implement
+ * Willem Dalton
+ */
+public interface CourseSorter {
+    public void sortCourses(List<ICourse> courses);
+}
\ No newline at end of file
diff --git a/src/main/java/design/model/course_search/SortByDifficulty.java b/src/main/java/design/model/course_search/SortByDifficulty.java
new file mode 100644
index 0000000..c006a40
--- /dev/null
+++ b/src/main/java/design/model/course_search/SortByDifficulty.java
@@ -0,0 +1,16 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+import java.util.Comparator;
+
+/*
+ * Concrete strategy for sorting courses by their difficulty rating.
+ * Willem Dalton
+ */
+public class SortByDifficulty implements CourseSorter {
+    public void sortCourses(List<ICourse> courses)
+    {
+        courses.sort(Comparator.comparing(ICourse::getDifficultyRating));
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/design/model/course_search/SortByHoles.java b/src/main/java/design/model/course_search/SortByHoles.java
new file mode 100644
index 0000000..da98d4f
--- /dev/null
+++ b/src/main/java/design/model/course_search/SortByHoles.java
@@ -0,0 +1,16 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+import java.util.Comparator;
+
+/*
+ * Concrete strategy by sorting courses by their hole count (9 or 18)
+ * Willem Dalton
+ */
+public class SortByHoles implements CourseSorter {
+    public void sortCourses(List<ICourse> courses)
+    {
+        courses.sort(Comparator.comparing(ICourse::getHoleCount));
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/design/model/course_search/SortByLocation.java b/src/main/java/design/model/course_search/SortByLocation.java
new file mode 100644
index 0000000..ae9bd8b
--- /dev/null
+++ b/src/main/java/design/model/course_search/SortByLocation.java
@@ -0,0 +1,16 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+import java.util.Comparator;
+
+/*
+ * Concrete strategy for sorting courses by their location.
+ * Willem Dalton
+ */
+public class SortByLocation implements CourseSorter {
+    public void sortCourses(List<ICourse> courses)
+    {
+        courses.sort(Comparator.comparing(ICourse::getLocation));
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/design/model/course_search/SortByName.java b/src/main/java/design/model/course_search/SortByName.java
new file mode 100644
index 0000000..04625c6
--- /dev/null
+++ b/src/main/java/design/model/course_search/SortByName.java
@@ -0,0 +1,16 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+import java.util.Comparator;
+
+/*
+ * Concrete strategy for sorting courses base on their name.
+ * Willem Dalton
+ */
+public class SortByName implements CourseSorter {
+    public void sortCourses(List<ICourse> courses)
+    {
+        courses.sort(Comparator.comparing(ICourse::getName));
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/design/model/course_search/SortByPar.java b/src/main/java/design/model/course_search/SortByPar.java
new file mode 100644
index 0000000..2fa388c
--- /dev/null
+++ b/src/main/java/design/model/course_search/SortByPar.java
@@ -0,0 +1,16 @@
+package design.model.course_search;
+
+import design.model.*;
+import java.util.List;
+import java.util.Comparator;
+
+/*
+ * Concrete strategy for sorting courses based on their total par.
+ * Willem Dalton
+ */
+public class SortByPar implements CourseSorter {
+    public void sortCourses(List<ICourse> courses)
+    {
+        courses.sort(Comparator.comparing(ICourse::getTotalPar));
+    }
+}
\ No newline at end of file
diff --git a/src/test/java/design/TestCourseList.java b/src/test/java/design/TestCourseList.java
new file mode 100644
index 0000000..e18b9ab
--- /dev/null
+++ b/src/test/java/design/TestCourseList.java
@@ -0,0 +1,86 @@
+package design;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.api.Test;
+import design.model.course_search.*;
+import design.model.*;
+
+import java.util.List;
+
+class TestCourseList {
+
+    // A dummy Course implementation for testing
+    private static class DummyCourse implements ICourse {
+        private final String name;
+        private final float difficulty;
+
+        public DummyCourse(String name, float difficulty) {
+            this.name = name;
+            this.difficulty = difficulty;
+        }
+
+        @Override
+        public String getName() { return name; }
+
+        @Override
+        public float getDifficultyRating() { return difficulty; }
+
+        @Override
+        public String getLocation() { return ""; }
+
+        @Override
+        public int getTotalPar() { return 0; }
+
+        @Override
+        public int getHoleCount() { return 0; }
+
+        @Override
+        public List<Hole> getHoles() { return null; }
+    }
+
+    // A simple sorter that sorts courses by difficulty
+    private static class SortByDifficultyTest implements CourseSorter {
+        @Override
+        public void sortCourses(List<ICourse> courses) {
+            courses.sort((c1, c2) -> Float.compare(c1.getDifficultyRating(), c2.getDifficultyRating()));
+        }
+    }
+
+    @Test
+    public void testAddAndRemoveCourses() {
+        CourseList courseList = new CourseList();
+        ICourse course1 = new DummyCourse("Course A", 2.0f);
+        ICourse course2 = new DummyCourse("Course B", 5.0f);
+
+        courseList.add(course1);
+        courseList.add(course2);
+
+        assertEquals(2, courseList.getCourses().size(), "Should have 2 courses after adding");
+        assertTrue(courseList.getCourses().contains(course1), "Course A should be in the list");
+        assertTrue(courseList.getCourses().contains(course2), "Course B should be in the list");
+
+        courseList.remove(course1);
+        assertEquals(1, courseList.getCourses().size(), "Should have 1 course after removal");
+        assertTrue(!courseList.getCourses().contains(course1), "Course A should no longer be in the list");
+    }
+
+    @Test
+    public void testSortCourses() {
+        CourseList courseList = new CourseList();
+        courseList.add(new DummyCourse("Course A", 3.0f));
+        courseList.add(new DummyCourse("Course B", 1.0f));
+        courseList.add(new DummyCourse("Course C", 2.0f));
+
+        // Set sorting strategy
+        courseList.setSorter(new SortByDifficultyTest());
+
+        courseList.sort();
+
+        List<ICourse> sorted = courseList.getCourses();
+        assertEquals("Course B", sorted.get(0).getName(), "First course should have lowest difficulty");
+        assertEquals("Course C", sorted.get(1).getName(), "Second course should have medium difficulty");
+        assertEquals("Course A", sorted.get(2).getName(), "Last course should have highest difficulty");
+    }
+}
\ No newline at end of file