Developer Guide

Introduction

All-in-OneNUS is a Command Line Interface(CLI) application that aims to help students with their university lives. All-in-OneNUS has 4 components, Team Planner, CAP Calculator, Module Planner and Food Recommendation App.

Overall Design

The AllinOneNus class contains the main method of the program, which will call the run() method from the OverallParser class. From there, the user can then access the 4 components of the application, whereby inputting a number from 1-4 will call the respective classes. ** **

Team Planner

Design

The architecture Diagram displayed above explains the high level design of the Team Planner. There are a few core components to the TeamPlanner feature

1. TeamPlanner

• This is the main class of the team planner feature. It creates an instance of the TeamUi and TeamParser and supplies the inputs to be processed by the TeamParser class

1. TeamUi

• This is the class where the bulk of the methods are stored. Methods that add/delete the members/tasks are found in this class. If the user has not used the team planner feature before, an initialisation method will be called by TeamUi and the user will be requested to fill in information about the team.

1. TeamParser

• As the name implies, this class processes the input and supplies the parameters to TeamUi

1. TeamManager

• This class keeps track of the team members in the team

1. TaskManager

• This class keeps track of the task of each team member

1. TeamPlannerStorage

• This class handles the saving and loading of the data. It creates a “team.txt” file if no file can be found and loads from a “team.txt” file if “team.txt” can be found.

Implementation

CAP Calculator

Design

Architecture

The Architecture Diagram given above explains the high-level design of the CAP Calculator. Given below is a quick overview of each component.

1. UiText

• The UiText component manages interactions with the user and contains the methods to output to the user interface on the command line.

1. ParserForCapCalculator

• The ParserForCapCalculator component sieves out all the different commands based on the user input and passes it to CommandsForCapCalculator Component

1. CommandsForCapCalculator

• The CommandsForCapCalculator component executes the different tasks the CapCalculator is capable of doing. More will be elaborated in this section

1. ModuleList

• ModuleList handles computation, calculation and logic for CapCalculator

1. ModuleStorage

• The ModuleStorage component writes data to, and loads data from the hard disk

UiText Component

ParserForCapCalculator Component

CommandsForCapCalculator Component

ModuleStorage Component

ModuleList Component

Implementation

This section describes some unique details on how certain features are implemented

Add

A general explanation of how this feature works:

1. When the user calls this feature by adding in his module data (e.g. CS2113T A 4)
2. The AddNewModuleCommand calls ModuleList#gradesToPoints() method which handles the logic of converting the grades to points. So in this case A is translated to a 5.00.
3. It thens calls ModuleList#add method to add the moduleData to the list of modules.
4. It then calls UiText#moduleAlreadyUpdate() to inform the user that the input is verified and added.
5. AddNewModuleCommand then calls ModuleStorage#writeToFile() to store the updated data to hard disk.

PrintModuleList

A general explanation of how this feature works:

1. When the user calls this feature by requesting for “list” in the user interface
2. The PrintModuleListCommand calls UiText#printModuleData() to display the list of modules in the current semester
3. The PrintModuleListCommand starts and calls ModuleList#calculate() method twice which handles the logic of computing the current semester CAP and the overall CAP respectively.
4. It then calls ModuleList#printCurrentSemCap and ModuleList#printOverallCap to display the current semester’s CAP and the overall CAP respectively.

The calculation of the cap is given by this formula:

This is handled by ModuleList#calculate() which also self invocates ModuleList#totalMcsTimesGrade(), ModuleList#totalMcs() in order to output the correct computation

Module Planner

Design

Implementation

Food Recommendation App

Design

The Architecture Diagram shown above explains the high-level design of the Food Recommendation feature. There are 5 main components to the feature.

1. FoodRecommendation

• This is the main class of the Food Recommendation Feature. It contains all the methods for all the commands. It also handles the user input, stores the FoodStore class in an Arraylist, and is responsible for calling the methods for all the other classes. It creates an instance of FoodStoreUi and FoodStoreParser.

1. FoodStoreUi

• The FoodStoreUi class is responsible for all the outputs to the user. It contains all the methods required to show any output to the user.

1. FoodStoreParser

• The FoodStoreParser class is responsible for parsing all the inputs from the user into the correct arguments for the methods in FoodRecommendation class.

1. FoodStoreStorage

• The FoodStoreStorage class is responsible for saving and loading the FoodStore class into a single .txtfile. It will create a new .txt file if there is no such file to be found.

1. FoodStore

• The FoodStore class contains all the information about a food store that the user inputs. It contains all the methods to retrieve any information about the store. There are 4 classes that inherits from the FoodStore class, which is the main class. The 4 classes are DeckStore, FrontierStore, TechnoStore and UTownStore.

Implementation

A general explanation for the adding a food store to the list.

1. addStore method from FoodRecommendation class takes in a FoodStore class as a parameter.
2. The method then calls the addStore method from FoodStoreUi class.
3. The addStore method from FoodStoreUi class calls the showToUser method, which shows the FoodStore as an output to the user.
4. The method will terminate and return to the addStore from FoodRecommendation, which will now call the add method from FoodStoreList, which is the ArrayList that stores all the FoodStore classes.
5. The add method will terminate and return to the addStore from FoodRecommendation, which will also terminate.

Product scope

Target user profile:

• Prefers using CLI apps

• Is a student of NUS

• Needs to manage a team

• Requires more insights on the modules they are taking

• Tend to be food savvy

Value proposition

• Have all the relevant student obligations and desires managed at a single location

User Stories

Non-Functional Requirements

{Give non-functional requirements}

Glossary

• glossary item - Definition

Instructions for manual testing

{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}