Quek Wei Ping - Project Portfolio

This command allows you to have a basic summary of the money spent from their categorical expenses in a given period of their current budget.

The visual output of the statistics shown is a pie chart, with each piece representing the combined expenditure of all expenses under the category, taken as a percentage of the total expenditure in the budget the command was called.

Format: statsbasic [sd/<START_DATE>] [ed/<END_DATE>]

Tips:

Example of configurations:

Step-by-step guide: For example, MooLah is currently at the "Outside School" budget, and shown below is the view of the current window of the Budget from start of 18 Oct to the end of 24 Oct. There are exactly 4 expenses as shown in the example.

To generate the pie chart for the expenses for this window.

This command allows you to have a side-to-side comparison of the money spent from their categorical expenses in 2 periods of their current budget. In this comparison, we provide you with data of both the similarities and differences in these 2 periods.

The visual output of the statistics shown is a table view, with 5 columns, consisting of a category column, and 2 pairs of frequency-total expenditure columns. The cells in the first pair of columns, denoted as "similarity columns" represents the frequency and total expenditure in any existing overlapping interval between the 2 periods, while the cells in the second pair of columns, denoted as the "difference columns" represents the difference in frequency and difference in total expenditure.

Format: statscompare sd1/<START_DATE_1> sd2/<START_DATE_2>

Example of configurations:

Example with expected output: Test case: Create a new budget, one possible way is addbudget d/school p/3.00 sd/28-10 pr/day. then enter statscompare sd1/12-12 sd2/ 1 month ago

Expected: A success message of "Statistics Comparison Calculated!" appears with the the title "Statistics Summary: Comparing 12-12-2019 to 12-12-2019 with 12-10-2019 to 12-10-2019" but all entries reflect 0 for frequency and 0.00 for amount.

This command allows you to see the growth of the money spent from your categorical expenses in fixed units of time between the interval that you’re interested in finding out

The visual output of the statistics shown is in the form of plotted trend lines.

Currently 2 modes of usage can be selected.

The first one is a category mode where each individual trend lines represents one categories and every plotted point on a line represents the total expenditure starting from its stated date, till before the stated date of the next point.

The second mode is a budget mode where only 2 trend lines can be observed. The first trend line represents the budget limit where every plotted point represents the budget limit set starting from its stated date, till before the stated date of the next point.

The second trend line represents the total expenditure for all expenses regardless of category, where every plotted point represents the total expenditure starting from its stated date, till before the stated date of the next point.

Format: statstrend [sd/<START_DATE>] [ed/<END_DATE>] mode/MODE

Tips:

Example of configurations:

Example with expected output:

Test case: Create a new budget, one possible way is addbudget d/school p/3.00 sd/28-10 pr/day. Next, add an expense to the empty budget with addexpense d/ chicken rice p/2.50 c/food t/28-10 and type statstrend mode/category sd/28-10

Expected: A success message of "Statistics Trend Calculated!" appears with the title "Periodic trendline from 28-10-2019 to 29-11-2019 in the unit of days", 1 trend line for food is observed, with the first plotted point of the line being the highest non-zero point at y-axis = 2.50

The statistics feature allows users to have an alternative view for the entries in MooLah. It is facilitated by the Statistics interface, which is part of the model package, and is implemented by 3 classes PieChartStatistics, TabularStatistics and TrendStatistics. Each of the implementing classes will be invoked when their respective parsers detect its corresponding command word, which is statsbasic, statscompare and statstrend. The prefix configurations vary greatly between them as well as the visual representation they create.

Given below is a class diagram to summarise the relationship between Statistics and its implementing classes.

The main entries that Statistics interacts with are Expense class and the Budget class. The entire statistics features only supports the generating of statistics from only the current budget and responds to the different methods called by the current Budget object. Every successful interaction will force a switch to the Statistics Panel, where each of their different visual representations will be generated.

The following activity diagram summarizes how statistics are shown from a current budget after possible user inputs to modify the attributes of the budget.

In the following sections, the implementation details of one of the more complicated command words will be discussed, as well as its design considerations.

The purpose of the statsbasic command word is to request MooLah to visualise the total expenditure across expenses of different categories as a percentage of the total expenditure of all expenses tracked under the budget where the command is called. The visual representation used here will be a PieChart.

Given below is an example usage scenario and how the statsbasic command word is handled by MooLah.

Step 1. The user enters the command statsbasic sd/01-10-2019 ed/01-11-2019 to visualise the total percentage of each category as a percentage of total expenditure across all categories, in the primary budget. The command is received by MooLahParser, which then creates a StatsCommandParser object, to subsequently help to parse the input by the user.

Step 2. The newly created StatsCommandParser calls parse("stats sd/01-10-2019 ed/01-11-2019"), which in turns calls ArgumentTokenizer#tokenize("sd/01-10-2019 ed/01-11-2019", PREFIX_START_DATE, PREFIX_END_DATE) to split the arguments into its preamble(the start date and end date). This returns an ArgumentMultimap object, argMultimap containing the split input.

Step 3. The StatsCommandParser object creates a StatsDescriptor object desc to hold the start date and end date that was specified by the user. Depending on the presence of start date and end date, desc will be filled in differently.

If the start date and end date is both specified by the user, the end date will be checked to not be before the start date. If the end date happens to be before the start date, a ParseException will be thrown

Step 4. The filled desc will be returned to the LogicManager where a new StatsCommand object, statsCommand will be created with desc

Step 5. The LogicManager calls StatsCommand#run(), where the StatsCommand will be validated before getting executed.

Step 6. During execution, StatsCommand calls ModelManager#getPrimaryBudget() to retrieve the primary budget to calculate statistics from. After which, StatsCommand will call createPieChartStatistics, which takes in desc and the primary budget.

Step 7. To construct the time interval required for statistics, information from desc is being processed. If there are unspecified inputs inside desc, the time interval will be constructed with some information from the primary budget.

Step 8. The PieChartStatistics object will be created with the constructed interval as well as the expenses the primary budget tracks. After which, StatsCommand will call the PieChartStatistics implementation of populateData() to fill up its other fields

Step 9. StatsCommand calls ModelManager#setStatistics(statistics) which updates the Statistics attribute in ModelManager.

Step 10. A CommandResult is then created and returned to LogicManager, which will then force a switch to the Statistics Panel where a Pie Chart will be generated.

The following sequence diagram shows how the statsbasic operation works:

Figure 1. Sequence Diagram for executing a StatsCommand

When designing the interaction of the command word statsbasic, decisions have to be made on the most suitable visual representation for statsbasic particular use case.

For more sequence diagrams, you can find them below Figure 1 (here)