AB-3 Developer Guide

---

Acknowledgements

{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }

---

Setting up, getting started

Refer to the guide Setting up and getting started.

---

Design

Architecture

The Architecture Diagram given above explains the high-level design of the App.

Given below is a quick overview of main components and how they interact with each other.

Main components of the architecture

Main (consisting of classes Main and MainApp) 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.

The bulk of the app's work is done by the following four components:

• UI: The UI of the App.
• Logic: The command executor.
• Model: Holds the data of the App in memory.
• Storage: Reads data from, and writes data to, the hard disk.

Commons represents a collection of classes used by multiple other components.

How the architecture components interact with each other

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete 1.

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.

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.

The sections below give more details of each component.

UI component

The API of this component is specified in 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 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 is specified in 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.

Logic component

API : Logic.java

Here's a (partial) class diagram of the Logic component:

The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete 1") API call as an example.

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., DeleteCommandParser) and uses it to parse the command.
2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
3. The command can communicate with the Model when it is executed (e.g. to delete a person).
   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.
4. The result of the command execution is encapsulated as a CommandResult object which is returned back from Logic.

Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

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.

Model component

API : Model.java

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<Person> 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

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).
• 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.address.commons package.

---

Implementation

This section describes some noteworthy details on how certain features are implemented.

[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 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 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.

Step 4. The user now decides that adding the person 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.

The following sequence diagram shows how an undo operation goes through the Logic component:

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.

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:

• 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 person being deleted).
  • Cons: We must ensure that the implementation of each individual command are correct.

{more aspects and alternatives to be added}

[Proposed] Data archiving

{Explain here how the data archiving feature will be implemented}

---

Documentation, logging, testing, configuration, dev-ops

• Documentation guide
• Testing guide
• Logging guide
• Configuration guide
• DevOps guide

---

Appendix: Requirements

Product scope

Target user profile:

• Insurance Agent who manage multiple clients
• Who may need to find contacts of particular clients
• Who has to keep track of many meetings with clients

Value proposition: Centralised platform for keeping track of all work-related information, organising large amounts of information and helping with progress management of clients.

User stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Use cases

(For all use cases below, the System is FinHub and the Actor is the user, unless specified otherwise)

Use case: UC01 - Search client by name

MSS

1. The user searches for the client by their name.

2. FinHub shows details of clients with matching names.

   Use case ends.

Extensions

• 1a. FinHub detects an error in the command entered.

  • 1a1. FinHub displays an error message and prompts the user to input again.

  • 1a2. The user re-enters the command to search the client by name.

    Steps 1a1-1a2 are repeated until the command and data entered are correct.

    Use case resumes at step 2.

• 2a. The list is empty.

  Use case ends.

Use case: UC02 - Search client by email

MSS

1. The user searches for the client by their email.

2. FinHub shows details of clients with matching emails.

   Use case ends.

Extensions

• 1a. FinHub detects an error in the command entered.

  • 1a1. FinHub displays an error message and prompts the user to input again.

  • 1a2. The user re-enters the command to search the client by email.

    Steps 1a1-1a2 are repeated until the command and data entered are correct.

    Use case resumes at step 2.

• 2a. The list is empty.

  Use case ends.

Use case: UC03 - Search client by phone number

MSS

1. The user searches for the client by their phone number.

2. FinHub shows details of clients with matching phone number.

   Use case ends.

Extensions

• 1a. FinHub detects an error in the command entered.

  • 1a1. FinHub displays an error message and prompts the user to input again.

  • 1a2. The user re-enters the command to search the client by phone number.

    Steps 1a1-1a2 are repeated until the command and data entered are correct.

    Use case resumes at step 2.

• 2a. The list is empty.

  Use case ends.

Use case: UC04 - Mark client as complete

MSS

1. The user search client by their name (UC01).

2. FinHub displays a list of clients.

3. The user selects the client to be marked as complete.

4. FinHub successfully marks the client as complete and displays a success message.

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. FinHub detects an error in the command entered.

  • 3a1. FinHub displays an error message and prompts the user to input again.

  • 3a2. The user re-enters the command to mark client as completed.

    Steps 3a1-3a2 are repeated until the command and data entered are correct.

    Use case resumes at step 4.

Use case: UC05 - Add a client's contact

MSS

1. The user selects the option to add clients.

2. The user enters the client's details (name, telephone number, email address).

3. FinHub validates the input.

4. FinHub adds the new client into the address book.

5. FinHub displays a confirmation message.

   Use case ends.

Extensions

• 3a. The user enters invalid/missing inputs.

  • 3a1. FinHub prompts the user to enter the correct details.

    Use case resumes at step 2.

• 3b. The user enters an email/telephone number that has been added before.

  • 3b1. FinHub warns that a duplicate entry is not allowed.

    Use case ends.

Use case: UC06 - Delete a client's contact

Precondition: Client list must not be empty.

MSS

1. The user searches for the client to delete by their name (UC01).

2. The user selects the client to be deleted.

3. FinHub asks for confirmation of the deletion.

4. FinHub removes the client from the address book.

5. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client.

  • 2a1. FinHub warns that an invalid client has been selected, and prompts the user to select again.

    Step 2a1 is repeated until a valid client has been selected.

    Use case resumes at step 3.

• 3a. The user cancels the deletion.
  Use case ends.

Use case: UC07 - Edit a client's information

Precondition: Client list must not be empty.

MSS

1. The user searches for the client to edit by their name (UC01).

2. The user selects the client to be edited, and enters one or more updated fields.

3. FinHub validates the updated data.

4. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client.

  • 2a1. FinHub warns that an invalid client has been selected, and prompts the user to select again.

    Step 2a1 is repeated until a correct client has been selected.

    Use case resumes at step 3

• 2b. The user enters invalid fields.

  • 2b1. FinHub prompts the user to enter the correct details.

    Use case resumes at step 2.

Use case: UC08 - Delete reminder

Precondition: Client list must not be empty.

MSS

1. The user searches for the client to edit by their name (UC01).

2. The user selects which client and which reminder to delete.

3. FinHub displays a success message.

4. FinHub shows the client the list without the deleted reminder.

   Use case ends.

Extensions

• 2a. The user selects an invalid client or reminder.

  • 2a1. FinHub warns and specifies which is the invalid selection, and prompts the user to select again.

    Step 2a1 is repeated until a correct selection.

    Use case resumes at step 3.

Use case: UC09 - Receive alerts if client has not been contacted in a specified period

MSS

1. The user starts up the application.

2. FinHub displays a message containing all the clients that has not been contacted in a specific period of time.

3. FinHub returns to landing display.

   Use case ends.

Extensions

• 2a. There is no clients that are under this criteria.

  • 2a1. FinHub displays an empty message.

    Use case resumes at step 3.

Use case: UC10 - List of all upcoming policy renewal dates

MSS

1. The user starts up the application.

2. FinHub displays a message showing the few upcoming policy renewal dates in chronological order within a set interval.

3. FinHub returns to landing display.

   Use case ends.

Extensions

• 2a. There are no policy renewal dates in the data.

  • 2a1. FinHub displays an empty message.

    Use case resumes at step 3.

Use case: UC11 - Assign priority levels to tasks

MSS

1. FinHub will display a list of tasks saved.

2. The user will select the task that they want to assign a priority level to and the priority level.

3. FinHub will update the task with the corresponding level.

4. FinHub returns to landing display.

   Use case ends.

Extensions

• 2a. The user selects either invalid task or invalid priority level.

  • 2a1. FinHub warns and specifies which is the invalid selection, and prompts the user to select correct task/ priority level.

    Step 2a1 is repeated until a correct task and priority level has been selected.

    Use case resumes at step 3.

Use case: UC12 - Set reminder for clients

Precondition: Client list must not be empty.

MSS

1. The user searches for the client by their name (UC01).

2. The user selects which client and set reminder for the client by their index, and enters the reminder and the date and time to remind.

3. FinHub validates the updated data.

4. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client or reminder.

  • 2a1. FinHub warns and specifies which is the invalid selection, and prompts the user to select again.

    Step 2a1 is repeated until a correct selection.

    Use case resumes at step 3.

• 2b. The user enters invalid date/time inputs.

  • 2b1. FinHub prompts the user to enter proper date/time.

    Step 2b1 is repeated until a correct input has been entered.

    Use case resumes at step 3.

Use case: UC13 - Edit reminder for clients

Precondition: Client list must not be empty.

MSS

1. The user searches for the client by their name (UC01).

2. The user selects which client and edit reminder for the client by their index, and enters the amended reminder and the date and time to remind.

3. FinHub validates the updated data.

4. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client or reminder.

  • 2a1. FinHub warns and specifies which is the invalid selection, and prompts the user to select again.

    Step 2a1 is repeated until a correct selection.

    Use case resumes at step 3.

• 2b. The user enters invalid date/time inputs.

  • 2b1. FinHub prompts the user to enter proper date/time.

    Step 2b1 is repeated until a correct input has been entered.

    Use case resumes at step 3.

Use case: UC14 - Add client meeting notes

Precondition: Client list must not be empty.

MSS

1. The user searches for the client by their name (UC01).

2. The user selects the option to add meeting notes for the client by their index, and enters the meeting notes.

3. FinHub validates the updated data.

4. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client.

  • 2a1. FinHub warns that user does not exist and prompts the user to select again.

    Step 2a1 is repeated until a correct selection.

    Use case resumes at step 3.

Use Case: UC15 - Archive client

Precondition: User is logged into the CLI System.

MSS

1. The user searches for the client by their name (UC01).

2. The user types the archive command.

3. FinHub prompts for confirmation.

4. The user confirms.

5. FinHub changes the client's status from active to archived in the database.

6. FinHub displays a success message.

   Use case ends.

Extensions

• 2a. The user selects an invalid client.

  • 2a1. FinHub displays a message that client is not found.

    Use case ends.

• 3a. The user cancels at the confirmation step. Use case ends.

Use Case: UC16 - Enter application with password

MSS

1. The user launches the application.

2. FinHub prompts user to enter username.

3. The user enters their username.

4. FinHub prompts for password.

5. The user enters their password.

6. FinHub validates the credentials against stored records.

7. If valid, the user is granted access.

   Use case ends.

Extensions

• 6a. The user account does not exist.

  • 6a1. FinHub will display an error message.

    Use case ends.

• 6b. The password entered is wrong.

  • 6b1. FinHub will display an error message.

    Use case ends.

Non-Functional Requirements

1. Should work on any mainstream OS as long as it has Java 17 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.
4. The product should be for a single user
5. The data should be stored locally and should be in a human editable text file, instead of a database management system.
6. The software should work without requiring an installer.
7. The GUI should work well (i.e., should not cause any resolution-related inconveniences to the user) for standard screen resolutions 1920x1080 and higher, and for screen scales 100% and 125%.
8. The GUI should be usable (i.e., all functions can be used even if the user experience is not optimal) for resolutions 1280x720 and higher, and for screen scales 150%.
9. The product should be packaged into a .jar file
10. The product file size should be reasonable and should not exceed 100Mb.
11. The product is not required to cover communication with clients from the app, policy and financial calculation and payment and billing system.

Glossary

• Mainstream OS: Windows, Linux, Unix, MacOS
• Private contact detail: A contact detail that is not meant to be shared with others

---

Appendix: Instructions for manual testing

Given below are instructions to test the app manually.

Launch and shutdown

1. Initial launch

   1. Download the jar file and copy into an empty folder

   2. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

3. { more test cases …​ }

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.

2. { 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}

2. { more test cases …​ }