{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }
Refer to the guide Setting up and getting started.
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.
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),
interface
with the same name as the Component.{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.
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,
Logic
component.Model
data so that the UI can be updated with the modified data.Logic
component, because the UI
relies on the Logic
to execute commands.Model
component, as it displays Person
object residing in the Model
.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.
Note: The lifeline for DeleteCommandParser
should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.
How the Logic
component works:
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.Command
object (more precisely, an object of one of its subclasses e.g., DeleteCommand
) which is executed by the LogicManager
.Model
when it is executed (e.g. to delete a person).Model
) to achieve.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:
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.XYZCommandParser
classes (e.g., AddCommandParser
, DeleteCommandParser
, ...) inherit from the Parser
interface so that they can be treated similarly where possible e.g, during testing.API : Model.java
The Model
component,
Person
objects (which are contained in a UniquePersonList
object).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.UserPref
object that represents the user’s preferences. This is exposed to the outside as a ReadOnlyUserPref
objects.Model
represents data entities of the domain, they should make sense on their own without depending on other components)Note: An alternative (arguably, a more OOP) model is given below. It has a Tag
list in the AddressBook
, which Person
references. This allows AddressBook
to only require one Tag
object per unique tag, instead of each Person
needing their own Tag
objects.
API : Storage.java
The Storage
component,
AddressBookStorage
and UserPrefStorage
, which means it can be treated as either one (if only the functionality of only one is needed).Model
component (because the Storage
component's job is to save/retrieve objects that belong to the Model
)Classes used by multiple components are in the seedu.address.commons
package.
This section describes some noteworthy details on how certain features are implemented.
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
.
Note: If a command fails its execution, it will not call Model#commitAddressBook()
, so the address book state will not 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.
Note: If the currentStatePointer
is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The undo
command uses Model#canUndoAddressBook()
to check if this is the case. If so, it will return an error to the user rather
than attempting to perform the undo.
The following sequence diagram shows how an undo operation goes through the Logic
component:
Note: The lifeline for UndoCommand
should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
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.
Note: If the currentStatePointer
is at index addressBookStateList.size() - 1
, pointing to the latest address book state, then there are no undone AddressBook states to restore. The redo
command uses Model#canRedoAddressBook()
to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
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:
Aspect: How undo & redo executes:
Alternative 1 (current choice): Saves the entire address book.
Alternative 2: Individual command knows how to undo/redo by itself.
delete
, just save the person being deleted).{more aspects and alternatives to be added}
{Explain here how the data archiving feature will be implemented}
Target user profile: School coaches that coach relay teams in different schools. They:
Value proposition: Given that coaches generally have many athletes to keep track of, our product aims to help coaches manage athletes and teams from different schools faster than a typical mouse/GUI driven app
Priorities: High (must have) - * * *
, Medium (nice to have) - * *
, Low (unlikely to have) - *
Priority | As a … | I want to … | So that I can… |
---|---|---|---|
* * * | new user | see usage instructions | refer to instructions when I forget how to use the App |
* * * | user | add a new athlete | |
* * * | user | delete a athlete | remove entries that I no longer need |
* * * | user | find a person by name | locate details of persons without having to go through the entire list |
* * | user with lots of athletes to keep track of | find athletes by school, role or tag | locate details of athletes that I wish to find via these means |
* * | user managing multiple teams | group athletes by their teams | keep track of who is in which team |
* * | user | find a team by name | locate details of teams without having to go through the entire list |
* | user with multiple teams' training to keep track of | add a team's training sessions | keep track of team's training sessions |
* * | user | delete a team | remove teams that I no longer need |
* | user with many persons in the address book | sort persons by name | locate a person easily |
* | user needing to keep track of athletes' progress | record attendance for athletes | monitor his / her progress in training |
* | user | add a new session | record down all sessions date time and location |
* | user | assign athletes to a session | track down which athlete is supposed to attend a particular session |
* | user | list down all upcoming sessions | keep track of which sessions are upcoming and who is attending |
* | user | delete a session | remove unwanted sessions |
{More to be added}
(For all use cases below, the System is the RelayCoach
and the Actor is the Coach
, unless specified otherwise)
Use case: Add Athlete (Basic Info)
MSS
1. Coach chooses to add a new athlete.
2. RelayCoach requests the athlete’s basic details.
3. Coach provides the requested details.
4. RelayCoach validates the details.
5. RelayCoach saves the athlete’s record.
6. RelayCoach confirms the addition and displays the stored information.
Use case ends.
Extensions
3a. RelayCoach detects missing or invalid details.
3a1. RelayCoach requests correction of details.
3a2. Coach updates information.
Use case resumes from Step 4.
Use case: Add Athlete (Additional Info)
MSS
1. Coach selects an athlete from the list.
2. RelayCoach requests additional information (Role, Tags, Height, Weight).
3. Coach provides the information.
4. RelayCoach validates the information.
5. RelayCoach updates the athlete’s record.
6. RelayCoach confirms the update and displays the new information.
Use case ends.
Extensions
2a. Athlete Index not found.
2a1. RelayCoach displays an error message.
Use case ends.
4a. Invalid data.
4a1. RelayCoach requests correction of information.
Use case resumes from Step 3.
Use case: List Athletes
MSS
1. Coach requests to view all athletes.
2. RelayCoach retrieves all stored athletes.
3. RelayCoach displays the list with details (Name, School, Role, Tags, etc.).
Use case ends.
Extensions
2a. No athletes found.
2a1. RelayCoach informs the coach that no athletes are stored.
Use case ends.
Use case: Find Athletes by Filter
MSS
1. Coach chooses to find athletes by specifying one or more filters (Name, School, Role, Tag).
2. RelayCoach validates the filter input.
3. RelayCoach searches the database.
4. RelayCoach displays the matching athletes with details.
Use case ends.
Extensions
2a. Filter missing or invalid.
2a1. RelayCoach prompts for correction.
Use case ends.
3a. No athletes found.
3a1. RelayCoach informs the coach that no matching athletes were found.
Use case ends.
Use case: Delete Athlete
MSS
1. Coach selects an athlete to delete.
2. RelayCoach verifies the selection.
3. RelayCoach removes the athlete’s record.
4. RelayCoach confirms the deletion.
Use case ends.
Extensions
2a. Selection invalid (e.g., index out of bounds).
2a1. RelayCoach prompts for correction.
Use case ends.
Use case: Group Athletes by Teams
MSS
1. Coach chooses to form a new relay team.
2. RelayCoach requests the team name and athlete indexes.
3. Coach provides the team name and 4 valid athlete indexes.
4. RelayCoach validates the details.
5. RelayCoach creates the new team with the specified athletes.
6. RelayCoach confirms the team creation and displays the team details.
Use case ends.
Extensions
3a. Missing or invalid details provided.
3a1. RelayCoach requests correction of team name or indexes.
3a2. Coach updates information.
Use case resumes from Step 4.
4a. Fewer/more than 4 indexes provided.
4a1. RelayCoach rejects team creation and informs coach.
Use case ends.
4b. Invalid athlete index provided.
4b1. RelayCoach notifies coach that the index does not match any athlete.
Use case ends.
4c. Duplicate athlete index detected.
4c1. RelayCoach rejects team creation due to duplicate members.
Use case ends.
4d. Athlete already belongs to another team.
4d1. RelayCoach informs coach that the athlete is already in <existing_team>.
Use case ends.
4e. No athletes exist in the database.
4e1. RelayCoach prompts coach to add athletes first.
Use case ends.
Use case: View Team Information
MSS
1. Coach chooses to view teams.
2. RelayCoach requests an optional team name filter.
3. Coach provides either no team name or a specific team name.
4. RelayCoach retrieves the relevant team(s) and displays details.
5. Use case ends.
Extensions
3a. Invalid team name provided (non-alphabet characters).
3a1. RelayCoach notifies coach of invalid team name.
Use case ends.
4a. No teams exist in the database.
4a1. RelayCoach informs coach: “No teams found!”.
Use case ends.
4b. No teams match the provided team name.
4b1. RelayCoach informs coach: “No teams found!”.
Use case ends.
Use case: Add Session to Team
MSS
1. Coach chooses to add a training session for a team.
2. RelayCoach requests the team index, session date/time, and location.
3. Coach provides the requested details.
4. RelayCoach validates the input.
5. RelayCoach adds the session to the specified team.
6. RelayCoach confirms the addition and displays the updated team schedule.
Use case ends.
Extensions
3a. Missing team index.
3a1. RelayCoach notifies coach of missing team index.
Use case ends.
3b. Invalid date/time format provided.
3b1. RelayCoach requests correction using required format yyyy-MM-dd HHmm.
Use case ends.
3c. Missing location.
3c1. RelayCoach notifies coach that location must be provided.
Use case ends.
4a. Invalid team index.
4a1. RelayCoach informs coach the team does not exist.
Use case ends.
4b. Duplicate session detected (same team, same date/time).
4b1. RelayCoach rejects scheduling and notifies coach.
Use case ends.
Use case: Delete Team
MSS
1. Coach chooses to delete a team.
2. RelayCoach requests the team index.
3. Coach provides the team index.
4. RelayCoach validates the team index.
5. RelayCoach deletes the team from the database.
6. RelayCoach confirms deletion with a success message.
Use case ends.
Extensions
2a. Selection invalid (e.g., index out of bounds).
2a1. RelayCoach prompts for correction.
Use case ends.
Use case: Add Students to Session
MSS
1. Coach chooses to add students to a session.
2. RelayCoach requests session datetime, location, and student indexes.
3. Coach provides the requested details.
4. RelayCoach validates the input.
5. RelayCoach adds the students to the specified session.
6. RelayCoach confirms the addition and displays updated session details.
Use case ends.
Extensions
3a. Missing student index.
3a1. RelayCoach notifies coach that at least one student index must be provided.
Use case ends.
3b. Invalid date/time format.
3b1. RelayCoach requests correction using required format yyyy-MM-dd HHmm.
Use case ends.
3c. Missing location.
3c1. RelayCoach notifies coach that location is required.
Use case ends.
4a. Invalid student index provided.
4a1. RelayCoach informs coach that the student does not exist.
Use case ends.
17
or above installed.{More to be added}
Given below are instructions to test the app manually.
Note: These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.
Initial launch
Download the jar file and copy into an empty folder
Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
Saving window preferences
Resize the window to an optimum size. Move the window to a different location. Close the window.
Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained.
{ more test cases … }
Deleting a person while all persons are being shown
Prerequisites: List all persons using the list
command. Multiple persons in the list.
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.
Test case: delete 0
Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.
Other incorrect delete commands to try: delete
, delete x
, ...
(where x is larger than the list size)
Expected: Similar to previous.
{ more test cases … }
Dealing with missing/corrupted data files
{ more test cases … }