Update DG Storage Components and Implementation

docs/uml/content/AddingContentSequenceDiagram.puml

@@ -0,0 +1,27 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+skinparam sequenceMessageAlign center
+
+box Command #thistle
+participant ":AddNoteCommand" as AddNoteCommand #violet
+endbox
+
+box Content #goldenrod
+participant ":ContentManager" as ContentManager #gold
+participant ":Note" as Note #gold
+endbox
+
+-> AddNoteCommand : execute()
+activate AddNoteCommand
+create Note
+AddNoteCommand -> Note : Note()
+activate Note
+return
+AddNoteCommand -> ContentManager : add(:Note)
+activate ContentManager
+note right : Add the new Note into \nthe arraylist of Note \nin ContentManager.
+return
+return :CommandResult
+
+@enduml

docs/uml/content/DeletingContentSequenceDiagram.puml

@@ -0,0 +1,36 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+
+skinparam sequenceMessageAlign center
+
+box Command #thistle
+participant ":DeleteCommand" as DeleteCommand #violet
+endbox
+
+box Content #goldenrod
+participant ":ContentManager" as ContentManager #gold
+participant ":Content" as Content #gold
+endbox
+
+-> DeleteCommand : execute()
+activate DeleteCommand
+DeleteCommand -> ContentManager : deleteContent(contentNumber:int)
+activate ContentManager
+ContentManager -> ContentManager : isNotValidNumber(:int)
+activate ContentManager
+note left : Invalid contentNumber: \ncontentNumber < 1 and \ncontentNumber > the size of arraylist
+return
+alt contentNumber is not valid
+ContentManager --> DeleteCommand : InvalidArgumentException()
+else else
+ContentManager -> Content : getName()
+activate Content
+return
+note left : Remove the Content from \nthe arraylist of Content \nin ContentManager.
+destroy Content
+end
+return deletedContentName:String
+return :CommandResult
+
+@enduml

docs/uml/storage/Storage.puml

@@ -1,7 +1,8 @@
 @startuml
 'https://plantuml.com/class-diagram
 
-
+hide circle
+skinparam classAttributeIconSize 0
 
 'abstract class DGS
 'abstract AbstractCollection
@@ -15,38 +16,80 @@
 'AbstractCollection <|- AbstractList
 'AbstractList <|-- ArrayList
 
-Terminus "1" --> "1  " ModuleStorage: moduleStorage
+StorageManager --> "1" NoteStorage
+StorageManager --> "1" PdfStorage
+StorageManager --> "1" JsonStorage
+StorageManager --> "1" FolderStorage
+
+FilterManager <.. StorageManager : "filters \n ModuleManager <"
 
-Command "0..*  " ..> "0..1 " ModuleStorage: uses >
+NoteStorage --|> Storage
+PdfStorage --|> Storage
+JsonStorage --|> Storage
+FolderStorage --|> Storage
 
-class Terminus {
-  + main(): void {static}
-  + run(): void
-  - start(): void
-  - runUntilCommandExit(): void
-  - handleIoException(e: IOException): void
-  - exit(): void
+class StorageManager #mistyrose{
+  - isDisabled : Boolean
+  - baseDirectory : Path
+  + StorageManager(Path baseDirectory, String mainJsonFileName)
+  + executeCommandResult(ModuleManager moduleManager, CommandResult result) : void
+  + updateMainJsonFile(ModuleManager moduleManager) : void
+  + initialize() : ModuleManager
+  + save() : void
 }
 
-class ModuleStorage {
-  - filePath: Path
-  - gson: Gson
-  - ModuleStorage()
-  + init(filePath: Path): void
-  + getInstance(): ModuleStorage {static}
-  + loadFile(): ModuleManager
-  + saveFile(moduleManager: ModuleManager): void
-  + loadNotesFromModule(moduleManager: ModuleManager, mod: String): void
-  + saveAllNotes(moduleManager: ModuleManager): void
-  + saveNotesFromModule(moduleManager: ModuleManager, mod: String, toDeleteAll: Boolean): void
-  + removeNoteFromModule(moduleName: String, noteName, String): void
-  + addNoteFromModule(moduleName: String, newNote: Note): void
-  + createModuleDirectory(moduleName: String): boolean
-  + cleanAfterDeleteModule(mod: String): void
+class NoteStorage #mistyrose{
+  + execute() : void
+  # createNoteFile() : void
+  # loadNoteIntoModuleManager() : void
+  # saveAllNotes() : void
 }
 
-abstract Command {
+class PdfStorage #mistyrose{
+  + execute() : void
+  # exportModuleNotes() : void
+}
 
+class JsonStorage #mistyrose{
+  + execute() : void
+  + loadJson() : ModuleManager
+  # createJson() : void
+  # saveJson() : void
 }
 
+class FolderStorage #mistyrose{
+  + execute() : void
+  # createModuleFolder() : void
+  # deleteModuleFolder() : void
+  # renameModuleFolder() : void
+}
+
+class Storage #mistyrose{
+ + createFolder(Path folderPath) : void
+ + createFile(Path filePath) : void
+ + readFile(Path filePath) : String
+ + writeFile(Path filePath, String data): void
+ + delete(Path filePath) : void
+ + getListOfFiles(Path folderPath) : File[]
+ + renameFolder(Path oldPath, Path newPath) : void
+ + getBufferedReader(Path filePath) : void
+ + getFileType(File file) : String
+ + getAppendPath(Path corePath, String path) : Path
+ # cleanAllFilesInclusive(Path filePath) : void
+
+}
+
+class FilterManager #mistyrose{
+  + filter(ModuleManager moduleManager) : void
+  # filterLink(ContentManager<Link> linkContentManager) : void
+  # filterQuestion(ContentManager<Question> questionContentManager) : void
+  + {static} isQuestionValid(Question question) : Boolean
+  + {static} isScheduleValid(Link link) : Boolean
+  + {static} isModuleValid(String module) : Boolean
+
+}
+
+note "The input parameters in all functions \nfor <Type>Storage has been left out \nto make this diagram more compact." as note1
+
+
 @enduml

docs/uml/storage/StorageCommandResultSequenceDiagram.puml

@@ -0,0 +1,50 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+skinparam sequenceMessageAlign center
+
+box Terminus #whitesmoke
+participant ":Terminus" as Terminus #white
+endbox
+
+box Storage #lightpink
+participant ":StorageManager" as StorageManager #mistyrose
+participant ":JsonStorage" as JsonStorage #mistyrose
+participant ":PdfStorage" as PdfStorage #mistyrose
+participant ":FolderStorage" as FolderStorage #mistyrose
+participant ":NoteStorage" as NoteStorage #mistyrose
+endbox
+
+
+activate Terminus
+opt CommandResult has data change
+Terminus -> StorageManager : executeCommandResult(:ModuleManager, :CommandResult)
+activate StorageManager
+StorageManager -> StorageManager : execute()
+activate StorageManager
+note right : execute() takes in the following arguments \n\nmoduleManager : ModuleManager \naffectedModule : String \ndeletedItemName : String \nstorageAction : StorageActionEnum \nstorageType : StorageTypeEnum
+alt StorageTypeEnum == JSON
+StorageManager -> JsonStorage : execute(moduleManager, storageAction)
+activate JsonStorage
+return
+else PDF
+StorageManager -> PdfStorage : execute(affectedModule, deletedItemName, storageAction)
+activate PdfStorage
+return
+else FOLDER
+StorageManager -> FolderStorage : execute(affectedModule, deletedItemName, storageAction)
+activate FolderStorage
+return
+else NOTE
+StorageManager -> NoteStorage : execute(moduleManager, affectedModule, deletedItemName, storageAction)
+activate NoteStorage
+return
+end
+return
+return
+end
+
+
+
+
+@enduml