Eng Xuan En - Project Portfolio

Here is how you can clear the order list and return order list by following the steps below:

Step 1 : Type in the keyword clear.
Step 2 (Optional) : Provides the -f flag if you confirm that you would like to force clear both order list and return order list.
Step 3 (Optional) : Provides the -o or -r flag if you only want to clear either order list or return order list respectively.
Step 4 : Press Enter on your keyboard to send the instruction to Delino.

In this section, you will learn about the syntax for a valid clear command and the possible combinations of the command.

The syntax for a valid clear command can be seen below:

These are the possible combinations of the clear command:

Here is how you can import the orders and return orders into Delino by following the steps below:

Step 1 : Type in the keyword import.
Step 2 : Provide the CSV file name that you would like to import with the .csv extension behind.
Step 3 : Press Enter on your keyboard to send the instruction to Delino.

In this section, you will learn about the syntax of a valid import command, the format for both orders and return orders in the CSV file and the possible combination for the import command.

The syntax for a valid import command can be seen below:

The data in the CSV file should be written in the following format:

There is only one possible combination for the import Command:

The clear feature was implemented as a ClearCommand in the logic package.
The clear feature allows the user to remove the orders and return orders by input one command line.

The execution path of the clear command is shown below:

After user enter the clear command, the ClearCommandParser will run the following two checks:

If either one of the conditions occurs, exception will be thrown and the error message will be display to the user. Afterward, the new ClearCommand object will be executed.

During the execution of the clear command:

The following diagrams shows the overview of the clear command Class Diagram:

In the ClearCommand class, there are also some static messages for the different input command the user has key in:

In this section, the interactions between objects when clear command is executed will be display in the Clear Command Sequence Diagram below:

The above sequence diagram illustrate how the clear Command is being processed when the user inputs clear -f to force clear all of the orders and return orders without any prompt.

After the user input. the arguments passed to the clear command will be parsed by the ClearCommandParser class
If the given arguments are valid, a new ClearCommand object will be returned.

In ClearCommandParser, there will be two validation checks:
1. Ensure the flag is one of the three flags: -f, -o and -r
2. Ensure the arguments do not have both -o and -r flags.

After the two validation checks, the flag will be added into HashSet, flags which will then passed to the new ClearCommand object created by ClearCommandParser and it is being returned to the LogicManager. The LogicManager will start to run the execute the clear command, which will be shown in details in below diagram:

After LogicManager call the ClearCommand#execute(model), the clear command will update the model by pass a new OrderBook object and a new ReturnOrderBook object to Model. The Model will then update its own orderBook and returnOrderBook. In addition, the clear command will pass back a new CommandResult object with the success message in it to the LogicManager at the end of the execution.

The import feature was implemented as the ImportCommand in the logic package.
The import feature allows users to save the trouble of adding the delivery orders and the return orders one by one when they have large amount of delivery orders or return orders to add into Delino.

The execution path of the ImportCommand is shown below:

After the user enter the import command, there are three validation check for the file based on the input argument, FILE_NAME:

Afterward, a new ImportCommand will be created and executed. For every data inside the list, either order or return order will be added into the order book and return order book respectively based on the orderType value. If the orderType is invalid, add the data into the result, which will be displayed to the user after processing.

The following diagram shows the overview structure of the ImportCommand Class Diagram:

In the ImportCommand Class, there are also a few static message to display to the user for the various scenarios occurred during the importing of data from the CSV file:

In this section, the interactions between the objects when ImportCommand is executed will be shown in the Import Command Sequence Diagram below:

The arguments passed to the import command will be parsed by the ImportCommandParser class.
Then, the ImportCommandParser will called the ParseUtil#parseCsvFile() to get the filePath based on the input the user provides. Afterward, CsvProcessor will be called to retrieve the data from the csv file and return the processed fileData back to ParseUtil. The fileData will be further pass to ImportCommandParser and to the constructor of ImportCommand.

Afterward, the ImportCommand object is being returned to the LogicManager and the LogicManager will start to run the execute the ImportCommand, which will be shown at the diagram below.

The ImportCommand#execute() will first check if the data given starts with order or return and pass to the InsertCommandParser or ReturnCommandParser respectively.

Afterwards, InsertCommandParser or ReturnCommandParser will return a new InsertCommand or ReturnCommand respectively if it successfully parse the data. The ImportCommand will then call the InsertCommand#execute() or ReturnCommand#execute() depend whether it is delivery order or return order. This will cause a delivery order or return order being added into the Model.

The ImportCommand will call its own printResult() function and return a String message to the CommandResult object which is then pass back to the LogicManager.