[CS2113-T13-3] WhereGotTime #36
There are no files selected for viewing
| 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 |
|---|---|---|
|
|
@@ -2,24 +2,138 @@ | |
|
|
||
| ## Design & implementation | ||
|
|
||
| ### 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. The UML diagram looked a bit strange with the large blank spaces within the classes and the much smaller font used for the multiplicities.
There was a problem hiding this comment. The filled in black arrow heads were to be avoided iirc? (inheritance or association issue?)
|
||
|
|
||
| 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.
You could perhaps indicate more clearly where the arrows are coming from or going. There was a problem hiding this comment. You could also perhaps use the same software to create your uml diagrams for the sake of consistency, as the diagrams vary in style along the document. There was a problem hiding this comment.
|
||
|
|
||
| #### 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. |
||
|
|
||
| ### Delete Function<br/> | ||
|
|
||
| ### Clear Function<br/> | ||
|
|
||
| ### Display Function<br/> | ||
|
|
||
| ### Compare Function<br/> | ||
| #### System Architecture of the Compare Function<br/> | ||
|  <br/> | ||
|
There was a problem hiding this comment.
this diagram faces a similar issue of why the user can by pass the ui as mentioned above There was a problem hiding this comment. Same issue with the second "blue" user. There was a problem hiding this comment.
For this diagram why are there two different coloured users and why do they have different access to the program? The purpose of drawing this additional user and their role is unclear, even in the explanation below. The duplicated timetable box is also confusing. There was a problem hiding this comment.
|
||
| 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/> | ||
|
|
||
| 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/> | ||
|
There was a problem hiding this comment.
For this diagram it is a bit disorganized and confusing. Firstly, it is a bit unclear whether the User class here refers to the User class in the compare function (in which case there shouldn't be a random method call coming from it) or if it refers to an actual user (in which case the notation should be the stick figure not the class header) Secondly, from the CompareCommand activation bar has an unknown return coming from the middle of the activation bar, while the parsedInputs method call being made to the same activation bar is too low down. This is also the case with the activation bar for the self invoked method call execute and the common time array method call to the UI class. It is also unclear where the method call to the UI intends to return to as it is chronologically further down than the end of the return from the parsedInputs method. There was a problem hiding this comment.
|
||
|
|
||
| #### 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 | ||
| #### Class Diagram | ||
|  | ||
|
|
||
| #### 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 +145,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/> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| theme: jekyll-theme-slate |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Manifest-Version: 1.0 | ||
| Main-Class: seedu.duke.Duke | ||
|
|
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.
For this diagram it looks like the user can by pass the interface and directly add commands? Its a bit confusing whether this was intended or why it was designed this way. Further explanation on this part of the diagram would be helpful