[CS2113T-T12-1] Meeting Organizer #3
Conversation
Construct the basic structure for reservation-related commands
…aster Pull from main team repo.
…aster 2020.3.12 Version updated
…aster reservation fixed hopefully plz
docs/DeveloperGuide.md
Outdated
| ## 3. Implementation | ||
| This section describes some noteworthy details of how our application works in the backend. | ||
| ### 3.1. Detailed implementation of modulelogic component | ||
| <br> |
There was a problem hiding this comment.
Diagram is a little blurry and hard to see
docs/DeveloperGuide.md
Outdated
|
|
||
| ## 3. Implementation | ||
| This section describes some noteworthy details of how our application works in the backend. | ||
| ### 3.1. Detailed implementation of modulelogic component |
There was a problem hiding this comment.
I think the description of the modulelogic component was very well done. However, would be good if some context was given in the DG as I had to refer to the UG to understand the implementation.
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
|
|
||
| ## User Stories | ||
| ## Appendix B: User Stories | ||
|
|
||
| |Version| As a ... | I want to ... | So that I can ...| | ||
| |--------|----------|---------------|------------------| |
docs/DeveloperGuide.md
Outdated
| ## 3. Implementation | ||
| This section describes some noteworthy details of how our application works in the backend. | ||
| ### 3.1. Detailed implementation of logic.modulelogic component | ||
| <br> |
There was a problem hiding this comment.
Should there be an activation bar for the TimetableParser constructor?
docs/DeveloperGuide.md
Outdated
| ### 2.2. UI component | ||
|
|
||
| ### 2.3. Module parsing logic component | ||
| The Module parsing logic component retrieves module information from NUSMODS API. |
There was a problem hiding this comment.
Could a UML diagram be used here to describe the structure of the components?
docs/DeveloperGuide.md
Outdated
| From the figure above, ```ModuleApiParser``` instantiates a HTTP GET request object to fetch a Json object from the open-sourced NUSMOD API server, and is called by ```ModuleHandler``` every time a particular module information is requested. | ||
| <br> | ||
| ```ModuleHandler``` cleans the data provided by ```ModuleApiParser``` and stores an easy to use data structure to be used by ```LessonsGenerator```. | ||
| <br> |
There was a problem hiding this comment.
Should the creation of a new LessonsGenerator point directly to the LessonsGenerator class since it is creating a new LessonsGenerator object?
docs/DeveloperGuide.md
Outdated
| |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| |
There was a problem hiding this comment.
Consider adding more user stories instead of just 1 each per version
docs/DeveloperGuide.md
Outdated
| From the figure above, ```ModuleApiParser``` instantiates a HTTP GET request object to fetch a Json object from the open-sourced NUSMOD API server, and is called by ```ModuleHandler``` every time a particular module information is requested. | ||
| <br> | ||
| ```ModuleHandler``` cleans the data provided by ```ModuleApiParser``` and stores an easy to use data structure to be used by ```LessonsGenerator```. | ||
| <br> |
There was a problem hiding this comment.
Shouldn't there be another activation box for the lessonsChecker() method of the LessonsGenerator?
| Integer semester = Integer.parseInt(myTimetableParser.getSemester()) - 1; | ||
| for (String module : userModules) { | ||
| ModuleHandler myModuleHandler = new ModuleHandler(module); | ||
| message = myModuleHandler.generateModule(); |
There was a problem hiding this comment.
Should this be generateModule() and not generate(Module) in the sequence diagram
docs/DeveloperGuide.md
Outdated
| <br> | ||
| The above figure shows```TimetableParser```, a private class called exclusively by ```LessonsGenerator```. It makes use of regex to sift through timetable link provided by user in the form of ```String``` object and stores | ||
| the semester and the user's module information according to the timetable link provided. It depends on the ```common.Messages``` class to provide the exception message when an incorrect link is being parsed.<br> | ||
| <br> |
There was a problem hiding this comment.
As the TimetableParser and ModuleHandler parts are already in the LessonsGenerator sequence diagram, consider using another type of diagram instead for these components.
| 2. ```LessonsGenerator``` also uses ```Modulehandler``` to retrieve a set of information related to a specific module. | ||
| 3. With both information, ```LessonsGenerator``` is able to dynamically generate the user's time-slots stored in ```ArrayList<String[]>``` via a series of Key-Value pair hashing. | ||
| 4. ```Arraylist<String[]> ``` contains the start/end time, days and weeks of all modules the user is taking. |
There was a problem hiding this comment.
Consider giving the ArrayList<String[]> a name, or make it a separate class of its own, because referring to it as "ArrayList<String[]>" in the DG could be a bit confusing.
docs/DeveloperGuide.md
Outdated
| 1. ```TeamMember``` consists of information of a member's schedule. | ||
| 2. ```TeamMemberList``` is a ```Arraylist<TeamMember> ``` which new ```TeamMember``` can be added to. | ||
| 3. ```ScheduleHandler``` retrieves the schedule of selected ```TeamMember``` in the ```TeamMemberList```, to generate a combined schedule. | ||
| ### 2.5. Meeting component |
There was a problem hiding this comment.
Consider making sure that the subheaders are aligned, although I'm not too sure what is causing this issue in this case.
docs/DeveloperGuide.md
Outdated
| 2. ```TeamMemberList``` is a ```Arraylist<TeamMember> ``` which new ```TeamMember``` can be added to. | ||
| 3. ```ScheduleHandler``` retrieves the schedule of selected ```TeamMember``` in the ```TeamMemberList```, to generate a combined schedule. | ||
| ### 2.5. Meeting component | ||
| The Meeting component of our application consists of 2 classes: ```Meeting MeetingList``` |
There was a problem hiding this comment.
Consider making the 2 classes more obvious, maybe separate them with a comma or more spaces or something.
docs/DeveloperGuide.md
Outdated
| 4. ```Arraylist<String[]> ``` contains the start/end time, days and weeks of all modules the user is taking. | ||
| <br> | ||
|
|
||
| ### 2.4. Schedule component |
There was a problem hiding this comment.
Consider adding the detailed implementation of the schedule component as well.
| * This class contains essential methods to filter out the modules and the timeslots the user | ||
| * is taking from the NUSMOD link. | ||
| */ | ||
| public class TimetableParser { |
There was a problem hiding this comment.
Is there a need for the new keyword?
Other than that, the diagrams are rather concise
| @@ -0,0 +1,94 @@ | |||
| package logic.modulelogic; | |||
There was a problem hiding this comment.
Should the explanation for the sequence diagram for TimetableParser in the DG have more elaboration and links to the diagram? I felt that there was not enough explanation for it.
On the other hand, the explanations for the other 2 diagrams were rather well linked to the sequence diagram.
src/main/java/MeetingOrganizer.java
Outdated
| @@ -0,0 +1,172 @@ | |||
| import com.google.gson.JsonArray; | |||
src/main/java/MeetingOrganizer.java
Outdated
| @@ -0,0 +1,172 @@ | |||
| import com.google.gson.JsonArray; | |||
| import com.google.gson.JsonElement; | |||
| import com.google.gson.JsonObject; | |||
There was a problem hiding this comment.
I felt that section 3.2, Design Considerations was very useful. It takes into account the profile of an experienced developer, but is easy enough to understand for a new developer.
add exceptions for edit and schedule
Update DeveloperGuide.md
…into DevGuideUpdate
hard code values for PE
No description provided.