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

Add Property feature

The addProperty feature allows users to add a property to a client identified by the index in the displayed client list.

The AddPropertyCommand is executed through the following flow:

1. The command retrieves the currently displayed client list using Model#getFilteredPersonList().
2. The target client is identified using the provided index.
3. The command validates whether the property can be added to the target client.
4. A new Person object is created with the new property added.
5. The command calls Model#setPerson(personToEdit, editedPerson) to update the client.
6. ModelManager updates the underlying AddressBook.
7. The command returns a CommandResult.

For simplicity, the sequence diagram below focuses on the main interactions and omits lower-level validation details.

The following sequence diagram illustrates the interactions:

Edit Client feature

The editClient feature allows users to update the details of an existing client identified by an index in the displayed client list.

The EditClientCommand is executed through the following flow:

1. The command retrieves the currently displayed client list using Model#getFilteredPersonList().
2. The target client is identified using the provided index.
3. A new Person object is created with the updated fields.
4. The command calls Model#setPerson(personToEdit, editedPerson) to update the client.
5. ModelManager updates the underlying AddressBook.
6. The command returns a CommandResult.

If one or more t/ prefixes are provided, the client’s existing tags are replaced. If t/ is provided without a value, all existing tags are cleared.

For simplicity, the sequence diagram below focuses on the main interactions involved in updating the client and omits lower-level validation details such as index checks and exception handling.

The following sequence diagram illustrates the interactions:

Edit Property feature

The editProperty feature allows users to edit an existing property identified by its index in the displayed property list.

The EditPropertyCommand is executed through the following flow:

1. The command retrieves the currently displayed property list using Model#getFilteredPropertyList().
2. The target property is identified using the provided index.
3. The command identifies the client who owns the target property.
4. The property is updated through its owner.
5. A new Person object is created with the updated property.
6. The command calls Model#setPerson(owner, editedPerson) to update the client.
7. ModelManager updates the underlying AddressBook.
8. The command returns a CommandResult.

Only the specified fields are updated. All other fields remain unchanged.

For simplicity, the sequence diagram below focuses on the main interactions involved in editing a property and omits lower-level validation details such as index checks and exception handling.

The following sequence diagram illustrates the interactions:

Delete Property feature

The delete property feature allows users to delete a property identified by the index in the displayed property list. This is done by validating the property deletion and updating the target client in the address book.

The DeletePropertyCommand is executed through the following flow:

1. The command retrieves the currently displayed property list by calling Model#getFilteredPropertyList().
2. The target property is identified using the provided index.
3. The command validates whether the property can be deleted from the target client.
4. If the property deletion is valid, DeletePropertyCommand creates an updated Person object without the deleted property.
5. DeletePropertyCommand calls Model#setPerson(personToEdit, editedPerson).
6. ModelManager#setPerson(...) updates the target client in the underlying AddressBook.
7. The command returns a CommandResult after the target client has been updated.

For simplicity, the sequence diagram below focuses on the main interactions involved in updating the target client and omits lower-level validation details such as index checks, ownership checks, and exception handling.

The following sequence diagram illustrates the interactions:

Filter Property feature

The filter property feature allows users to filter properties by address keywords, price range, and size range, and automatically display the owners of those properties. This is done by updating the predicates on the FilteredList objects.

The FilterPropertyCommand is executed through the following flow:

1. The command is executed with a property predicate (PropertyMatchesFilterPredicate) built from the user input, which may include address keywords, price range, and/or size range.
2. FilterPropertyCommand calls Model#updateFilteredPropertyList(predicate).
3. ModelManager#updateFilteredPropertyList(...) updates the property FilteredList by calling setPredicate(...).
4. FilterPropertyCommand then calls Model#updateFilteredPersonList(predicate).
5. ModelManager#updateFilteredPersonList(...) updates the person FilteredList by calling setPredicate(ownersOfFilteredProperties).
6. The command returns a CommandResult after both filtered lists have been updated.

The following sequence diagram illustrates the interactions:

Design Highlights

• Multi-criteria Filtering: The PropertyMatchesFilterPredicate implements the Predicate<Property> interface and supports filtering by address keywords, price range, and size range simultaneously.
• Address Keyword Matching: The predicate supports multiple address keywords and performs case-insensitive matching using StringUtil.containsWordIgnoreCase(). Keywords use OR logic (properties matching any keyword are included).
• Numeric Range Filtering: The predicate supports optional minimum and maximum price and size boundaries. A property must fall within all specified ranges to match.
• Cascading Filter: After filtering properties, the command automatically updates the person list to show only those who own matching properties, providing a complete view of relevant data.
• Flexible Criteria: At least one filter criterion (address keywords, price range, or size range) must be provided, but users can combine any of these filters as needed.

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

Tech-savvy property agents in Singapore who handle transactions and manage multiple buyers/sellers concurrently. They rely on fast retrieval of key client + property details during time-sensitive interactions (calls, viewings, negotiations) and prefer a keyboard-centric workflow over mouse-heavy CRM tools

Value Proposition:

ClientVault enables Singapore residential property agents to capture, organize, and retrieve client + property details in seconds through a fast, keyboard-driven interface. This reduces the friction of searching across chat logs and spreadsheets when handling daily tasks such as:

• recalling unit details (flat type / size / bedrooms / lease remaining)
• tracking buyer requirements (budget, location, preferred property type)
• quickly matching buyers to suitable seller listings.

User stories

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

{More to be added}

Use Cases

Use Case 1: Adding a new client followed by new listing under said client

Actor: Residential Property Agent(John)

Goal: Add a new client with his/her property details after first meeting

MSS:

1. John launches application

2. John adds new client with his/her relevant details

3. John reads the system confirmation that the new client has been added

4. John adds a new property listing under said client

5. John reads the system confirmation that the new listing has been added under said client

   Use case ends

Extensions:

• 2a. Application detects error in John’s entry format

  • 2a1. Application requests for new entry with correct format

  • 2a2. John enters data in correct format

    Steps 2a1-2a2 repeats until John uses the proper format.

    Use case resumes from step 4

Use Case 2: View Property Information of a Client

Actor: Property Agent

Goal: See all properties listed under a specific client

MSS:

1. Agent identifies client name

2. Agent uses the viewProperty feature with the client’s name as the parameter

3. System retrieves all properties linked to client

4. Displays the list of properties linked to client(indexed)

5. User chooses the specific property by index

6. System displays all relevant information about the specific property

   Use Case ends

Extensions:

• 2a. Client does not exist

  • 2a1. Client does not exist message displayed to user

    Use case ends

• 3a. Client exists but no property listed under client

  • 3a1. No property listed under client message displayed to user

    Use case ends

Use Case 3: Delete property listing after successful transaction

Actor: Property agent

Goal: Delete a listing

MSS:

1. Agent confirms a property has been sold

2. Agent identifies client name and index

3. Agent uses the deleteProperty feature with client name, index, address, price and size

4. System verifies property exists

5. System confirmation that said property is deleted

   Use case ends

Extension:

• 4a. One of the inputs does not match an existing property

  • 4a1. System informs user that specified property does not exist

  • 4a2. Prompts user to try deleting again and give a delete format to follow

  • 4a3. Steps 4a1 to 4a2 repeats as long as user doesn’t input the valid details of an existing property

    Use case ends

Non-Functional Requirements

1. The application should work on any mainstream OS as long as it has Java 17 or above installed.
2. The system should be able to manage at least 1000 client records without noticeable degradation in performance during typical usage.
3. A user with above-average typing speed for regular English text should be able to complete most tasks faster using keyboard commands than using the mouse.
4. The system should respond to any valid user command within 2 seconds under normal operating conditions.
5. Error messages should be clear and guide the user towards corrective action.
6. The application should be packaged as a single executable JAR file.
7. User data should be stored locally and not transmitted externally without user consent.

Glossary

• Mainstream OS: Windows, macOS, and Linux.
• Executable JAR file: A packaged Java archive file that can be run directly to start the application.
• MSS: Stands for Main Success Scenario, a scenario of the use case which will be considered a successful one.

---

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