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:

• has a need to manage a significant number of contacts
• prefer desktop apps over other types
• can type fast
• prefers typing to mouse interactions
• is reasonably comfortable using CLI apps
• for this evolution: semi-professional youth football coaches managing multiple teams

Value proposition:

• manage contacts faster than a typical mouse/GUI driven app
• specifically for football coaches: quickly organise and access player, parent, and assistant contacts across multiple teams
• optimised for fast, command-line style data entry and squad management

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 AddressBook and the Actor is the user, unless specified otherwise)

Use case: UC01 - Add a player

MSS

1. User requests to add a player with all relevant details

2. AddressBook adds the player

   Use case ends.

Extensions

• 1a. The given player details are invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

• 1b. The player to be added already exists in the list.

  • 1b1. AddressBook shows an error message.

    Use case ends.

Use case: UC02 - Delete a player

MSS

1. User requests to list players

2. AddressBook shows a list of players

3. User requests to delete a specific player in the list

4. AddressBook deletes the player

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: UC03 - Add a team

MSS

1. User requests to add a team with a unique name
2. AddressBook adds the team

Extensions

• 1a. The given team name is invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

• 1b. The team to be added already exists.

  • 1b1. AddressBook shows an error message.

  Use case ends.
  

Use case: UC04 - Delete a team

MSS

1. User requests to list teams

2. AddressBook shows a list of teams

3. User requests to delete a specific team in the list

4. AddressBook deletes the team

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given team name does not exist.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: UC05 - Add a player to a team

MSS

1. User requests to list players

2. AddressBook shows a list of players

3. User requests to list teams

4. AddressBook shows a list of teams

5. User requests to add a specific player to a specific team

6. AddressBook adds the player to the team

   Use case ends.

Extensions

• 2a. The player list is empty.

  Use case ends.

• 4a. The team list is empty.

  Use case ends.

• 5a. The given player or team selection is invalid.

  • 5a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: UC06 - Assign an injury status to a player

Guarantees: Player's injury status and rehab timeline are updated and persisted

MSS

1. User requests to list players

2. AddressBook shows a list of players

3. User requests to assign an existing injury status to a player by specifying the injury name and timeframe

4. AddressBook updates the player's availability and rehab timeline

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given player selection is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

• 3b. The specified injury status does not exist.

  • 3b1. AddressBook shows an error message and prompts User to create a new injury status.

  • 3b2. User creates the new injury status.

    Use case resumes at step 3.

• 3c. The specified timeframe is invalid.

  • 3c1. AddressBook shows an error message.

    Use case resumes at step 3.

• 3d. The specified injury status has already been assigned to the selected player.

  • 3d1. AddressBook shows an error message.

    Use case ends.

======= Use case: UC07 - List all players

MSS

1. User requests to list all players.

2. PlayBook shows a list of players

   Use case ends.

Extensions

• 2a. The list is empty.

  • 2a1. PlayBook shows an error message.

    Use case ends.

Use case: UC08 - Search for a player

MSS

1. User requests to search for a player by name.

2. PlayBook shows the player's details.

   Use case ends.

Extensions

• 1a. The player name is missing.

  • 1a1. PlayBook shows an error message.

    Use case ends.

• 1b. The player name is invalid.

  • 1b1. PlayBook shows an message.

    Use case ends.

• 2a. No player matches the given name.

  • 2a1. PlayBook shows an error message.

    Use case ends.

Use case: UC09 - Filter players by team

MSS

1. User requests to filter players by a team name.

2. PlayBook shows the list of players in that team.

   Use case ends.

Extensions

• 1a. The team name is missing.

  • 1a1. PlayBook shows an error message.

    Use case ends.

• 1b. The team name is invalid.

  • 1b1. PlayBook shows an error message.

    Use case ends.

• 2a. The team does not exist.

  • 2a1. PlayBook shows an error message.

    Use case ends.

• 2b. The team exists but has no players.

  • 2b1. PlayBook shows an error message.

    Use case ends.

Use case: UC10 - Filter players by injury

MSS

1. User requests to filter players by an injury status.

2. PlayBook shows the list of players with that injury status.

Extensions

• 1a. The injury status is missing.

  • 1a1. PlayBook shows an message.

    Use case ends.

• 1b. The injury status is invalid.

  • 1b1. PlayBook shows an error message.

    Use case ends.

• 2a. No players match the given injury status.

  • 2a1. PlayBook shows an error message.

    Use case ends.

Use case: UC11 - Filter players by position

MSS

1. User requests to filter players by a position.

2. PlayBook shows the list of players in that position.

   Use case ends.

Extensions

• 1a. The position is missing.

  • 1a1. PlayBook shows an error message.

    Use case ends.

• 1b. The position is invalid.

  • 1b1. PlayBook shows an error message.

    Use case ends.

• 2a. No players are in that position.

  • 2a1. PlayBook shows an error message.

    Use case ends.

Use case: UC12 - Create a position

MSS

1. User requests to create a position with specific details

2. AddressBook adds a position with given details

   Use case ends.

Extensions

• 1a. Position detail is invalid

  • 1a1. AddressBook shows an error message

    Use case ends.

• 2a. Position already exists

  • 2a1. AddressBook shows an error message

    Use case ends.

Use case: UC13 - Delete a position

MSS

1. User requests to delete a position with specific details

2. AddressBook deletes a position with given details

Extensions

• 1a. Position detail is invalid

  • 1a1. AddressBook shows an error message

    Use case ends.

• 2a. Position does not exist

  • 2a1. AddressBook shows an error message

    Use case ends.

Use case: UC14 - Assign position to a player

MSS

1. User requests to assign a position to a player with specific details

2. AddressBook assigns a position to a player with given details

   Use case ends.

Extensions

• 1a. Position detail is invalid

  • 1a1. AddressBook shows an error message

    Use case ends.

• 2a. Player detail is invalid

  • 2a1. AddressBook shows an error message

    Use case ends.

• 3a. Position does not exist

  • 3a1. AddressBook shows an error message

    Use case ends.

• 4a. Player does not exist

  • 4a1. AddressBook shows an error message

    Use case ends.

Use case: UC15 - Save player's email

MSS

1. User requests to save a player's email under player's details

2. AddressBook updates email under player's detail

   Use case ends.

Extensions

• 1a. The given player is invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

Use case: UC16 - Save player's dietary restriction

MSS

1. User requests to save a player's dietary restriction under player's details

2. AddressBook updates dietary restriction under player's detail

   Use case ends.

Extensions

• 1a. The given player is invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

Use case: UC17 - Save player's jersey number

MSS

1. User requests to save a player's jersey number under player's details

2. AddressBook updates jersey number under player's detail

   Use case ends.

Extensions

• 1a. The given player is invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

• 1b. The jersey number had already been taken

  • 1b1. AddressBook ask for confirmation to give number to this player despite another player having this number.

  • 1b2. User confirms decision

  • 1b3. AddressBook removes old player's number

  • 1b4. AddressBook updates jersey number of player

    Use case ends.

Use case: UC18 - Save a player as captain

MSS

1. User requests to save a player as captain under player's details

2. AddressBook updates if player is captain under player's detail

   Use case ends.

Extensions

• 1a. The given player is invalid.

  • 1a1. AddressBook shows an error message.

    Use case ends.

{More to be added}

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 football players 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. Should be packaged into a single JAR file such that no additional installation steps are required.
5. Should work fully offline and must not depend on any custom remote server for normal operations.
6. User data should be stored locally in a human editable JSON file, without using a DBMS.
7. GUI should render optimally at 1920x1080 and above (for 100% & 125% scaling) and remain fully functional at 1280x720 and above (for 150% scaling) on any mainstream OS.
8. Response to any single user command should be visible within 3 seconds on any mainstream OS.
9. User interface should be intuitive for football coaches with limited technical background to complete core tasks after reading the user guide once.
10. Sensitive player data should be safeguarded against accidental disclosure via manual export and delete options, and by running the app in a secure environment where local files are protected by the device's password.

{More to be added}

Glossary

• Mainstream OS: Windows, Linux, Unix, MacOS
• Private contact detail: A contact detail that is not meant to be shared with others
• Player: An individual footballer managed by the coach
• Team: A named group of players (eg. U15, First Team) managed by the coach
• Position: The role of a player on the field (eg. Goalkeeper (GK), Center Back (CB), Striker (ST))

---

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