ip

Developer Guide

Acknowledgements

Setting up, getting started

Refer to the guide Setting up and getting started.

Design

The Design consist of different classes and component like Ui, Storage, Parser, TaskList, MainWindow and Duke.

Class UML Diagram

The two classes called Launcher and Main are responsible for,
At app launch: Initializes the components in the correct sequence, and connects them up with each other.
At shut down: Shuts down the components and invokes cleanup methods where necessary.

The rest of the App consists of four components.

UI: The UI of the App. (MainWindow, Ui and DialogBox)
Logic: The command executor. (Parser, Command)
Model: Holds the data of the App in memory. (Tasks, TaskList)
Storage: Reads data from, and writes data to, the hard disk. (Storage)

The Ui component will work together with Duke to get the user input. And Duke will work together with the Logic (Parser), Model (TaskList) and Storage (Storage) component to execute the command enter by the user.

Sequence Diagram

An example of the sequence diagram when the user key in the list command:

Object diagram

Implementation

This section describes some noteworthy details on how certain features are implemented.

Search for duplicate task

When the user used the Event, Deadline or Todo command, during the execution of the adding into the TaskList, there will be a search for the same task description against the current list. If there are duplicate task description, the task will be added into a temporary ArrayList which at the end of adding, will inform the user that there are duplicate task description. The current task description will still be added to the list in case the user still wants to keep it (He can remove it using the remove command if he does not want to keep it). The search for duplicate will be done:

across all task without regards to the type of task (e.g. Event, Todo, Deadline, etc.)
regardless of capitalization (i.e. Does not matter if the word is in Lower case or upper case)

Exit Command

The Exit Command consist of Bye, Quit and Exit. After the user has given the command, Duke will say goodbye to the user before doing a countdown to close the program. The code made used of javafx.animation.Timeline to set a timer of 11sec before the application is close. This is such that user would know that the app is closing due to the program instead being unsure if the app has properly closed or crash. The user is also able to see that Duke has said goodbye to them instead of suddenly closing.
The program uses a few javafx.animation.Timeline to close the program. The first one was use to set a timer of 11sec to close the program. After that, the program will have a loop of 10 cycle to create 10 more timer, 1 each from 10 sec to 1 sec, to display the countdown to the user.

Target user profile

has a lot of activities going on and need tracking prefers using computer instead of phone prefers typing to mouse interactions is reasonably comfortable using CLI apps

Value proposition

keep record of tasks track daily tasks easily avoid missing some important tasks

User Stories

Version	As a …	I want to …	So that …
v1.0	new user	know what kind of command there are	I can what are the feature and how I can use them
v1.0	new user	know how to add a task	I can record the task to track
v1.0	new user	view the list of task	I can see all my task that I need to do
v1.0	new user	delete a task	If I keyed in wrongly, I can remove it
v1.0	new user	mark a task as done	I can know which task are done instead of deleting it from record
v1.5	semi-new user	save my task for future use	Once I switch on the app, the task I recorded previously are still there
v2.0	user	find a task using keywords	I can easily check for the information I need
v2.0	user	group my task to ToDo, Event and Deadlines	I can have more types of task to keep track and include time for specific task
v2.0	user	clear my current list of task	I don’t have to delete one by one
v3.0	user	have a GUI instead of CLI	it feels more like a chatbot and look nicer
v3.0	user	be informed if I have keyed in a task with a similar description	I know I had keyed in a duplicated task
v3.0	user	have a countdown for closing of the app	I know that the app is responding and is closing

Non-Functional Requirements

Each request should be processed within 3 seconds.
Program to function properly on different operating systems.
Program should be easily add in new function or new modules.
Command should be easy to use and understand.
GUI should be as simple and neat as possible.

Glossary

Mainstream OS: Windows, Linux, Unix, OS-X CLI - Command Line Interface GUI - Graphical User Interface