Add new UML diagrams

Author: channne

docs/DeveloperGuide.md

@@ -257,7 +257,7 @@ The implementation of `labedit` is as follows:
 
 6. The `EditLabCommand` calls `LabList#setLab` of the student specified by the given `INDEX`, which edits the target `Lab` to the new `Lab`.
 
-The following sequence diagram shows the interactions between components during the execution of the `labedit` command:
+The following sequence diagram shows the interactions between components during a `labedit` command, `labedit l/1 s/u`:
 
 <img src="images/EditLabCommandSequenceDiagram.png" width="850" />
 
@@ -272,9 +272,9 @@ The detailed steps are as follows:
 1. `LabList#setLab` checks if the edited `Lab` is the same as the original `Lab`, and whether the target `Lab` exists in the `LabList`.
 2. `LabList#setLab` edits the target `Lab` to the new `Lab` with different `LabStatus` and/or `LabMark`.
 
-To summarize, the following activity diagram summarizes what happens when the user requests to edit a lab:
+To summarize, the following activity diagram shows what happens when the user requests to edit a lab:
 
-<img src="images/EditLabCommandActivityDiagram.png" width="600" />
+<img src="images/EditLabCommandActivityDiagram.png" width="500" />
 
 
 ### \[Proposed\] Undo/redo feature

docs/diagrams/EditLabCommandActivityDiagram.puml

@@ -0,0 +1,30 @@
+@startuml
+'https://plantuml.com/activity-diagram-beta
+
+start
+:User executes labedit command;
+if () then ([valid command format])
+  if () then ([index out of bounds])
+    :Displays error message;
+  else ([else])
+    if () then ([valid combination of LabStatus and LabMark])
+      if () then ([LabMark is 'Unknown'])
+        :Creates new lab with given LabStatus;
+      else ([else])
+        :Creates new lab with LabStatus GRADED and given LabMark;
+      endif
+      if () then ([target lab exists and is different from new lab])
+        :Edits target lab to new lab;
+      else ([else])
+        :Displays error message;
+      endif
+    else ([else])
+      :Displays error message;
+    endif
+  endif
+ else ([invalid command format or parameters])
+    :Displays error message;
+ endif
+stop
+
+@enduml

docs/diagrams/EditLabCommandSequenceDiagram.puml

@@ -0,0 +1,97 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":EditLabCommandParser" as EditLabCommandParser LOGIC_COLOR
+participant "e:EditLabCommand" as EditLabCommand LOGIC_COLOR
+participant "c:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:Model" as Model MODEL_COLOR
+participant ":List<Student>" as List MODEL_COLOR
+participant "s:Student" as Student MODEL_COLOR
+participant "list:LabList" as LabList MODEL_COLOR
+end box
+
+[-> LogicManager : execute("labedit l/1 s/u")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("labedit l/1 s/u")
+activate AddressBookParser
+
+create EditLabCommandParser
+AddressBookParser -> EditLabCommandParser
+activate EditLabCommandParser
+
+EditLabCommandParser --> AddressBookParser
+deactivate EditLabCommandParser
+
+AddressBookParser -> EditLabCommandParser : parse("l/1 s/u")
+activate EditLabCommandParser
+
+create EditLabCommand
+EditLabCommandParser -> EditLabCommand
+activate EditLabCommand
+
+EditLabCommand --> EditLabCommandParser : e
+deactivate EditLabCommand
+
+EditLabCommandParser --> AddressBookParser : e
+deactivate EditLabCommandParser
+EditLabCommandParser -[hidden]-> AddressBookParser
+destroy EditLabCommandParser
+
+AddressBookParser --> LogicManager : e
+deactivate AddressBookParser
+
+LogicManager -> EditLabCommand : execute(m)
+activate EditLabCommand
+
+EditLabCommand -> Model : getFilteredStudentList()
+activate Model
+
+Model --> EditLabCommand
+deactivate Model
+
+EditLabCommand -> List : get(index)
+activate List
+
+List --> EditLabCommand : s
+deactivate List
+
+EditLabCommand -> Student : getLabs()
+activate Student
+
+Student --> EditLabCommand : list
+deactivate Student
+
+EditLabCommand -> LabList : getLab()
+activate LabList
+
+LabList --> EditLabCommand : labToEdit
+deactivate LabList
+
+EditLabCommand -> LabList : setLab(labToEdit, editedLab)
+activate LabList
+
+LabList --> EditLabCommand
+deactivate LabList
+
+create CommandResult
+EditLabCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> EditLabCommand
+deactivate CommandResult
+
+EditLabCommand --> LogicManager
+deactivate EditLabCommand
+
+[<--LogicManager :
+deactivate LogicManager
+
+@enduml

docs/diagrams/LabListSetLabSequenceDiagram.puml

@@ -0,0 +1,35 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+!include style.puml
+
+box Model MODEL_COLOR_T1
+participant "LabList" as LabList MODEL_COLOR
+participant "target:Lab" as Lab MODEL_COLOR
+participant ":ObservableList<Lab>" as ObservableList MODEL_COLOR
+end box
+
+[-> LabList : setLab(target, editedLab)
+activate LabList
+
+LabList -> Lab : equals(editedLab)
+activate Lab
+
+Lab --> LabList
+deactivate Lab
+
+LabList -> ObservableList : indexOf(target)
+activate ObservableList
+
+ObservableList --> LabList
+deactivate ObservableList
+
+LabList -> ObservableList : set(target, editedLab)
+activate ObservableList
+
+ObservableList --> LabList
+deactivate ObservableList
+
+[<-- LabList
+deactivate LabList
+
+@enduml