[CS2113-T13-3] WhereGotTime #36
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,290 @@ | ||
| # Developer Guide | ||
|
|
||
| ## Table of content | ||
| **1. Setting Up**\ | ||
| **2. Design**\ | ||
| **3. Implementation** | ||
|
|
||
| ## 1. Setting Up | ||
|
|
||
| **Prerequisites:** | ||
| * JDK 11 | ||
| * IntelliJ IDE | ||
|
|
||
| Refer to the guide [_Setting Up_](SettingUp.md). | ||
|
|
||
| ## 2. Design | ||
|
|
||
| ### 2.1 Architecture | ||
| The **Architecture Diagram** below shows a high-level design of WhereGotTime. The design is based | ||
| on multi-tier architecture where the processing, UI, logic and data management are separated. The upper | ||
| tiers make use of services provided by lower tiers. | ||
|
|
||
|  | ||
|
|
||
| <div markdown="span" class="alert alert-primary"> | ||
|
|
||
| **Tip:** The `.puml` files used to create diagrams in this document can be found in the [diagrams](https://github.com/se-edu/addressbook-level3/tree/master/docs/diagrams/) folder. Refer to the [_PlantUML Tutorial_](https://se-education.org/guides/tutorials/plantUml.html) to learn to create and edit diagrams. | ||
|
|
||
| </div> | ||
|
|
||
| Here is a quick overview of the main components of WhereGotTime: | ||
| 1. `WhereGotTime` - initializes the components in the app | ||
| 1. `UI` - the user interface of the app | ||
| 1. `Parser` - analyzes and interprets user input | ||
| 1. `Command` - executes the action required by user | ||
| 1. `Storage` - reads and writes data to file | ||
| 1. `Common` - collection of classes used by multiple components | ||
| * `Users` - the users who have logged into WhereGotTime | ||
| * `Timetable` - the timetable of each of the users | ||
| * `Event` - an object representing a lesson in the timetable | ||
|
|
||
| **How architecture components interact** | ||
|
|
||
| The following Sequence Diagram displays how components interact when the user inputs `clear /fri` | ||
|
|
||
|  | ||
|
|
||
| ## 3. Design & Implementation | ||
| This section describes how features/functions are implemented. | ||
|
|
||
| ### Add Function | ||
|
|
||
| #### System Architecture of the Add Function<br/> | ||
|
|
||
|  | ||
|
|
||
| The Architecture Diagram given above explains the high-level design of the add command.<br/> | ||
|
|
||
| Below we will discuss a quick overview of each component. | ||
|
|
||
| * UI: The User Interface of the app<br/> | ||
| * Add Command: The main logic command of the add function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
|
|
||
| #### Design of the Add Function<br/> | ||
|
|
||
| UML Class Diagram of the Add function: | ||
| <br/> | ||
|
There was a problem hiding this comment. Is the bracket of the execute function supposed to be beside "execute" instead of "void"? |
||
|
|
||
| 1) The Add function gets the inputs from the User and places it to the event class so that | ||
| it can parser to string.<br/> | ||
| 2) It will then pass the event data onto UI class to display and inform user of the event added | ||
| to the timetable.<br/> | ||
| 3) Next,the add function will pass all the parameters (event name,day,time | ||
| and location) to the timetable class into its arraylist divided by the day of the week<br/> | ||
|
|
||
| #### Sequence Design of Add Function<br/> | ||
| <br/> | ||
|
There was a problem hiding this comment. Perhaps this sequence diagram should be done using an online application instead of hand drawn? There was a problem hiding this comment. Would it be better to use a software to draw the sequence diagram instead of hand drawing it? There was a problem hiding this comment. There should be a return arrow from the activation bar under the Timetable class to the activation bar of execute(). |
||
|
|
||
| #### Improvements to be made to Version 2.0<br/> | ||
| * To ensure that the users do not enter duplicate event that has the same timing or in between the time | ||
| that is entered. | ||
| * A verification check is added to the add command of the version 2.0 of WhereGotTime. | ||
|
|
||
|
There was a problem hiding this comment. You could perhaps add a segment to explain the above sequence diagram? |
||
| E.g. | ||
| * add /CS2113 Lec /Mon /1200-1400 /LT21<br/> | ||
| * add /CS2113 Lec /Mon /1300-1400 /LT22<br/> | ||
| * add /CS2040C Tut /Mon /1300-1500 /LT32<br/> | ||
|
|
||
| The above would result in the first line being add, | ||
| while the other two will result in the app giving an error message | ||
| prompting the user to re-enter again.<br/> | ||
|
|
||
| ### Edit Function<br/> | ||
|
There was a problem hiding this comment. This segment seems incomplete? Minimally some description of what these functions are instead of simply listing would be helpful to the reader. |
||
|
|
||
| #### Class Diagram <br/> | ||
|
|
||
| <br/> | ||
|
|
||
| ### Delete Function | ||
|
|
||
| #### System Architecture of the Delete Function<br/> | ||
|
|
||
|  | ||
|
|
||
| The Architecture Diagram given above explains the high-level design of the delete command.<br/> | ||
| * UI: The User Interface of the app<br/> | ||
| * DeleteCommand: The main logic command of the delete function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
| * WhereGotTime: The main logic component of the app<br/> | ||
|
|
||
| #### Design of the Delete Function<br/> | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Is there a better way to show 3 arrows pointing to Ui? Perhaps a slightly larger diagram would help? |
||
|
|
||
| 1. `DeleteCommand` gets the input from the User and gets the relevant timetable from `Timetable` | ||
| 1. `DeleteCommand` then proceeds to delete the event in the timetable based on the index in the user input | ||
| 1. `DeleteCommand` passes the day, deleted event and size of timetable to the `UI` | ||
| 1. `UI` updates the user of the successful deletion of the event | ||
|
|
||
| #### Sequence Design of Delete Function<br/> | ||
| <br/> | ||
|
|
||
| ### Clear Function | ||
|
|
||
| #### System Architecture of the Clear Function<br/> | ||
|
There was a problem hiding this comment. Perhaps the system architecture of the delete and clear functions could be consolidated, since they are similar in nature? |
||
|
|
||
|  | ||
|
|
||
| The Architecture Diagram given above explains the high-level design of the clear command.<br/> | ||
| * UI: The User Interface of the app<br/> | ||
| * ClearCommand: The main logic command of the clear function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
| * WhereGotTime: The main logic component of the app<br/> | ||
|
|
||
| #### Design of the Clear Function<br/> | ||
|
|
||
|  | ||
|
|
||
| 1. `ClearCommand` gets the input from the User and gets the relevant timetable from `Timetable` | ||
| 1. `ClearCommand` then proceeds to clear all events from the timetable | ||
| 1. `ClearCommand` passes the day and cleared lesson to the `UI` | ||
| 1. `UI` updates the user of the successful clearing of events | ||
|
|
||
| #### Sequence Design of Clear Function<br/> | ||
| <br/> | ||
|
|
||
| ### List Function | ||
|
|
||
| #### System Architecture of the List Function<br/> | ||
|
|
||
|  | ||
|
|
||
| The Architecture Diagram given above explains the high-level design of the list command.<br/> | ||
| * UI: The User Interface of the app<br/> | ||
| * ListCommand: The main logic command of the list function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
| * WhereGotTime: The main logic component of the app<br/> | ||
|
|
||
| #### Design of the List Function<br/> | ||
|
|
||
|  | ||
|
Comment on lines
+157
to
+167
There was a problem hiding this comment.
Comment on lines
+166
to
+167
There was a problem hiding this comment.
|
||
|
|
||
| 1. `ListCommand` gets the input from the User and gets the relevant user's timetable(s) from `Timetable` | ||
| 1. `ListCommand` then passes the user's timetable(s) to the `UI` | ||
| 1. `UI` prints all the classes in the timetable | ||
|
|
||
| #### Sequence Design of List Function<br/> | ||
| <br/> | ||
|
Comment on lines
+173
to
+174
There was a problem hiding this comment.
Comment on lines
+173
to
+174
There was a problem hiding this comment. Might be better to add an activation bar under the Ui class when printList is called. After calling the printList method, arrows can then be used to indicate returning from Ui to ListCommand and also from execute() to the ListCommand class itself |
||
|
|
||
| ### Find Function | ||
|
|
||
| #### System Architecture of the Find Function<br/> | ||
|
|
||
|  | ||
|
|
||
| The Architecture Diagram given above explains the high-level design of the find command.<br/> | ||
| * UI: The User Interface of the app<br/> | ||
| * FindCommand: The main logic command of the find function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
| * WhereGotTime: The main logic component of the app<br/> | ||
|
|
||
| #### Design of the Find Function<br/> | ||
|
|
||
|  | ||
|
|
||
| 1. `FindCommand` gets the input from the User and gets the timetable from `Timetable` | ||
| 1. `FindCommand` then searches through the timetable to find event that match the keyword entered by User | ||
| 1. `FindCommand` passes the matching events to `UI` | ||
| 1. `UI` prints the matching events | ||
|
|
||
| #### Sequence Design of Find Function<br/> | ||
| <br/> | ||
|
Comment on lines
+197
to
+198
There was a problem hiding this comment.
|
||
|
|
||
| ### Compare Function<br/> | ||
| #### System Architecture of the Compare Function<br/> | ||
|  <br/> | ||
| The System Architecture given above explains the high-level design of the <b>COMPARE</b> command.<br/> | ||
|
|
||
| Listed below are some features we will be highlighting:<br/> | ||
|
|
||
| * Ui: The User Interface of the app<br/> | ||
| * CompareCommand: The main logic command of the <b>COMPARE</b> function<br/> | ||
| * Timetable: The arraylist where events that are added are stored accordingly<br/> | ||
| * User: User(s) of the program<br/> | ||
| * UserList: An arraylist of User<br/> | ||
|
|
||
| #### Design of the Compare Function<br/> | ||
| <br/> | ||
|
There was a problem hiding this comment. Is there a missing bracket in the getTimetable function? |
||
|
|
||
| 1) The <b>COMPARE</b> function gets the inputs from the User and retrieves the User's / Target User's<br/> | ||
| timetables based on a specific day. It will then compare the timetables and return an arraylist | ||
| of common timeslots.<br/> | ||
| 2) It will then pass the arraylist onto Ui class to display the range of common <br/> | ||
| timeslots the User and Target User have on a specific day of the week.<br/> | ||
|
|
||
|
|
||
| #### Sequence Design of Compare Function<br/> | ||
|  <br/> | ||
|
Comment on lines
+223
to
+224
There was a problem hiding this comment. You can improve this by maybe making the arrow that indicate returning from the Ui class from the end of the activation bar, it should reach the activation bar of the execute() in CompareCommand class. Also, try to use puml for diagrams as it would be neater compared to drawing it by hand. |
||
|
|
||
| #### Improvements to be made to Version 2.0<br/> | ||
| * Display a range of timings instead of individual hours<br/> | ||
| * Remove edge cases<br/> | ||
|
|
||
| E.g.<br/> | ||
| * compare /Alex /Mon<br/> | ||
| * compare /Tammy /Mon<br/> | ||
|
|
||
| These cases above would no longer output "0000HR, 0100HR" etc but | ||
| instead "0000HR - 1000HR" | ||
|
|
||
| ### Login Function | ||
| #### System Architecture of the Login Function<br/> | ||
|  | ||
| * UI: The User Interface of the app<br/> | ||
| * LogInCommand: The main logic command of the Login function<br/> | ||
| * Parser: The main logic that takes input data and builds the command. | ||
| * User: The Class where username, password, etc are stored | ||
| * UserList: The Class that creates an ArrayList where the User objects will be stored | ||
|
|
||
| #### Class Diagram | ||
|  | ||
|
There was a problem hiding this comment. Perhaps some methods like getters should be omitted from the class diagram to simplify and increase readability of the class diagram? 😄 |
||
| 1.) The LogInCommand checks the UserList to check if the inputted user already exists. | ||
| <br/> | ||
| 2.) In the case that the User is a first time user, the LogInCommand will create a new User object then add it into | ||
| the UserList. | ||
|
|
||
| #### Sequence Diagram | ||
|  | ||
|
|
||
|
There was a problem hiding this comment. Opt should be used instead of alt here as there are no alternatives provided. |
||
| 1.) When the user inputs a Login Command, a LogInCommand Object is created with the input member Username and Password. | ||
| <br/> | ||
| 2.) The Login Command is then executed by sending the users UserList, ui Ui and the User nowUser to the method where | ||
| it search the users to check if the input Username already exists with the correct password. | ||
| <br/> | ||
| 3.) If the User already exists, it will return the User back to the method as currentUser. Otherwise, it will create a | ||
| User with the input Username and Password. | ||
| <br/> | ||
|
|
||
| #### Improvements to be made to Version 2.0<br/> | ||
| * In order to protect the User's privacy, the User's Passwords have been encrypted on the save file. | ||
| * A Cryptography Class with encipherPassword and decipherPassword has been implemented as part of the version 2.0 of | ||
| WhereGotTime. | ||
|
|
||
| ## Product scope | ||
| ### Target user profile | ||
|
|
||
| Our Application, WhereGotTime is developed for University students. | ||
|
|
||
| ### Value proposition | ||
| It was developed to solve the inconvenience students face when accessing timetables and lecture venues and | ||
| to keep track of their timetable. | ||
| It is also developed to assist in finding common available time slots for students to study with their peers. | ||
|
|
||
| ## User Stories | ||
|
|
||
| |Version| As a ... | I want to ... | So that I can ...| | ||
| |--------|----------|---------------|------------------| | ||
| |v1.0|new user|login to my own timetable|be sure that it is my own timetable that is shown there| | ||
| |v1.0|new user|add events into my timetable for the day|refer to the timetable to remind me of the event| | ||
| |v1.0|new user|edit events that I have entered into my timetable for the day|easily change the details as I need it| | ||
| |v1.0|new user|delete events in my timetable for the day|remove an event in the timetable that I do not wish to keep| | ||
| |v1.0|new user|clear my timetable for the day|so that I can remove all the entries I have entered wrongly| | ||
| |v1.0|new user|compare my timetable with my friends|schedule a common time for revision together| | ||
| |v2.0|user|have my password encrypted|only I can access my own timetables| | ||
| |v2.0|user|be assured that my inputs are correctly added|my input are correctly convey into the timetable| | ||
| |v2.0|user|access my saved timetables|I do not have to manually enter the timetables again| | ||
|
|
||
| ## Non-Functional Requirements | ||
|
|
||
|
|
||
|
|
@@ -31,4 +296,27 @@ | |
|
|
||
| ## Instructions for manual testing | ||
|
There was a problem hiding this comment. Is it better to follow the format given in here? |
||
|
|
||
| login Alex /123123<br/> | ||
| add /CS2113 Lec /mon /1200-1300 /LT21<br/> | ||
| add /CS3243 Lec /mon /1400-1500 /LT22<br/> | ||
| add /CS2040C Tut /mon /0800-1000 /COM1-2<br/> | ||
| add /CG2028 Tut /Thu /0900-1100 /E4-4-1<br/> | ||
| add /CG2023 Lec /Fri /1700-1800 /E7-3-10<br/> | ||
| list /all<br/> | ||
| list /mon<br/> | ||
| edit /mon /3 /1300-1400<br/> | ||
| edit /fri /1 /0900-1100<br/> | ||
| list /all<br/> | ||
| list /mon<br/> | ||
| login Tammy /321321<br/> | ||
| add /CS2113 Lec /mon /1200-1300 /LT21<br/> | ||
| add /CS2040C Tut /mon /0800-1000 /COM1-2<br/> | ||
| add /CG2028 Tut /Thu /0900-1100 /E4-4-1<br/> | ||
| compare /Alex /mon<br/> | ||
| list /mon<br/> | ||
| edit /mon /2 /1000-1200<br/> | ||
| compare /Alex /mon<br/> | ||
| login Alex /123123<br/> | ||
| delete /mon /2<br/> | ||
| clear /fri<br/> | ||
| bye<br/> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
This image is not loading for me. Perhaps the ".png" is supposed to be ".PNG" instead?