From a9c8a3435d1f2956c7b91ecee1caec7cf17590b4 Mon Sep 17 00:00:00 2001 From: Vision-2000 <122250743+Vision-2000@users.noreply.github.com> Date: Mon, 15 Apr 2024 19:21:32 +0800 Subject: [PATCH] Update DG --- docs/AboutUs.md | 1 - docs/DeveloperGuide.md | 188 ++++++------------ .../diagrams/ArchitectureSequenceDiagram.puml | 4 +- docs/diagrams/BetterModelClassDiagram.puml | 23 --- docs/diagrams/FindSequenceDiagram.puml | 24 +-- .../ForceDeleteAllSequenceDiagram-Logic.puml | 16 +- docs/diagrams/ListSequenceDiagram.puml | 14 +- docs/diagrams/ModelClassDiagram.puml | 19 +- docs/diagrams/ParserClasses.puml | 8 +- docs/diagrams/StorageClassDiagram.puml | 24 +-- docs/diagrams/UiClassDiagram.puml | 16 +- docs/diagrams/VisitModelClassDiagram.puml | 14 ++ .../tracing/LogicSequenceDiagram.puml | 14 +- 13 files changed, 146 insertions(+), 219 deletions(-) delete mode 100644 docs/diagrams/BetterModelClassDiagram.puml create mode 100644 docs/diagrams/VisitModelClassDiagram.puml diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 9ab02c90330..094e06781d4 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -27,7 +27,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[github](http://github.com/Vision-2000)] -[[portfolio](team/johndoe.md)] * Role: Developer * Responsibilities: Testing + UI + Logic diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 9117d689a22..4272d69666f 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -15,7 +15,7 @@ - [Regular-Expressions.info](https://www.regular-expressions.info/tutorial.html) was our source for learning regex. -_{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }_ +- The format of User Guide and Developer Guide was inspired by [AddressBook Level-3](https://se-education.org/addressbook-level3/). -------------------------------------------------------------------------------------------------------------------- @@ -37,7 +37,7 @@ Given below is a quick overview of main components and how they interact with ea **Main components of the architecture** -**`Main`** (consisting of classes [`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)) is in charge of the app launch and shut down. +**`Main`** (consisting of classes [`Main`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down. * At app launch, it initializes the other components in the correct sequence, and connects them up with each other. * At shut down, it shuts down the other components and invokes cleanup methods where necessary. @@ -69,24 +69,24 @@ 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) +The **API** of this component is specified in [`Ui.java`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/ui/Ui.java) -The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI. +The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PatientListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI. -The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml) +The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/resources/view/MainWindow.fxml) The `UI` component, * executes user commands using the `Logic` component. * listens for changes to `Model` data so that the UI can be updated with the modified data. * 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`. +* depends on some classes in the `Model` component, as it displays `Patient` object residing in the `Model`. ### 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/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/logic/Logic.java) Here's a (partial) class diagram of the `Logic` component: @@ -103,7 +103,7 @@ The sequence diagram below illustrates the interactions within the `Logic` compo How the `Logic` component works: -1. When `Logic` is called upon to execute a command, it is passed to an `AddressBookParser` object which in turn creates a parser that matches the command (e.g., `FindCommandParser`) and uses it to parse the command. +1. When `Logic` is called upon to execute a command, it is passed to an `InputParser` object which in turn creates a parser that matches the command (e.g., `FindCommandParser`) and uses it to parse the command. 1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `FindCommand`) which is executed by the `LogicManager`. 1. The command can communicate with the `Model` when it is executed (e.g. to delete a patient).
Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the `Model`) to achieve. @@ -114,36 +114,36 @@ Here are the other classes in `Logic` (omitted from the class diagram above) tha 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. -* 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. +* When called upon to parse a user command, the `InputParser` 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 `InputParser` returns back as a `Command` object. +* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteByIndexCommandParser`, ...) 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) +**API** : [`Model.java`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/model/Model.java) The `Model` component, -* stores the address book data i.e., all `Patient` objects (which are contained in a `UniquePatientList` object). +* stores the patient list data i.e., all `Patient` objects (which are contained in a `UniquePatientList` object). * stores the currently 'selected' `Patient` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change. * stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects. * does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components) ### Storage component -**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java) +**API** : [`Storage.java`](https://github.com/AY2324S2-CS2103T-T14-2/tp/tree/master/src/main/java/seedu/address/storage/Storage.java) The `Storage` component, -* can save both address book data and user preference data in JSON format, and read them back into corresponding objects. -* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed). +* can save both patient list data and user preference data in JSON format, and read them back into corresponding objects. +* inherits from both `PatientListStorage` 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 -Classes used by multiple components are in the `seedu.addressbook.commons` package. +Classes used by multiple components are in the `seedu.address.commons` package. -------------------------------------------------------------------------------------------------------------------- @@ -169,7 +169,7 @@ The following activity diagram describes the operation of `FindCommandParser`: Each valid prefix is checked, and if found, the value proceeding it in the argument string is saved in the form of a subclass -of `Predicate`. Otherwise, a `Predicate` that always returns true is used instead. When `FindCommand` is created, all of the +of `Predicate`. Otherwise, a `Predicate` that always returns true is used instead. When `FindCommand` is created, both of the `Predicate` are passed into it, which will be chained into a singular `Predicate` such that the `Model` component can use to update the `PatientList`. @@ -192,6 +192,12 @@ the name `Bob`, the command would be `find-n Bob`. This was rejected as it only to a less flexible feature. +#### Planned enhancements + +In later iterations, we plan to add appointment and the 3 visit fields as optional conditions. The implementation will be identical to the above, as we can exploit the chaining of multiple `Predicate` objects in Java. + +More complex enhancements can be made using the `Flag` subclass of `Prefix`, which is integrated into `ArgumentMultimap` as a zero-argument `Prefix`. This allows us to reuse the same command word `find`, but implement a different set of behaviour that is triggered when one or more optional `Flag` is detected. For example, the command `find-d n/Bob` could be implemented to find and delete all patients with the keyword `Bob` in their name. + ### List in alphabetical order feature @@ -203,13 +209,13 @@ The implementation of the `list` command works as follows. Upon the user's entering the `list` command, after checking that the list of patients is not empty, a list of all `Patients` is retrieved from the `Model` object and added to a separate `ArrayList`. From there, a `Comparator` is created that sorts the list of `Patients` using their `fullName`. Then, each element from the `ArrayList` is removed then added in the correct alphabetical order. Once this is completed, the `CommandResult` returns successfully and displays the correct output, a list of all patients in alphabetical order. -The following sequence diagram shows the sequence of events when the 'list' command is typed by a user. +The following sequence diagram shows the sequence of events when the `list` command is typed by a user. #### Design considerations -The current design was chosen as the existing list of `Patients` in the `Model` object, `getFilteredPersonList()`, is an immutable object that necessitated the creation of an `ArrayList` object, though it may be inefficient. +The current design was chosen as the existing list of `Patients` in the `Model` object, `getFilteredPatientList()`, is an immutable object that necessitated the creation of an `ArrayList` object, though it may be inefficient. ### Delete All feature @@ -217,13 +223,13 @@ The current design was chosen as the existing list of `Patients` in the `Model` #### Implementation The feature of deleting all entries is implemented via two separate commands (DeleteAllCommand and ForceDeleteAllCommand). -When the user enters 'delete-all' command, AddressBookParser parses the command into a DeleteAllCommand. +When the user enters 'delete-all' command, InputParser parses the command into a DeleteAllCommand. The LogicManager executes the DeleteAllCommand. This would return a CommandResult with a confirmation message, which asks if the user wants to truly delete all entries. When prompted with the confirmation message, the user would have the choice to enter 'delete-all-f' command or to cancel the 'delete-all' command. -When the 'delete-all-f' command is entered, AddressBookParser would parse the command into a ForceDeleteAllCommand. +When the 'delete-all-f' command is entered, InputParser would parse the command into a ForceDeleteAllCommand. The LogicManager would execute the ForceDeleteAllCommand. This would set the current model of the patient list to clear -out all existing entries by calling setAddressBook method with an empty AddressBook object used as its argument. +out all existing entries by calling setPatientList method with an empty PatientList object used as its argument. A CommandResult object would be returned with a success message that states that all data has been successfully deleted. The following sequence diagram describes the sequence of logic when the user inputs 'delete-all-f' command: @@ -237,103 +243,19 @@ user truly wants to delete all entries when the 'delete-all' command is given. If the user wishes to bypass the safety check and is certain of the intent to delete all entries, the user can enter 'delete-all-f' command to forcefully delete all entries. +### Visit feature -### \[Proposed\] Undo/redo feature - -#### Proposed Implementation - -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: - -* `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. - -These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively. - -Given below is an example usage scenario and how the undo/redo mechanism behaves at each step. - -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. The user executes `delete 5` command to delete the 5th patient 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 3. The user executes `add n/David …​` to add a new patient. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`. - - - - - -**Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`. - - - -Step 4. The user now decides that adding the patient was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state. - - - - - - -**Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather -than attempting to perform the undo. - - - -The following sequence diagram shows how an undo operation goes through the `Logic` component: - - - - - -**Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram. - - - -Similarly, how an undo operation goes through the `Model` component is shown below: - - - -The `redo` command does the opposite — it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state. - - - -**Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo. - - - -Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged. - - - -Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all address book states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …​` command. This is the behavior that most modern desktop applications follow. - - - -The following activity diagram summarizes what happens when a user executes a new command: - - - -#### Design considerations: - -**Aspect: How undo & redo executes:** +#### Implementation -* **Alternative 1 (current choice):** Saves the entire address book. - * Pros: Easy to implement. - * Cons: May have performance issues in terms of memory usage. + -* **Alternative 2:** Individual command knows how to undo/redo by - itself. - * Pros: Will use less memory (e.g. for `delete`, just save the patient being deleted). - * Cons: We must ensure that the implementation of each individual command are correct. +The `Visit` - `Patient` relationship in the `Logic` component is identical to that of `Patient` - `PatientList` relationship. In our implementation, the `Patient` class has the added responsibility of acting as a container for all `Visit` objects associated with it. This is achieved by the `UniqueVisitList` created upon construction of a `Patient` instance. -_{more aspects and alternatives to be added}_ +#### Design Considerations -### \[Proposed\] Data archiving +The current design is convenient as all methods relating to the `Visit` object will be going through the `Patient` object, which means the `Visit` does not need to hold a reference to the `Patient` it belongs to. Furthermore, `Command` instances that uses `Visit` will not need a reference to it, ensuring immutability. -_{Explain here how the data archiving feature will be implemented}_ +The initial design was to have the 3 `Visit` fields be part of the `Patient` object to keep track of the latest instance of visit. This was primarily for ease of implementation, as fewer new classes would need to be created. However, this design fell apart as we needed to keep track of past patient visits as well. -------------------------------------------------------------------------------------------------------------------- @@ -373,13 +295,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | receptionist | see usage instructions | refer to instructions when I forget how to use the App | | `* * *` | receptionist | see the list of patients | check the index of all patients | | `* * *` | receptionist | add a new patient | | +| `* * *` | receptionist | add a new visit | specify a patient and record their visit | | `* * *` | receptionist | delete a patient | remove entries that are outdated | +| `* * *` | receptionist | delete a visit | remove details of a patient's latest visit | | `* * *` | receptionist | find a patient by name | locate details of a patient without having to go through the entire list | | `* *` | receptionist | find a patient by contact number | look for a specific patient without worrying about duplicate names | | `* *` | receptionist | delete all patients | easily reset the list to a blank state | | `* *` | receptionist | exit with a command | close the application with keyboard inputs only | -*{More to be added}* ### Use cases @@ -486,14 +409,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 5. Can only be used by a registered receptionist. 6. Each command should take no more than 1 second until a response is displayed. -*{More to be added}* - ### Glossary * **Mainstream OS**: Windows, Linux, MacOS * **Patient**: A patient who has visited the clinic at least once due to an illness -* **Receptionist** The user operating MediTrack -* **Patient information**: Name, contact number, address, email, date of birth, symptoms, date of visit +* **Receptionist**: The user operating MediTrack +* **Patient information**: Name, contact number, address, email, date of birth, sex, appointment +* **Visit**: An instance of a particular patient coming to the clinic for a medical reason +* **Visit information**: Condition, severity, date of visit -------------------------------------------------------------------------------------------------------------------- @@ -515,7 +438,7 @@ testers are expected to do more *exploratory* testing. 1. Download the jar file and copy into an empty folder - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. + 1. Double-click the jar file
Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. 1. Saving window preferences @@ -524,7 +447,21 @@ testers are expected to do more *exploratory* testing. 1. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. -1. _{ more test cases …​ }_ +1. Shutting down + + 1. Test case: `exit`
+ Expected: Confirmation message prompting a yes or no. + 2. Test case: `yes`
+ Expected: Window closes. + +### Adding a patient + +1. Adding a patient when no patients exist + 1. Prerequisites: Ensure that the list is empty by using the command `delete-all-f`. + 1. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 b/25/2/2024 s/Male`
+ Expected: Patient added to the list. Details of the patient shown in the status message. + 1. Incorrect add commands to try: the above, but with some arguments missing
+ Expected: No patient added. Error details shown in status message. ### Deleting a patient @@ -533,20 +470,13 @@ testers are expected to do more *exploratory* testing. 1. Prerequisites: List all patients using the `list` command. Multiple patients in the list. 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. + Expected: First patient is deleted from the list. Details of the deleted patient shown in the status message. 1. Test case: `delete 0`
- Expected: No patient is deleted. Error details shown in the status message. Status bar remains the same. + Expected: No patient is deleted. Error details shown in the status message. 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
Expected: Similar to previous. -1. _{ more test cases …​ }_ - -### Saving data - -1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ -1. _{ more test cases …​ }_ diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml index 48b6cc4333c..1cbd090a708 100644 --- a/docs/diagrams/ArchitectureSequenceDiagram.puml +++ b/docs/diagrams/ArchitectureSequenceDiagram.puml @@ -14,13 +14,13 @@ activate ui UI_COLOR ui -[UI_COLOR]> logic : execute("delete 1") activate logic LOGIC_COLOR -logic -[LOGIC_COLOR]> model : deletePerson(p) +logic -[LOGIC_COLOR]> model : deletePatient(p) activate model MODEL_COLOR model -[MODEL_COLOR]-> logic deactivate model -logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook) +logic -[LOGIC_COLOR]> storage : savePatientList(patientlist) activate storage STORAGE_COLOR storage -[STORAGE_COLOR]> storage : Save to file diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml deleted file mode 100644 index d3b2868c15f..00000000000 --- a/docs/diagrams/BetterModelClassDiagram.puml +++ /dev/null @@ -1,23 +0,0 @@ -@startuml -!include style.puml -skinparam arrowThickness 1.1 -skinparam arrowColor MODEL_COLOR -skinparam classBackgroundColor MODEL_COLOR - -AddressBook *-right-> "1" UniquePatientList -AddressBook *-right-> "1" UniqueTagList -UniqueTagList -[hidden]down- UniquePatientList -UniqueTagList -[hidden]down- UniquePatientList - -UniqueTagList -right-> "*" Tag -UniquePatientList -right-> Patient - -Patient -up-> "*" Tag - -Patient *--> Name -Patient *--> Phone -Patient *--> Email -Patient *--> Address -Patient *--> DateOfBirth -Patient *--> Sex -@enduml diff --git a/docs/diagrams/FindSequenceDiagram.puml b/docs/diagrams/FindSequenceDiagram.puml index 5d7c049e1dd..86d71ecb4b2 100644 --- a/docs/diagrams/FindSequenceDiagram.puml +++ b/docs/diagrams/FindSequenceDiagram.puml @@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR -participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR +participant ":InputParser" as InputParser LOGIC_COLOR participant ":FindCommandParser" as FindCommandParser LOGIC_COLOR participant "f:FindCommand" as FindCommand LOGIC_COLOR participant "r:CommandResult" as CommandResult LOGIC_COLOR @@ -17,17 +17,17 @@ end box [-> LogicManager : execute("find n/Bob") activate LogicManager -LogicManager -> AddressBookParser : parseCommand("find n/Bob") -activate AddressBookParser +LogicManager -> InputParser : parseCommand("find n/Bob") +activate InputParser create FindCommandParser -AddressBookParser -> FindCommandParser +InputParser -> FindCommandParser activate FindCommandParser -FindCommandParser --> AddressBookParser +FindCommandParser --> InputParser deactivate FindCommandParser -AddressBookParser -> FindCommandParser : parse("n/Bob") +InputParser -> FindCommandParser : parse("n/Bob") activate FindCommandParser create FindCommand @@ -37,19 +37,19 @@ activate FindCommand FindCommand --> FindCommandParser : deactivate FindCommand -FindCommandParser --> AddressBookParser : f +FindCommandParser --> InputParser : f deactivate FindCommandParser 'Hidden arrow to position the destroy marker below the end of the activation bar. -FindCommandParser -[hidden]-> AddressBookParser +FindCommandParser -[hidden]-> InputParser destroy FindCommandParser -AddressBookParser --> LogicManager : f -deactivate AddressBookParser +InputParser --> LogicManager : f +deactivate InputParser LogicManager -> FindCommand : execute(m) activate FindCommand -FindCommand -> Model : updateFilteredPersonList(namePredicate) +FindCommand -> Model : updateFilteredPatientList(namePredicate) activate Model Model --> FindCommand @@ -65,6 +65,6 @@ deactivate CommandResult FindCommand --> LogicManager : r deactivate FindCommand -[<--LogicManager +[<--LogicManager : r deactivate LogicManager @enduml diff --git a/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml b/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml index dd4ab3235c2..a16929d5c04 100644 --- a/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml +++ b/docs/diagrams/ForceDeleteAllSequenceDiagram-Logic.puml @@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR -participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR +participant ":InputParser" as InputParser LOGIC_COLOR participant "f:ForceDeleteAllCommand" as ForceDeleteAllCommand LOGIC_COLOR end box @@ -14,23 +14,23 @@ end box [-> LogicManager : execute(delete-all-f) activate LogicManager -LogicManager -> AddressBookParser : parseCommand(delete-all-f) -activate AddressBookParser +LogicManager -> InputParser : parseCommand(delete-all-f) +activate InputParser create ForceDeleteAllCommand -AddressBookParser -> ForceDeleteAllCommand +InputParser -> ForceDeleteAllCommand activate ForceDeleteAllCommand -ForceDeleteAllCommand --> AddressBookParser +ForceDeleteAllCommand --> InputParser deactivate ForceDeleteAllCommand -AddressBookParser --> LogicManager : f -deactivate AddressBookParser +InputParser --> LogicManager : f +deactivate InputParser LogicManager -> ForceDeleteAllCommand : execute() activate ForceDeleteAllCommand -ForceDeleteAllCommand -> Model : setAddressBook() +ForceDeleteAllCommand -> Model : setPatientList() activate Model Model --> ForceDeleteAllCommand diff --git a/docs/diagrams/ListSequenceDiagram.puml b/docs/diagrams/ListSequenceDiagram.puml index 11276724b89..7139d747081 100644 --- a/docs/diagrams/ListSequenceDiagram.puml +++ b/docs/diagrams/ListSequenceDiagram.puml @@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR -participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR +participant ":InputParser" as InputParser LOGIC_COLOR participant "f:ListCommand" as ListCommand LOGIC_COLOR participant ":CommandResult" as CommandResult LOGIC_COLOR end box @@ -16,21 +16,21 @@ end box [-> LogicManager : execute("list") activate LogicManager -LogicManager -> AddressBookParser : parseCommand("list") -activate AddressBookParser +LogicManager -> InputParser : parseCommand("list") +activate InputParser create ListCommand -AddressBookParser -> ListCommand +InputParser -> ListCommand activate ListCommand -ListCommand -> Model : updateFilteredPersonList +ListCommand -> Model : updateFilteredPatientList Model -> ListCommand : (patient1, patient2) ListCommand --> Model Model --> ListCommand -ListCommand -> Model: deletePerson +ListCommand -> Model: deletePatient Model --> ListCommand -ListCommand -> Model: addPerson +ListCommand -> Model: addPatient Model --> ListCommand ListCommand -> CommandResult: sortedList diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml index 68ddcb1df9b..0fec628f9e1 100644 --- a/docs/diagrams/ModelClassDiagram.puml +++ b/docs/diagrams/ModelClassDiagram.puml @@ -5,10 +5,10 @@ skinparam arrowColor MODEL_COLOR skinparam classBackgroundColor MODEL_COLOR Package Model as ModelPackage <>{ -Class "<>\nReadOnlyAddressBook" as ReadOnlyAddressBook +Class "<>\nReadOnlyPatientList" as ReadOnlyPatientList Class "<>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs Class "<>\nModel" as Model -Class AddressBook +Class PatientList Class ModelManager Class UserPrefs @@ -20,6 +20,8 @@ Class Name Class Phone Class DateOfBirth Class Sex +Class Appointment +Class UniqueVisitList Class I #FFFFFF } @@ -27,16 +29,16 @@ Class I #FFFFFF Class HiddenOutside #FFFFFF HiddenOutside ..> Model -AddressBook .up.|> ReadOnlyAddressBook +PatientList .up.|> ReadOnlyPatientList ModelManager .up.|> Model Model .right.> ReadOnlyUserPrefs -Model .left.> ReadOnlyAddressBook -ModelManager -left-> "1" AddressBook +Model .left.> ReadOnlyPatientList +ModelManager -left-> "1" PatientList ModelManager -right-> "1" UserPrefs UserPrefs .up.|> ReadOnlyUserPrefs -AddressBook *--> "1" UniquePatientList +PatientList *--> "1" UniquePatientList UniquePatientList --> "~* all" Patient Patient *--> Name Patient *--> Phone @@ -44,6 +46,8 @@ Patient *--> Email Patient *--> Address Patient *--> DateOfBirth Patient *--> Sex +Patient *--> Appointment +Patient *-right-> "1"UniqueVisitList Patient -[hidden]up--> I UniquePatientList -[hidden]right-> I @@ -53,6 +57,9 @@ Phone -[hidden]right-> Email Email -[hidden]right-> Address Address -[hidden]right-> DateOfBirth DateOfBirth -[hidden]right-> Sex +Sex -[hidden]right-> Appointment +Appointment -[hidden]up-> UniqueVisitList + ModelManager --> "~* filtered" Patient @enduml diff --git a/docs/diagrams/ParserClasses.puml b/docs/diagrams/ParserClasses.puml index ce4c5ce8c8d..6c17c32ef96 100644 --- a/docs/diagrams/ParserClasses.puml +++ b/docs/diagrams/ParserClasses.puml @@ -9,7 +9,7 @@ Class XYZCommand package "Parser classes"{ Class "<>\nParser" as Parser -Class AddressBookParser +Class InputParser Class XYZCommandParser Class CliSyntax Class ParserUtil @@ -19,12 +19,12 @@ Class Prefix } Class HiddenOutside #FFFFFF -HiddenOutside ..> AddressBookParser +HiddenOutside ..> InputParser -AddressBookParser .down.> XYZCommandParser: <> +InputParser .down.> XYZCommandParser: <> XYZCommandParser ..> XYZCommand : <> -AddressBookParser ..> Command : <> +InputParser ..> Command : <> XYZCommandParser .up.|> Parser XYZCommandParser ..> ArgumentMultimap XYZCommandParser ..> ArgumentTokenizer diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml index a821e06458c..c2a3d763dd2 100644 --- a/docs/diagrams/StorageClassDiagram.puml +++ b/docs/diagrams/StorageClassDiagram.puml @@ -14,12 +14,12 @@ Class JsonUserPrefsStorage Class "<>\nStorage" as Storage Class StorageManager -package "AddressBook Storage" #F4F6F6{ -Class "<>\nAddressBookStorage" as AddressBookStorage -Class JsonAddressBookStorage -Class JsonSerializableAddressBook -Class JsonAdaptedPerson -Class JsonAdaptedTag +package "PatientList Storage" #F4F6F6{ +Class "<>\nPatientListStorage" as PatientlistStorage +Class JsonPatientListStorage +Class JsonSerializablePatientList +Class JsonAdaptedPatient +Class JsonAdaptedVisit } } @@ -29,15 +29,15 @@ HiddenOutside ..> Storage StorageManager .up.|> Storage StorageManager -up-> "1" UserPrefsStorage -StorageManager -up-> "1" AddressBookStorage +StorageManager -up-> "1" PatientlistStorage Storage -left-|> UserPrefsStorage -Storage -right-|> AddressBookStorage +Storage -right-|> PatientlistStorage JsonUserPrefsStorage .up.|> UserPrefsStorage -JsonAddressBookStorage .up.|> AddressBookStorage -JsonAddressBookStorage ..> JsonSerializableAddressBook -JsonSerializableAddressBook --> "*" JsonAdaptedPerson -JsonAdaptedPerson --> "*" JsonAdaptedTag +JsonPatientListStorage .up.|> PatientlistStorage +JsonPatientListStorage ..> JsonSerializablePatientList +JsonSerializablePatientList --> "*" JsonAdaptedPatient +JsonAdaptedPatient --> "*" JsonAdaptedVisit @enduml diff --git a/docs/diagrams/UiClassDiagram.puml b/docs/diagrams/UiClassDiagram.puml index 95473d5aa19..67b8177c240 100644 --- a/docs/diagrams/UiClassDiagram.puml +++ b/docs/diagrams/UiClassDiagram.puml @@ -11,8 +11,8 @@ Class UiManager Class MainWindow Class HelpWindow Class ResultDisplay -Class PersonListPanel -Class PersonCard +Class PatientListPanel +Class PatientCard Class StatusBarFooter Class CommandBox } @@ -32,26 +32,26 @@ UiManager .left.|> Ui UiManager -down-> "1" MainWindow MainWindow *-down-> "1" CommandBox MainWindow *-down-> "1" ResultDisplay -MainWindow *-down-> "1" PersonListPanel +MainWindow *-down-> "1" PatientListPanel MainWindow *-down-> "1" StatusBarFooter MainWindow --> "0..1" HelpWindow -PersonListPanel -down-> "*" PersonCard +PatientListPanel -down-> "*" PatientCard MainWindow -left-|> UiPart ResultDisplay --|> UiPart CommandBox --|> UiPart -PersonListPanel --|> UiPart -PersonCard --|> UiPart +PatientListPanel --|> UiPart +PatientCard --|> UiPart StatusBarFooter --|> UiPart HelpWindow --|> UiPart -PersonCard ..> Model +PatientCard ..> Model UiManager -right-> Logic MainWindow -left-> Logic -PersonListPanel -[hidden]left- HelpWindow +PatientListPanel -[hidden]left- HelpWindow HelpWindow -[hidden]left- CommandBox CommandBox -[hidden]left- ResultDisplay ResultDisplay -[hidden]left- StatusBarFooter diff --git a/docs/diagrams/VisitModelClassDiagram.puml b/docs/diagrams/VisitModelClassDiagram.puml new file mode 100644 index 00000000000..ac0c23019f2 --- /dev/null +++ b/docs/diagrams/VisitModelClassDiagram.puml @@ -0,0 +1,14 @@ +@startuml +!include style.puml +skinparam arrowThickness 1.1 +skinparam arrowColor MODEL_COLOR +skinparam classBackgroundColor MODEL_COLOR + +Patient *--> "1" UniqueVisitList + +UniqueVisitList -down-> Visit + +Visit *--> Condition +Visit *--> Severity +Visit *--> DateOfVisit +@enduml diff --git a/docs/diagrams/tracing/LogicSequenceDiagram.puml b/docs/diagrams/tracing/LogicSequenceDiagram.puml index 42bf46d3ce8..76d1fd43db3 100644 --- a/docs/diagrams/tracing/LogicSequenceDiagram.puml +++ b/docs/diagrams/tracing/LogicSequenceDiagram.puml @@ -3,20 +3,20 @@ skinparam ArrowFontStyle plain Participant ":LogicManager" as logic LOGIC_COLOR -Participant ":AddressBookParser" as abp LOGIC_COLOR +Participant ":InputParser" as ip LOGIC_COLOR Participant ":EditCommandParser" as ecp LOGIC_COLOR Participant "command:EditCommand" as ec LOGIC_COLOR [-> logic : execute activate logic -logic -> abp ++: parseCommand(commandText) +logic -> ip ++: parseCommand(commandText) create ecp -abp -> ecp -abp -> ecp ++: parse(arguments) +ip -> ecp +ip -> ecp ++: parse(arguments) create ec -ecp -> ec ++: index, editPersonDescriptor +ecp -> ec ++: index, editPatientDescriptor ec --> ecp -- -ecp --> abp --: command -abp --> logic --: command +ecp --> ip --: command +ip --> logic --: command @enduml