Developer Guide

• Acknowledgements
• Setting up, getting started
• Design
  • Architecture
  • UI component
  • Logic component
  • Model component
  • Storage component
  • Common classes
• Implementation
  • [Proposed] Undo/redo feature
    • Proposed Implementation
    • Design considerations:
  • [Proposed] Data archiving
• Documentation, logging, testing, configuration, dev-ops
• Appendix: Requirements
  • Product scope
• MVP User Stories
• Non-MVP User Stories
  • Use cases
  • Non-Functional Requirements
  • Glossary
• Appendix: Instructions for manual testing
  • Launch and shutdown
  • Deleting a person
  • Saving data

---

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

Value proposition: manage contacts faster than a typical mouse/GUI driven app

MVP User Stories

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

Priority	As a …​	I want to …​	So that I can…​
* * *	Instructor	add a student’s details	new student details can be added
* * *	Instructor	delete a student’s details	remove or withdraw incorrect entries from the system
* * *	Instructor	view a list of all students in my course	quickly see who is enrolled
* * *	Instructor	add students to a team	teams remain accurate throughout the semester
* * *	Instructor	remove students from a team	teams remain accurate throughout the semester

Non-MVP User Stories

Priority	As a …​	I want to …​	So that I can…​
* *	Instructor	assign teams to designated tutors	each tutor knows which teams they are responsible for monitoring
* *	Instructor	edit a student’s contact details	student records are kept up to date
* *	Instructor	view teammates’ GitHub links or repositories	submissions can be easily checked
* *	Instructor	search for a student by name, ID, or team	quickly locate student information
* *	Instructor	see which students belong to each team	monitor team formation and collaboration
* *	Instructor	attach GitHub repo links or project files	keep all relevant information in one place
* *	Instructor	store Zoom links for team meetings	ensure all teams can access the correct meeting easily
* *	Instructor	filter students/teams by submission or status	quickly find relevant groups
* *	Instructor	assign teams to specific tutorial groups	align team activities with tutorial sessions
* *	Instructor	track student contributions	assess participation and ensure fair grading
* *	Instructor	receive notifications of repo updates	stay informed of progress and submissions in real time
* *	Instructor	set deadlines or milestones	keep students on track and monitor progress
*	Careless Instructor	be warned before entering duplicate data	avoid accidental data errors
*	User on the go	access the platform from any device	manage student data from home, office, or in class
*	Forgetful Instructor	have the system auto-save changes	prevent losing updates when managing multiple teams
*	Instructor	export student and team data	share it with TAs and instructors

{More to be added}

Use cases

Use case: UC01 - Add Student Contact Details

MSS

1. Instructor chooses to add a student.
2. SWEatless requests for required details.
3. Instructor enters the required details (name, email, phone, Github username).
4. SWEatless validates input.
5. SWEatless displays details of new student. Use case ends.

Extensions

• 3a. Missing/invalid details entered. 3a1. SWEatless shows error message. 3a2. Instructor re-enters details. Use case resumes from step 3.

Use case: UC02 - Delete Student Contact Details

MSS

1. Instructor chooses to delete a student.
2. SWEatless requests for student email or id.
3. Instructor provides details.
4. SWEatless verifies membership.
5. SWEatless requests confirmation.
6. Instructor confirms.
7. SWEatless removes student. Use case ends.

Extensions

• 4a. Student not found. SWEatless shows error and cancels.

Use case: UC03 - View list of students

MSS

1. Instructor requests to view all students.
2. SWEatless retrieves and displays student list. Use case ends.

Extensions

• 2a. No students exist. SWEatless displays “No students found.”

Use case: UC04 - Add Student to Team

MSS

1. Instructor chooses to add a student to a team.
2. SWEatless requests student name and team ID.
3. Instructor provides details.
4. SWEatless checks if student and team exist.
5. SWEatless adds the student to the team.
6. SWEatless displays confirmation and updated team list. Use case ends.

Extensions

• 4a. Student does not exist. SWEatless shows error.

• 4b. Team does not exist or is full. SWEatless shows error.

• 4c. Student already in the team. SWEatless warns and prevents duplication.

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 persons 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 support only a single user and the data created by one user must not be accessible by another during regular use.
5. Should run without requiring installation and be usable as a JAR.
6. Should not depend on a remote server.
7. Should work well at screen resolutions of 1920×1080 and above at 100% and 125% scaling, and remain usable at 1280×720 and above at 150% scaling.
8. Should be distributed as a single JAR file.
9. Should allow all core actions to be performed using concise CLI commands.
10. Commands should be case-insensitive and whitespace-tolerant to reduce user fustration.
11. Should support loading student and team data files containing up to 800 students and 160 teams within 2 seconds on standard hardware.
12. Should return results of all CLI commands within 1 second under typical usage conditions.
13. Should remain usable on CLI-only environments.
14. Should be able to recover corrupted data file using the last valid backup.
15. Should maintain more than 80% unit test coverage for core features to ensure maintainability.
16. Should keep user guide and developer guide PDF-friendly, with examples of CLI commands and screenshots kept under 15MB per file.
17. Should provide quick-start examples in documentation.
18. Should follow object-oriented design principles, making it easy to add new student attributes without major code changes.
19. Should allow only a single authorized user to have write-access to the data file during runtime.

{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

• Instructor: Teaching staff who manage course delivery and teams. Can assign students to teams, view rosters, and monitor projects

• Student: A learner enrolled in a course, whose details (name, email, phone, GitHub) are managed in SWEatless

• Team: A group of students working together on a project. Identified by a Team ID (e.g., F12-3)

• Team ID: A structured identifier used to represent a team, where:

1. Format: -
2. ClassNumber: Two digit number representing the tutorial class
3. GroupNumber: one digit number representing the group (from 1 to 4)
4. Example: 12-1 (Class 12, Group 1)

• GitHub Username: The student’s GitHub handle (1–39 characters, alphanumeric and hyphen only). Used for linking project repositories

• GitHub Repository (Repo): A storage space for a team’s project files hosted on GitHub. SWEatless may store these links for instructors to monitor progress

• Roster: A list of students enrolled in a course. Maintained by the Administrator, accessible by Instructors.

• CLI (Command-Line Interface): The text-based interface used by teaching staff to interact with SWEatless. Users enter typed commands instead of using a graphical interface

• Command Format: The strict syntax required for each CLI command (e.g., add_student NAME /email EMAIL /phone PHONE /github USERNAME)

• Duplicate Handling: The rules SWEatless uses to prevent duplicate entries (e.g., duplicate students identified by email/phone)

• Validation Rule: A defined rule that ensures inputs (e.g., email, phone, GitHub username) are valid before being stored in the system

• Error Message: A system response shown when invalid input or actions occur (e.g., “Invalid email format.”)

---

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