tp

Developer Guide

Welcome to the PlanPal Developer Guide! Thank you for taking an interest in the behind-the-scenes work of our product. We hope this document proves informative and useful for your work!

Design & Implementation
Ui
Parser
Mode: Contact Manager
Mode: Expense Manager
Mode: Activity Manager
Product Scope
User Stories
Non-Functional Requirements
Glossary
Instructions for manual testing

Acknowledgements

MVN REPOSITORY - Zip4j : Used for storing back up folder in an encrypted zip folder.
Code adapted from AddressBook-Level3.
Gradle - used for build automation
ChatGPT - codes from GPT has been commented in the code base

Design & Implementation

Architecture

A high-level overview of the system is shown in the Architecture Diagram below.
Architecture.drawio.png

Main Components

PlanPal: Main entry of the program, initialises and connects to the Ui
Ui: In charge of printing messages
Parser: Determines the command to execute
Modes: Determines the group of functionalities that the user wants to use.
FileManager: Read and write data from hard disk

Program Flow

The sequence diagram below describes how the components interacts with one another when the user issues a command.

For simplicity, the 3 different modes will be classified as :Mode.

Sequence Diagram for PlanPal
MainProgramFlowDiagram.drawio.png

Ui

Overview
The Ui component handles operations that displays messages for the user to read as an instruction.
Additionally, it is also used to capture user inputs in certain functions.

Methods
The Ui component has the following key methods:

Method	Description
printWelcomeMessage	Prints the welcome message
printAvailableModes	Print all modes that are currently available in PlanPal
printByeMessage	Prints the good bye message
printCreateStorage	Prints the path to the storage that is created
getSetCategory	Capture user input when using the category function in certain modes
printCat	Prints the categories available in certain modes
printCategoryNotFound	Prints when category is not found
print	Custom print function that accepts multiple strings

Design Considerations
This component was created as functionalities such as printing will be used in most of the classes in the PlanPal Application.
Consolidating all the print methods that are repeated reduces repetition in code and makes it easier to update when necessary.

Parser

Overview
This component handles the logic behind the application. The parser component consists of the parent Parser Class and 3 children that inherits the Parser Class. These 3 children are used when the respective modes are in play.

Class Diagram for Parser Component

ParserClassDiagram.drawio.png

Design Considerations
The Parser class follows this structure as there are common commands between the different modes. Using inheritance prevents the repetition of code. Additionally, different parsers were created since different modes require different functionalities.

Mode: Contact Manager

The class diagram below represents the contact book system

Class Diagram for Contact Manager

ContactClassDiagram.drawio.png

General Classes

The PlanPal class is the main entry point of the system, containing a main(String[]) method to launch the application.
The ParserFactory class is a factory that provides different parsers (e.g., ContactParser) based on the input type.
The Parser class is a class with methods to load and process commands from a file.
The BackUpManager class manages data backups, including backing up, restoring, and creating directories for backup files.
The UI class is responsible for displaying messages and menus to the user.
The ListFunctions interface defines methods for list operations like adding, deleting, and finding items.
The FileManager class handles saving and loading data to and from storage
The Storable interface defines methods for managing storage paths and command descriptions.
The Editable interface defines methods for editing command descriptions.

Contact Classes

The Contact class represents a contact with attributes like name, phone, email, command description, and categories. It implements the Editable and Storable interfaces for editing and storage functionalities.
The ContactParser class handles contact-related commands, processing strings and interacting with the ContactManager.
The ContactManager class manages a list of contacts and categories, with methods to add, delete, edit, find, and search contacts and categories.
The SetContactCategory class manages contact categories, providing methods for adding, removing, and validating categories.

Methods

Methods
addContact
deleteContact
viewContactList
editContact
findContact

Add Command

The sequence diagram below illustrates the process for resolving the “add” command.
AddContact.drawio.png

Components Breakdown:

For simplicity, the Ui component has been taken out
ContactParser class is the Parser component
ContactManager class is the Mode component

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “add /name: john” is sent, the processCommand function is executed.
Since the command is “add”, addContact function is executed using the description “/name: john”.
This creates a new contact and is then added to the list of contacts
Finally, contact file is saved in the savedContacts FileManager.

Delete Command

The sequence diagram below illustrates the process for resolving the “delete” command.

DeleteContact.drawio.png

Components Breakdown:

For simplicity, the Ui component has been taken out
ContactParser class is the Parser component
ContactManager class is the Mode component

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When the command “delete 1” is sent, the processCommand function is executed.
Since the command is “delete”, deleteContact function is executed using the index “1”.
This will delete the contact with that is assigned with the index “1” in the list of contacts.
Finally, the updated contact file is saved in the savedContacts FileManager.

List Command

The sequence diagram below illustrates the process for resolving the “list” command.
ViewContact.drawio.png

Components Breakdown:

For simplicity, the Ui component has been taken out
ContactParser class is the Parser component
ContactManager class is the Mode component
There is no need for saving for list here.

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “list” is sent, the processCommand function is executed.
Since the command is “list”, viewContactList command is executed, printing all the contacts in the list.

Edit Command

The sequence diagram below illustrates the process for resolving the “edit” command.
EditContact.drawio.png

Components Breakdown:

For simplicity, the Ui component has been taken out
ContactParser class is the Parser component
ContactManager class is the Mode component

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “edit” is sent, the processCommand function is executed.
Since the command is “edit”, editList command is executed using the description 1 /name: Bob.
The editList function edits the field at the stated index
Finally, contact file is saved in the savedContacts FileManager.

Find Command

The sequence diagram below illustrates the process for resolving the “find” command.

FindContactDiagram.drawio.png

Components Breakdown:

For simplicity, the Ui component has been taken out
ContactParser class is the Parser component
ContactManager class is the Mode component
There is no need for saving for list here.

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “find john” is sent, the processCommand function is executed.
Since the command is “find”, findContact command is executed using the description “john”.
This finds contacts containing the description “john” and adds them to an ArrayList of matching contacts.
Finally, the matching contacts are printed out for the user to see.

Set Category Command

The sequence diagram below illustrates the process for resolving the “category” command. ContactManager is omitted from the diagram for simplicity.

SetContactCategory.drawio.png

Components Breakdown:

ContactParser class is the Parser component
SetContactCategory class is the Mode component

Explanation:

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “category” is sent, the processCommand function is executed in ContactManager.
Then handle function is called in SetContactCategory.
“add {category}” can be used to add new category
“remove {category}” can be used to remove existing category
“edit {contact id} {category1/category2/..}” can be used to assign category to contact with specified id
“view” is executed to show all existing categories
“list” is executed to show all existing contacts
“exit” is executed to exit setting category mode
Finally, contact file is saved in the savedContacts FileManager.

Search Command

The sequence diagram below illustrates the process for resolving the “search” command.

SearchByCategory.drawio.png

Explanation:

The ‘search’ command allows users to search contacts belonging to user-defined categories

Before this command is executed, the user will have to choose their mode.
When modeInput is 1, representing contact manager, the user is then asked for a command in this mode.
When command “search {category}” is sent, the processCommand function is executed.
Since the command is “search {category}”, a list of contacts that is assigned with the category is shown

Mode: Expense Manager

The class diagram below represents the Expense Manager system.

Expense Classes

The Expense class represents an individual expense with attributes like command description, cost, month, name, and type. It implements the Editable and Storable interfaces for editing and storage functionalities.
The ExpenseType class is an enumeration that categorizes expenses into different types.
The ExpenseParser class is responsible for parsing expense-related commands and delegating them to the ExpenseManager.
The ExpenseManager class manages and processes expenses, interacting with the FileManager, BudgetManager, and RecurringManager.
The RecurringExpense class represents an expense that recurs monthly.
The RecurringManager class manages recurring expenses, including adding, viewing, and removing them.
The BudgetManager class manages user budgets, including setting, retrieving, and clearing budgets.
The ExpenseModeFunctions interface defines methods for handling expense modes, such as current month and recurring expenses.