Talentcy Developer Guide

---

Acknowledgements

• This is a software development project for CS2103.
  This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

---

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.

Find feature

The Find feature follows the sequence diagram here:

Mass Reject feature

The Mass Reject feature follows the sequence diagram here:

Delete feature

The Delete feature follows this sequence diagram:

Sort feature

The Sort feature follows the sequence diagram here:

Statistics feature

The Statistics feature follows the sequence diagram here:

Like ListCommand, it does not require the use of its own parser, as it only calls upon the FilteredList of the address book and processes it within the statistics feature. It uses a helper class called JobCodeStatistics that stores the number of applicants in each interview stage for that job code.

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

---

Planned Enhancements

Team size: 4

1. Enhanced Find Command with Multiple Keywords
   The current find command supports only one keyword at a time for each field. We plan to extend this functionality to accept multiple keywords (e.g., find n/Hans or n/Hera), making it easier for users to locate multiple persons in a single search.

2. Extended Tagging Functionality
   Presently, only a limited set of tags is supported. We plan to expand this feature to support additional types of tags, enabling more flexible categorization and better organization of persons.

3. Resizable Feedback Box
   Users are currently unable to adjust the feedback box size. To improve usability, we plan to make the feedback box resizable, allowing users to expand or contract it based on their preferences and screen size.

4. Restrictive Phone Number Validation
   The existing phone number validation allows entries as short as three digits. We plan to tighten validation criteria to ensure that phone numbers meet a more realistic length requirement, improving data accuracy and reliability.

5. Appendable Remarks
   Currently, remarks can only be overwritten, not appended to. We plan to enhance the remark feature to support appending, so users can add additional notes without replacing existing remarks.

6. Advanced Statistics Filtering Options
   To support more detailed insights, we plan to extend statistics functionality by offering additional predicate filters. This enhancement will allow users to specify criteria (e.g., stats [j/] [t/]) for more targeted statistical analysis.

7. Mass Actions Command
   At present, the massreject command allows only batch rejections. We plan to rename this command to mass and introduce a predicate/parameter option to enable mass deletions, edits, or rejections. This will streamline bulk actions, making management of large applicant pools more efficient.

8. Better Handling of Corrupted Data File At present, when data file is corrupted for just one person, all entry in the book is discarded. We plan to handle this better by discarding the persons whose data is corrupted and inform users about it.

---

Documentation, logging, testing, configuration, dev-ops

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

---

Appendix: Requirements

Product scope

Target user profile:

• employees of a company's talent recruitment departments who need to manage contacts of job applicants.
• prefer desktop apps over other types
• can type fast
• prefers typing to mouse interactions
• is reasonably comfortable using CLI apps

Value proposition: This app streamlines the process of managing talent contact information by centralizing essential contact details, making it easier to organise, search, and update information on potential candidates. Its search and filtering capabilities help recruiters quickly find profiles based on specific criteria, improving efficiency and reducing time spent on administrative tasks.

User stories

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

Use Cases

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

---

UC001: Add A Person

MSS

1. User requests to add a new person by providing a name, phone number, email, job code, tag, and optional remark.

2. System validates the provided input.

3. System checks if the person already exists by verifying the uniqueness of the phone number and email.

4. System adds the person to the system and displays a confirmation message.

   Use case ends.

Extensions

• 2a. The provided input is invalid (e.g., invalid phone number format, name too long).

  • 2a1. System shows an error message and prompts the user to correct the input.

    Use case ends.

• 3a. A duplicate person is found (same phone number or email).

  • 3a1. System displays a duplicate person error message.

    Use case ends.

---

UC002: Delete A Person

MSS

1. User requests to delete a specific person by providing a valid identifier, which can be one of the following:
   Index (positive integer), Name (n/NAME), Email (e/EMAIL), Phone (p/PHONE).

2. System validates the provided input: Checks if the identifier matches the valid format (e.g., positive integer, name, email, or phone).

3. System checks if the person exists (using the provided identifier, which could be a name, email, or phone number).

4. System deletes the person and displays a confirmation message.

   Use case ends.

Extensions

• 2a. The provided input is invalid (e.g., invalid phone number format, name too long, invalid command format).

  • 2a1. System shows an error message indicating invalid command format or invalid parameter and prompts the user to correct the input.

    Use case ends.

• 3a. No person matches the provided identifier.

  • 3a1. System shows an error message stating that no person matches the provided identifier and prompts the user to correct the input.

    Use case ends.

• 3b. Multiple persons with the same name are found, and the user has not provided a phone number or email.

  • 3b1. System asks the user to provide other details (phone number or email) to specify the person to delete.
    Use case ends.

---

UC003: List All Persons

MSS

1. User requests to list all persons.

2. System retrieves all stored persons from the system.

3. System displays the list of persons.

   Use case ends.

---

UC004: Find Persons

MSS

1. User requests to find persons by name, phone number, email, job code, tag, remark or a combination of some of them.

2. System validates the find criteria.

3. System retrieves and displays the persons matching the criteria.

   Use case ends.

Extensions

• 2a. The find criteria are invalid (e.g., tag not recognized).

  • 2a1. System shows an error message.

    Use case ends.

---

UC005: Viewing Help

MSS

1. User requests help to use the system.

2. System displays a link to website containing more information (user guide).

3. User goes to the provided link to see more information.

   Use case ends.

---

UC006: Showing Applicant Statistics

MSS

1. User requests to view applicant statistics.

2. System retrieves statistics data (e.g., counts of applicants by job code and tags).

3. System displays the statistics in a summary view.

   Use case ends.

---

UC007: Bulk Rejecting Persons

MSS

1. User requests to bulk reject contacts by providing a job code, tag, or both.

2. System validates the input and checks if any contacts match the criteria.

3. System updates the matching contacts' tags to r (rejected) and displays a confirmation message.

   Use case ends.

Extensions

• 2a. The criteria are invalid (e.g., tag not recognized).

  • 2a1. System shows an error message.

    Use case ends.

---

UC008: Sorting Persons

MSS

1. User requests to sort persons by specifying zero or more sorting criteria (e.g., name, phone, email, job code, tag).

2. System validates the sorting criteria.

3. System sorts the persons based on the specified criteria in the given order.

4. System displays the sorted list of persons.

   Use case ends.

Extensions

• 2a. The sorting criteria are invalid (e.g., unsupported field for sorting).

  • 2a1. System shows an error message indicating invalid sorting criteria.

    Use case ends.

---

UC009: Clearing All Persons

MSS

1. User requests to clear all persons from the address book.

2. System deletes all persons and displays a confirmation message.

   Use case ends.

---

UC010: Exiting the Program

MSS

1. User requests to exit the program.

2. System terminates and closes the application.

   Use case ends.

---

UC011: Edit A Person

MSS

1. User requests to edit a specific person by providing an index and one or more fields to update (name, phone number, email, job code, tag).

2. System validates the provided input.

3. System checks if the person exists at the specified index.

4. System checks if the edited details causes duplicate.

5. System updates the person’s details with the provided information and displays a confirmation message.

   Use case ends.

Extensions

• 2a. The provided input is invalid (e.g. invalid phone number format).

  • 2a1. System shows an error message indicating invalid input and prompts the user to correct it.

    Use case ends.

• 3a. No person is found at the specified index.

  • 3a1. System shows an error message indicating that no person exists at the specified index.

    Use case ends.

• 4a. The edited details causes duplicate persons.

  • 4a1. System shows an error message indicating that the person already exists.

    Use case ends.

Non-Functional Requirements

1. The system should work seamlessly across macOS, Windows, and Linux operating systems.
2. The system should support both 32-bit and 64-bit environments.
3. Should work on any mainstream OS as long as it has Java 17 or above installed.
4. The system should execute commands (such as adding, deleting, or listing persons) within 1 second under normal loads (e.g., up to 1,000 persons).
5. Should be able to hold up to 1,000 persons without noticeable sluggishness in performance for typical usage.
6. 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.
7. The system must be user-friendly and usable by individuals with no prior experience with contact management systems.
8. Volatility: Transaction data should be stored persistently and remain available for a minimum of 10 years.
9. Complete user documentation, including installation and setup instructions, must be provided.
10. The system should be designed to allow for the addition of new modules without requiring a full redesign.
11. The system should gracefully handle incorrect or incomplete inputs by providing meaningful error messages without crashing.

Glossary

• Applicant: An individual who has submitted job application to the company.
• Job Code : A code that represents the company's specific job role.
• Tag : Interview stages that applicants will go through for a job before they could get hired. The following are the default tags and abbreviations in the address book:

• Person: A single entry in Talency address book that contains information about a particular applicant such as name, phone number, email address, and any other relevant details.
• Command: A specific text-based instruction given by the user to the system to perform a particular action (e.g., add NAME p/PHONE e/EMAIL j/JOB CODE t/TAG is a command to add a person to the address book).

---

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. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar Talentcy.jar command to run the application.
      Expected: Shows the GUI with a set of sample persons. 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 opening command terminal in the folder containing the jar file, then use java -jar Talentcy.jar.
      Expected: The most recent window size and location is retained.

Adding a Person

1. Adding a Person
   1. Test case: add n/John Doe p/98765432 e/johnd@example.com j/SWE123 t/N r/Good skills
      Expected: Assuming no duplicates, a new person named John Doe is added to the list. The status message displays details of the added person.
   2. Test case: add n/ p/ e/ j/ t/
      Expected: No person is added. An error message displays in the status, indicating missing fields.
   3. Other incorrect add commands to try: add n/John, add p/98765432, add e/notemail, add t/Went to NUS
      Expected: Error messages display for each incomplete command, and no person is added.

Deleting a person

1. Deleting a person while all persons are being shown

   1. Prerequisites: List all persons using the list command. At least one person in the list.

   2. Test case: delete 1
      Expected: First person is deleted from the list. Details of the deleted person is shown in the status message.

   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: Error messages displayed, and no person is deleted.

2. Deleting a person based on its attribute

   1. Prerequisites: At least one person stored in the app.

   2. Test case: delete n/John Doe Expected: Assuming there are only one person with the name John Doe in the list, that person will be deleted from the list. Details of the deleted person is shown in status message.

   3. Test case: delete p/80981234 Expected: Assuming a person with phone number 80981234 exists in the list, that person will be deleted. Details of the deleted person is shown in status message.

   4. Test case: delete e/pu09com Expected: No person is deleted. Error message is shown in the status bar.

   5. Other incorrect delete commands to try: delete John Doe, delete p/x (where a person with phone number x doesn't exist in the list). Expected: No person is deleted. Error message is shown in the status bar.

Finding Persons by Criteria

1. Finding Persons with Specific Criteria
   1. Prerequisites: Ensure there are persons with various entry of fields.
   2. Test case:find n/John
      Expected: Displays a list of person(s) with "John" in their names, case-insensitive. Empty list will be displayed if a person with that specific criteria(s) is not found.
   3. Test case: find t/TP n/Jane
      Expected: Shows a list of person(s) with "Jane" in their name and tagged as Technical Interview in Progress. Empty list will be displayed if a person with that specific criteria(s) is not found.
   4. Incorrect add commands to try: find, find John, find p/notphone
      Expected: Error message is shown in the status bar. List of persons shown will remain the same.

Sorting Persons by Fields

1. Sorting by Fields
   1. Prerequisites: Ensure there are multiple persons with various entry of fields.
   2. Test case: sort n/
      Expected: Sorts the persons alphabetically by name.
   3. Test case: sort t/ j/
      Expected: Sorts first by tag, then by job code within each tag group.
   4. Test case: sort j/ n/
      Expected: Sorts first by job code, then by name within each job code group.

Bulk Rejecting by Criteria

1. Bulk Rejecting Contacts
   1. Prerequisites: Ensure there are persons with various job codes and tags, including the Accepted tag.
   2. Test case: massreject j/SWE2024 t/TP
      Expected: Marks all persons with job code SWE2024 and tag TP (if any) as rejected, displaying a confirmation status.
   3. Test case: massreject j/AWE2023
      Expected: Marks all persons with job code AWE2023 as rejected, except for the person(s) that has an Accepted tag.`.

---

Viewing Applicant Statistics

1. Viewing Statistics
   1. Prerequisites: Ensure there are multiple persons with diverse tags and job codes.
   2. Test case: stats
      Expected: Displays the total number of applicants, the percentage of applicants in each interview stage, and the breakdown of applicants by job code.

Saving Data with Missing/Corrupted Files

1. Handling Missing or Corrupted Data Files**

   1. Prerequisites: Ensure talentcy.json has multiple entries, and back up the file before testing.

   2. Test Case: Invalid Data Format Simulation: Edit one field from a person entry in the JSON file (e.g. change the phone field to non-numeric), then launch the app. Expected: The app discards all data and starts with an empty list.

   3. Test Case: Missing talentcy.json File Simulation: Delete talentcy.json, then launch the app. Expected: The app creates a new talentcy.json, the app starts on clean slate (i.e. with sample data only).