Jeremy Loye Hean Wei - Project Portfolio

The user enters a set command (e.g. set $/120). The command is passed down and received by the LogicManager.

The LogicManger calls the FinanceTrackerParser#ParseCommand() method which creates a SetCommandParser object. The FinanceTrackerParser#ParseCommand() method then calls the SetCommandParser#parse() method, passing in the amount argument entered by the user ("120" in example).

SetCommandParser#parse() calls ParserUtil#ParseAmount() to handle the parsing of the amount. The method checks if the argument is a valid amount value and throws an exception if it is not. If there are no exceptions, ParserUtil#ParseAmount() returns the processed amount string. SetCommandParser#parse() then creates a SetCommand with the processed amount ("120" in example) and the new SetCommand gets passed back to the LogicManager.

Now that the command is processed, LogicManager#execute() calls SetCommand#execute() to execute the command. SetCommand#execute() creates a new Budget object initialised with the amount (budget of 120 created in example). The Budget object (labelled p) is then passed to the ModelManager by the ModelManager#addBudget() method.

ModelManager#addBudget() calls FinanceTracker#addBudget() to update the budget of the current instance of the Finance Tracker. FinanceTracker#addBudget() updates the TotalBudget object field (labelled q) in FinanceTracker by calling TotalBudget#updateBudget() and passing the Budget p and the records stored in the FinanceTracker.

TotalBudget#updateBudget() first checks whether the new budget set is more than or equal to the sum of the category budgets and throws an exception if it is not. It then gets the budget data (totalBudget, currentBudget) from Budget p and sets it using TotalBudget#set() (total budget of app is now 120 in example). It then updates the current budget and spending based on the records that was stored and passed in by the FinanceTracker. This is shown in the code snippet below:

public void updateBudget(Budget budget, ObservableList<Record> records) throws
            CategoryBudgetExceedTotalBudgetException {
        Double totalCategoryBudget = 0.0;
        for (CategoryBudget cb: this.categoryBudgets) {
            totalCategoryBudget += cb.getTotalBudget();
        }
        if (budget.getTotalBudget() < totalCategoryBudget) {
            throw new CategoryBudgetExceedTotalBudgetException(budget, totalCategoryBudget);
        }
        set(budget.getTotalBudget(), budget.getCurrentBudget());
        updateBudget(records);
    }

Once TotalBudget q has finished updating, control is passed all the way back to SetCommand#execute() which will create a CommandResult (labelled result). The result is passed back to LogicManager#execute and all the way to the user to show that the budget has been set (Budget set to 120 in example).

Although not shown in the diagram, the UI is then updated with the new budget. The UI update of budget data will be covered in Updating the UI with Budget Data.

The command is first executed by the LogicManager. The execution of commands will update the budget data in the Finance Tracker as specified in previous sections. The success message of the command is then displayed to the user (Result of command that user typed).

There is then a conditional check on whether the command has changed the budget data (Based on CommandResult passed back from command execution). For brevity and based on the scope of the section, the other conditional checks for the command will be excluded. List of Commands that change budget: spend, edit, delete, set, allocate, clear, setfile, undo, redo

When it has been determined that the command has altered budget data, 3 components of the UI need to be updated before continuing. If you are unfamiliar with the components of the UI, refer to the Graphical User Interface section of our User Guide.

After the UI is updated, there is another check to see if the command given was summary. If it was, the current Panel being displayed (BrowserPanel or SummaryPanel) is swapped to the other panel. Again, refer to the Summary section below for more implementation details.

The method ends by returning the CommandResult that was returned from the execution of command to the MainApp.