ClubHub 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

Primary User: CCA secretary in NUS, who needs to:

• Manage 50+ contacts of members with different roles in a structured way.
• Keep track of members’ preferences and dietary restrictions.
• Record event attendees and mark attendance.
• Delegate and track tasks.

Pain Points:

• Fragmented systems: Currently uses spreadsheets, group chats, and manual checklists, which are error-prone and time-consuming.
• Repetitive tasks: Re-entering the same member details across multiple files and attendance sheets.
• Lack of structure: Hard to filter/search members quickly (e.g., “all Year 1 members who are vegetarian”).

Value Proposition

A streamlined address book that organises member details, tracks unique preferences, and simplifies event attendance — helping secretaries stay efficient, accurate, and focused on building stronger communities.

User Stories

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

ClubHub Developer Guide

Use Cases

For all use cases below, the System is ClubHub and the Actor is the Secretary, unless specified otherwise.

---

Use case: UC01 – Add Member

System: ClubHub Actor: Secretary

MSS (Main Success Scenario):

1. Secretary chooses to add a member.
2. ClubHub requests name, year, role, dietary requirements, student number, phone number(above compulsory) and telegram handle(optional).
3. Secretary enters the requested details.
4. ClubHub validates inputs and creates the member record.
5. ClubHub displays confirmation and the updated member list. Use case ends.

Extensions:

• 3a. Missing/invalid fields.
  • 3a1. ClubHub shows specific error and usage hint.
  • 3a2. Secretary re-enters data.
  • Use case resumes from step 4.
• *a. At any time, Secretary cancels.
  • *a1. ClubHub asks to confirm cancellation.
  • *a2. Secretary confirms.
  • Use case ends.

---

Use case: UC02 – Search Members by Field

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to search members.
2. ClubHub requests search criteria (e.g., field and query).
3. Secretary enters the field and query (e.g., Field: Year, Query: 3).
4. ClubHub searches members whose specified field matches the query.
5. ClubHub displays a list of matching members with key details (e.g., Name, Year, Role, Dietary Restriction).
6. (Optional) Secretary selects a member to view full details. Use case ends.

Extensions:

• 2a. Secretary omits field or query.
  • 2a1. ClubHub prompts for the missing input(s).
  • Use case resumes from step 3.
• 3a. Invalid field name provided.
  • 3a1. ClubHub lists supported fields.
  • 3a2. Secretary re-enters a valid field.
  • Use case resumes from step 3.
• 4a. No members match the criteria.
  • 4a1. ClubHub displays "No member found." and suggests refining the query.
  • Use case ends.
• 5a. Result set is too large.
  • 5a1. ClubHub paginates results or prompts for filters.
  • Use case resumes from step 3 or continues browsing.
• *a. At any time, Secretary cancels.
  • *a1. ClubHub asks to confirm cancellation.
  • *a2. Secretary confirms.
  • Use case ends.

---

Use case: UC03 – Create Event

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to create an event.
2. ClubHub requests event ID, date, and description.
3. Secretary enters details.
4. ClubHub validates and creates the event.
5. ClubHub displays confirmation. Use case ends.

Extensions:

• 3a. Duplicate/non-conforming EventID or invalid date/description.
  • 3a1. ClubHub shows validation error(s).
  • 3a2. Secretary re-enters data.
  • Use case resumes from step 4.

---

Use case: UC04 – Record Event Attendance

System: ClubHub Actor: Secretary

MSS:

1. Secretary searches for an event by ID or date.
2. ClubHub displays the event details.
3. Secretary chooses to record attendance.
4. ClubHub displays the list of members.
5. Secretary marks members as attended.
6. ClubHub saves the attendance and confirms. Use case ends.

Extensions:

• 1a. Event not found.
  • 1a1. ClubHub displays “Event not found.”
  • Use case ends.
• 5a. Secretary marks the same member again.
  • 5a1. ClubHub ignores duplicate and continues.

---

Use case: UC05 – Update Member Details

System: ClubHub Actor: Secretary

MSS:

1. Secretary searches for the member by name and year.
2. ClubHub displays the member’s current details.
3. Secretary chooses to edit details.
4. ClubHub requests updated information.
5. Secretary enters new details (e.g., role changed).
6. ClubHub validates and updates the record.
7. ClubHub confirms the update. Use case ends.

Extensions:

• 1a. No member matches the search.
  • 1a1. ClubHub displays “No member found.”
  • Use case ends.
• 6a. Invalid details entered.
  • 6a1. ClubHub requests correction.
  • 6a2. Secretary re-enters details.
  • Use case resumes from step 7.

---

Use case: UC06 – Assign and Track Tasks

System: ClubHub Actor: Secretary

MSS:

1. Secretary searches for a member.
2. ClubHub displays the member’s profile.
3. Secretary chooses to assign a task.
4. ClubHub requests task details.
5. Secretary enters task description and deadline.
6. ClubHub saves the task under the member’s record.
7. Secretary later views the list of pending tasks.
8. When task is done, Secretary marks it completed.
9. ClubHub updates the task status. Use case ends.

Extensions:

• 1a. Member not found.
  • 1a1. ClubHub displays “No member found.”
  • Use case ends.
• 5a. Task details are missing/invalid.
  • 5a1. ClubHub prompts for correction.
  • 5a2. Secretary re-enters details.
  • Use case resumes from step 6.

---

Use case: UC07 – Undo Last Action

System: ClubHub Actor: Secretary

MSS:

1. Secretary issues the undo command.
2. ClubHub restores the system to its state before the last action.
3. ClubHub displays confirmation. Use case ends.

Extensions:

• 1a. No action available to undo.
  • 1a1. ClubHub displays “No action to undo.”
  • Use case ends.

---

Use case: UC08 – View Attendance and Follow-Up

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to view attendance for an event.
2. ClubHub displays the list of members who attended.
3. Secretary identifies absentees for follow-up actions (e.g., reminders). Use case ends.

Extensions:

• 1a. Event not found.
  • 1a1. ClubHub displays “Event not found.”
  • Use case ends.
• 2a. No attendance recorded yet.
  • 2a1. ClubHub shows “No attendance recorded yet.”
  • Use case ends.

---

Use case: UC09 – Delete Event

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to delete an event.
2. ClubHub requests event ID and confirmation.
3. Secretary provides the ID and confirms deletion.
4. ClubHub deletes the event and shows success message. Use case ends.

Extensions:

• 2a. Event not found.
  • 2a1. ClubHub displays “Event not found.”
  • Use case ends.
• *a. Secretary cancels at confirmation.
  • *a1. ClubHub cancels deletion.
  • Use case ends.

---

Use case: UC10 – View Pending Tasks

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to view pending tasks.
2. ClubHub retrieves and lists all tasks not marked as completed, grouped by member.
3. Secretary reviews tasks. Use case ends.

Extensions:

• 2a. No pending tasks.
  • 2a1. ClubHub displays “No pending tasks.”
  • Use case ends.

---

Use case: UC11 – View Attendance Statistics

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to view attendance statistics.
2. ClubHub calculates attendance percentage for each member across all events.
3. ClubHub displays summary statistics (e.g., member name, number of events attended, attendance rate). Use case ends.

Extensions:

• 2a. No attendance data available.
  • 2a1. ClubHub displays “No attendance data found.”
  • Use case ends.

---

Use case: UC12 – Archive Past Events

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to archive events.
2. ClubHub lists past events (e.g., before today’s date).
3. Secretary selects one or more events to archive.
4. ClubHub moves the events into the archive section.
5. ClubHub confirms success. Use case ends.

Extensions:

• 2a. No past events available.
  • 2a1. ClubHub displays “No past events to archive.”
  • Use case ends.

---

Use case: UC13 – Filter Members’ Common Free Time

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to check common free time for members.
2. ClubHub requests the list of members to include in the check.
3. Secretary selects members (e.g., Exco team).
4. ClubHub cross-references schedules/free-time data.
5. ClubHub displays the common available time slots. Use case ends.

Extensions:

• 2a. No schedules available for some members.
  • 2a1. ClubHub notifies which members lack schedules.
  • 2a2. Secretary may continue with available data.
• 5a. No common free time found.
  • 5a1. ClubHub suggests splitting into smaller groups.
  • Use case ends.

---

Use case: UC14 – Share Contact List Access

System: ClubHub Actor: Secretary, Other Exco Members

MSS:

1. Secretary chooses to share the contact list.
2. ClubHub requests the role or specific member(s) to grant access.
3. Secretary specifies the exco members.
4. ClubHub grants read/write access to those members.
5. ClubHub confirms access granted. Use case ends.

Extensions:

• 3a. Member not in exco.
  • 3a1. ClubHub rejects request.
  • Use case resumes from step 2.
• *a. Secretary revokes access later.
  • *a1. ClubHub updates permissions.
  • Use case ends.

---

Use case: UC15 – Bulk Import/Export Member Details

System: ClubHub Actor: Secretary

MSS:

1. Secretary chooses to import or export member details.
2. For import:
   • ClubHub requests a CSV/Excel file.
   • Secretary uploads the file.
   • ClubHub validates the file format and contents.
   • ClubHub imports member data and shows summary of new/updated records.
3. For export:
   • ClubHub generates a CSV/Excel file with current member details.
   • Secretary downloads the file. Use case ends.

Extensions:

• 2a. Import file invalid (wrong format, missing fields).
  • 2a1. ClubHub shows error message with line numbers.
  • 2a2. Secretary corrects file and retries.
• 2b. Duplicate entries in import file.
  • 2b1. ClubHub prompts whether to update or skip.
  • Use case resumes from step 2.

Non-Functional Requirements

• Performance: Actions (add/search/edit) should respond within 1 second for up to 200 members.
• Usability: Must be usable via CLI with clear error messages and undo support.
• Portability: Runs locally on Windows, macOS, and Linux.
• Single-user: Only one secretary per copy of the app.
• No remote server: All data stored locally.
• Reliability: Data should not be lost when the program closes.
• Incremental development: Feature additions should not break previous functionality.
• Security: User data should not be exposed externally.

Glossary

Actor An entity (usually a user or external system) that interacts with ClubHub. In most use cases, the actor is the Secretary, though other Exco members may also interact with the system.

Attendance A record of which members were present at an event. Used to generate statistics and track participation.

ClubHub The system being developed to support secretarial duties, including member management, event organisation, task assignment, and record-keeping.

Dietary Restriction Any limitation on food or drink that a member cannot consume (e.g., vegetarian, halal, no seafood). Stored in member records to aid event meal planning.

Event A scheduled club activity created and tracked in ClubHub. Each event has an ID, date, and description, and may include attendance records.

Exco (Executive Committee) The group of members responsible for running the club (e.g., President, Treasurer, Secretary). Exco members may have special access privileges.

Field A specific attribute of a member record (e.g., Name, Year, Role, Dietary Restriction) used for searching and filtering.

Member A registered individual in ClubHub with stored details such as name, year of study, role, student number, phone number, and optional telegram handle.

Member Record The collection of data fields stored for a member in ClubHub.

Pending Task A task assigned to a member that has not yet been marked as completed.

Role The position a member holds in the club (e.g., President, Treasurer, Secretary, General Member).

Secretary The main user of ClubHub. Responsible for managing members, creating events, tracking attendance, assigning tasks, and maintaining records.

Task An assigned responsibility given to a member, tracked by ClubHub until marked completed.

Telegram Handle An optional contact field that stores a member’s Telegram username for communication purposes.

Undo A command that allows the Secretary to reverse the most recent action in ClubHub.

Year of Study The academic year of a member (e.g., Year 1, Year 2, etc.). Used for filtering and organising members.

---

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