[CS2113-W13-2] easySEP #6
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,20 +31,4 @@ jobs: | |
| java-package: jdk+fx | ||
|
|
||
| - name: Build and check with Gradle | ||
| run: ./gradlew check | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "java.configuration.updateBuildConfiguration": "interactive" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,4 +43,5 @@ checkstyle { | |
|
|
||
| run{ | ||
| standardInput = System.in | ||
| enableAssertions = true | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Hanyang University% | ||
| CSE1002;Introduction to computer science;3;nil;wednesday;15:00;16:00% | ||
| /Boston University% | ||
| CS103;Introduction to Internet Technologies and Web Programming;3;nil;tuesday;11:00;12:00% | ||
| MET CS 248;Discrete Mathematics;3;nil;monday;11:00;12:00% |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| Hanyang University% | ||
| null% | ||
| F% | ||
| /Boston University% | ||
| null% | ||
| F% | ||
| CS103;Introduction to Internet Technologies and Web Programming;3;IT1001;Introduction to Computing;4% |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| # About us | ||
|
|
||
|
|
||
| Display | Name | Github Profile | Portfolio | ||
| --------|:--------:|:-----------------------------:|:---------: | ||
|  | Ong Zhi Hong | [Github](https://github.com/helpdesk1234) | [Portfolio](linkedin.com/in/ongzhihong) | ||
|  | Ian Ng | [Github](https://github.com/nshian) | [Portfolio](https://www.linkedin.com/in/nshian) | ||
|  | Wang Tingjia | [Github](https://github.com/wangtingjia) | [Portfolio](https://www.linkedin.com/in/wangtingjia/) | ||
|  | Alfred | [Github](https://github.com/alfred-leong) | [Portfolio](https://www.linkedin.com/in/alfred-leong/) | ||
|  | Joshua Nee | [Github](https://github.com/joshuan98) | [Portfolio](docs/team/johndoe.md) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,8 +8,189 @@ | |
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
|
|
||
|
|
||
| ### Database | ||
|
|
||
| The database reads in SEP module data from data.csv and stores the useful data into an ArrayList of module mappings and universities. | ||
|
|
||
| Upon starting easySEP, the DatabaseStorage will load each line from data.csv, parse the line using DatabaseParser, and store the data into the Database. | ||
|
|
||
| Relevant exceptions are thrown when there are unexpected scenarios. For instance, if data.csv cannot be found at the given file path, a FileNotFoundException is thrown. | ||
|
There was a problem hiding this comment. You may consider putting data.csv in a code block, e.g. |
||
|
|
||
| The following diagram illustrates the relationships between the three main database classes - DatabaseStorage, DatabaseParser, and Database. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Consider changing from square bullets to '+' and '-' to show public and private methods There was a problem hiding this comment.
Can consider removing the circle C symbol as it is not the standard textbook convention taught to us. There was a problem hiding this comment. Good that the multiplicity and directionality are all included! |
||
|
|
||
| The following diagram illustrates the flow of the program, from the initial loadDatabase call to the eventual completion of updating the entire database. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment.
Is the activation bar suppose for DatabaseStorage suppose to start? |
||
|
|
||
| ### User Storage | ||
|
|
||
| User Storage stores 2 different user information. University list is a list of interested universities for SEP | ||
| and it is stored in a text file ("data/uni_info.txt"). For each university in the list, information includes | ||
| Partner University's name, country, list of modules and their corresponding information. It also records whether the | ||
| user previously added the particular university in the favourites list. Timetable list is a list of timetables | ||
| for universities that the user is interested in and it is stored in a text file ("data/timetable_info.txt"). For each | ||
| timetable in the list, information includes Partner University's name, country, module information and lesson timings. | ||
|
|
||
| Upon starting easySEP, the UserStorage class will take in information from both text files and convert them into Strings. | ||
| UserStorageParser will create a new UserUniversityListManager, by converting the String into a HashMap<String, UserUniversityList> | ||
| which serves as myManager for the UserUniversityListManager class. UserStorageParser will also create a new TimetableManager, | ||
| and add lessons to the TimetableManager, using the String extracted from the text file. | ||
|
|
||
| Relevant exceptions are thrown when there are unexpected scenarios. For example, if the data in the text file is stored in an invalid format, | ||
| an InvalidUserStorageFileException will be thrown. | ||
|
|
||
| During the duration of the program, whenever the user decides to alter the data corresponding to UserUniversityListManager | ||
| (ie. add / delete universities or modules, or create new university list), UserStorageParser class will update "data/uni_info.txt" accordingly. | ||
| Similarly, whenever the user decides to alter the data corresponding to TimetableManager (ie. add / delete lessons), UserStorageParser class will update | ||
| "data/timetable_info.txt" accordingly. This is achieved by converting UserUniversityListManager / TimetableManager into a String, | ||
| before saving it in the text file. | ||
|
|
||
| The following diagram illustrates the relationships between the two main user storage classes - UserStorage and UserStorageParser. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Great detailed class diagram that gives an overview of the functions in the parser. To aid readability and understanding, maybe you might want to reduce the functions that are shown in the diagram and show the more important ones instead? There was a problem hiding this comment. Consider removing the C next to your class names for class diagrams There was a problem hiding this comment. Class diagrams are nice with additional information on the navigability |
||
|
|
||
| The following diagram illustrates the flow of the program, from initialisation to updating of the text file. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. I like how there are separate dividers in the sequence diagram, i.e. Initialization and Getting User Input to demarcate the purpose very clearly. Nice! |
||
|
|
||
| ### Timetable | ||
|
|
||
| Upon starting easySEP, a TimetableManager is created in preparation for users to begin adding Timetables. The TimetableManager is used to create new Timetables, manage existing Timetables and delete old Timetables. | ||
| These Timetables are stored in a HashMap and indexed by university name to facilitate easy reference. | ||
|
|
||
| For existing Timetables, they can be used to add and delete Lessons. Each Timetable is made up of a HashMap of ArrayLists(type: Lesson) indexed by weekday e.g. Monday for easy compartmentalisation. | ||
| Within Timetables, Lessons will compromise details like the day, start time and end time. The ArrayLists(type: Lesson) are sorted in non-descending order by the start time of the Lessons. | ||
|
|
||
| Relevant exceptions are thrown when unanticipated scenarios occur. For instance, if the user attempts to delete a non-existent Timetable, a TimetableNotFoundException is thrown. | ||
| Another example is the user attempting to add a lesson that is conflicting with an existing lesson in his/her timetable. In this case, a TimetableClashException is thrown. | ||
|
|
||
| The following diagram illustrates the relationships between the three main timetable classes - TimetableManager, Timetable and Lesson. | ||
|
|
||
|  | ||
|
|
||
| In chronological order, the following diagrams illustrate the flow of the program for adding lessons, deleting lessons and displaying timetables to the user. | ||
|
There was a problem hiding this comment. All 3 class diagrams are well explained and focused on the main flow. |
||
|
|
||
|  | ||
|
There was a problem hiding this comment. Detailed and clear diagram. Perhaps might want to put the There was a problem hiding this comment. Is there a missing return variable for the |
||
|  | ||
|  | ||
|
|
||
| ### Delete History | ||
|
|
||
| To help users recall the modules that they had recently deleted, the Delete History feature allows them to view up to 5 most | ||
| recently deleted module mappings. This can help them to add the module mappings back to the lists without having to search for the specific | ||
| module code again. | ||
|
|
||
| The UserDeletedModules class has an ArrayDeque, which stores the recently deleted module mappings. | ||
| When the user deletes a module mapping, it will be added to the ArrayDeque. | ||
| If the ArrayDeque already contains 5 module mappings, the last one (least recent) will be deleted, before the addition of a new module mapping. | ||
| Do note that delete history information is not stored upon exiting the app (ie. it is not stored in User Storage). | ||
|
|
||
| The following diagram illustrates the relationship between UserUniversityListManager and UserDeletedModules classes. | ||
|
|
||
|  | ||
|
|
||
| The following diagram illustrates the flow of the program, when a user deletes a module. | ||
|
|
||
|  | ||
|
|
||
| ### Ui | ||
|
|
||
| The Ui class is the cornerstone of the Duke program to facilitate interaction with the user. It is used to scan and collect user input, print error messages to the user upon invalid input commands, | ||
| and display the appropriate acknowledgements or required information based on the user's command. | ||
|
|
||
| The following diagram illustrates the methods within the Ui class that can be invoked by the other classes in Duke for the purpose of user interaction. | ||
|
There was a problem hiding this comment. Nice looking class diagram with clearly written functions. I think you might want to consider adding like how the class is connected to other classes in the application, rather than showing it as a standalone UI class on its own |
||
|
|
||
|  | ||
|
|
||
| ### Commands | ||
|
|
||
| To interact with easySEP, users have to input commands specified with parameters to perform operations which will be passed to the CommandParser to generate a corresponding Command according to their input. | ||
| The Command will then be executed to perform the operation on the other classes managing the timetables and databases. Error checking is handled to throw InvalidUserCommandException if the user's input does not match | ||
| the specified Command format. To deal with parsing parameters, spaces in University names and Module codes are to be replaced with underscores. | ||
|
|
||
| The following class diagram illustrates the relationship between Command class and its subclasses as well as other classes related to Commands. | ||
|  | ||
|
There was a problem hiding this comment. Your command class diagram is not rendered on the website view (https://ay2223s1-cs2113-w13-2.github.io/tp/DeveloperGuide.html), might want to look into this |
||
|
|
||
| #### Create Command | ||
|
|
||
| A Create command can be used to create a university list and its corresponding timetable. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of a create command. | ||
|
|
||
|  | ||
|
|
||
| #### Exit Command | ||
|
|
||
| An Exit command can be used to exit the application. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of an exit command. | ||
|
|
||
|  | ||
|
|
||
| #### Help Command | ||
|
|
||
|
There was a problem hiding this comment. (For all the command classes) Please write more explanation to support the diagrams rather than the short one to three sentences! |
||
| A Help command can be used to exit the application. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of a help command. | ||
|
|
||
|  | ||
|
|
||
|
There was a problem hiding this comment. You are missing columns in your sequence diagram as UI, database, etc. are objects |
||
| #### Add Command | ||
|
|
||
| An add command can be used to add a lesson to the timetable or add a module mapping to the user university list. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of an add command. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. You might want to take separate screenshots as the sequence is huge and is not really readable. There was a problem hiding this comment. consider using reference frames for your sequence diagrams to help you break down your sequence diagrams There was a problem hiding this comment. You may wish to consider removing the trivial functions from the sequence diagram so that more emphasis is placed on the important functions, and help improve readability of your diagram. There was a problem hiding this comment. Consider abstracting and explaining only the logic of the add command. The interaction with Duke class could be excluded and explain in an overall sequence diagram before all the command class. |
||
|
|
||
| #### Delete Command | ||
|
|
||
| A delete command can be used to delete a lesson from the timetable, delete a module mapping from the user university list or delete an entire user created university list. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of a delete command. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. You may consider adding |
||
|
|
||
| #### View Command | ||
|
|
||
| A view command can be used to view all user created university lists, view user's delete history, view user's selected university list or view all the user's created university lists' timetables. | ||
|
|
||
| The following sequence diagram illustrates the relationship between the respective classes involved in the creation and execution of a view command. | ||
|
|
||
|  | ||
|
|
||
| #### List Command | ||
|
|
||
| A list command can be used to display all the module mappings in the database, all the universities in the database, or allow users to filter by NUS module code or partner university name. | ||
|
|
||
| The following class diagram illustrates the relationship between the respective classes involved in the creation and execution of a list command. | ||
|
|
||
|
There was a problem hiding this comment. Nice graph! Can add more labels to the graph so that the graph is clearer |
||
|  | ||
|
There was a problem hiding this comment. I like that there is an There was a problem hiding this comment. I noticed that the
|
||
|
|
||
| To differentiate between the various functions of the list command, a variable `listOption` is used. This variable signals Duke to execute the relevant commands accordingly. | ||
|
|
||
| The following sequence diagram illustrates the flow of the program to read in the user input, parse the user input, check if it is a valid list command, and execute the relevant list command based on the `listOption`. | ||
|
|
||
|  | ||
|
|
||
| #### Favourite Command | ||
|
|
||
| A favourite command can be used by the user to favourite or un-favourite lists of module mappings that they have curated. It can also be used to display all of the user's favourite lists and the module mappings they contain. | ||
|
|
||
| To differentiate between the various functions of the favourite command, a variable `favouriteOption` is used. This variable signals Duke to execute the relevant commands accordingly. | ||
|
|
||
| The following class diagram illustrates the relationship between the respective classes involved in the creation and execution of a favourite command. | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. As we are not taught to use the circle bubbles in the diagrams, which I think it really makes the diagram more clear, you do however might want to consider taking the bubbles away? |
||
|
|
||
| The following sequence diagram illustrates the flow of the program to read in the user input, parse the user input, check if it is a valid favourite command, and execute the relevant favourite command. | ||
|
|
||
|  | ||
|
|
||
| ## Product scope | ||
|
|
||
|
|
||
| ### Target user profile | ||
|
|
||
| {Describe the target user profile} | ||
|
|
@@ -20,18 +201,18 @@ | |
|
|
||
| ## User Stories | ||
|
|
||
| | Version | As a ... | I want to ... | So that I can ... | | ||
| | ------- | -------- | ------------------------- | ----------------------------------------------------------- | | ||
| | v1.0 | new user | see usage instructions | refer to them when I forget how to use the application | | ||
| | v2.0 | user | find a to-do item by name | locate a to-do without having to go through the entire list | | ||
|
|
||
| ## Non-Functional Requirements | ||
|
|
||
| {Give non-functional requirements} | ||
|
|
||
| ## Glossary | ||
|
|
||
| - _glossary item_ - Definition | ||
|
|
||
| ## Instructions for manual testing | ||
|
|
||
|
There was a problem hiding this comment. I am unsure if you missed this section or decided not to do it, as it is empty. Consider deleting it if you don't need it. |
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello! There isn't an introduction on what your application is about :/
As well as any acknowledgement is missing as well.