+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Rye-Catcher)]
+[[portfolio](team/rye-catcher.md)]
+[[blog](https://x1a0teng.page/posts/about/)]
-* Role: Project Advisor
+* Role: Documentation and Integration
+* Responsibilities: Ensure project documentation in good quality
+and various parts of codes can be integrated to create a whole.
-### Jane Doe
+### Tan Juay Hee
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/juayhee)]
+[[portfolio](team/juayhee.md)]
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality and Testing
+* Responsibilities: Ensures the testing of the project is done properly and on time; looks
+after code quality and ensures adherence to coding standards.
-### Johnny Doe
+### Abdulelah Faisal S Al Ghrairy
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/aalghrairy)] [[portfolio](team/aalghrairy.md)]
-* Role: Developer
-* Responsibilities: Data
+* Role: Deliverables and Deadline
+* Responsibilities: Ensure project deliverables are done on time and in the right format
-### Jean Doe
+### Sim Jun Heng
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/simjunheng)]
+[[portfolio](team/simjunheng.md)]
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Documentation and Integration
+* Responsibilities: In charge of versioning, repository maintenance, and code integration. Assist and ensure
+that all documentations are in-order.
-### James Doe
-
-* Role: Developer
-* Responsibilities: UI
+[[github](http://github.com/prgj)]
+[[portfolio](team/prgj.md)]
+
+* Role: Scheduling and tracking
+* Responsibilities: In charge of defining, assigning, and tracking project tasks.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
index 46eae8ee565..ede35c08427 100644
--- a/docs/DeveloperGuide.md
+++ b/docs/DeveloperGuide.md
@@ -7,26 +7,30 @@ title: Developer Guide
--------------------------------------------------------------------------------------------------------------------
-## **Acknowledgements**
+## **1. Acknowledgements**
-* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+* http://java-buddy.blogspot.com/2013/07/move-node-to-front.html
+* https://stackoverflow.com/questions/38028825/javafx-save-view-of-pane-to-image
+* https://docs.oracle.com/javase/tutorial/java/javaOO/initial.html
--------------------------------------------------------------------------------------------------------------------
-## **Setting up, getting started**
+
+
+## **2. Setting up, getting started**
Refer to the guide [_Setting up and getting started_](SettingUp.md).
--------------------------------------------------------------------------------------------------------------------
-## **Design**
+## **3. Design**
@@ -34,9 +38,11 @@ The ***Architecture Diagram*** given above explains the high-level design of the
Given below is a quick overview of main components and how they interact with each other.
+
+
**Main components of the architecture**
-**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
+**`Main`** has two classes called [`Main`](https://github.com/AY2122S2-CS2103T-W14-2/tp/blob/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2122S2-CS2103T-W14-2/tp/blob/src/main/java/seedu/address/MainApp.java). It is responsible for,
* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
* At shut down: Shuts down the components and invokes cleanup methods where necessary.
@@ -49,6 +55,7 @@ The rest of the App consists of four components.
* [**`Model`**](#model-component): Holds the data of the App in memory.
* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+
**How the architecture components interact with each other**
@@ -59,7 +66,7 @@ The *Sequence Diagram* below shows how the components interact with each other f
Each of the four main components (also shown in the diagram above),
* defines its *API* in an `interface` with the same name as the Component.
-* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.
+* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point).
For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
@@ -67,9 +74,11 @@ For example, the `Logic` component defines its API in the `Logic.java` interface
The sections below give more details of each component.
-### UI component
+
-The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
+### 3.2 UI component
+
+The **API** of this component is specified in [`Ui.java`](https://github.com/AY2122S2-CS2103T-W14-2/tp/blob/master/src/main/java/seedu/address/ui/Ui.java)
@@ -84,20 +93,24 @@ The `UI` component,
* keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
* depends on some classes in the `Model` component, as it displays `Person` object residing in the `Model`.
-### Logic component
+
+
+### 3.3 Logic component
-**API** : [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
+**API** : [`Logic.java`](https://github.com/AY2122S2-CS2103T-W14-2/tp/blob/master/src/main/java/seedu/address/logic/Logic.java)
Here's a (partial) class diagram of the `Logic` component:
How the `Logic` component works:
-1. When `Logic` is called upon to execute a command, it uses the `AddressBookParser` class to parse the user command.
+1. When `Logic` is called upon to execute a command, it uses the `Coach2K22Parser` class to parse the user command.
1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `AddCommand`) which is executed by the `LogicManager`.
1. The command can communicate with the `Model` when it is executed (e.g. to add a person).
1. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`.
+
+
The Sequence Diagram below illustrates the interactions within the `Logic` component for the `execute("delete 1")` API call.
@@ -105,16 +118,20 @@ The Sequence Diagram below illustrates the interactions within the `Logic` compo
How the parsing works:
-* When called upon to parse a user command, the `AddressBookParser` class creates an `XYZCommandParser` (`XYZ` is a placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `AddressBookParser` returns back as a `Command` object.
+* When called upon to parse a user command, the `Coach2K22Parser` class creates an `XYZCommandParser` (`XYZ` is a placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `Coach2K22Parser` returns back as a `Command` object.
* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
-### Model component
-**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
+
+
+### 3.4 Model component
+**API** : [`Model.java`](https://github.com/AY2122S2-CS2103T-W14-2/tp/blob/master/src/main/java/seedu/address/model/Model.java)
@@ -124,18 +141,14 @@ The `Model` component,
* stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
* stores the currently 'selected' `Person` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList- -
-
-
@@ -144,234 +157,1872 @@ The `Storage` component,
* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
-### Common classes
+### 3.6 Common classes
Classes used by multiple components are in the `seedu.addressbook.commons` package.
--------------------------------------------------------------------------------------------------------------------
-## **Implementation**
+
+
+## **4. Implementation**
This section describes some noteworthy details on how certain features are implemented.
-### \[Proposed\] Undo/redo feature
+### 4.1 Contact Management
-#### Proposed Implementation
+#### 4.1.1 Add Feature
-The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`. Additionally, it implements the following operations:
+##### Implementation
-* `VersionedAddressBook#commit()` — Saves the current address book state in its history.
-* `VersionedAddressBook#undo()` — Restores the previous address book state from its history.
-* `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history.
+This feature allows the user to add persons to the person list. It is facilitated by `ModelManager` which
+makes use of the method `#addPerson()` to add a new person to the person list.
-These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
+Given below is an example usage scenario of how the add person mechanism behaves at each step.
-Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.
+Step 1: The user inputs `add-p n/Johnson p/83918273 a/Woodlands Avenue 4 e/johnson@gmail.com` to add a new person to the person list.
-Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
+Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddPersonCommandParser` where its method `#parse()` is called to process the user inputs.
-
+Step 3: It then returns a newly initialised `AddPersonCommand` back to the `LogicManager` for command execution.
-Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state.
+Step 4: During the command execution, the `ModelManager#addPerson()` is called which adds the new person to an internal list and updates the GUI display. A new contact named "Johnson" with his relevant details is then shown in the person list.
-
+
-Step 3. The user executes `add n/David …` to add a new person. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`.
+The steps above are summarised using a sequence diagram as shown below.
+
-
+##### Design Consideration
-
+#### 4.1.3 Edit Feature
-#### Design considerations:
+##### Implementation
-**Aspect: How undo & redo executes:**
+This feature allows the user to edit persons from the person list. It is facilitated by `ModelManager` which
+makes use of the method `#setPerson()` to update a person from the person list. If the person's name is edited in this process, the method `#setTask()` will be called to ensure all tasks tagged with this person is updated according.
-* **Alternative 1 (current choice):** Saves the entire address book.
- * Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+Given below is an example usage scenario of how the edit person mechanism behaves at each step.
-* **Alternative 2:** Individual command knows how to undo/redo by
- itself.
- * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
- * Cons: We must ensure that the implementation of each individual command are correct.
+Step 1: The user inputs `edit-p 1 n/Johnson` to edit the first person in the person list.
-_{more aspects and alternatives to be added}_
+Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `EditPersonCommandParser` where its method `#parse()` is called to process the user inputs.
-### \[Proposed\] Data archiving
+Step 3: It then returns a newly initialised `EditPersonCommand` back to the `LogicManager` for command execution.
-_{Explain here how the data archiving feature will be implemented}_
+Step 4: During the command execution, the `ModelManager#setTask()` method is called multiple times to update the
+name of the corresponding person in all the tasks. After which, the `ModelManager#setPerson()` method is called to update the specified person in the person list.
+Step 5: The GUI display is then updated to show a new contact and task list with the updated person details.
---------------------------------------------------------------------------------------------------------------------
+
-## **Documentation, logging, testing, configuration, dev-ops**
+The steps above are summarised using a sequence diagram as shown below.
+
-* [Documentation guide](Documentation.md)
-* [Testing guide](Testing.md)
-* [Logging guide](Logging.md)
-* [Configuration guide](Configuration.md)
-* [DevOps guide](DevOps.md)
+##### Design Consideration
---------------------------------------------------------------------------------------------------------------------
+**Aspect: Should there be an abstraction for persons:**
-## **Appendix: Requirements**
+* **Alternative 1 (current choice):** Separate `edit-p` command for editing a person.
+ * Pros: Easy to extend and modify.
+ * Cons: Not as intuitive for the user.
+* **Alternative 2:** Single `edit` command that edits tasks/persons depending on parameters.
+ * Pros: More intuitive for the user.
-### Product scope
+
-**Target user profile**:
+#### 4.1.4 Clear Feature
-* has a need to manage a significant number of contacts
-* prefer desktop apps over other types
-* can type fast
-* prefers typing to mouse interactions
-* is reasonably comfortable using CLI apps
+##### Implementation
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+This feature allows users to clear all persons from the person list.
+It is facilitated by the `ModelManager` which sets a new `AddressBook` object to the `ModelManager` to clear the person list. The method `#setTask()` will also be called to ensure all tasks do not have any persons tagged to it.
+Given below is an example usage scenario of how the clear person mechanism behaves at each step.
-### User stories
+Step 1: The user inputs `clear-p` to clear all persons from the person list.
-Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
+Step 2: This argument is passed into the `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable
+parser class which corresponds with the provided command to parse the user's inputs.
-| Priority | As a … | I want to … | So that I can… |
-| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
-| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
-| `* * *` | user | add a new person | |
-| `* * *` | user | delete a person | remove entries that I no longer need |
-| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
-| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
-| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
+Step 3: Since there are no arguments for this command, a newly initialised `ClearPersonCommand` is returned to the `LogicManager` for command execution.
-*{More to be added}*
+Step 4: During the command execution, the `ModelManager#setTask()` method is called multiple times to delete persons in all the tasks. After which, a new `AddressBook` object is passed into the `ModelManager#setAddressBook()` method which clears out the person list.
-### Use cases
+Step 5: The GUI display is then updated to show an empty contact and new task list without any persons tagged to the tasks.
-(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
+
-**Use case: Delete a person**
+The steps above are summarised using a sequence diagram as shown below.
+
-**MSS**
+##### Design Consideration
-1. User requests to list persons
-2. AddressBook shows a list of persons
-3. User requests to delete a specific person in the list
-4. AddressBook deletes the person
+**Aspect: Should there be separate clear commands for clearing tasks and persons:**
- Use case ends.
+* **Alternative 1 (current choice):** A separate command for clearing tasks and persons.
+ * Pros: Easy to implement.
+ * Cons: Hard to extend.
+* **Alternative 2:** A combined command for clearing tasks and persons.
+ earPer * Pros: Easier and more intuitive for the user to understand
+ * Cons: Hard to implement.
-**Extensions**
+
-* 2a. The list is empty.
+#### 4.1.5 Add Tags Feature
- Use case ends.
+##### Implementation
+This feature allows the user to add tags to contacts in the list. It is facilitated by `ModelManager` which
+makes use of the method `#setPerson()` and `#updateFilteredPersonList()` to add tags to a contact.
-* 3a. The given index is invalid.
+Given below is an example usage scenario of how the add tag mechanism behaves at each step.
- * 3a1. AddressBook shows an error message.
+Step 1: The user inputs `tag-add-p 1 friend` to add the tag "friend" to the first contact in the list.
- Use case resumes at step 2.
+Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddPersonTagCommandParser` where its method `#parse` is called to process the user inputs.
-*{More to be added}*
+Step 3: It then returns a newly initialised `AddPersonTagCommand` back to the `LogicManager` for command execution. This `AddPersonTagCommand` contains information about the new tag (in this case, "friend")
-### Non-Functional Requirements
+Step 4: During the command execution, the `ModelManager#setPerson()` is called which edits the tags of the person with the user-supplied tags. The filtered person list is updated with `ModelManager#updateFilteredPersonList` to display the new information to the user.
-1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
-2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
-3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+
-*{More to be added}*
+The steps above are summarised using a sequence diagram as shown below.
+
-### Glossary
-* **Mainstream OS**: Windows, Linux, Unix, OS-X
-* **Private contact detail**: A contact detail that is not meant to be shared with others
+##### Design Consideration
---------------------------------------------------------------------------------------------------------------------
+**Aspect: Should the implementation use the existing edit functionalities in Coach2K22:**
+* **Alternative 1:** Use the current EditCommand class to edit a person's tags.
+ * Pros: Maintains abstraction and reuses code instead of writing new code.
+ * Cons: Creates a cyclic dependency, making the code base harder to maintain later on
-## **Appendix: Instructions for manual testing**
+* **Alternative 2 (current choice):** Implement AddPersonTagCommand independently, rewriting similar code
+ * Pros: Cleaner code and less dependencies
+ * Cons: Repetitive code that is not abstracted
-Given below are instructions to test the app manually.
+
-- Expected: The most recent window size and location is retained. +The steps above are summarised using a sequence diagram as shown below. + -1. _{ more test cases … }_ -### Deleting a person +##### Design Consideration -1. Deleting a person while all persons are being shown +**Aspect: Should the implementation use the existing edit functionalities in AB3:** +* **Alternative 1:** Use the current EditCommand class to edit a person's tags. + * Pros: Maintains abstraction and reuses code instead of writing new code. + * Cons: Creates a cyclic dependency, making the code base harder to maintain later on + +* **Alternative 2 (current choice):** Implement DeletePersonTagCommand independently, rewriting similar code + * Pros: Cleaner code and less dependencies + * Cons: Repetitive code that is not abstracted + + + +#### 4.1.7 Find Feature + +##### Implementation + +This feature allows the user to display selected persons in the contact list. It is facilitated by `ModelManager` which +makes use of the method `#updateFilteredPersonList()` to find persons by name or tag. + +Given below is an example usage scenario of how the find person mechanism behaves at each step. + +Step 1: The user inputs `find n/Alex t/friends` to find selected persons. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `FindPersonCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `FindPersonCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#updateFilteredPersonList()` is called which updates the GUI display with only selected persons shown in the contact list. The command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be a separate find command for name and tag:** + +* **Alternative 1 (current choice):** A combined command for finding name and tag. + * Pros: Easy to implement. + * Cons: Users may have to remember more prefixes. + +* **Alternative 2:** A separate command for finding name and tag. + * Pros: Commands may be more intuitive to the users. + * Cons: Possible violation of the DRY principle. + +**Aspect: Should there be separate find commands for finding tasks and persons:** + +* **Alternative 1 (current choice):** A separate command for finding tasks and persons. + * Pros: Easy to implement. + * Cons: Hard to extend. + +* **Alternative 2:** A combined command for finding tasks and persons. + * Pros: Easier and more intuitive for the user to understand. + * Cons: Hard to implement. + + + +#### 4.1.7 Add Strength/Weakness/Misc Features + +##### Implementation + +These features allow the user to add a strength, weakness, or miscellaneous note to a person in the person list . It is facilitated by `ModelManager` which +makes use of the method `#setPerson()` to replace the particular person with the new person with modified note list (depending on the given command). + +Given below is an example usage scenario of how the Add Strength mechanism behaves at each step._Note that three commands have similar implementations, so only the Add Strength feature implementation will be provided here._ + +Step 1: The user inputs `strength-add 1 great endurance` to add the strength `great endurance` to the person in index `1` of the person list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddStrengthCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `AddStrengthCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, `ModelManager#setPerson()` method is called to update the specified person in the person list with the new strength list. + + + +The steps above are summarised using a sequence diagram as shown below. Note that all occurrences of `Strength` or `AddStrengthCommand` (and similar instances) will be generalized to `Note` and `AddNoteCommand` respectively to represent the implementation of the Add Strength, Weakness, and Misc features. + + +##### Design Consideration + +**Aspect: Should there be different note lists for each person:** + +* **Alternative 1 (current choice):** Separate `note-add` command into three different commands. + * Pros: Easier to use and more intuitive. + * Cons: Difficult to extend and modify. +* **Alternative 2:** Single `note-add` command for adding to each list with provided prefixes. + * Pros: Easier to extend and modify. + * Cons: Not intuitive for the user and more prone to feature flaws + + + +#### 4.1.8 Delete Strength/Weakness/Misc Features + +##### Implementation + +These features allow the user to delete a strength, weakness, or miscellaneous note from a person in the person list . It is facilitated by `ModelManager` which +makes use of the method `#setPerson()` to replace the particular person with the new person with modified note list (depending on the given command). + +Given below is an example usage scenario of how the Delete Strength mechanism behaves at each step._Note that three commands have similar implementations, so only the Delete Strength feature implementation will be provided here._ + +Step 1: The user inputs `strength-del 1 1` to delete the first strength from the person in index `1` of the person list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `DeleteStrengthCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `DeleteStrengthCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, `ModelManager#setPerson()` method is called to update the specified person in the person list with the new strength list. + + + +The steps above are summarised using a sequence diagram as shown below. Note that all occurrences of `Strength` or `DeleteStrengthCommand` (and similar instances) will be generalized to `Note` and `AddNoteCommand` respectively to represent the implementation of the Delete Strength, Weakness, and Misc features. + + +##### Design Consideration + +**Aspect: Should there be different note lists for each person:** + +* **Alternative 1 (current choice):** Separate `note-del` command into three different commands. + * Pros: Easier to use and more intuitive. + * Cons: Difficult to extend and modify. +* **Alternative 2:** Single `note-del` command for adding to each list with provided prefixes. + * Pros: Easier to extend and modify. + * Cons: Not intuitive for the user and more prone to feature flaws + + + +#### 4.1.9 Sort by Strength/Weakness Features + +##### Implementation + +These features allow the user to sort the person list by the total number of strengths/weaknesses in descending order. It is facilitated by `ModelManager` which +makes use of the method `#setAddressBook()` to replace the address book with the newly sorted person list without modification. + +Given below is an example usage scenario of how the Sort Strength mechanism behaves at each step._Note that two commands have similar implementations, so only the Sort Strength feature implementation will be provided here._ + +Step 1: The user inputs `sort-strength` to sort the entire person list by total number of strengths in descending order. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find the command class to process the command. + +Step 3: It then returns a newly initialised `SortStrengthCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, `ModelManager#setAddressBook()` method is called to update the person list with the newly sorted list of persons based on total number of strengths in descending order. + + + +The steps above are summarised using a sequence diagram as shown below. Note that all occurrences of `Strength` or `SortStrengthCommand` (and similar instances) will be generalized to `Note` and `SortNoteCommand` respectively to represent the implementation of the Sort by Strength and Weakness features. + + +##### Design Consideration + +**Aspect: Should there be different sorting functions for address book and schedule:** + +* **Alternative 1 (current choice):** Use different commands for sorting the address book and schedule. + * Pros: Easier to use and more intuitive. + * Cons: Difficult to extend and modify. +* **Alternative 2:** Single `sort` command for sorting the `AddressBook` and `TaskBook`. + * Pros: Easier to extend and modify. + * Cons: Not intuitive for the user and difficult to implement + + + +### 4.2 Task Management + +#### 4.2.1 Add Feature + +##### Implementation + +This feature allows the user to add tasks to the task list. It is facilitated by `ModelManager` which +makes use of the method `#addTask()` to add a new task to the task list. + +Given below is an example usage scenario of how the add task mechanism behaves at each step. + +Step 1: The user inputs `add-t n/Meet d/11-11-2022 st/11:00 et/01:00` to add a new task to the task list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddTaskCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `AddTaskCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#addTask()` is called which adds the new task to an internal list and updates the GUI display. A new task named "Meet" with the subsequent date and time details is then shown in the task list. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be an abstraction for tasks:** + +* **Alternative 1 (current choice):** Separate `add-t` command for creating a task. + * Pros: Easy to extend and modify. + * Cons: Not as intuitive for the user. +* **Alternative 2:** Single `add` command that adds tasks/persons depending on parameters. + * Pros: More intuitive for the user. + + + +#### 4.2.2 Delete Feature + +##### Implementation + +This feature allows the user to delete tasks from the task list. It is facilitated by `ModelManager` which +makes use of the method `#deleteTask()` to delete a task from the task list. - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +Given below is an example usage scenario of how the delete task mechanism behaves at each step. + +Step 1: The user inputs `del-t 1` to delete the first task in the task list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `DeleteTaskCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `DeleteTaskCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#deleteTask()` is called which deletes the specified person from an internal list and updates the GUI display. A new task list without the deleted task then shown. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be an abstraction for tasks:** + +* **Alternative 1 (current choice):** Separate `del-t` command for deleting a task. + * Pros: Easy to extend and modify. + * Cons: Not as intuitive for the user. +* **Alternative 2:** Single `del` command that deletes tasks/persons depending on parameters. + * Pros: More intuitive for the user. + + + +#### 4.2.3 Add Tags Feature + +##### Implementation +This feature allows the user to add tags to tasks in the list. It is facilitated by `ModelManager` which +makes use of the method `#setTask()` and `#updateFilteredTaskList()` to add tags to a task. + +Given below is an example usage scenario of how the add tag mechanism behaves at each step. + +Step 1: The user inputs `tag-add-t 1 important` to add the tag "friend" to the first task in the list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddTaskTagCommandParser` where its method `#parse` is called to process the user inputs. + +Step 3: It then returns a newly initialised `AddTaskTagCommand` back to the `LogicManager` for command execution. This `AddTaskTagCommand` contains information about the new tag (in this case, "important") + +Step 4: During the command execution, the `ModelManager#setTask()` is called which edits the tags of the task with the user-supplied tags. The filtered task list is updated with `ModelManager#updateFilteredTaskList` to display the new information to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + + + +#### 4.2.4 Delete Tags Feature + +##### Implementation +This feature allows the user to delete tags from tasks in the list. It is facilitated by `ModelManager` which +makes use of the method `#setTask()` and `#updateFilteredTaskList()` to delete tags from a task. + +Given below is an example usage scenario of how the delete tag mechanism behaves at each step. + +Step 1: The user inputs `tag-del-t 1 important` to delete the tag "important" from the first task in the list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `DeleteTaskTagCommandParser` where its method `#parse` is called to process the user inputs. + +Step 3: It then returns a newly initialised `DeleteTaskTagCommand` back to the `LogicManager` for command execution. This `DeleteTaskTagCommand` contains information about the tag to be deleted (in this case, "important") + +Step 4: During the command execution, the `ModelManager#setTask()` is called which edits out the tag from the task. The filtered task list is updated with `ModelManager#updateFilteredTaskList` to display the new information to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + + + +#### 4.2.5 Edit Feature + +##### Implementation + +This feature allows the user to edit tasks from the task list. It is facilitated by `ModelManager` which +makes use of the method `#setTask()` to update a task from the task list. + +Given below is an example usage scenario of how the edit task mechanism behaves at each step. + +Step 1: The user inputs `edit-p 1 n/Meeting` to edit the first task in the task list. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `EditTaskCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `EditTaskCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#setTask()` is called which edits the specified task from an internal list and updates the GUI display. A new task list with the updated task details is then shown. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be an abstraction for tasks:** + +* **Alternative 1 (current choice):** Separate `edit-t` command for editing a task. + * Pros: Easy to extend and modify. + * Cons: Not as intuitive for the user. +* **Alternative 2:** Single `edit` command that edits tasks/persons depending on parameters. + * Pros: More intuitive for the user. + + + +#### 4.2.6 Clear Feature + +##### Implementation + +This feature allows users to clear all tasks from the task list, or only tasks that correspond with a given date. +It is facilitated by the `ModelManager` which utilizes the method `deleteTask()` to delete each corresponding task one +by one, or sets a new `TaskBook` object to the `ModelManager` to refresh the task list. + +Given below is an example usage scenario of how the clear task mechanism behaves at each step. + +Step 1: The user inputs `clear-t 2022-10-10` to clear all tasks that correspond with the date `2022-10-10` in the task list. + +Step 2: This argument is passed into the `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable +parser class which corresponds with the provided command to parse the user's inputs. This initializes the `ClearTaskCommandParser`, +where its method `parse()` is called to process the user inputs. + +Step 3: The newly initialized `ClearTaskCommandParser` is then returned to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#deleteTask()` method is called multiple times to remove the +corresponding tasks from the internal task list. Inside the function call, the `ModelManager#updateFilteredTaskList()` +is also called, which updates the GUI to display the new task list. The command results are then generated and shown to +the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be separate clear commands for clearing tasks and players:** + +* **Alternative 1 (current choice):** A separate command for clearing tasks and players. + * Pros: Easy to implement. + * Cons: Hard to extend. +* **Alternative 2:** A combined command for clearing tasks and player. + * Pros: Easier and more intuitive for the user to understand + * Cons: Hard to implement. + + + +#### 4.2.7 Find Feature + +##### Implementation + +This feature allows the user to display selected tasks in the task list. It is facilitated by `ModelManager` which +makes use of the method `#updateFilteredTaskList()` to find tasks by name or tag. + +Given below is an example usage scenario of how the find task mechanism behaves at each step. + +Step 1: The user inputs `find n/meeting t/friends` to find selected tasks. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `FindTaskCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `FindTaskCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#updateFilteredTaskList()` is called which updates the GUI display with only selected tasks shown in the task list. The command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be a separate find command for name and tag:** + +* **Alternative 1 (current choice):** A combined command for finding name and tag. + * Pros: Easy to implement. + * Cons: Users may have to remember more prefixes. + +* **Alternative 2:** A separate command for finding name and tag. + * Pros: Commands may be more intuitive to the users. + * Cons: Possible violation of the DRY principle. + +**Aspect: Should there be separate find commands for finding tasks and persons:** + +* **Alternative 1 (current choice):** A separate command for finding tasks and persons. + * Pros: Easy to implement. + * Cons: Hard to extend. + +* **Alternative 2:** A combined command for finding tasks and persons. + * Pros: Easier and more intuitive for the user to understand. + * Cons: Hard to implement. + + + +#### 4.2.8 Get Person Feature + +##### Implementation + +This feature allows the user to retrieve contact details of persons tagged to a selected task in the task list. It is facilitated by `ModelManager` which +makes use of the method `#updateFilteredPersonList()` to get persons tagged to a task. + +Given below is an example usage scenario of how the get person mechanism behaves at each step. + +Step 1: The user inputs `get-person 1` to retrieve contact details of persons tagged to the first task. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `GetPersonCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `GetPersonCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#updateFilteredPersonList()` is called. The GUI display then updates the person list - showing only the contact details of persons tagged to the specified task. + + + +The steps above are summarised using a sequence diagram as shown below. + + + + +#### 4.2.9 Sort by Date Feature + +##### Implementation + +This feature allows the user to sort the task list in chronological order. The resulting task list will be sorted by earliest date and time first. +It is facilitated by `ModelManager` which makes use of the method `#getUnfilteredTaskList()` to get the list of tasks. + +Given below is an example usage scenario of how the sort date mechanism behaves at each step. + +Step 1: The user inputs `sort-date` to sort the task list by date. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22#parseCommand()`. Since this command does not require parameters, the SortTaskByDateCommand object is created directly instead of through a Parser. + +Step 3: The newly initialised `SortTaskByDateCommand` is returned back to the `LogicManager` for command execution. + +Step 4: During the command execution, the current list of tasks is sorted using an internal sorting algorithm, then a new TaskBook object is created to store the new ordered list of tasks. + +Step 5: The model replaces its old TaskBook with the new sorted TaskBook using `ModelManager#setTaskBook`, and the GUI updates the task list accordingly. + + + +The steps above are summarised using a sequence diagram as shown below. + + + + +### 4.3 Strategic Planning + +#### 4.3.1 Add Feature + +##### Implementation + +This feature allows the user to add players to the strategy board. It is facilitated by `ModelManager` which +makes use of the method `#addPlayer()` and `#updateFilteredPlayerList()` to add a new player to the strategy board. + +Given below is an example usage scenario of how the adding player mechanism behaves at each step. + +Step 1: The user inputs `add-player Cena` to add a new player to the strategy board. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `AddPlayerCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `AddPlayerCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#addPlayer()` is called which adds the new player to an internal list and updates the GUI display with a new player named "Cena" shown in the strategy board. The command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be an abstraction for players:** + +* **Alternative 1:** A player is a String of player name. + * Pros: Easy to implement. + * Cons: Hard to extend. +* **Alternative 2 (current choice):** A player is an object of class `Player`. + * Pros: Easy to extend and manipulate attributes of a player. + * Cons: Hard to implement. + + + +#### 4.3.2 Load Court Feature + +##### Implementation + +This feature allows the user to load an image to serve as the background of the strategy board. It is facilitated by `CommandResult` which +carries a representation of the image to the `MainWindow` to update the background of the strategy board accordingly. + +Given below is an example usage scenario of how the load court mechanism behaves at each step. + +Step 1: The user inputs `load-court basketball` to load the image from the filepath `courts/basketball.png` to serve as the background of strategy board. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `LoadCourtCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `LoadCourtCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `CommandResult` object is returned to the `MainWindow`, where `CommandResult#getBackgroundImage()` is called to retrieve the image representation. Then, `MainWindow#handleLoadImage(back)` is called to update the background of the strategy board with a new image. The command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be different filetypes for images:** + +* **Alternative 1 (current choice):** Only png images are allowed. + * Pros: Easy to implement. + * Cons: Hard to extend and not intuitive for the user. +* **Alternative 2:** Allow for different filetypes of images (png, jpeg, etc.). + * Pros: Easy to extend and more intuitive for the user. + * Cons: Hard to implement. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + + +#### 4.3.3 Delete Feature - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +##### Implementation - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +This feature allows the user to remove players from the strategy board. It is facilitated by `ModelManager` which +makes use of the method `#deletePlayer()` and `#updateFilteredPlayerList()` to delete an existing player from the strategy board. -1. _{ more test cases … }_ +Given below is an example usage scenario of how the deleting player mechanism behaves at each step. -### Saving data +Step 1: The user inputs `del-player Cena` to remove a player named `Cena` from the strategy board. -1. Dealing with missing/corrupted data files +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `DelPlayerCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `DeletePlayerCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#deletePlayer()` is called which remove the player from an internal list and updates the GUI display with a new player named "Cena" shown in the strategy board. The command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should allow users to remove multiple players at once:** + +* **Alternative 1:** Users can remove multiple players at once. + * Pros: Possibly improve the efficiency for users. + * Cons: User inputs are more prone to errors. +* **Alternative 2 (current choice):** Users can only remove one player at a time. + * Pros: Easy to implement. + * Cons: Users need to repeat the same command multiple times to remove multiple players. + + + +#### 4.3.4 Move Feature + +##### Implementation + +This feature allows the user to move players on the strategy board. It is facilitated by `ModelManager` which +makes use of the method `#deletePlayer()`, `#addPlayer()`, and `#updateFilteredPlayerList()` to move an existing player to a new position on the strategy board. + +Given below is an example usage scenario of how the moving player mechanism behaves at each step. + +Step 1: The user inputs `move Cena x/200 y/100` to move a player named `Cena` to a new position with x-coordinate `200` and y-coordinate `100` on the strategy board. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable parser class to process the user inputs. This initialises the `MovePlayerCommandParser` where its method `#parse()` is called to process the user inputs. + +Step 3: It then returns a newly initialised `MovePlayerCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `ModelManager#deletePlayer()` is firstly called which removes the player named "Cena" from an internal list. +Then the `ModelManager#addPlayer()` is called which adds the player with same name but new position to an internal list and updates the GUI display with a player named "Cena" with new position `(200, 100)` shown in the strategy board. +At last, the command results are then generated and shown to the user. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should allow users to move multiple players at once:** +* **Alternative 1:** Users can move multiple players at once. + * Pros: Possibly improve the efficiency for users. + * Cons: User inputs are more prone to errors. +* **Alternative 2 (current choice):** Users can only move one player at a time. + * Pros: Easy to implement. + * Cons: Users need to repeat the same command multiple times to move multiple players. + + + +#### 3.3.5 Export Feature + +##### Implementation + +This feature allows the user to export the strategy board as a .png image into their device. +It is facilitated by `CommandResult` which makes use of the method `#captureAndSaveStrategyBoard()` +from the `StrategyPanel` to export the strategy board. + +Given below is an example usage scenario of how the export command mechanism behaves at each step. + +Step 1: The user inputs `export` to into the command line to export the current strategy board. + +Step 2: This argument is passed into `LogicManager` which calls on `Coach2K22Parser#parseCommand()` to find a suitable +parser class to process the user inputs. + +Step 3: It then returns a newly initialised `ExportCommand` back to the `LogicManager` for command execution. + +Step 4: During the command execution, the `CommandResult` object is returned to the `MainWindow`, +where `MainWindow#captureAndSaveStrategyPanel()` is called to capture an image of the strategy board. +The user is then prompted to choose a directory from their local disk to save the image in, and hence the picture is saved locally. + + + +The steps above are summarised using a sequence diagram as shown below. + + +##### Design Consideration + +**Aspect: Should there be a predetermined location and randomly generated file names for the images:** + +* **Alternative 1 (current choice):** User is prompted to select their local directory and filename of choice. + * Pros: Allows users to categorize and structure their filenames according to their preferences. + * Cons: Hard to guarantee execution on user end. +* **Alternative 2:** A directory is created in-app with randomly generated file names`. + * Pros: Easier for users as they have less work to do. + * Cons: Hard to organize and structure. + +-------------------------------------------------------------------------------------------------------------------- + + + +## **5. Documentation, logging, testing, configuration, dev-ops** + +* [Documentation guide](Documentation.md) +* [Testing guide](Testing.md) +* [Logging guide](Logging.md) +* [Configuration guide](Configuration.md) +* [DevOps guide](DevOps.md) + +-------------------------------------------------------------------------------------------------------------------- + +## **6. Appendix: Requirements** + +### 6.1 Product scope + +**Target user profile**: + +* is a coach managing a team of players +* has a need to manage a significant number of players +* prefer desktop apps over other types +* can type fast +* prefers typing to mouse interactions +* is reasonably comfortable using CLI apps +* needs to keep track of administrative tasks +* can help enhance decision-making during games instantaneously + +**Value proposition**: helps busy sports coaches organise their overwhelming lists of contacts and messy weekly +schedules, and provides them with a platform to visualise defensive and offensive plays as the game unfolds + + + +### 6.2 User stories + +Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` + +| Priority | As a … | I want to … | So that I can… | +|----------|---------------------------------|-----------------------------------------------------------------|------------------------------------------------------------------------------| +| `* * *` | forgetful coach | enter team-specific or player note | look up these information | +| `* * *` | coach | delete team-specific or player note | keep these information relevant and up-to-date | +| `* * *` | forgetful coach | remember the names of players on my team | look up them in case I forget | +| `* * *` | disorganized | add and tag new roles/teams to a contact | easily retrieve relevant information | +| `* * *` | coach | easily retrieve contact information of relevant parties | quickly broadcast information to them | +| `* * *` | organized coach | view players by their strengths and weaknesses | make informed decision on choosing the best person | +| `* * *` | disorganized coach | add existing and upcoming tasks | keep track of my schedule easily | +| `* * *` | disorganized coach | delete wrongly added or past tasks | organize my schedule better | +| `* *` | lazy and forgetful coach | view a list of help commands and their descriptions | easily recall how to do a specific task | +| `* *` | organised coach | view players by their strengths and weaknesses | make informed decisions on choosing the best person for a specific objective | +| `**` | organized and data-driven coach | sort my players by strengths and weaknesses | get a better understanding of how players compare | +| `*` | strategic coach | change the position of players (x-y coordinate) during the game | ensure my team works together | +| `*` | coach | drag and drop a player into a calendar | plan scheduled events for them according to their needs | + + + +### 6.3 Use cases + +(For all use cases below, the **System** is `Coach2K22` and the **Actor** is the `user`, unless specified otherwise) + +#### 6.3.1 Contact Management + +**Use case: Add a person** + +**MSS** + +1. User requests to add a new person in the list +2. Coach2K22 shows a list with the newly added person + + Use case ends. + +**Extensions** + +* 1a. The parameters supplied by the user is invalid. + + * 1a1. Coach2K22 shows an error message. + + Use case ends. + +* 1b. Compulsory parameters not supplied by the user. + + * 1b1. Coach2K22 shows an error message. + + Use case ends. + + + +**Use case: Edit a person** + +**MSS** + +1. User requests to edit an existing person in the list +2. Coach2K22 shows a list with the newly edited person + + Use case ends. + +**Extensions** + +* 1a. The person list is empty. + + Use case ends. + +* 1b. The parameters supplied by the user is invalid. + + * 1b1. Coach2K22 shows an error message. + + Use case ends. + +* 1c. Compulsory parameters not supplied by the user. + + * 1c1. Coach2K22 shows an error message. + + Use case ends. + + + +**Use case: Delete a person** + +**MSS** + +1. User requests to list persons +2. Coach2K22 shows a list of persons +3. User requests to delete a specific person in the list +4. Coach2K22 deletes the person + + Use case ends. + +**Extensions** + +* 2a. The list is empty. + + Use case ends. + +* 3a. The given index is invalid. + + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Add a strength to a person** + +**MSS** + +1. User requests to list persons +2. Coach2K22 shows a list of persons +3. User requests to add a strength to a person +4. Coach2K22 shows the new details of the person + + Use case ends. + +**Extensions** + +* 2a. The person list is empty. + + * 2a1. Coach2K22 shows an error message. + + Use case ends. + +* 3a. The given list index cannot be found in Coach2K22. + + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. + +* 3b. The strength provided is an empty string. + + * 3b1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Add a weakness to a person** + +* This use case describes a similar interaction between the user and Coach2K22 to that of `Add a strength to a person` + * Takes in a weakness instead of a strength + +**Use case: Add a miscellaneous note to a person** + +* This use case describes a similar interaction between the user and Coach2K22 to that of `Add a strength to a person` + * Takes in a miscellaneous note instead of a strength + +**Use case: Delete a strength from a person** + +**MSS** + +1. User requests to list persons +2. Coach2K22 shows a list of persons +3. User requests to delete a strength for a person +4. Coach2K22 shows the new details of the person + + Use case ends. + + + +**Extensions** + +* 2a. The person list is empty. + + * 2a1. Coach2K22 shows an error message. + + Use case ends. + +* 3a. The given list index is invalid. + + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. + +* 3b. Strengths have not been assigned to the person. + + * 3b1. Coach2K22 shows an error message. + + Use case resumes at step 2. + +* 3c. The given strength index is invalid. + + * 3c1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Delete a weakness from a person** + +* This use case describes a similar interaction between the user and Coach2K22 to that of `Delete a strength from a person` + * Takes in a weakness index instead of a strength index + +**Use case: Delete a miscellaneous note from a person** + +* This use case describes a similar interaction between the user and Coach2K22 to that of `Delete a strength from a person` + * Takes in a misc. index instead of a strength index + +**Use case: Find persons by name or tag** + +**MSS** + +1. User requests to list persons with a specific name or tag +2. Coach2K22 shows a list of filtered persons + + Use case ends. + + + +**Extensions** + +* 1a. The given name and tag keywords cannot be found in Coach2K22. + + * 1a1. Coach2K22 shows an empty list. + + Use case ends. + +* 1b. The keyword provided is not indicated by a prefix e.g. `n/` or `t/`. + + * 1b1. Coach2K22 shows an error message. + + Use case ends. + +* 1c. No keywords are provided after the `find` command. + + * 1c1. Coach2K22 shows an error message. + + Use case ends. + +* 1d. Missing keyword after a prefix is given e.g. `n/` or `t/`. + + * 1d1. Coach2K22 shows an error message. + + Use case ends. + + + +**Use case: Sort address book by strengths in descending order** + +**MSS** + +1. User requests to sort the list of persons by total number of strengths +2. Coach2K22 shows the new sorted list of persons + + Use case ends. + +**Extensions** + +* 1a. The person list is empty. + + * 1a1. Coach2K22 shows an error message. + + Use case ends. + +**Use case: Sort address book by weaknesses in descending order** + +* This use case describes a similar interaction between the user and Coach2K22 to that of `Sort address book by strengths in descending order` + * Sorts list of persons by total number of weaknesses in descending order instead of total number of strengths + + + +**Use case: Add a tag to a person** + +**MSS** + +1. User requests to list persons +2. Coach2K22 shows a list of persons +3. User requests to attach a new tag to a person +4. Coach2k22 shows the new details of the person + + Use case ends. + +**Extensions** + +* 2a. The list is empty + + Use case ends. + + + +**Use case: Delete a tag from a person** + +**MSS** + +1. User requests to list persons +2. Coach2K22 shows a list of persons +3. User requests to remove an existing tag from a person +4. Coach2k22 shows the updated details of the person + + Use case ends. + +**Extensions** + +* 2a. The list is empty. + + Use case ends. +@ +* 3a. The tag requested to remove does not exist for the person. + + * 3a1. Coach2K22 shows an error message. + + Use case ends. + +* 3b. No argument for tag removal is provided. + + * 3b1. Coach2K22 shows an error message. + + Use case ends. + + + +#### 6.3.2 Task Management + +**Use case: Add a task to the task list** + +**MSS** + +1. User requests to add a new task to the list +2. Coach2K22 shows a list with the newly added task + + Use case ends. + +**Extensions** + +* 1a. The parameters supplied by the user is invalid. + + * 1a1. Coach2K22 shows an error message. + + Use case resumes at step 1. + +* 1b. Compulsory parameters not supplied by the user. + + * 1b1. Coach2K22 shows an error message. + + Use case resumes at step 1. + + + +**Use case: Edit a task** + +**MSS** + +1. User requests to edit an existing task from the list +2. Coach2K22 shows a list with the newly edited task + + Use case ends. + +**Extensions** + +* 1a. The task list is empty. + + Use case ends. + +* 1b. No index supplied by the user. + + * 1b1. Coach2K22 shows an error message. + + Use case ends. + +* 1c. The parameters supplied by the user is invalid. + + * 1c1. Coach2K22 shows an error message. + + Use case ends. + +* 1d. Compulsory parameters not supplied by the user. + + * 1d1. Coach2K22 shows an error message. + + Use case ends. + + + +**Use case: Delete a task from the task list** + +**MSS** + +1. User requests to view the list of tasks +2. Coach2K22 shows a list of tasks +3. User requests to delete a specific task from the list +4. Coach2K22 deletes the task + + Use case ends. + +**Extensions** + +* 1a. The task list is empty. + + Use case ends. + +* 3a. The index requested does not exist. + + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2 + + + +**Use case: Clear all tasks from task list** + +**MSS** + +1. User requests to list tasks +2. Coach2K22 shows a list of tasks +3. User requests to clear the task list +4. Coach2k22 shows the updated details of the task list + + Use case ends. + +**Extensions** + +* 2a. The task list is empty. + + Use case ends. + + + +**Use case: Clear all tasks for a specified date from task list** + +**MSS** + +1. User requests to list tasks +2. Coach2K22 shows a list of tasks +3. User requests to clear all tasks of a specified date from the task list +4. Coach2k22 shows the updated details of the task list + + Use case ends. + +**Extensions** + +* 2a. The task list is empty. + + Use case ends. + +* 3a. The provided date is not in the correct format. + + Use case resumes at step 2. + + + +**Use case: Add a tag to a task from task list** + +**MSS** + +1. User requests to list tasks +2. Coach2K22 shows a list of tasks +3. User requests to add a tag to a task of a specified index in the task list +4. Coach2k22 shows the updated details of the task list + + Use case ends. + +**Extensions** + +* 2a. The task list is empty. + + Use case ends. + + + +**Use case: Remove a tag from a task in task list** + +**MSS** + +1. User requests to list tasks +2. Coach2K22 shows a list of tasks +3. User requests to remove a tag from a task of a specified index in the task list +4. Coach2K22 shows the updated details of the task list + + Use case ends. + +**Extensions** + +* 1a. The task list is empty. + + Use case ends. + +* 3a. The task does not have that specified tag. + + Use case resumes at step 2. + +* 3b. The index provided is invalid. + + Use case resumes at step 2. + + + +**Use case: Find tasks by name or tag** + +**MSS** + +1. User requests to view the list of tasks +2. Coach2K22 shows a list of filtered tasks + + Use case ends. + +**Extensions** + +* 1a. The given name and tag keywords cannot be found in Coach2K22. + + * 1a1. Coach2K22 shows an empty list. + + Use case ends. + +* 1b. The keyword provided is not indicated by a prefix e.g. `n/` or `t/`. + + * 1b1. Coach2K22 shows an error message. + + Use case ends. + +* 1c. No keywords are provided after the `find` command. + + * 1c1. Coach2K22 shows an error message. + + Use case ends. + +* 1d. Missing keyword after a prefix is given e.g. `n/` or `t/`. + + * 1d1. Coach2K22 shows an error message. + + Use case ends. + + + +**Use case: Find persons tagged to a task** + +**MSS** + +1. User requests to view the list of tasks +2. Coach2K22 shows a list of tasks +3. User requests to find persons tagged to a specified task from the list +4. Coach2K22 shows a filtered list containing the specified persons + + Use case ends. + +**Extensions** + +* 1a. The task list is empty. + + Use case ends. + +* 3a. The index requested does not exist. + + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2 + +* 3b. No persons are tagged to the specified task. + + * 3b1. Coach2K22 shows an empty contact list. + + Use case ends + + + +**Use case: Sort task list by date** + +**MSS** + +1. User requests to sort the task list by date. +2. Coach2k22 shows the updated task list, sorted with the tasks with the earliest deadline at the top. + + Use case ends. + +**Extensions** + +* 1a. The task list is empty. + + Use case ends. + + + +#### 6.3.3 Strategic Planning + +**Use case: Add a new player to the strategy board** + +**MSS** + +1. User requests to show all players on the strategy board +2. Coach2K22 shows players +3. User requests to add a new player to the strategy board +4. Coach2K22 shows the updated strategy board with the new player + + Use case ends. + +**Extensions** +* 3a. The player name is invalid. + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3b. The player name is already on the strategy board. + * 3b1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3c. The player name is not provided. + * 3c1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Remove a player from the strategy board** + +**MSS** + +1. User requests to show all players on the strategy board +2. Coach2K22 shows players +3. User requests to remove a player from the strategy board +4. Coach2K22 shows the updated strategy board without the player + + Use case ends. + +**Extensions** +* 3a. The player name is invalid. + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3b. The player name is not on the strategy board. + * 3b1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3c. The player name is not provided. + * 3c1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Move a player on the strategy board** + +**MSS** + +1. User requests to show all players on the strategy board +2. Coach2K22 shows players +3. User requests to move a player on the strategy board +4. Coach2K22 shows the updated strategy board with the player moved to the new position + + Use case ends. + +**Extension** +* 3a. The player name is invalid. + * 3a1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3b. The player name is not on the strategy board. + * 3b1. Coach2K22 shows an error message. + + Use case resumes at step 2. +* 3c. The position is invalid. + * 3c1. Coach2K22 shows an error message. + + Use case resumes at step 2. + + + +**Use case: Load new background image for strategy tab** + +**MSS** + +1. User requests load a new background image. +2. Coach2k22 shows the updated strategy tab with the new background image. + + Use case ends. + +**Extensions** + +* 1a. Provided name of image is invalid. + + Use case ends. + +* 1b. Image does not exist. + + Use case ends. + +* 1c. Image is not in `png` format. + + Use case ends. + +**Use case: Export strategy tab** + +**MSS** + +1. User requests to export the current strategy tab. +2. Coach2k22 creates the image and prompts user to save it locally. + + Use case ends. + + + +### 6.4 Non-Functional Requirements + +1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. +2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. +3. Should be able to hold up to 100 teams without a noticeable sluggishness in performance for typical usage. +4. Should be able to hold up to 50 tags without a noticeable sluggishness in performance for typical usage. +5. Should be portable so moving from one OS to another OS will not create problems. +6. Should warn the user when attempting to delete a contact. +7. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. + + +### 6.5 Glossary + +* **Mainstream OS**: Windows, Linux, Unix, OS-X +* **Private contact detail**: A contact detail that is not meant to be shared with others +* **Time-clash**: An error where the user attempts to schedule an event at the same time as another +* **Switchover**: The action of switching a player for another on a given field +* **Liability-Potential** The statistics of a player's overall penalties and injuries across games +* **DRY Principle** The *Don't Repeat Yourself (DRY)* is a Software Engineering principle of reducing repetition in the code + +-------------------------------------------------------------------------------------------------------------------- + + + +## **7. Appendix: Instructions for manual testing** + +Given below are instructions to test the app manually. + +
+ Expected: The most recent window size and location is retained. + + + + +### 7.3 Saving data + +1. Dealing with corrupted data files + +1. Stop the program. + +2. Delete all files in the folder `data`; This folder should be found in the same directory as your JAR file. + +3. Restart the program. + +### 7.2 Deleting a person + +1. Deleting a person while all persons are being shown + + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + + 2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + + 4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + + + +### 7.4 Adding a Strength/Weakness/Miscellaneous note to a person + +1. Adding a strength/weakness/miscellaneous (using `strength-add`, `weakness-add`, and `misc-add` respectively) note to a person while currently viewable person list has people. + +2. Prerequisites: Currently viewable Contacts list has to contain some people. + +3. Test case: `strength-add 1 good stamina`
+ Expected: The note `good stamina` is added to the strength list of the first person in the current Contacts list. Details of the modified contact shown in the status message. + +4. Test case: `weakness-add 1 bad stamina`
+ Expected: The note `bad stamina` is added to the weakness list of the first person in the current Contacts list. Details of the modified contact shown in the status message. + +5. Test case: `misc-add 1 likes ice cream`
+ Expected: The note `likes ice cream` is added to the misc list of the first person in the current Contacts list. Details of the modified contact shown in the status message. + +6. Test case: `strength-add 0 good stamina`
+ Expected: No note is added. Error details shown in the status message. Status bar remains the same. + +7. Other incorrect commands to try: `strength-add`, `misc-add x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + + + +### 7.5 Deleting a Strength/Weakness/Miscellaneous note to a person + +1. Deleting a strength/weakness/miscellaneous note (using `strength-del`, `weakness-del`, and `misc-del` respectively) to a person while currently viewable person list has people. + +2. Prerequisites: Currently viewable Contacts list has to contain some people. + +3. Test case: `strength-del 1 1`
+ Expected: The first note is deleted from the strength list of the first person in the current Contacts list. Details of the modified contact shown in the status message. + +4. Test case: `weakness-del 1 1`
+ Expected: Similar to previous, except the note is deleted from the weakness list. + +5. Test case: `misc-del 1 1`
+ Expected: Similar to previous, except the note is deleted from the misc list. + +6. Test case: `strength-del 0 1`
+ Expected: No note is deleted. Error details shown in the status message. Status bar remains the same. + +7. Test case: `strength-del 1 0`
+ Expected: Similar to previous. + +8. Other incorrect commands to try: `strength-del`, `misc-del x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + + + + +### 7.6 Clearing all Tasks from the task list or only those on a particular day + +1. Empty the task list or remove only those that correspond with a given day. + +2. Prerequisites: Unfiltered Schedule must contain some tasks. + +3. Test case: `clear-t`
+ Expected: The entire task list in contacts will be cleared. + +4. Test case: `clear-t d/03-03-2022`
+ Expected: If there are tasks that are allocated on `03-03-2022`, remove them. Otherwise, no task is deleted, and error details are shown in the status message. + +5. Test case: `clear-t d/30-02-2022`
+ Expected: No task is deleted. Error details shown in the status message. Status bar remains the same. + +6. Test case: `clear-t d/2022-03-03`
+ Expected: Similar to previous. + +7. Other incorrect commands to try: `clear-t d/abc`, `clear-t d`, `clear-t d/`, `...`
+ Expected: Similar to previous. + + + +### 7.7 Sort the Contacts list by strength or weakness in descending order + +1. Sort the entire Contact list by strength (for `sort-strength`) or weakness (for `sort-weakness`) in descending order + +2. Prerequisites: Unfiltered Contacts list must contain some people. + +3. Test case: `sort-strength`
+ Expected: The entire contact list is sorted by total number of strengths in descending order. + +4. Test case: `sort-weakness`
+ Expected: The entire contact list is sorted by total number of weaknesses in descending order. + +5. Test case: `sort-strength abc`
+ Expected: The entire contact list is sorted by total number of strengths in descending order (anything after the command word is ignored). + + + +### 7.8 Load new image to serve as court in Strategy Tab + +1. Loads the given image by the provided name to serve as the court in Strategy Tab. + +2. Prerequisites: Image must be a png file and stored in the automatically generated `courts` directory which exists in the same folder as the JAR. + +3. Test case: `load-court basketball`
+ Expected: The image `basketball.png` will be loaded from the `courts` directory and serve as the court in the Strategy tab. If it does not exist, no image is loaded, and error details are shown in the status message. + +4. Test case: `load-court`
+ Expected: No image is loaded, and error details are shown in the status message. + +5. Test case: `load-court test/`
+ Expected: Similar to previous. Even if `test.png` exists, as `/` are not allowed in command argument. + + + +### 7.9 Finding persons by name or tag + +1. Find persons matching any of the given keywords from our contact list. You can choose to find by `NAME(s)`, `TAG(s)`, or both. + +2. Prerequisites: Contact List should not be empty. + +3. Test case: `find-p n/Alan t/team1`
+ Expected: All persons whose name matches the keyword `Alan` (case-insensitive) or tag matches the keyword `team1`(case-insensitive). + +4. Test case: `find-p n/Alan n/John`
+ Expected: All persons whose name matches at least one of the keywords `Alan` or `John` (case-insensitive). + +5. Test case: `find-p t/team1 n/team2` + Expected: All persons whose tag matches at least one of the keyword `team1` or `team2` (case-insensitive). + +6. Test case: `find-p` + Expected: Error message shown in the status message denoting the arguments `find-p` takes in. + + + +### 7.10 Finding tasks by name or tag + +1. Find tasks matching any of the given keywords from our contact list. You can choose to find by `NAME(s)`, `TAG(s)`, or both. + +2. Prerequisites: Task List should not be empty. + +3. Test case: `find-t n/Meeting t/team1`
+ Expected: All persons whose name matches the keyword `Meeting` (case-insensitive) or tag matches the keyword `team1`(case-insensitive). + +4. Test case: `find-t n/Meeting n/Talk`
+ Expected: All persons whose name matches at least one of the keywords `Meeting` or `Talk` (case-insensitive). + +5. Test case: `find-t t/team1 n/team2`
+ Expected: All persons whose tag matches at least one of the keyword `team1` or `team2` (case-insensitive). + +6. Test case: `find-t`
+ Expected: Error message shown in the status message denoting the arguments `find-t` takes in. + + + +### 7.11 Finding persons tagged to a task + +1. Pull out the contact information of persons tagged to a task. + +2. Prerequisites: Task List should not be empty. + +3. Assumption: All tasks have persons tagged to it. + +3.1 Test case: `get-person 1`
+Expected: Switch to the contacts tab and show contact details of all persons tagged to the first task in the task list. + +3.2 Test case: `get-person`
+Expected: Error message shown in the status message denoting the arguments `get-person` takes in. + +4. Assumption: All tasks do not have persons tagged to it. + +4.1 Test case: `get-person 1`
+Expected: Switch to the contacts tab and show an empty contact list. + +4.2 Test case: `get-person`
+Expected: Same as point 3.2. + + + +### 7.12 Adding a person +1. Add a person into the contact list. + +2. Test case: `add-p n/Johnson p/83918273 a/Woodlands Avenue 4 e/johnson@gmail.com t/Hustlers`
+ Expected: Add a person named `Johnson` with his relevant details into the contact list + +3. Test case: `add-p`
+ Expected: Error message shown in the status message denoting the arguments `add-p` takes in. + +### 7.13 Editing a person +1. Edit a person in the contact list. + +2. Prerequisites: Contact list should not be empty. + +3. Assumption: The first person in the contact list has the name `Johnson`. + + 3.1 Test case: `edit-p 1 n/John`
+ Expected: The first person in the contact list will have his name changed to `John`. + Additionally, all tasks with person `Johnson` tagged to it will have the specific participant tag changed from `Johnson` to `John`. + + 3.2 Test case: `edit-p 2 a/Woodlands`
+ Expected: The second person in the contact list will have his address details changed to `Woodlands`. + + 3.3 Test case: `edit-p 1`
+ Expected: Error message shown in the status message denoting the arguments `edit-p` takes in. + + 3.4 Test case: `edit-p n/hello`
+ Expected: Same as previous. + + 3.5 Test case: `edit-p`
+ Expected: Same as previous. + + + +### 7.14 Clearing all contact entries +1. Clears all entries from the contact list. + +2. Test case: `clear-p`
+ Expected: All entries in the contact list will be cleared. It also clears the participant field of all tasks. + +-------------------------------------------------------------------------------------------------------------------- - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +## **8. Appendix: Effort** -1. _{ more test cases … }_ +1. The team has extended the program to deal with three different entity types: `Person`, `Task`, `Strategy`. These entities are interconnected where features specific to `Person` may directly affect the `Task` entity. Deliberate and extensive checks are implemented across features to ensure functional correctness. + +2. The team has implemented a JavaFX strategy board with draggable nodes. In addition, a `move` feature is implemented to cater to existing requirements. It was tough to implement this as nodes placements are determined by its relative position. Our team also tried to get these placements as accurate as possible to ensure functional correctness - increasing the implementation difficulty levels. diff --git a/docs/Gemfile b/docs/Gemfile index 999a7099d8d..f3648431048 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -2,7 +2,7 @@ source "https://rubygems.org" -git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } +git_source(:github) {"https://github.com/AY2122S2-CS2103T-W14-2/tp"} gem 'jekyll' gem 'github-pages', group: :jekyll_plugins diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3716f3ca8a4..fffebdf0067 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -2,50 +2,151 @@ layout: page title: User Guide --- - -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +[](https://codecov.io/gh/AY2122S2-CS2103T-W14-2/tp) * Table of Contents -{:toc} + {:toc} -------------------------------------------------------------------------------------------------------------------- -## Quick start +## **1. Introduction** +Welcome to the Coach2k22 User guide! +Coach2K22 is a desktop app to helps busy sports coaches **organise their overwhelming lists of contacts and messy weekly schedules.** in addition to providing a **platform to visualise defensive and offensive plays** as the game unfolds. + +## **2. Quick Start** + +This section answers all your question on how to get started! This application is **optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Coach2K22 can get your administrative tasks done faster than it takes to learn the interface of traditional GUI apps! + +### 2.1 Installation Instructions + +Installation is fairly simple, just follow these steps. Do ensure you have Java `11` or above installed in your computer +before starting. + +1.Download the latest '.jar' file from [here](https://github.com/AY2122S2-CS2103T-W14-2/tp/releases). + +2.Copy the file to the folder you want to use as the _home folder_ for your copy of Coach2k22. + +3.Double-click the file to start the app, and you're done! + +A GUI similar to the image below should appear in a few seconds. +Note how the app contains some sample data.
+ + +### 2.2 Using the application + +The GUI is designed to ensure all necessary information is present at first glance. Follow along to find out what each section is and does. + +For reference, below is a labelled diagram of what each section is. + + +1. Type your commands in the Command Line Interface box (CLI) labeled above. + +2. You can switch between the three tabs (Contact, Schedule, Strategy tabs). + +3. Scroll through each list in the Contact and Schedule tabs to view other items in the list. + +4. Refer to the [Features](#4-features) below for details of each command, as well as their formats.
+ +Contacts and Schedule related tabs have automatic saving features and changes to it will be saved without any user action. +Strategy tabs have the option to be explicitly saved using the `export` command. +For more details head to the [Features](#4-features) section! + +
-  +2. Double-click the file to launch the application. -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +3. Upon launch, the GUI like in section 2.1 will be visible to you! - * **`list`** : Lists all contacts. +4. Hover your cursor over the CLI input box and click on it once. - * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +5. You can now use their keyboard to type commands into the CLI. - * **`delete`**`3` : Deletes the 3rd contact shown in the current list. +6. If the command entered is valid, it should disappear from the CLI box upon pressing enter. +A message indicating successful completion will pop up. - * **`clear`** : Deletes all contacts. +6.1 A visual successful example for the command [add-task](#422-adding-a-task-add-t) is shown below! - * **`exit`** : Exits the app. + -1. Refer to the [Features](#features) below for details of each command. +7. If the command entered is invalid it will turn red and remain in the CLI box upon pressing enter. An error message +detailing what might have gone wrong will pop up instead! + +7.1 A visual example for the command [add-task](#422-adding-a-task-add-t) is shown below! + + + +8.For more information on the commands Refer to the [Features](#4-features) section below for more information and details on the command formats Coach2k22 accepts! -------------------------------------------------------------------------------------------------------------------- -## Features -
e.g., `list-p` | +|**Prefix** | An indicator used to mark the start of a *Parameter*
e.g., `n/` `st/` | +|**Parameter** | A value supplied by the user in a command
e.g., `NAME` `START_TIME` | +|**Command Format** | The *Command Format* describes the arrangement of the *Command*, *Prefix*, and *Parameter*
e.g., `add-p n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL` | + +### 3.5 Notes about the Command Format -**:information_source: Notes about the command format:**
+The Command format includes two major sections, as detailed in this image below: + + + +All feature command formats minimally include a 'Command' section. Each feature has its own specifications on what needs to be included in the 'Prefix and Parameter' section, however, they all follow some general principles as detailed below! +The tips in this section include noteworthy information about the command format that will be useful in guiding you through the [Features](#4-features) section. * Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. + e.g. in `add-p n/NAME`, `NAME` is a parameter which can be used as `add-p n/John Doe`. * Items in square brackets are optional.
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. @@ -62,131 +163,678 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -
-  +**Format:** `tag-add-p INDEX TAG_NAME` + +**Examples:** +* `tag-add-p 1 public` adds the tag `public` to the first person in the contact list. + +
+ +* The tag name should not contain spaces and should be alphanumeric. + +
+ +* The tag name should not contain spaces and should be alphanumeric. +* The tag name is case-sensitive and must be an exact match for it to be recognised. + +
-Deletes the specified person from the address book. +* One of the optional items e.g. `[n/NAME]` must be present for the command to work. +* The search is case-insensitive e.g. `hans` will match `Hans`. +* The order of the keywords does not matter e.g. `n/hans n/bo` will return the same result as `n/bo n/hans`. +* Only full words will be matched e.g. `Han` will not match `Hans`. +* Persons matching at least one keyword will be returned e.g. `n/Hans n/Bo` will return the persons `Hans Gruber` and `Bo Yang`. +* Keywords should not contain spaces and should be alphanumeric. -Format: `delete INDEX` +
+ +* Adds a strength at the specified `INDEX`. +* `INDEX` refers to the index number shown in the displayed person list. +* The provided `INDEX` must be a valid (must be an unsigned non-zero integer and exists in the list). +* The `STRENGTH_DESCRIPTION` must not be greater than 50 characters. + +
+ +* Adds a weakness at the specified `INDEX`. +* `INDEX` refers to the index number shown in the displayed person list. +* The provided `INDEX` must be a valid (must be an unsigned non-zero integer and exists in the list). +* The `WEAKNESS_DESCRIPTION` must not be greater than 50 characters. + +
+ +* Adds a miscellaneous note at the specified `INDEX`. +* `INDEX` refers to the index number shown in the displayed person list. +* The provided `INDEX` must be a valid (must be an unsigned non-zero integer and exists in the list). +* The `NOTE_DESCRIPTION` must not be greater than 50 characters. + +
+ +* Deletes the strength at the specified `INDEX`. +* The index refers to the index number shown in the displayed person list. +* The strength index refers to the index number shown in the strength list of the respective person. +* Both indices **must be a positive integer** 1, 2, 3, … +* Both indices must be valid (existing in their respective lists). + +
+ +* Deletes the weakness at the specified `INDEX`. +* The index refers to the index number shown in the displayed person list. +* The weakness index refers to the index number shown in the weakness list of the respective person. +* Both indices **must be a positive integer** 1, 2, 3, … +* Both indices must be valid (existing in their respective lists). + +
+ +* Deletes the miscellaneous note at the specified `INDEX`. * The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +* The note index refers to the index number shown in the misc. list of the respective person. +* Both indices **must be a positive integer** 1, 2, 3, … +* Both indices must be valid (existing in their respective lists) + +
+ +* `PERSON_NAME` has to be present in the contact list for them to be tagged to a task. + +
+ +* A task can have any number of tags (including 0)
+ +* A task can also be assigned to multiple persons (including 0) + +
+ +* Deletes the task at the specified `INDEX`. +* The index can be obtained by referring to the indicated task index on the displayed task list. +* Index values start from 1 and are always positive integers. + +
+ +* Clears all tasks on the specified `DATE`. +* Date must be in the format `dd-mm-yyyy`. + +
+ +* The tag name should not contain spaces and should be alphanumeric. + +
+ +* The tag name should not contain spaces and should be alphanumeric. +* The tag name is case-sensitive and must be an exact match for it to be recognised. + +
+ +* One of the optional items e.g. `[n/NAME]` must be present for the command to work. +* The search is case-insensitive e.g. `meeting` will match `Meeting`. +* The order of the keywords does not matter e.g. `n/meeting n/shareholder` will return the same result as `n/shareholder n/meeting`. +* Only full words will be matched e.g. `Meeting` will not match `Meetings`. +* Tasks matching at least one keyword will be returned e.g. `n/Meeting n/Shareholders` will return the persons `Engagement with Shareholders` and `Annual Meeting`. +* Keywords should not contain spaces and should be alphanumeric. + +
+ +* A folder named `courts` will be automatically generated in the same directory as the JAR file +* Image must be in `png` format and be contained in the aforementioned `courts` directory. +* Loads the given image from the filepath `courts/IMAGE_NAME.png`. + +
+ +* `PLAYER_NAME` is case-sensitive e.g. `John Cena` will NOT match `john Cena`. +* `PLAYER_NAME` can not be empty and its length must be less or equal to `50` characters. +* `PLAYER_NAME` must be unique and can NOT contain the character `/`. + +
+ +* `PLAYER_NAME` is case-sensitive e.g. `John Cena` will NOT match `john Cena`. +* `PLAYER_NAME` can not be empty and its length must be less or equal to `50` characters. +* `PLAYER_NAME` must be unique and can NOT contain the character `/`. +* `PLAYER_NAME` must be present in the strategy board + +
+ +* `PLAYER_NAME` is case-sensitive e.g. `John Cena` will NOT match `john Cena`. +* `PLAYER_NAME` can not be empty and its length must be less or equal to `50` characters. +* `PLAYER_NAME` must be unique and can NOT contain the character `/`. +* `PLAYER_NAME` must be present in the strategy board. +* `X_COORDINATE` and `Y_COORDINATE` must be integers. +* `X_COORDINATE` must be non-negative and less than or equal to `1000`. +* `Y_COORDINATE` must be non-negative and less than or equal to `600`. + +
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Coach2k22 home folder. + +**Q**: What is the purpose of having a separate command for listing player strengths and weaknesses
+**A**: These functions allow coach to judge players based on their respective strengths/weaknesses for improved judgement of abilities, analyzing their liabilities, and strategically choosing the right player for the right purpose. +**Q**: Why can't I load a court using the `load-court` command despite using the right command format?
+**A**: Check to see if the /courts directory in the application has the aforementioned court file! If not, do remember to upload that in. + +**Q**: I saved an image using `export` before but after saving another image the first one disappeared?
+**A**: Make sure to change the file name when you download the image to your local directory. Oftentimes if you have two images with the same name in the same place the new file replaces the older one. -------------------------------------------------------------------------------------------------------------------- -## Command summary - -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +## **6. Command summary** + +This section gives you a summary of all the available commands in the application. +They are classified into the following categories by command usage: + +* [Contact Management](#61-contact-management) +* [Task Management](#62-task-management) +* [Strategic Planning](#63-strategic-planning) +* [General](#64-general) + +You can find the corresponding command format and an example for the actions you are able to perform on the application. + +### 6.1 Contact Management +This section lists all the commands available for contact management in the application. + +| Action | Format, Examples | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **List** | `list-p` | +| **Add** | `add-p n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL [t/TAG_NAME]…`
e.g., `add-p n/Johnson p/83918273 a/Woodlands Avenue 4 e/johnson@gmail.com t/Hustlers` | +| **Delete** | `del-p INDEX`
e.g., `del-p 1` | +| **Edit** | `edit-p INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG_NAME]…`
e.g., `edit-p 1 p/98273712 e/johndoe@example.com` | +| **Clear** | `clear-p` | +| **Add Tag** | `tag-add-p INDEX TAG_NAME`
e.g., `tag-add-p 1 public` | +| **Delete Tag** | `tag-del-p INDEX TAG_NAME`
e.g., `tag-del-p 1 team` | +| **Find** | `find-p [n/NAME]… [t/TAG]…`
e.g., `find-p n/Alex n/Charlotte t/team1 t/team2` | +| **Add Strength** | `strength-add INDEX STRENGTH_DESCRIPTION`
e.g., `strength-add 1 Great stamina` | +| **Add Weakness** | `weakness-add INDEX WEAKNESS_DESCRIPTION`
e.g., `weakness-add 1 Poor defensive abilities` | +| **Add Miscellaneous** | `misc-add INDEX NOTE_DESCRIPTION`
e.g., `misc-add 1 Likes ice cream` | +| **Delete Strength** | `strength-del INDEX STRENGTH_INDEX`
e.g., `strength-del 1 1` | +| **Delete Weakness** | `weakness-del INDEX WEAKNESS_INDEX`
e.g., `weakness-del 1 1` | +| **Delete Miscellaneous** | `misc-del INDEX NOTE_INDEX`
e.g., `misc-del 1 1` | +| **Sort by Strengths** | `sort-strength` | +| **Sort by Weaknesses** | `sort-weakness`
| + + +### 6.2 Task Management +This section lists all the commands available for task management in the application. + +| Action | Format, Examples | +|------------------|-----------------------------------------------------------------------------------| +| **List** | `list-t` | +| **Add** | `add-t n/NAME d/DATE st/STARTTIME et/ENDTIME [t/TAG_NAME]… [c/PERSON_NAME]…`
e.g., `add-t n/Welcome Tea d/24-04-2022 st/09:00 et/12:00 t/Socials c/Alex Yeoh`| +| **Delete** | `del-t INDEX`
e.g., `del-p 1` | +| **Edit** | `edit-t INDEX [n/NAME] [d/DATE] [st/STARTTIME] [et/ENDTIME] [t/TAG_NAME]… [c/PERSON_NAME]…`
e.g., `edit-t 2 d/29-04-2022 et/10:00`| +| **Clear** | `clear-t [d/DATE]`
e.g., `clear-t 2022-10-10` | +| **Add Tag** | `tag-add-t INDEX TAG_NAME`
e.g., `tag-add-t 1 important` | +| **Delete Tag** | `tag-del-t INDEX TAG_NAME`
e.g., `tag-del-t 1 important` | +| **Find** | `find-t [n/NAME]… [t/TAG]…`
e.g., `find-p n/Meeting n/Training t/team1 t/team2` | +| **Get Person** | `get-person INDEX`
e.g., `get-person 2` | +| **Sort By Date** | `sort-date` | + + +### 6.3 Strategic Planning +This section lists all the commands available for performing strategic planning in the application. + +| Action | Format, Examples | +|-------------------|-------------------------------------------------------------------------| +| **Load BG Image** | `load-court IMAGE_NAME`
e.g., `load-court basketball` | +| **Add** | `add-player PLAYER_NAME`
e.g., `add-player Messi` | +| **Delete** | `del-player PLAYER_NAME`
e.g., `del-player Messi` | +| **Move** | `move PLAYER_NAME x/X_COORDINATE y/Y_COORDINATE`
e.g., `move Messi x/0 y/0` | +| **Export** | `export` | + + +### 6.4 General +This section lists all the commands available for general usage. + +| Action | Format, Examples | +|--------------|-------------------------| +| **Help** | `help` | +| **Exit** | `exit` | + diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..a25da783525 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "Coach2K22" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2122S2-CS2103T-W14-2/tp" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss index 0d3f6e80ced..93eada6d494 100644 --- a/docs/_sass/minima/_base.scss +++ b/docs/_sass/minima/_base.scss @@ -288,7 +288,7 @@ table { text-align: center; } .site-header:before { - content: "AB-3"; + content: "Coach2K22"; font-size: 32px; } } diff --git a/docs/_sass/minima/_layout.scss b/docs/_sass/minima/_layout.scss index ca99f981701..f370d3f40a5 100644 --- a/docs/_sass/minima/_layout.scss +++ b/docs/_sass/minima/_layout.scss @@ -176,7 +176,7 @@ .post-content { margin-bottom: $spacing-unit; - h1, h2, h3 { margin-top: $spacing-unit * 2 } + h1, h2, h3 { margin-top: $spacing-unit } h4, h5, h6 { margin-top: $spacing-unit } h2 { diff --git a/docs/diagrams/AddNoteSequenceDiagram.puml b/docs/diagrams/AddNoteSequenceDiagram.puml new file mode 100644 index 00000000000..7997f3ffa90 --- /dev/null +++ b/docs/diagrams/AddNoteSequenceDiagram.puml @@ -0,0 +1,67 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddNoteCommandParser" as AddNoteCommandParser LOGIC_COLOR +participant "p:AddNoteCommand" as AddNoteCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("note-add 1 has...") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("note-add 1 has...") +activate Coach2K22Parser + +create AddNoteCommandParser +Coach2K22Parser -> AddNoteCommandParser +activate AddNoteCommandParser + +AddNoteCommandParser --> Coach2K22Parser +deactivate AddNoteCommandParser + +Coach2K22Parser -> AddNoteCommandParser : parse("note-add 1 has...") +activate AddNoteCommandParser + +create AddNoteCommand +AddNoteCommandParser -> AddNoteCommand +activate AddNoteCommand + +AddNoteCommand --> AddNoteCommandParser : p +deactivate AddNoteCommand +AddNoteCommandParser --> Coach2K22Parser : p + +AddNoteCommandParser -[hidden]-> Coach2K22Parser +destroy AddNoteCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> AddNoteCommand : execute() +activate AddNoteCommand + +AddNoteCommand -> Model : setPerson(originalPerson, editedPerson) +activate Model + +Model --> AddNoteCommand +deactivate Model + +create CommandResult +AddNoteCommand -> CommandResult +activate CommandResult + +CommandResult --> AddNoteCommand +deactivate CommandResult + +AddNoteCommand --> LogicManager : result +deactivate AddNoteCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddPersonSequenceDiagram.puml b/docs/diagrams/AddPersonSequenceDiagram.puml new file mode 100644 index 00000000000..10960ffe667 --- /dev/null +++ b/docs/diagrams/AddPersonSequenceDiagram.puml @@ -0,0 +1,67 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddPersonCommandParser" as AddPersonCommandParser LOGIC_COLOR +participant "p:AddPersonCommand" as AddPersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("add-p n/Johnson ...") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("n/Johnson ...") +activate Coach2K22Parser + +create AddPersonCommandParser +Coach2K22Parser -> AddPersonCommandParser +activate AddPersonCommandParser + +AddPersonCommandParser --> Coach2K22Parser +deactivate AddPersonCommandParser + +Coach2K22Parser -> AddPersonCommandParser : parse("n/Johnson ...") +activate AddPersonCommandParser + +create AddPersonCommand +AddPersonCommandParser -> AddPersonCommand +activate AddPersonCommand + +AddPersonCommand --> AddPersonCommandParser : p +deactivate AddPersonCommand +AddPersonCommandParser --> Coach2K22Parser : p + +AddPersonCommandParser -[hidden]-> Coach2K22Parser +destroy AddPersonCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> AddPersonCommand : execute() +activate AddPersonCommand + +AddPersonCommand -> Model : addPerson("Johnson ...") +activate Model + +Model --> AddPersonCommand +deactivate Model + +create CommandResult +AddPersonCommand -> CommandResult +activate CommandResult + +CommandResult --> AddPersonCommand +deactivate CommandResult + +AddPersonCommand --> LogicManager : result +deactivate AddPersonCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddPersonTagSequenceDiagram.puml b/docs/diagrams/AddPersonTagSequenceDiagram.puml new file mode 100644 index 00000000000..84b343d9b52 --- /dev/null +++ b/docs/diagrams/AddPersonTagSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddPersonTagCommandParser" as AddPersonTagCommandParser LOGIC_COLOR +participant "p:AddPersonTagCommand" as AddTagCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("tag-add-p 1 friend") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("tag-add-p 1 friend") +activate Coach2K22Parser + +create AddPersonTagCommandParser +Coach2K22Parser -> AddPersonTagCommandParser +activate AddPersonTagCommandParser + +AddPersonTagCommandParser --> Coach2K22Parser +deactivate AddPersonTagCommandParser + +Coach2K22Parser -> AddPersonTagCommandParser : parse(" 1 friend") +activate AddPersonTagCommandParser + +create AddTagCommand +AddPersonTagCommandParser -> AddTagCommand +activate AddTagCommand + +AddTagCommand --> AddPersonTagCommandParser : p +deactivate AddTagCommand + +AddPersonTagCommandParser --> Coach2K22Parser : p +deactivate AddPersonTagCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +AddPersonTagCommandParser -[hidden]-> Coach2K22Parser +destroy AddPersonTagCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> AddTagCommand : execute() +activate AddTagCommand + +AddTagCommand -> Model : setPerson(personToEdit, editedPerson) +activate Model + +Model --> AddTagCommand +deactivate Model + +create CommandResult +AddTagCommand -> CommandResult +activate CommandResult + +CommandResult --> AddTagCommand +deactivate CommandResult + +AddTagCommand --> LogicManager : result +deactivate AddTagCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddPlayerSequenceDiagram.puml b/docs/diagrams/AddPlayerSequenceDiagram.puml new file mode 100644 index 00000000000..6d8a73c4dd4 --- /dev/null +++ b/docs/diagrams/AddPlayerSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddPlayerCommandParser" as AddPlayerCommandParser LOGIC_COLOR +participant "p:AddPlayerCommand" as AddPlayerCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("add-player Cena") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("add-player Cena") +activate Coach2K22Parser + +create AddPlayerCommandParser +Coach2K22Parser -> AddPlayerCommandParser +activate AddPlayerCommandParser + +AddPlayerCommandParser --> Coach2K22Parser +deactivate AddPlayerCommandParser + +Coach2K22Parser -> AddPlayerCommandParser : parse("Cena") +activate AddPlayerCommandParser + +create AddPlayerCommand +AddPlayerCommandParser -> AddPlayerCommand +activate AddPlayerCommand + +AddPlayerCommand --> AddPlayerCommandParser : p +deactivate AddPlayerCommand + +AddPlayerCommandParser --> Coach2K22Parser : p +deactivate AddPlayerCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +AddPlayerCommandParser -[hidden]-> Coach2K22Parser +destroy AddPlayerCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> AddPlayerCommand : execute() +activate AddPlayerCommand + +AddPlayerCommand -> Model : addPlayer(Player) +activate Model + +Model --> AddPlayerCommand +deactivate Model + +create CommandResult +AddPlayerCommand -> CommandResult +activate CommandResult + +CommandResult --> AddPlayerCommand +deactivate CommandResult + +AddPlayerCommand --> LogicManager : result +deactivate AddPlayerCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddTaskSequenceDiagram.puml b/docs/diagrams/AddTaskSequenceDiagram.puml new file mode 100644 index 00000000000..8eec52a4e82 --- /dev/null +++ b/docs/diagrams/AddTaskSequenceDiagram.puml @@ -0,0 +1,84 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddTaskCommandParser" as AddTaskCommandParser LOGIC_COLOR +participant "t:AddTaskCommand" as AddTaskCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("add-t n/Meet ...") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("add-t n/Meet ...") +activate Coach2K22Parser + +create AddTaskCommandParser +Coach2K22Parser -> AddTaskCommandParser +activate AddTaskCommandParser + +AddTaskCommandParser --> Coach2K22Parser +deactivate AddTaskCommandParser + +Coach2K22Parser -> AddTaskCommandParser : parse("n/Meet ...") +activate AddTaskCommandParser + +create AddTaskCommand +AddTaskCommandParser -> AddTaskCommand +activate AddTaskCommand + +AddTaskCommand --> AddTaskCommandParser : t +deactivate AddTaskCommand +AddTaskCommandParser --> Coach2K22Parser : t + +AddTaskCommandParser -[hidden]-> Coach2K22Parser +destroy AddTaskCommandParser + +Coach2K22Parser --> LogicManager : t +deactivate Coach2K22Parser + +LogicManager -> AddTaskCommand : execute() +activate AddTaskCommand + +AddTaskCommand -> Model : addTask("Meet ...") +activate Model + +Model --> AddTaskCommand +deactivate Model + +AddTaskCommand -> Model : hasStartEndTimeConflict() +activate Model + +Model --> AddTaskCommand +deactivate Model + +loop size of Task ContactList + loop size of TaskList + AddTaskCommand -> Model : hasDateTimeConflict("Meet ...") + activate Model + Model --> AddTaskCommand + deactivate Model + end +end + + + +create CommandResult +AddTaskCommand -> CommandResult +activate CommandResult + +CommandResult --> AddTaskCommand +deactivate CommandResult + +AddTaskCommand --> LogicManager : result +deactivate AddTaskCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddTaskTagSequenceDiagram.puml b/docs/diagrams/AddTaskTagSequenceDiagram.puml new file mode 100644 index 00000000000..1534b98a2f1 --- /dev/null +++ b/docs/diagrams/AddTaskTagSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":AddTaskTagCommandParser" as AddTaskTagCommandParser LOGIC_COLOR +participant "p:AddTaskTagCommand" as AddTaskTagCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("tag-add-t 1 important") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("tag-add-t 1 important") +activate Coach2K22Parser + +create AddTaskTagCommandParser +Coach2K22Parser -> AddTaskTagCommandParser +activate AddTaskTagCommandParser + +AddTaskTagCommandParser --> Coach2K22Parser +deactivate AddTaskTagCommandParser + +Coach2K22Parser -> AddTaskTagCommandParser : parse(" 1 important") +activate AddTaskTagCommandParser + +create AddTaskTagCommand +AddTaskTagCommandParser -> AddTaskTagCommand +activate AddTaskTagCommand + +AddTaskTagCommand --> AddTaskTagCommandParser : p +deactivate AddTaskTagCommand + +AddTaskTagCommandParser --> Coach2K22Parser : p +deactivate AddTaskTagCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +AddTaskTagCommandParser -[hidden]-> Coach2K22Parser +destroy AddTaskTagCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> AddTaskTagCommand : execute() +activate AddTaskTagCommand + +AddTaskTagCommand -> Model : setTask(taskToEdit, editedTask) +activate Model + +Model --> AddTaskTagCommand +deactivate Model + +create CommandResult +AddTaskTagCommand -> CommandResult +activate CommandResult + +CommandResult --> AddTaskTagCommand +deactivate CommandResult + +AddTaskTagCommand --> LogicManager : result +deactivate AddTaskTagCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/ClearPersonSequenceDiagram.puml b/docs/diagrams/ClearPersonSequenceDiagram.puml new file mode 100644 index 00000000000..2d7c61bb3b4 --- /dev/null +++ b/docs/diagrams/ClearPersonSequenceDiagram.puml @@ -0,0 +1,65 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant "p:ClearPersonCommand" as ClearPersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("clear-p") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("clear-p") +activate Coach2K22Parser + +create ClearPersonCommand +Coach2K22Parser -> ClearPersonCommand +activate ClearPersonCommand + +ClearPersonCommand --> Coach2K22Parser : p +deactivate ClearPersonCommand + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> ClearPersonCommand : execute() +activate ClearPersonCommand + +ClearPersonCommand -> Model : getFilteredTaskList() +activate Model + +Model --> ClearPersonCommand +deactivate Model + +loop size of TaskList + ClearPersonCommand -> Model : setTask(editedTask) + activate Model + Model --> ClearPersonCommand + deactivate Model +end + +ClearPersonCommand -> Model : setAddressBook(new AddressBook) +activate Model + +Model --> ClearPersonCommand +deactivate Model + +create CommandResult +ClearPersonCommand -> CommandResult +activate CommandResult + +CommandResult --> ClearPersonCommand +deactivate CommandResult + +ClearPersonCommand --> LogicManager : result +deactivate ClearPersonCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/ClearTaskSequenceDiagram.png b/docs/diagrams/ClearTaskSequenceDiagram.png new file mode 100644 index 00000000000..fc0f5542c50 Binary files /dev/null and b/docs/diagrams/ClearTaskSequenceDiagram.png differ diff --git a/docs/diagrams/ClearTaskSequenceDiagram.puml b/docs/diagrams/ClearTaskSequenceDiagram.puml new file mode 100644 index 00000000000..c385addace2 --- /dev/null +++ b/docs/diagrams/ClearTaskSequenceDiagram.puml @@ -0,0 +1,75 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":ClearTaskCommandParser" as ClearTaskCommandParser LOGIC_COLOR +participant "p:ClearTaskCommand" as ClearTaskCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("clear-t 2020-10-10") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("clear-t 2020-10-10") +activate Coach2K22Parser + +create ClearTaskCommandParser +Coach2K22Parser -> ClearTaskCommandParser +activate ClearTaskCommandParser + +ClearTaskCommandParser --> Coach2K22Parser +deactivate ClearTaskCommandParser + +Coach2K22Parser -> ClearTaskCommandParser : parse("2020-10-10") +activate ClearTaskCommandParser + +create ClearTaskCommand +ClearTaskCommandParser -> ClearTaskCommand +activate ClearTaskCommand + +ClearTaskCommand --> ClearTaskCommandParser : p +deactivate ClearTaskCommand + +ClearTaskCommandParser --> Coach2K22Parser : p +deactivate ClearTaskCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +ClearTaskCommandParser -[hidden]-> Coach2K22Parser +destroy ClearTaskCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> ClearTaskCommand : execute() +activate ClearTaskCommand + +Model -> ClearTaskCommand :getFilteredTaskList() + +loop size of TaskList +alt task.getDate() == date + ClearTaskCommand -> Model : deleteTask(task) + end +end +activate Model + +Model --> ClearTaskCommand +deactivate Model + +create CommandResult +ClearTaskCommand -> CommandResult +activate CommandResult + +CommandResult --> ClearTaskCommand +deactivate CommandResult + +ClearTaskCommand --> LogicManager : result +deactivate ClearTaskCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeleteNoteSequenceDiagram.puml b/docs/diagrams/DeleteNoteSequenceDiagram.puml new file mode 100644 index 00000000000..57f99db8db6 --- /dev/null +++ b/docs/diagrams/DeleteNoteSequenceDiagram.puml @@ -0,0 +1,67 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeleteNoteCommandParser" as DeleteNoteCommandParser LOGIC_COLOR +participant "p:DeleteNoteCommand" as DeleteNoteCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("note-del 1 1...") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("note-del 1 1...") +activate Coach2K22Parser + +create DeleteNoteCommandParser +Coach2K22Parser -> DeleteNoteCommandParser +activate DeleteNoteCommandParser + +DeleteNoteCommandParser --> Coach2K22Parser +deactivate DeleteNoteCommandParser + +Coach2K22Parser -> DeleteNoteCommandParser : parse("note-del 1 1...") +activate DeleteNoteCommandParser + +create DeleteNoteCommand +DeleteNoteCommandParser -> DeleteNoteCommand +activate DeleteNoteCommand + +DeleteNoteCommand --> DeleteNoteCommandParser : p +deactivate DeleteNoteCommand +DeleteNoteCommandParser --> Coach2K22Parser : p + +DeleteNoteCommandParser -[hidden]-> Coach2K22Parser +destroy DeleteNoteCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> DeleteNoteCommand : execute() +activate DeleteNoteCommand + +DeleteNoteCommand -> Model : setPerson(originalPerson, editedPerson) +activate Model + +Model --> DeleteNoteCommand +deactivate Model + +create CommandResult +DeleteNoteCommand -> CommandResult +activate CommandResult + +CommandResult --> DeleteNoteCommand +deactivate CommandResult + +DeleteNoteCommand --> LogicManager : result +deactivate DeleteNoteCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeletePersonSequenceDiagram.puml b/docs/diagrams/DeletePersonSequenceDiagram.puml new file mode 100644 index 00000000000..f6d5c4ae5ae --- /dev/null +++ b/docs/diagrams/DeletePersonSequenceDiagram.puml @@ -0,0 +1,82 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeletePersonCommandParser" as DeletePersonCommandParser LOGIC_COLOR +participant "p:DeletePersonCommand" as DeletePersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("del-p 1") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("del-p 1") +activate Coach2K22Parser + +create DeletePersonCommandParser +Coach2K22Parser -> DeletePersonCommandParser +activate DeletePersonCommandParser + +DeletePersonCommandParser --> Coach2K22Parser +deactivate DeletePersonCommandParser + +Coach2K22Parser -> DeletePersonCommandParser : parse("1") +activate DeletePersonCommandParser + +create DeletePersonCommand +DeletePersonCommandParser -> DeletePersonCommand +activate DeletePersonCommand + +DeletePersonCommand --> DeletePersonCommandParser : p +deactivate DeletePersonCommand +DeletePersonCommandParser --> Coach2K22Parser : p + +DeletePersonCommandParser -[hidden]-> Coach2K22Parser +destroy DeletePersonCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> DeletePersonCommand : execute() +activate DeletePersonCommand + +DeletePersonCommand -> Model : getFilteredTaskList() +activate Model + +Model --> DeletePersonCommand +deactivate Model + +loop size of TaskList + alt task.contains(personToDelete) + DeletePersonCommand -> Model : setTask(editedTask) + activate Model + Model --> DeletePersonCommand + deactivate Model + end +end + +DeletePersonCommand -> Model : deletePerson(person) +activate Model + +Model --> DeletePersonCommand +deactivate Model + +create CommandResult +DeletePersonCommand -> CommandResult +activate CommandResult + +CommandResult --> DeletePersonCommand +deactivate CommandResult + +DeletePersonCommand --> LogicManager : result +deactivate DeletePersonCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeletePersonTagSequenceDiagram.puml b/docs/diagrams/DeletePersonTagSequenceDiagram.puml new file mode 100644 index 00000000000..7d9f2554f33 --- /dev/null +++ b/docs/diagrams/DeletePersonTagSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeletePersonTagCommandParser" as DeletePersonTagCommandParser LOGIC_COLOR +participant "p:DeletePersonTagCommand" as DeletePersonTagCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("tag-del-p 1 friend") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("tag-del-p 1 friend") +activate Coach2K22Parser + +create DeletePersonTagCommandParser +Coach2K22Parser -> DeletePersonTagCommandParser +activate DeletePersonTagCommandParser + +DeletePersonTagCommandParser --> Coach2K22Parser +deactivate DeletePersonTagCommandParser + +Coach2K22Parser -> DeletePersonTagCommandParser : parse(" 1 friend") +activate DeletePersonTagCommandParser + +create DeletePersonTagCommand +DeletePersonTagCommandParser -> DeletePersonTagCommand +activate DeletePersonTagCommand + +DeletePersonTagCommand --> DeletePersonTagCommandParser : p +deactivate DeletePersonTagCommand + +DeletePersonTagCommandParser --> Coach2K22Parser : p +deactivate DeletePersonTagCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +DeletePersonTagCommandParser -[hidden]-> Coach2K22Parser +destroy DeletePersonTagCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> DeletePersonTagCommand : execute() +activate DeletePersonTagCommand + +DeletePersonTagCommand -> Model : setPerson(personToEdit, editedPerson) +activate Model + +Model --> DeletePersonTagCommand +deactivate Model + +create CommandResult +DeletePersonTagCommand -> CommandResult +activate CommandResult + +CommandResult --> DeletePersonTagCommand +deactivate CommandResult + +DeletePersonTagCommand --> LogicManager : result +deactivate DeletePersonTagCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeletePlayerSequenceDiagram.puml b/docs/diagrams/DeletePlayerSequenceDiagram.puml new file mode 100644 index 00000000000..7699f4e6313 --- /dev/null +++ b/docs/diagrams/DeletePlayerSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeletePlayerCommandParser" as DeletePlayerCommandParser LOGIC_COLOR +participant "p:DeletePlayerCommand" as DeletePlayerCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("del-player Cena") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("del-player Cena") +activate Coach2K22Parser + +create DeletePlayerCommandParser +Coach2K22Parser -> DeletePlayerCommandParser +activate DeletePlayerCommandParser + +DeletePlayerCommandParser --> Coach2K22Parser +deactivate DeletePlayerCommandParser + +Coach2K22Parser -> DeletePlayerCommandParser : parse("Cena") +activate DeletePlayerCommandParser + +create DeletePlayerCommand +DeletePlayerCommandParser -> DeletePlayerCommand +activate DeletePlayerCommand + +DeletePlayerCommand --> DeletePlayerCommandParser : p +deactivate DeletePlayerCommand + +DeletePlayerCommandParser --> Coach2K22Parser : p +deactivate DeletePlayerCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +DeletePlayerCommandParser -[hidden]-> Coach2K22Parser +destroy DeletePlayerCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> DeletePlayerCommand : execute() +activate DeletePlayerCommand + +DeletePlayerCommand -> Model : deletePlayer(Player) +activate Model + +Model --> DeletePlayerCommand +deactivate Model + +create CommandResult +DeletePlayerCommand -> CommandResult +activate CommandResult + +CommandResult --> DeletePlayerCommand +deactivate CommandResult + +DeletePlayerCommand --> LogicManager : result +deactivate DeletePlayerCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeleteSequenceDiagram.puml b/docs/diagrams/DeleteSequenceDiagram.puml index 1dc2311b245..1184437fd46 100644 --- a/docs/diagrams/DeleteSequenceDiagram.puml +++ b/docs/diagrams/DeleteSequenceDiagram.puml @@ -3,7 +3,7 @@ box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR -participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR participant ":CommandResult" as CommandResult LOGIC_COLOR @@ -16,17 +16,17 @@ end box [-> LogicManager : execute("delete 1") activate LogicManager -LogicManager -> AddressBookParser : parseCommand("delete 1") -activate AddressBookParser +LogicManager -> Coach2K22Parser : parseCommand("delete 1") +activate Coach2K22Parser create DeleteCommandParser -AddressBookParser -> DeleteCommandParser +Coach2K22Parser -> DeleteCommandParser activate DeleteCommandParser -DeleteCommandParser --> AddressBookParser +DeleteCommandParser --> Coach2K22Parser deactivate DeleteCommandParser -AddressBookParser -> DeleteCommandParser : parse("1") +Coach2K22Parser -> DeleteCommandParser : parse("1") activate DeleteCommandParser create DeleteCommand @@ -36,14 +36,14 @@ activate DeleteCommand DeleteCommand --> DeleteCommandParser : d deactivate DeleteCommand -DeleteCommandParser --> AddressBookParser : d +DeleteCommandParser --> Coach2K22Parser : d deactivate DeleteCommandParser 'Hidden arrow to position the destroy marker below the end of the activation bar. -DeleteCommandParser -[hidden]-> AddressBookParser +DeleteCommandParser -[hidden]-> Coach2K22Parser destroy DeleteCommandParser -AddressBookParser --> LogicManager : d -deactivate AddressBookParser +Coach2K22Parser --> LogicManager : d +deactivate Coach2K22Parser LogicManager -> DeleteCommand : execute() activate DeleteCommand diff --git a/docs/diagrams/DeleteTaskSequenceDiagram.puml b/docs/diagrams/DeleteTaskSequenceDiagram.puml new file mode 100644 index 00000000000..50d52f0240a --- /dev/null +++ b/docs/diagrams/DeleteTaskSequenceDiagram.puml @@ -0,0 +1,67 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeleteTaskCommandParser" as DeleteTaskCommandParser LOGIC_COLOR +participant "t:DeleteTaskCommand" as DeleteTaskCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("del-t 1") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("del-t 1") +activate Coach2K22Parser + +create DeleteTaskCommandParser +Coach2K22Parser -> DeleteTaskCommandParser +activate DeleteTaskCommandParser + +DeleteTaskCommandParser --> Coach2K22Parser +deactivate DeleteTaskCommandParser + +Coach2K22Parser -> DeleteTaskCommandParser : parse("1") +activate DeleteTaskCommandParser + +create DeleteTaskCommand +DeleteTaskCommandParser -> DeleteTaskCommand +activate DeleteTaskCommand + +DeleteTaskCommand --> DeleteTaskCommandParser : t +deactivate DeleteTaskCommand +DeleteTaskCommandParser --> Coach2K22Parser : t + +DeleteTaskCommandParser -[hidden]-> Coach2K22Parser +destroy DeleteTaskCommandParser + +Coach2K22Parser --> LogicManager : t +deactivate Coach2K22Parser + +LogicManager -> DeleteTaskCommand : execute() +activate DeleteTaskCommand + +DeleteTaskCommand -> Model : deleteTask(task) +activate Model + +Model --> DeleteTaskCommand +deactivate Model + +create CommandResult +DeleteTaskCommand -> CommandResult +activate CommandResult + +CommandResult --> DeleteTaskCommand +deactivate CommandResult + +DeleteTaskCommand --> LogicManager : result +deactivate DeleteTaskCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/DeleteTaskTagSequenceDiagram.puml b/docs/diagrams/DeleteTaskTagSequenceDiagram.puml new file mode 100644 index 00000000000..1d8729ab8f6 --- /dev/null +++ b/docs/diagrams/DeleteTaskTagSequenceDiagram.puml @@ -0,0 +1,69 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":DeleteTaskTagCommandParser" as DeleteTaskTagCommandParser LOGIC_COLOR +participant "p:DeleteTaskTagCommand" as DeleteTaskTagCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("tag-del-t 1 important") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("tag-del-t 1 important") +activate Coach2K22Parser + +create DeleteTaskTagCommandParser +Coach2K22Parser -> DeleteTaskTagCommandParser +activate DeleteTaskTagCommandParser + +DeleteTaskTagCommandParser --> Coach2K22Parser +deactivate DeleteTaskTagCommandParser + +Coach2K22Parser -> DeleteTaskTagCommandParser : parse(" 1 important") +activate DeleteTaskTagCommandParser + +create DeleteTaskTagCommand +DeleteTaskTagCommandParser -> DeleteTaskTagCommand +activate DeleteTaskTagCommand + +DeleteTaskTagCommand --> DeleteTaskTagCommandParser : p +deactivate DeleteTaskTagCommand + +DeleteTaskTagCommandParser --> Coach2K22Parser : p +deactivate DeleteTaskTagCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +DeleteTaskTagCommandParser -[hidden]-> Coach2K22Parser +destroy DeleteTaskTagCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> DeleteTaskTagCommand : execute() +activate DeleteTaskTagCommand + +DeleteTaskTagCommand -> Model : setTask(taskToEdit, editedTask) +activate Model + +Model --> DeleteTaskTagCommand +deactivate Model + +create CommandResult +DeleteTaskTagCommand -> CommandResult +activate CommandResult + +CommandResult --> DeleteTaskTagCommand +deactivate CommandResult + +DeleteTaskTagCommand --> LogicManager : result +deactivate DeleteTaskTagCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/EditPersonSequenceDiagram.puml b/docs/diagrams/EditPersonSequenceDiagram.puml new file mode 100644 index 00000000000..61f8a914d1c --- /dev/null +++ b/docs/diagrams/EditPersonSequenceDiagram.puml @@ -0,0 +1,82 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":EditPersonCommandParser" as EditPersonCommandParser LOGIC_COLOR +participant "p:EditPersonCommand" as EditPersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("edit-p 1 n/Johnson") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("edit-p 1 n/Johnson") +activate Coach2K22Parser + +create EditPersonCommandParser +Coach2K22Parser -> EditPersonCommandParser +activate EditPersonCommandParser + +EditPersonCommandParser --> Coach2K22Parser +deactivate EditPersonCommandParser + +Coach2K22Parser -> EditPersonCommandParser : parse("1 n/Johnson") +activate EditPersonCommandParser + +create EditPersonCommand +EditPersonCommandParser -> EditPersonCommand +activate EditPersonCommand + +EditPersonCommand --> EditPersonCommandParser : p +deactivate EditPersonCommand +EditPersonCommandParser --> Coach2K22Parser : p + +EditPersonCommandParser -[hidden]-> Coach2K22Parser +destroy EditPersonCommandParser + +Coach2K22Parser --> LogicManager : p +deactivate Coach2K22Parser + +LogicManager -> EditPersonCommand : execute() +activate EditPersonCommand + +EditPersonCommand -> Model : getFilteredTaskList() +activate Model + +Model --> EditPersonCommand +deactivate Model + +loop size of TaskList + alt newName != prevName && task.contains(prevName) + EditPersonCommand -> Model : setTask(editedTask) + activate Model + Model --> EditPersonCommand + deactivate Model + end +end + +EditPersonCommand -> Model : setPerson(editedPerson) +activate Model + +Model --> EditPersonCommand +deactivate Model + +create CommandResult +EditPersonCommand -> CommandResult +activate CommandResult + +CommandResult --> EditPersonCommand +deactivate CommandResult + +EditPersonCommand --> LogicManager : result +deactivate EditPersonCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/EditTaskSequenceDiagram.puml b/docs/diagrams/EditTaskSequenceDiagram.puml new file mode 100644 index 00000000000..fbb7cb4c64b --- /dev/null +++ b/docs/diagrams/EditTaskSequenceDiagram.puml @@ -0,0 +1,84 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":EditTaskCommandParser" as EditTaskCommandParser LOGIC_COLOR +participant "t:EditTaskCommand" as EditTaskCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("edit-t 1 n/Meeting") +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand("edit-t 1 n/Meeting") +activate Coach2K22Parser + +create EditTaskCommandParser +Coach2K22Parser -> EditTaskCommandParser +activate EditTaskCommandParser + +EditTaskCommandParser --> Coach2K22Parser +deactivate EditTaskCommandParser + +Coach2K22Parser -> EditTaskCommandParser : parse("1 n/Meeting") +activate EditTaskCommandParser + +create EditTaskCommand +EditTaskCommandParser -> EditTaskCommand +activate EditTaskCommand + +EditTaskCommand --> EditTaskCommandParser : t +deactivate EditTaskCommand +EditTaskCommandParser --> Coach2K22Parser : t + +EditTaskCommandParser -[hidden]-> Coach2K22Parser +destroy EditTaskCommandParser + +Coach2K22Parser --> LogicManager : t +deactivate Coach2K22Parser + +LogicManager -> EditTaskCommand : execute() +activate EditTaskCommand + +EditTaskCommand -> Model : setTask(editedTask) +activate Model + +Model --> EditTaskCommand +deactivate Model + +EditTaskCommand -> Model : hasStartEndTimeConflict() +activate Model + +Model --> EditTaskCommand +deactivate Model + +loop size of Task ContactList + loop size of TaskList + EditTaskCommand -> Model : hasDateTimeConflict(editedTask) + activate Model + Model --> EditTaskCommand + deactivate Model + end +end + + + +create CommandResult +EditTaskCommand -> CommandResult +activate CommandResult + +CommandResult --> EditTaskCommand +deactivate CommandResult + +EditTaskCommand --> LogicManager : result +deactivate EditTaskCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/ExportStrategySequenceDiagram.puml b/docs/diagrams/ExportStrategySequenceDiagram.puml new file mode 100644 index 00000000000..7da1bf9f1b6 --- /dev/null +++ b/docs/diagrams/ExportStrategySequenceDiagram.puml @@ -0,0 +1,49 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":ExportCommand" as ExportCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box MainWindow MODEL_COLOR_T1 +participant ":MainWindow" as MainWindow MODEL_COLOR +end box + +[-> LogicManager : execute() +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand(args) +activate Coach2K22Parser + +create ExportCommand +Coach2K22Parser -> ExportCommand : e +activate ExportCommand + +ExportCommand --> Coach2K22Parser +deactivate ExportCommand + +Coach2K22Parser --> LogicManager : e +deactivate Coach2K22Parser + +LogicManager -> ExportCommand : execute() +activate ExportCommand + +create CommandResult +ExportCommand -> CommandResult +activate CommandResult + +CommandResult --> ExportCommand + +MainWindow --> CommandResult : captureAndSaveStrategyPanel() +CommandResult --> MainWindow +deactivate CommandResult + +ExportCommand --> LogicManager : result +deactivate ExportCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/FindPersonSequenceDiagram.puml b/docs/diagrams/FindPersonSequenceDiagram.puml new file mode 100644 index 00000000000..94bdd59065e --- /dev/null +++ b/docs/diagrams/FindPersonSequenceDiagram.puml @@ -0,0 +1,66 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":FindPersonCommandParser" as FindPersonCommandParser LOGIC_COLOR +participant "f:FindPersonCommand" as FindPersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box +[-> LogicManager : execute(arg) +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand(arg) +activate Coach2K22Parser + +create FindPersonCommandParser +Coach2K22Parser -> FindPersonCommandParser +activate FindPersonCommandParser + +FindPersonCommandParser --> Coach2K22Parser +deactivate FindPersonCommandParser + +Coach2K22Parser -> FindPersonCommandParser : parse(arg) +activate FindPersonCommandParser + +create FindPersonCommand +FindPersonCommandParser -> FindPersonCommand +activate FindPersonCommand + +FindPersonCommand --> FindPersonCommandParser : f +deactivate FindPersonCommand + +FindPersonCommandParser --> Coach2K22Parser : f +deactivate FindPersonCommandParser + +Coach2K22Parser --> LogicManager : f +deactivate Coach2K22Parser +destroy FindPersonCommandParser + +LogicManager -> FindPersonCommand : execute() +activate FindPersonCommand + +FindPersonCommand -> Model: updateFilteredPersonList(predicate) +activate Model + +Model --> FindPersonCommand +deactivate Model + +create CommandResult +FindPersonCommand -> CommandResult +activate CommandResult + +CommandResult --> FindPersonCommand +deactivate CommandResult + +FindPersonCommand -->LogicManager : result +deactivate FindPersonCommand + +[<--LogicManager : result +deactivate LogicManager +@enduml diff --git a/docs/diagrams/FindTaskSequenceDiagram.puml b/docs/diagrams/FindTaskSequenceDiagram.puml new file mode 100644 index 00000000000..2d76eaf9fb2 --- /dev/null +++ b/docs/diagrams/FindTaskSequenceDiagram.puml @@ -0,0 +1,66 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":FindTaskCommandParser" as FindTaskCommandParser LOGIC_COLOR +participant "f:FindTaskCommand" as FindTaskCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box +[-> LogicManager : execute(arg) +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand(arg) +activate Coach2K22Parser + +create FindTaskCommandParser +Coach2K22Parser -> FindTaskCommandParser +activate FindTaskCommandParser + +FindTaskCommandParser --> Coach2K22Parser +deactivate FindTaskCommandParser + +Coach2K22Parser -> FindTaskCommandParser : parse(arg) +activate FindTaskCommandParser + +create FindTaskCommand +FindTaskCommandParser -> FindTaskCommand +activate FindTaskCommand + +FindTaskCommand --> FindTaskCommandParser : f +deactivate FindTaskCommand + +FindTaskCommandParser --> Coach2K22Parser : f +deactivate FindTaskCommandParser + +Coach2K22Parser --> LogicManager : f +deactivate Coach2K22Parser +destroy FindTaskCommandParser + +LogicManager -> FindTaskCommand : execute() +activate FindTaskCommand + +FindTaskCommand -> Model: updateFilteredTaskList(predicate) +activate Model + +Model --> FindTaskCommand +deactivate Model + +create CommandResult +FindTaskCommand -> CommandResult +activate CommandResult + +CommandResult --> FindTaskCommand +deactivate CommandResult + +FindTaskCommand --> LogicManager : result +deactivate FindTaskCommand + +[<--LogicManager : result +deactivate LogicManager +@enduml diff --git a/docs/diagrams/GetPersonSequenceDiagram.puml b/docs/diagrams/GetPersonSequenceDiagram.puml new file mode 100644 index 00000000000..0f699162755 --- /dev/null +++ b/docs/diagrams/GetPersonSequenceDiagram.puml @@ -0,0 +1,66 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":GetPersonCommandParser" as GetPersonCommandParser LOGIC_COLOR +participant "f:GetPersonCommand" as GetPersonCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box +[-> LogicManager : execute(arg) +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand(arg) +activate Coach2K22Parser + +create GetPersonCommandParser +Coach2K22Parser -> GetPersonCommandParser +activate GetPersonCommandParser + +GetPersonCommandParser --> Coach2K22Parser +deactivate GetPersonCommandParser + +Coach2K22Parser -> GetPersonCommandParser : parse(arg) +activate GetPersonCommandParser + +create GetPersonCommand +GetPersonCommandParser -> GetPersonCommand +activate GetPersonCommand + +GetPersonCommand --> GetPersonCommandParser : f +deactivate GetPersonCommand + +GetPersonCommandParser --> Coach2K22Parser : f +deactivate GetPersonCommandParser + +Coach2K22Parser --> LogicManager : f +deactivate Coach2K22Parser +destroy GetPersonCommandParser + +LogicManager -> GetPersonCommand : execute() +activate GetPersonCommand + +GetPersonCommand -> Model: updateFilteredPersonList(predicate) +activate Model + +Model --> GetPersonCommand +deactivate Model + +create CommandResult +GetPersonCommand -> CommandResult +activate CommandResult + +CommandResult --> GetPersonCommand +deactivate CommandResult + +GetPersonCommand -->LogicManager : result +deactivate GetPersonCommand + +[<--LogicManager : result +deactivate LogicManager +@enduml diff --git a/docs/diagrams/LoadCourtSequenceDiagram.puml b/docs/diagrams/LoadCourtSequenceDiagram.puml new file mode 100644 index 00000000000..c8a31fbaced --- /dev/null +++ b/docs/diagrams/LoadCourtSequenceDiagram.puml @@ -0,0 +1,65 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":Coach2K22Parser" as Coach2K22Parser LOGIC_COLOR +participant ":LoadCourtCommandParser" as LoadCourtCommandParser LOGIC_COLOR +participant "l:LoadCourtCommand" as LoadCourtCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box MainWindow MODEL_COLOR_T1 +participant ":MainWindow" as MainWindow MODEL_COLOR +end box + +[-> LogicManager : execute() +activate LogicManager + +LogicManager -> Coach2K22Parser : parseCommand(args) +activate Coach2K22Parser + +create LoadCourtCommandParser +Coach2K22Parser -> LoadCourtCommandParser +activate LoadCourtCommandParser + +LoadCourtCommandParser --> Coach2K22Parser +deactivate LoadCourtCommandParser + +Coach2K22Parser -> LoadCourtCommandParser : parse(args) +activate LoadCourtCommandParser + +create LoadCourtCommand +LoadCourtCommandParser -> LoadCourtCommand +activate LoadCourtCommand + +LoadCourtCommand --> LoadCourtCommandParser +deactivate LoadCourtCommand + +LoadCourtCommandParser --> Coach2K22Parser + +LoadCourtCommandParser -[hidden]-> Coach2K22Parser +destroy LoadCourtCommandParser + +Coach2K22Parser --> LogicManager +deactivate Coach2K22Parser + +LogicManager -> LoadCourtCommand : execute() +activate LoadCourtCommand + +create CommandResult +LoadCourtCommand -> CommandResult +activate CommandResult + +CommandResult --> LoadCourtCommand + +MainWindow --> CommandResult : getBackgroundImage() +CommandResult --> MainWindow +deactivate CommandResult + +LoadCourtCommand --> LogicManager : result +deactivate LoadCourtCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/LogicClassDiagram.puml b/docs/diagrams/LogicClassDiagram.puml index d4193173e18..aca2f458245 100644 --- a/docs/diagrams/LogicClassDiagram.puml +++ b/docs/diagrams/LogicClassDiagram.puml @@ -6,7 +6,7 @@ skinparam classBackgroundColor LOGIC_COLOR package Logic { -Class AddressBookParser +Class Coach2K22Parser Class XYZCommand Class CommandResult Class "{abstract}\nCommand" as Command @@ -27,8 +27,8 @@ Class HiddenOutside #FFFFFF HiddenOutside ..> Logic LogicManager .right.|> Logic -LogicManager -right->"1" AddressBookParser -AddressBookParser ..> XYZCommand : creates > +LogicManager -right->"1" Coach2K22Parser +Coach2K22Parser ..> XYZCommand : creates > XYZCommand -up-|> Command LogicManager .left.> Command : executes > diff --git a/docs/diagrams/ModelClassDiagram.png b/docs/diagrams/ModelClassDiagram.png new file mode 100644 index 00000000000..ed7f36f85b8 Binary files /dev/null and b/docs/diagrams/ModelClassDiagram.png differ diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml index 4439108973a..568b8fa3a11 100644 --- a/docs/diagrams/ModelClassDiagram.puml +++ b/docs/diagrams/ModelClassDiagram.puml @@ -7,9 +7,14 @@ skinparam classBackgroundColor MODEL_COLOR Package Model <
+ * Specifically used for load-court and export commands.
*/
- public CommandResult(String feedbackToUser, boolean showHelp, boolean exit) {
+ public CommandResult(String feedbackToUser, boolean showHelp, boolean exit, int tabPane,
+ boolean isLoadImage, Image image, boolean isExportCommand) {
this.feedbackToUser = requireNonNull(feedbackToUser);
this.showHelp = showHelp;
+ this.isLoadImage = isLoadImage;
+ this.image = image;
this.exit = exit;
+ this.tabPane = tabPane;
+ this.isExportCommand = isExportCommand;
}
/**
@@ -31,7 +63,7 @@ public CommandResult(String feedbackToUser, boolean showHelp, boolean exit) {
* and other fields set to their default value.
*/
public CommandResult(String feedbackToUser) {
- this(feedbackToUser, false, false);
+ this(feedbackToUser, false, false, DEFAULT, false, null, false);
}
public String getFeedbackToUser() {
@@ -46,6 +78,22 @@ public boolean isExit() {
return exit;
}
+ public int getTabPane() {
+ return tabPane;
+ }
+
+ public boolean isLoadImageCommand() {
+ return isLoadImage;
+ }
+
+ public Image getBackgroundImage() {
+ return image;
+ }
+
+ public boolean isExportCommand() {
+ return isExportCommand;
+ }
+
@Override
public boolean equals(Object other) {
if (other == this) {
@@ -60,12 +108,27 @@ public boolean equals(Object other) {
CommandResult otherCommandResult = (CommandResult) other;
return feedbackToUser.equals(otherCommandResult.feedbackToUser)
&& showHelp == otherCommandResult.showHelp
- && exit == otherCommandResult.exit;
+ && exit == otherCommandResult.exit
+ && tabPane == otherCommandResult.tabPane
+ && isLoadImage == otherCommandResult.isLoadImage
+ && image == otherCommandResult.image;
}
@Override
public int hashCode() {
- return Objects.hash(feedbackToUser, showHelp, exit);
+ return Objects.hash(feedbackToUser, showHelp, exit, tabPane, isLoadImage, image);
}
+ @Override
+ public String toString() {
+ return "CommandResult{"
+ + "feedbackToUser='" + feedbackToUser + '\''
+ + ", showHelp=" + showHelp
+ + ", exit=" + exit
+ + ", tabPane=" + tabPane
+ + ", isLoadImage=" + isLoadImage
+ + ", image=" + image
+ + ", isExportCommand=" + isExportCommand
+ + '}';
+ }
}
diff --git a/src/main/java/seedu/address/logic/commands/DeleteCommand.java b/src/main/java/seedu/address/logic/commands/DeleteCommand.java
deleted file mode 100644
index 02fd256acba..00000000000
--- a/src/main/java/seedu/address/logic/commands/DeleteCommand.java
+++ /dev/null
@@ -1,53 +0,0 @@
-package seedu.address.logic.commands;
-
-import static java.util.Objects.requireNonNull;
-
-import java.util.List;
-
-import seedu.address.commons.core.Messages;
-import seedu.address.commons.core.index.Index;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.model.Model;
-import seedu.address.model.person.Person;
-
-/**
- * Deletes a person identified using it's displayed index from the address book.
- */
-public class DeleteCommand extends Command {
-
- public static final String COMMAND_WORD = "delete";
-
- public static final String MESSAGE_USAGE = COMMAND_WORD
- + ": Deletes the person identified by the index number used in the displayed person list.\n"
- + "Parameters: INDEX (must be a positive integer)\n"
- + "Example: " + COMMAND_WORD + " 1";
-
- public static final String MESSAGE_DELETE_PERSON_SUCCESS = "Deleted Person: %1$s";
-
- private final Index targetIndex;
-
- public DeleteCommand(Index targetIndex) {
- this.targetIndex = targetIndex;
- }
-
- @Override
- public CommandResult execute(Model model) throws CommandException {
- requireNonNull(model);
- List