Au Liang Jun - Project Portfolio

ModelManager#addFolder(CardFolder cardfolder) - Adds a specified cardfolder to the ModelManager’s list

ModelManager#deleteFolder(int index) - Deletes the CardFolder at the specified index in the ModelManager’s list

ModelManager#getActiveCardFolderIndex() - Gets the index of the current active CardFolder

ModelManager#enterFolder(int index) - Specifies the active CardFolder for operations to be performed on via the index in ModelManager’s list and sets the boolean inFolder to true to denote that user is inside a folder.

ModelManager#exitFolderToHome() - Sets the boolean inFolder to false to indicate that the user is at the home directory.

ModelManager#renameFolder(int index, String newName) - Renames the folder at the specified index in the ModelManager’s list to the new name.

ModelManager#getState() - Returns the current state of the ModelManager. The possible states are {IN_FOLDER, IN_HOMEDIR, IN_TEST, IN_REPORT}.

StorageManager#readCardFolders() - Reads in all CardFolders from all CardFolderStorage objects in the list.

StorageManager#saveCardFolders(List<ReadOnlyCardFolder> cardFolders) - Saves all CardFolders provided in the argument to the user’s data directory.

Step 1. The addfolder command is executed. For example, addfolder f.

Step 2. As with every command, the command parser reads the input and generates the relevant Command object, in this case an AddFolderCommand. The object is returned to the LogicManager.

Step 3. The LogicManager executes the AddFolderCommand, Before transferring control to the Model component with the ModelManager#addFolder() method, a few checks are performed to ensure that the user is inside a folder and the model does not already have a folder with the same name (not shown in sequence diagram).

Step 4. The ModelManager creates a VersionedCardFolder to represent the newly created folder, storing a reference to its currently empty list of cards. Before returning control to the Logic component, ModelManager#indicateModified() is invoked to notify listeners in the LogicManager that the list of CardFolders have changed.

Step 5. The Logic component takes over control and checks if the ModelManager is modified. In the case of addfolder the object is indeed modified (as a result of Step 4) and thus the component proceeds to save the Model’s CardFolders to Storage.

Step 6. Before handing over control to Storage, the LogicManager obtains the information to save and the path to save to with ModelManager#getCardFolders() and ModelManager#getCardFoldersFilesPath() respectively. It then passes these objects as parameters when it calls StorageManager#saveCardFolders().

Step 7. The Storage component receives control, with the StorageManager clearing the directory of data files at the specified path and creating JsonCardFolderStorage objects with path names equivalent to the names of the folders it has received. It then proceeds to invoke JsonCardFolderStorage#saveCardFolder() on all the JsonCardFolderStorage to save all the folders before returning to the LogicManager.

Step 8. The LogicManager terminates and returns the result of the command to the calling method.

When the user is in the home directory, fullScreenPlaceholder holds a FolderListPanel to display all the folders in a list inside the main window.

When the user is within a folder, fullScreenPlaceholder holds a CardMainScreen object, which is composed of a CardListPanel and BrowserPanel. These represent the list of cards on the scrolling sidebar, as well as the card viewer on the right. The content within the CardMainScreen depends on the particular folder the user has navigated into, as different folders hold different cards.

Step 1. The Logic component informs the UI component that the user has entered a folder. The UI component responds by invoking MainWindow#handleEnterFolder().

Step 2. UI retrieves the list of cards belonging to the entered folder from the LogicManager.

Step 3. A new CardListPanel is created with the information obtained in Step 2.

Step 4. The new CardListPanel from Step 3, together with the existing BrowserPanel, are used to create a new CardMainScreen object.

Step 5. The content held by fullScreenPlaceholder is replaced with the newly generated CardMainScreen.

Alternative 1 (current choice): List of structures representing individual folders

Alternative 2: A single structure containing Cards with information on their folder membership (folder operations performed by iterating over all cards)

Alternative 1: Use a unique folder name

Alternative 2: Identify a folder by its cards

Alternative 3 (current choice): Mixed approach, use Alternative 1 for comparing different folders and Alternative 2 for comparing the same folder across time

Alternative 1: Let folder name be the file name of the storage file

Alternative 2 (current choice): Let file name be independent of folder name, which is stored inside the storage file itself

Alternative 1: Display a sample folder

Alternative 2: Display non-corrupted folders

Alternative 3 (current choice): Mixed approach, display all non-corrupted folders unless all data is corrupted, in which case display sample folder

The commands that affect cards (e.g. adding a card, editing a card) are executed within folders and are known as Card Operations.

Commands that affect folders (e.g. adding a folder, deleting a folder) are only executable at the home directory and are known as Folder Operations.

Alternative 1 (current choice): Use variations of the same command (e.g. cd .. and cd INDEX )

Alternative 2: Use distinct commands (e.g. home and enter INDEX)

A folder of the desired name is created.

A particular folder as selected by the student is renamed to the desired name.