[CS2113-T10-1] EasInternship #12
Conversation
| public void execute(ArrayList<String> args) { | ||
| String role = ""; | ||
| String company = ""; | ||
| String startDate = "01/01"; | ||
| String endDate = "01/01"; | ||
| boolean hasRole = false; | ||
| boolean hasCompany = false; | ||
|
|
||
| uiCommand.clearInvalidFlags(); | ||
| for (String arg : args) { | ||
| String[] words = arg.split(" ", 2); | ||
| String flag = words[0]; | ||
| switch (flag) { | ||
| case "role": | ||
| hasRole = true; | ||
| if (words.length > 1) { | ||
| role = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "company": | ||
| hasCompany = true; | ||
| if (words.length > 1) { | ||
| company = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "from": | ||
| if (words.length > 1) { | ||
| startDate = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "to": | ||
| if (words.length > 1) { | ||
| endDate = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| default: | ||
| uiCommand.addInvalidFlag(flag); | ||
| break; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| if (!hasRole) { | ||
| uiCommand.addInvalidFlag("role"); | ||
| } | ||
|
|
||
| if (!hasCompany) { | ||
| uiCommand.addInvalidFlag("company"); | ||
| } | ||
| if (!uiCommand.getInvalidFlags().isEmpty()) { | ||
| uiCommand.printInvalidFlags(); | ||
| return; | ||
| } | ||
|
|
||
| Internship newInternship = new Internship(role, company, startDate, endDate); | ||
| internships.addInternship(newInternship); | ||
| uiCommand.showEditedInternship(newInternship, "add"); | ||
| } |
There was a problem hiding this comment.
This method is a bit long, perhaps you could refactor it to separate the argument parsing and the logic for creation of a new internship.
| switch (flag) { | ||
| case "role": | ||
| hasRole = true; | ||
| if (words.length > 1) { | ||
| role = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "company": | ||
| hasCompany = true; | ||
| if (words.length > 1) { | ||
| company = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "from": | ||
| if (words.length > 1) { | ||
| startDate = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| case "to": | ||
| if (words.length > 1) { | ||
| endDate = words[INDEX_DATA]; | ||
| } else { | ||
| uiCommand.addInvalidFlag(flag); | ||
| } | ||
| break; | ||
| default: | ||
| uiCommand.addInvalidFlag(flag); | ||
| break; | ||
| } |
There was a problem hiding this comment.
Since the if checks and else statements are the same for all the switch cases, maybe you could do the if else checks before the switch cases so that the switch cases would be more concise.
| public void updateStatus(String userStatus) throws InvalidStatus { | ||
| List<String> statuses = Arrays.asList("Application Pending", "Application Completed", "Accepted", "Rejected"); | ||
| for (String status : statuses) { | ||
| if (status.equalsIgnoreCase(userStatus)) { | ||
| this.status = status; | ||
| return; | ||
| } | ||
| } | ||
| throw new InvalidStatus(); | ||
| } |
There was a problem hiding this comment.
You could consider using an enum here to make the code easier to update and expand on in the future.
|
|
||
| This is represented with the class diagram below: | ||
|
|
||
|  |
There was a problem hiding this comment.
I believe the visibility of the methods and attributes in this diagram should be signs like "-" and "+" instead of squares and circles. You can consider configuring your plantuml to reflect this.
docs/DeveloperGuide.md
Outdated
| ### 1.1 Architecture | ||
| The architecture of EasInternship is designed to follow the MVC (Model-View-Controller) pattern to facilitate separation of concerns, modularity, and maintainability. | ||
|
|
||
| - **View (UI)**: Responsible for interacting with the user by displaying output and reading input. | ||
| - **Controller (Command and Parser)**: Responsible for parsing user input and invoking the appropriate commands. | ||
| - **Model (InternshipList)**: Manages the state of the application, including the list of internships and tasks. | ||
| - **Storage**: Responsible for loading and saving data from and to the disk. | ||
|
|
There was a problem hiding this comment.
I feel that an architecture diagram help could be a very helpful diagram to add here to give a brief overview of how your different classes interact with each other
docs/UML/loadFromFile.png
Outdated
There was a problem hiding this comment.
Is the format for the "new Internship()" method call correct? My understanding is that it should call a constructor of a new object of "InternshipList" that is created at that point, instead of pointing to an existing object of "InternshipList" with a lifeline before the "new Internship()" method is called.
docs/DeveloperGuide.md
Outdated
| ### Overview | ||
|
|
||
| The `EasInternship` class serves as the entry point of the application. It manages the application's main loop, where the user is continually prompted for input, and commands are processed in response. The class is responsible for initializing the UI, loading saved data, and handling user input until the user chooses to exit the program. | ||
|
|
There was a problem hiding this comment.
I feel that the overview would be more fitting being placed earlier in the documentation guide, perhaps you can give this some consideration?
|
|
||
| ## 1. Design | ||
|
|
||
| ### 1.1 Architecture |
There was a problem hiding this comment.
Consider adding an architecture diagram
|
|
||
| This is represented with the class diagram below: | ||
|
|
||
|  |
There was a problem hiding this comment.
iirc we are supposed to change the default style of the class diagram that is given by PlantUML? Ie use "+" and "-" instead of red squares and green circles.
|
|
||
| This is represented with the class diagram below: | ||
|
|
||
|  |
There was a problem hiding this comment.
also can consider only adding the important methods, instead of spamming all your methods to improve clarity
| There are two main functions, `loadFromFile` and `saveFromFile`. | ||
|
|
||
| The following sequence diagrams depict how the Storage Functions work. | ||
|  |
There was a problem hiding this comment.
the sequence diagram shouldnt have 2 sets of class name?
docs/DeveloperGuide.md
Outdated
|
|
||
| --- | ||
|
|
||
| ### Overview |
There was a problem hiding this comment.
This structure feels abit weird to me. Might be better if you continued to follow the naming structure above? (ie 1.2, 1.3, 2.1, etc)
Refactor output of SortCommand
…r-stories update the value proposition and user story
update 1 in DG of user stories
Add CalendarCommand getUsage to HelpCommand
# Conflicts: # src/main/java/seedu/duke/Internship.java # src/main/java/seedu/duke/Parser.java # src/main/java/seedu/duke/Storage.java
update the ug for stanard output for sortCommand
Implement functionality to mark internships as favourite and filter by favourite internships
…ponding change in UG and DG for SortCommand
# Conflicts: # docs/DeveloperGuide.md
Rahul PPP v2.0
Fix formattinga at the end
Add FilterCommand and FavouriteCommand to DG index
Branch fix sort deadline
updated rahul ppp link
Expand on FAQ in UG
Fix errors in DG
Fix sort by deadline
EasInternship aims to streamline the process of searching for internship opportunities. It optimized for CLI users who are familiar with typing commands and general CLI usage.