Developer Guide

• Acknowledgements
• Setting up, getting started
• Design
  • Architecture
  • UI component
  • Logic component
  • Model component
  • Storage component
  • Common classes
• Implementation
  • [Proposed] Undo/redo feature
    • Proposed Implementation
    • Design considerations:
  • [Proposed] Data archiving
• Documentation, logging, testing, configuration, dev-ops
• Appendix: Requirements
  • Product scope
  • User stories
  • Use cases
  • Use case: add
  • Use case: edit
  • Use case: delete
  • Use case: find
  • Use case: help
  • Use case: stats
  • Use case: list
  • Non-Functional Requirements
  • Glossary
• Appendix: Instructions for manual testing
  • Launch and shutdown
  • Deleting a person
  • Saving data

---

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:

• independent, tech-savvy insurance agents in Singapore
• has a need to actively manage a mid-sized portfolio of clients
• need a lightweight contact management solution
• prefer desktop apps over other types
• can type fast
• prefers typing to mouse interactions
• is reasonably comfortable using CLI apps

Value proposition: optimize contact management for independent agents with a simple, efficient tool.

User stories

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

Priority	As a …​	I want to …​	So that I can…​
* * *	Insurance Agent	find clients using attributes other than name (e.g., uid, email, phone)	locate clients more flexibly
* * *	Insurance Agent	view client details and insurance premium	keep track of my client details
* * *	Insurance Agent	add a new client’s contact information	maintain an up-to-date client list
* * *	Insurance Agent	edit a client’s details	quickly update changes like phone numbers or address
* * *	Insurance Agent	avoid adding duplicate clients	avoid keeping the same person twice
* * *	Insurance Agent	delete contacts	keep my contact list clean and relevant
* * *	Insurance Agent (First-time user)	access a command guide (main page)	learn or recall the command formats quickly
* * *	Insurance Agent	save client details	ensure client details will not go missing
* * *	Analytical Insurance Agent	view a summary of plans purchased and customer statistics	quickly analyse the demographics of clients
* *	Experienced Insurance Agent	tag clients (e.g., “priority”, “prospect”, “policyholder”)	organise my portfolio logically
* *	Insurance Agent	view tags as folders	group and browse clients by relationship or category
* *	Insurance Agent	undo my mistake while using the application	rectify errors without re-editing an entry
* *	Insurance Agent	sort clients based on attributes (e.g., name, date added)	quickly update changes like phone numbers or addresses
* *	Insurance Agent	see a live preview of client input while adding/editing	know immediately if I missed a field
* *	Insurance Agent	perform multi-entry actions (e.g., delete multiple clients in one command)	save time when cleaning up data
* *	Insurance Agent	import/export to excel	view data in excel and share with others
* *	Insurance Agent	get a warning before dangerous action	avoid losing client details by accident
*	Insurance Agent	use aliases for commands (e.g., ls for list)	work faster without clashing with existing commands
*	Insurance Agent	use AI assistant to deep analysis on my data	uncover invaluable insights
*	Insurance Agent	ask AI to perform actions on the application	save time and manual labour
*	Insurance Agent	build schedule for all my meetings	keep track of my schedule in a single application
*	Insurance Agent	auto-calculate insurance premium per term	quickly know how much the client has/will be paying over the term years

{More to be added}

Use cases

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

Use case: add

Example 1
System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG]… command.
2. System validates each parameter.
3. System checks for duplicates using (name + phone).
4. If valid, system creates a new client entry and updates the display.
   • Use case ends.

Extensions:

• 2a. Missing required fields.
  • 2a1. System displays: “ERROR: Missing required fields. Required: n/, p/, e/, a/.”
  • Use case ends.
• 2b. Invalid parameter format.
  • 2b1. System displays specific error message (e.g., “Phone must be a valid number”).
  • 2b2. Agent corrects input.
  • Use case resumes from step 2.
• 3a. Duplicate detected.
  • 3a1. System displays: “DUPLICATE CLIENT: A client with the same phone/email already exists.”
  • 3a2. Agent may use edit INDEX instead.
  • Use case ends.

---

Use case: edit

System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… command.
2. System validates the index and input fields.
3. System checks for duplicates (name + phone).
4. If valid, system updates client details and displays confirmation.
   • Use case ends.

Extensions:

• 2a. Index out of bounds.
  • 2a1. System displays error: “Index not found.”
  • Use case ends.
• 2b. Invalid parameter format.
  • 2b1. System displays error specifying invalid field.
  • 2b2. Agent corrects input.
  • Use case resumes from step 2.
• 3a. Duplicate detected.
  • 3a1. System displays duplicate warning.
  • Use case ends.
• 4a. Tag replacement error.
  • 4a1. System rejects entire edit if one invalid tag is found.
  • Use case ends.
• 4b. Storage failure occurs.
  • 4b1. System displays: “Couldn’t save data. Your edit was cancelled.”
  • Use case ends.

---

Use case: delete

System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues delete INDEX command.
2. System verifies the index.
3. System deletes the client record at that index.
4. System displays confirmation: “Deleted Person: ”.
   • Use case ends.

Extensions:

• 2a. Index out of bounds.
  • 2a1. System displays error: “Index not found.”
  • Use case ends.

---

Use case: find

System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues find STRING command.
2. System searches client records by name, UID, email, or phone.
3. System returns matching records in a tabular list (CLI) or as clickable results (GUI).
4. Agent views or selects the desired client record.
   • Use case ends.

Extensions:

• 2a. No matches found.
  • 2a1. System displays: “No clients matched the provided filters.”
  • Use case ends.
• 2b. Invalid parameter provided (e.g., malformed input).
  • 2b1. System displays error specifying the issue (e.g., invalid characters).
  • 2b2. Agent re-enters correct input.
  • Use case resumes from step 2.
• 2c. Conflicting filters applied.
  • 2c1. System displays: “No clients matched all provided filters.”
  • Use case ends.

---

Use case: help

System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues help command.
2. System displays a list of commands with usage details.
3. Agent reads and continues working.
   • Use case ends.

Extensions:

• 1a. Agent types synonym (e.g., guide, man).
  • 1a1. System displays: “Unknown command. Type help to see available commands.”
  • Use case ends.

---

Use case: stats

System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues stats command.
2. System analyses customer data.
3. System displays summary table (Packages vs. No. of Customers).
4. Agent reviews performance insights.
   • Use case ends.

Extensions:

• 2a. No data available.
  • 2a1. System displays: “No statistics available – no clients found.”
  • Use case ends.

---

Use case: list

Example 1
System: Insurance Management App
Actor: Insurance Agent

MSS:

1. Agent issues list command.
2. System displays all the persons in the address book.
3. 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. A user should be able to pull up a customer’s records in the shortest time possible.
5. User’s customer data should be stored in a human-editable format (JSON).
6. The GUIs should work well for standard screen resolutions (1920 by 1080) and scales between 100% and 125%.
7. The GUIs should be uncluttered and easy on the eyes of the user.
8. The help page for the app’s usage parameters should be easily accessible.
9. The UI should be designed to minimize cognitive load, ensuring that users can quickly identify the features they need without excessive searching or confusion.
10. The app should be packaged into a single file.

{More to be added}

Glossary

• Mainstream OS: Windows, Linux, Unix, MacOS

• Private contact detail: Contact Liangce @Habutiii if you have any queries

• AddressBook: The core system being developed is a lightweight contact management application for independent ethical insurance agents.
• Actor: A user (typically Insurance Agent) or external entity that interacts with the system.
• Analytical Insurance Agent: A type of user who wants to analyse client demographics, insurance plans and overall portfolio statistics.
• Client: An individual whose personal and insurance details are stored and managed in the AddressBook (AB3).
• Command Guide: A reference page within the application that shows all available commands and their formats.
• Contact Detail: Any piece of information related to a client, such as name, phone number, email or insurance details.
• Duplicate Client: An entry in the AddressBook that repeats an existing client’s details.
• GUI (Graphical User Interface): The visual interface of the application, allowing users to interact with the AddressBook via windows, buttons and other graphical elements.
• Human-editable format (JSON): A structured text format (JavaScript Object Notation) used to store client data, which can be read and edited directly by users.
• Insurance Premium: The regular payment made by a client for their insurance coverage.
• Non-Functional Requirement (NFR): A requirement that specifies system quality or constraints (e.g., performance, usability, storage format), rather than a specific feature.
• Tag: A label attached to a client (e.g., “priority”, “prospect”, “policyholder”) that helps agents organize and filter their portfolio.
• Undo: A feature allowing the user to revert a mistaken action (e.g., wrong edit or deletion).

---

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 …​ }