Developer Guide

• Introduction
• Acknowledgements
• Setting Up
• Design
  • Architecture
  • UI
  • Parser
  • Entry
  • Command
  • Member
  • Training
  • Attendance
  • Storage
• Restrictions
• Appendix: Requirements
  • Product Scope
  • User Stories
  • Non-functional Requirements
• Appendix: Manual Testing
  • Testing Member Features
  • Testing Training Features
  • Testing Attendance Features
• Exit

Introduction

CCA Manager is a simple and easy to use organisational planner for CCAs (Co-Curricular Activities) in NUS. It is designed specifically for students who are key appointment holders of such CCAs. Features include storing and tracking of information on CCA members, training schedules and attendance records which can be accessed quickly via a Command Line Interface (CLI). CCA Manager aims to centralise and optimize all CCA-related information, so that you can focus on improving other aspects of the CCA.

CCA Manager is written in Java 11 and designed with OOP (Object Oriented Programming) as a guideline to help design a modular and organized structure for the application.

Prerequisites: JDK 11, update Intellij to the most recent version.

Acknowledgements

• SE-EDU
  1. AB3 Developer Guide Format
  2. AB3 User Guide Format
  3. AB3 Appendix: Requirements
  4. AB2 Code Basics
• PlantUML

Setting Up

CCA Manager is written in Java 11, which you can download here.

You can retrieve the latest JAR version of CCA Manager here

You can retrieve the source code for CCA Manager here. You can refer here to learn how to fork and clone the repository of CCA Manager into your local workstation.

We recommend the use of IntelliJ when working on CCA Manager.

Design

Architecture

The architecture diagram above presents a high-level overview of CCA Manager.

Components of the architecture

• UI: UI of CCA Manager
• Parser: Parses user inputs into keywords
• Entry: Converts keywords from Parser into commands to run
• Command: Executes a command based on keyword given
• Members: Stores member details as Member objects in MemberList
• Training: Stores training details as TrainingSchedule objects in TrainingList
• Attendance: Object that links a Member to a TrainingSchedule
• Storage: Stores details of Members, Training and Attendance in hard disk space

Components Interaction

The sequence diagram below shows how various components of the architecture interact with one another when a user inputs a valid command "add /m Bob /s A01231234B /p 98765432"

Note:

• Examples below have their arguments removed for the sake of brevity
• waitForQuery(): Blocks until a user input is received.
• getKeywordStatus(): Given user input, return the keyword.
• getMemberDetails(): Given user input, return a Member object with all information from user input.
• addMember(): Calling a class that creates a new Member object and adds it to the MemberList members.
• members.addMember(): Adds a Member member to MemberList members.
• writeMemberFile(): Writes the content of MemberList members to the File memberFiles, which should be a .csv file in hard drive.

The sequence diagram below shows how various components of the architecture interact with one another when a user inputs a valid command "delete /m 1"

Note:

• getKeywordStatus(): Gets the keyword value from the Keyword enum class.
• deleteMember(members, entry): Deletes the member from the memberList.
• deleteMemeber(memberNumber): Deletes the member using the index number provided by the user.
• writeMemberFile(): Writes the data to the csv file.

The sections below give more details of each component.

UI Component

Hint: You can click on the Application Programming Interface (API) links to be redirected to its source code!

API : Ui

The Ui component handles the output display of CCA Manager. Whenever the user enters a command, the Ui class will print a message corresponding to the user input. Current Functionalities:

• Display message on start-up.
• Help message when user inputs --help.
• Listing of Members in MemberList.
• Listing of Training in TrainingList.
• Listing of Attendance in AttendanceList.
• Displaying error messages on invalid command inputs.
• Displaying success messages on valid command inputs.

Parser Component

API : Parser

The Parser component handles the input parsing of CCA Manager. User input is parsed to produce a keyword and corresponding inputs, such as index , name, etc. are identified.

A keyword is an identifier used by CCA Manager to determine what operation (add, edit, delete or list) to do.

Current Functionalities:

• Retrieving keyword from user input.
• Create a TrainingSchedule object from user input.
• Create a Member object from user input.
• Create a Attendance object from user input.

Entry Component

API : Entry

The Entry component performs a command based on the keyword given. If the user enters an invalid command, for example, the Entry component will direct the Ui component to print an error message. It uses simple switch-case statements to handle the different keyword received.

Command Component

API : Command

The Command component directly interacts with the Member, Training or Attendance component based on the keyword given in order to perform a specific operation.

Current Functionalities

• Adding Member to MemberList in Member Component.
• Adding TrainingSchedule to TrainingList in Training Component.
• Adding Attendance to AttendanceList in Attendance Component.
• Deleting Member from MemberList in Member Component.
• Deleting TrainingSchedule from TrainingList in Training Component.
• Deleting Attendance from AttendanceList in Attendance Component.
• Editing a field in Member
• Editing a field in Training
• Finding a specific Member in MemberList
  • Search by index and Search by member name is supported.
• Finding a specific TrainingSchedule in TrainingList
  • Search by index and Search by training name is supported.

Member Component

API : Member

The Member component consist of MemberList and Member. Member consist of important member information such as name, studentName, gender, phoneNumber and index which is the index of member shown to user of the program.

Current Functionalities

• instantiates an MemberList object comprising 0 Member objects.
• stores inputted Member objects in a list as an ArrayList<Member> in MemberList class.
• stores the MemberList object in a csv file with the help of MemberStorage.

Training Component

API : Training

The Training component consists of TrainingList and TrainingSchedule. Information regarding Trainings, such as name, date/time and venue are handled by the Training component.

Current Functionalities

The Training component,

• instantiates a TrainingList object of 0 TrainingSchedule objects
  • TrainingSchedules in a TrainingList hold an Index that CCA Manager uses in relevant commands, such as delete by index or find by index
• TrainingSchedule is an object that holds the information of CCA information, such as:
  • Training Name
  • Training Date
  • Training Venue
• stores TrainingSchedule in TrainingList whenever addTrainingSchedule() is called
• edits TrainingSchedule in TrainingList whenever EditTraining() is called
• removes TrainingSchedule from TrainingList whenever deleteTrainingSchedule() is called
• returns a list of matching TrainingSchedule whenever findTraining() is called
• stores TrainingList entries on disk in CCATrainings.csv

Attendance component

API : Attendance

The Attendance component,

• instantiates an Attendance object comprising of 1 Member object and 1 TrainingSchedule object.
• stores inputted Attendance objects in a list as an ArrayList<Attendance> in AttendanceList class.
• stores the AttendanceList object in a csv file with the help of AttendanceStorage.

Storage component

API : Storage

The Storage component consists of 3 sub-components, corresponding to MemberStorage , AttendanceStorage and SrainingStorage

The MemberStorage component

• can save members’ data in CSV format and read them back into the MemberList object.
• automatically adds to DukeMembers.csv whenever a new member is added to the MemberList object.
• automatically edits to DukeMembers.csv whenever member details are edited in the MemberList object.
• automatically deletes to DukeMembers.csv whenever a member is deleted from the MemberList object.

The AttendanceStorage component

• can save attendance data in CSV format and read them back into the AttendanceList object.
• automatically deletes to AttendanceStorage.csv whenever a member is deleted from the AttendanceList object.

The TrainingStorage component

• can save trainings schedules and read them back into the TrainingList object.
• automatically deletes in the file whenever a training schedule is deleted from the TrainingList object.

When the program is run, it will either create the relevant files if it is the first time running, or it will load the relevant files. While loading, if there is any invalid fields in any of the data files,it will terminate the program with a message prompt telling the user to make all inputs valid before running the program again.

Restrictions

IMPORTANT!

One restriction of the current implementation (v2.1) of CCAManager is that the user input cannot contain any commas.

This is because data is saved in a .csv file, which uses commas as field delimiters. Hence, if user input were to contain commas, this may cause data to be imported inaccurately during the loading of existing files at start-up.

Appendix: Requirements

Product scope

Target user profile

• Is in an administrative position for a CCA in NUS, and deals with the book-keeping of CCA information
• Has the need to centralize and record a multitude of CCA information (member details, training schedules, etc.)
• Is comfortable with the use of CLI such as cmd.exe
• Prefers typing to mouse interactions
• Prefers the use of desktop apps for CCA administrative matters over other alternatives (mobile app, etc.)
• Can type fast

Value proposition

User can update CCA information faster than using a GUI, and offers a centralized platform to store all relevant CCA information

User Stories

Version	As a …	I want to …	So that I can …
v1.0	CCA Leader	Add member details	Keep a record of all active members and know how to contact them
v1.0	CCA Leader	Edit member details	Keep the details of active members updated and accurate
v1.0	CCA Leader	Delete member details	Reduce clutter by removing entries for members no longer in the CCA (Graduated,Quit,etc.)
v1.0	CCA Leader	Add training schedule	Record an upcoming training and its details for reference
v1.0	CCA Leader	Edit training schedule	Update details of an upcoming training in case of any sudden changes (Venue,Date/Time,etc.)
v1.0	CCA Leader	Delete training schedule	Remove any erroneous trainings (Cancelled training,etc.)
v1.0	CCA Leader	Export data to .csv	Keep a backup of updated CCA information and make use of Excel formulas and macros to help with book-keeping
v1.0	CCA Leader	Import data from .csv	Automatically read saved CCA information
v2.0	CCA Leader	Add attendance	Keep track of which members attended which training sessions
v2.0	CCA Leader	Delete attendance	Remove any erroneous attendance (Listed member as present when he was not,etc.)
v2.0	CCA Leader	Find member	Find specific members if I need any of their details.
v2.0	CCA Leader	Find training name	Filter out which Trainings I want to find out about.

Non-Functional Requirements

1. CCA Manager should work on any modern OS which has Java 11 installed
2. CCA Manager should be able to record a lot of data without noticeable performance issues
3. A User with above average typing speed should be able to get tasks done faster with the use of CCA Manager compared to using a mouse

Appendix: Manual Testing

Setup

1. Download the latest release from here

Initial Launch

1. Place CCAManager.jar in your folder of choice.
2. Run cmd.exe
3. Run CCA Manager by calling java -jar CCAManager.jar on cmd.exe
   1. Note that cmd.exe must be in the directory of CCAManager.jar

Running Commands

1. You can refer to the list of commands here
2. Upon a successful command run, data will be saved to DukeMembers.csv

Testing Member-related features

1. Storing a new member, with a unique student ID
   • Input: add /m /n John Hwee /s A1231234B /g M /p 98765432
   • Expected Output: Assuming that the program is run for the first time, John Hwee will be the first entry in MemberList and given an index of 1
   • A new .csv file named CCAMembers.csv will be created and John Hwee will be recorded in it
2. Storing a new member, with an existing student ID
   • Input: add /m /n Frank Han /s A1231234B /g M /p 91231234
   • Expected Output: Since John Hwee already has the student number A1231234B, this command will not succeed. An error message will be printed.
3. Editing a member’s information
   • Input: edit /m 1 /p 91234567
   • Expected Output: John Hwee was assigned the index 1 above, so this command will update his phone number to 91234567
   • The change will be recorded in CCAMembers.csv as well
4. Listing out all members
   • Input: list /m
   • Expected Output: Since Frank Han was not successfully added, only John Hwee exists in the member list. Hence, this command will show only 1 member: John Hwee
5. Delete member
   • By name
     • Input: delete /m John
     • Expected Output: Since there is only one member in the list, whose name is John Hwee, his entry will be deleted
   • By index
     • Input: delete /m 1
     • Expected Output: Since John Hwee is assigned index 1, his details will be deleted from the list.
   • The entry will be deleted from CCAMembers.csv as well

Testing Training-related features

1. Storing a new training, with a unique training name
   • Input: add /t /n Friday Training 1 /a 5 Nov 2021 /v MPSH1
   • Expected Output: Assuming that the program is run for the first time, Friday Training 1 will be the first entry in TrainingList and given an index of 1
   • A new .csv file named CCATrainings.csv will be created and Friday Training 1 will be recorded in it
2. Editing an existing training detail
   • Input: edit /t 1 /v MPSH2
   • Expected Output: Since Friday Training 1 is assigned the index 1, its venue will be updated from MPSH1 to MPSH2
   • This change will be reflected in CCATrainings.csv
3. Listing out all trainings
   • Input: list /t
   • Expected Output: Since there is only 1 training entry, Friday Training 1, the list command will succeed and show the details of Friday Training 1
4. Delete an existing training
   • By name
     • Input: delete /t Friday
     • Expected Output: Since there is only one training entry in the list, Friday Training 1, it will be deleted since it matches the search Friday
     • If there are more than 1 entries in the training list that contains Friday, you will be given an additional prompt to key in the index matching the training you wish to delete
   • By index
     • Input: delete /t 1
     • Expected Output: Since Friday Training 1 is index 1, it will be deleted
   • Friday Training 1 will be removed from CCATrainings.csv as well

Testing Attendance-related features

1. Adding a new attendance
   • Input: add /att /m John Hwee /n Friday Training 1 /d 1
   • Expected Output: If there is a John Hwee in the Member list AND there is a Friday Training 1 in the Training List, this command will succeed
   • Attendance entries are reliant on the members and trainings already existing beforehand
   • If this command succeeds, John Hwee will be added as an entry to Friday Training 1.csv, located in the Attendance sub-folder.
     • If Friday Training 1.csv did not exist before, it will be created
   • 1 represents ‘Present’, 0 represents ‘Absent’
2. Deleting a valid attendance
   • Input: delete /att /t Friday Training 1 /i 1
   • Expected Output: This will delete the first member in the Friday Training 1 attendance list. In the above case, if the command succeeded then John Hwee would be index 1. Hence, his entry would be deleted
3. Listing all attendance entries
   • Input: list /att /t Friday Training 1 /d 1
   • Expected Output: This will list ALL the members who were present for Friday Training 1. In this case, only John Hwee would be listed.
   • Regardless of whether your syntax is correct or not, there will be a prompt to ask whether you would like to list the FULL attendance list
     • Reply with y to see the full attendance list, and n to skip

Exit

1. Call bye to exit CCA Manager.