ClientConnect 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, ClientListPanel, 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 Client 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 client).
   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 Client objects (which are contained in a UniqueClientList object).
• stores the currently 'selected' Client objects (e.g., results of a search query) as a separate filtered list which is exposed to outsiders as an unmodifiable ObservableList<Client> 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.

Rank feature

Command Architecture

The Rank command component,

• holds a client Comparator that determines the sort order between any two clients using the compare method.
• each Comparator has a COMPARATOR_WORD String that is used to parse user input to create the suitable Comparator.
• each Comparator also depends on the Client which helps to gain access to the required parameters to compare with.

Implementation

Given below is an example usage scenario and how the rank mechanism behaves at each step.

• The user launches the application, and decides that they want to see Alice at the top of their client list.
• They would simply have to type rank name as the command input.

Here's the sequence diagram that shows the flow of the execution for the command rank name.

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

• salespeople who wish to know their users' preferences better
• prefer desktop apps over other types
• can type fast
• prefers typing to mouse interactions
• is reasonably comfortable using CLI apps

Value proposition: provide fast access to clients’ addresses and preferences to help salespeople in making sales decisions and building rapports with clients, which can potentially increase their sales revenue

User stories

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

{More to be added}

Use cases

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

Use case: Adding a client

MSS

1. User enters the command to add a client.

2. ClientConnect validates the input format and checks that all required fields are present.

3. ClientConnect adds the client to the address book.

4. ClientConnect displays a confirmation message showing the newly added contact details.

   Use case ends.

Extensions

• 2a. Invalid Field Detected:

  • 2a1. If ClientConnect detects a missing or incorrectly formatted field, it displays an error message.
  • 2a2. User re-enters the correct information.
  • 2a3. ClientConnect re-validates the updated input and proceeds from step 2 once the error is resolved.

Use case: View List of Clients

MSS

1. User enters the command to view current list of added entities

2. ClientConnect validates the command input.

3. ClientConnect retrieves all stored entities from the address book.

4. ClientConnect displays the list with each entity’s name, contact number, and address in a clear, formatted view.

   Use case ends.

Extensions

• 2a: If the command input is not recognized (e.g., due to a typo), ClientConnect displays: “I do not understand your command, please try again.”
• 3a: If no entities are found (i.e., the address book is empty), ClientConnect displays the message: “Your list is empty.”

Use case: Delete a client

MSS

1. User enters the command to view the list of clients.

2. ClientConnect displays the full list of clients.

3. User enters the command to delete a client.

4. ClientConnect validates the command.

5. ClientConnect retrieves the details of the client at the specified index.

6. ClientConnect deletes the client's details from the address book.

7. ClientConnect displays a success message:”Deleted: ”

   Use case ends.

Extensions

• 4a: If the parameter is missing or not an integer, ClientConnect displays: “Please provide a valid index for the entry.”
• 4a: If the command includes extra parameters beyond the required , ClientConnect ignores the additional fields and processes the command based solely on the valid .
• 5a: If the provided is not within the range of the list size, ClientConnect displays: “Please provide a valid index for the entry.”
• 5a: If the address book is empty when the command is executed, ClientConnect displays an error message: “Your list is empty.”

Use case: find a client

MSS

1. User enters the command to find a list of clients that contains the keyword.

2. ClientConnect validates the command.

3. ClientConnect retrieves the information of clients that contains that specified keyword in their descriptions.

4. ClientConnect displays the list of clients.

   Use case ends.

Extensions

• 2a: If the command input is not recognised, ClientConnect displays: “I do not understand your command, please try again.”
• 3a: If there is no client found with , ClientConnect displays: "No client found with ."

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 clients 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 user interface should be minimalist and intuitive so that even users who are not tech-savvy can use with ease.
5. All operations should take less than 1s to finish and display the results.
6. Should be stable and handles errors gracefully, and minimize data loss in case of failures.

{More to be added}

Glossary

• Client: The customers who the salesclient (also user of this application) is selling products to.
• Command: A one-line instruction typed into the application by user.
• Contact detail: Including contact names, phone numbers, adresses and optionally tags, etc.
• CSV file: Comma-separated values, a plain text file format that stores data in a table-like structure. Can be opened using Microsoft Excel or be imported to other supported applications.
• Main features: The main features of this application, including list, add, delete, etc.
• Mainstream OS: Windows, Linux, Unix, MacOS
• Salesclient: Anyone who is selling things and has the need to note down clients' information.
• Private contact detail: A contact detail that is not meant to be shared with others
• Product Preference: A specific product or category of products that a client is interested in.

---

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 client

1. Deleting a client while all clients are being shown

   1. Prerequisites: List all clients using the list command. Multiple clients 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 client 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 …​ }