Lim Ming Hong - Project Portfolio

This feature implements a new method in Model

The BackupList object holds a map of files with indexes as its keys. It also has an array of String. The position of the strings corresponds to the index of the file it represents in the map.

This feature implements a new method in Model

Step 1. The user executes backup to create a backup snapshot

Step 2. The user input is first parsed by AddressBookParser which creates a new BackupCommand object.

Step 3. BackupCommand is executed and calls Model#backUpAddressbook(Path) with the path of the .backup folder as the argument. This creates a copy of the address book data in the folder as an XML file.

Step 4. An AddressBookStorage will be created in the Model#backUpAddressbook(Path) method which facilitates the saving of the data of address book.

Step 5. saveAddressBook() will be called to save the data of the address book.

The following sequence diagrams shows you how the add operation works:

Figure 1. Interactions inside the Logic component for the backup command.

Figure 2. Interactions inside the Storage component for the backup command.

Step 1. The user executes restore-snapshots to get a list of all backup snapshots

Step 2. The user input is first parsed by AddressBookParser which creates a new RestoreSnapshotsCommand object.

Step 3. RestoreSnapshotsCommand is executed and calls readBackupList(String) with the directory of the .backup folder as the argument. This reads a BackupList from the given destination path. A list of formatted file names will be created which will be shown to the user.

The following sequence diagrams shows you how the add operation works:

Figure 3. Interactions inside the Logic component for the restore-snapshots command.

Step 1. The user executes restore 1 to restore their data with a backup snapshot denoted by an index of 1

Step 2. The user input is first parsed by AddressBookParser which creates a new RestoreCommandParser object.

Step 3. The argument, 1, is then parsed by RestoreCommandParser.

Step 4. RestoreCommandParser checks the validity of the index as input by the user. It then creates a BackupList object.

Step 5. RestoreCommandParser then creates a new RestoreCommand with the BackupList and index as its arguments.

Step 6. RestoreCommand is executed and calls Model#replaceData(Path) which replaces the data of the address book with the XML file denoted by the Path.

Step 7. A XmlAddressBookStorage will be initialised which helps to read the data of the XML file.

Step 8. The address book will be overwritten with the new data by calling resetData with the new data as its argument.

Figure 4. Interactions inside the Logic component for the restore 1 command.

Figure 5. Interactions inside the Storage component for the restore 1 command.

CsvWriter is an object that takes in a path of where the export is to be saved and write a CSV file into the said path.
The conversion is as follows:
Step 1. The constructor converts an ObservableList<Person> into a List<Person> Step 2. The convertToCsv() method will be called in ExportCommand and a new CSV file will be written with the content of the created List<Person>.
Step 3. This file will be created in the path.

CsvReader is an object that takes in a CSV file and converts it into a list of persons.
The conversion is as follows:
Step 1. The constructor reads a CSV file line by line.
Step 2. The convertToList method formats the file into a Model friendly format.
Step 3. It then converts the strings into a persons.
Step 4. These persons are then stored in a List<Person> and returned.

Step 1. The user executes export d/C:\Users\USER\Desktop\DemoExport f/test to export their data to the directory with the file name the user wants.

Step 2. The user input is first parsed by AddressBookParser which creates a new ExportCommandParser object.

Step 3. The argument, d/C:\Users\USER\Desktop\DemoExport f/test, is then parsed by ExportCommandParser.

Step 4. ExportCommandParser checks the validity of the directory as input by the user. It then creates a ExportCommand object with the directory and file name as its arguments.

Step 5. ExportCommand is executed and creates a CsvWriter object. The CsvWriter object is created with a copy of the address book taken from Model

Step 6. convertToCsv(String directory) is called with the full directory as the argument which writes the data of the address book to a file of CSV format.

The following sequence diagrams shows you how the add operation works:

Figure 1. Interactions inside the Logic component for the export d/C:\Users\USER\Desktop\DemoExport f/test command.

Figure 2. Interactions inside the Storage component for the export d/C:\Users\USER\Desktop\DemoExport f/test command.

Step 1. The user executes import d/C:\Users\USER\Desktop\DemoExport f/test to import their data from the directory with the name of the file.

Step 2. The user input is first parsed by AddressBookParser which creates a new ImportCommandParser object.

Step 3. The argument, d/C:\Users\USER\Desktop\DemoExport f/test, is then parsed by ImportCommandParser.

Step 4. ImportCommandParser checks the validity of the directory as input by the user. It then creates a ImportCommand object with the directory and file.

Step 5. ImportCommand is executed and creates a CsvReader object. The CsvReader object is created with the file identified

Step 6. convertToList() is called which creates a list of persons that can be added.

Step 7. There is a loop that iterates through the list and add the persons into the address book. All duplicated persons will be skipped.

The following sequence diagrams shows you how the add operation works:

Figure 1. Interactions inside the Logic component for the import d/C:\Users\USER\Desktop\DemoExport f/test command.