Merge pull request #150 from wwweert123/VisDG

Fix DG sequence diagram for cat and vis
AY2324S1-CS2113-T18-2 · Nov 3, 2023 · ad69fe0 · ad69fe0
2 parents 3f4327a + d95af1b
commit ad69fe0
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 21 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -31,7 +31,7 @@
 ## Acknowledgements
 
 **Xchart (A Simple Charting Library for Java)**
-- author: KNOWN
+- author: KNOWM
 - source: [https://knowm.org/open-source/xchart/](https://knowm.org/open-source/xchart/)
 
 **JSON Simple (simple Java toolkit for encoding and decoding JSON)**
@@ -125,6 +125,13 @@ VisCommand's Role:
 
 3) Calls the Visualizer to display the chart to the user
 
+As with other Commands in our Financial Planner application, the constructor of VisCommand
+takes RawCommand as parameter. The RawCommand would provide the arguments (chart type and cashflow type) 
+for the VisCommand provided. 
+
+The VisCommand also inherits from the abstract Command class which would provide the execute() abstract method
+that would be called in main()
+
 Categorizer's Role: 
 
 According to the cashflow type (Income/Expense) arugment passed in, the Categorizer sorts the 
@@ -145,11 +152,11 @@ Overall
 
 ![](images/vis/visualisationSequence.png)
 
-Categorizer
+Categorizer (`sort cashflow entries` ref from overall sequence diagram above)
 
 ![](images/vis/categorizerSequence.png)
 
-Visualizer
+Visualizer (`displaying chart` ref from overall sequence diagram above)
 
 ![](images/vis/visualizerSequence.png)
 

diff --git a/docs/diagrams/vis/categorizerSequence.puml b/docs/diagrams/vis/categorizerSequence.puml
@@ -9,10 +9,10 @@ participant "<<class>>\nCategorizer"
 
 ":VisCommand"-> "<<class>>\nCategorizer": Categorizer.sortType(cashflowList, type)
 
-alt type == "expense"
+alt "expense"
     "<<class>>\nCategorizer" -> "<<class>>\nCategorizer": sortExpenses(cashflowList)
     return
-else type == "income"
+else "income"
     "<<class>>\nCategorizer" -> "<<class>>\nCategorizer": sortIncome(cashflowList)
     return
 end

diff --git a/docs/diagrams/vis/visualisationClass.puml b/docs/diagrams/vis/visualisationClass.puml
@@ -3,14 +3,9 @@
 
 skinparam classFontColor automatic
 
-
-class "{abstract}\nCommand"  #MintCream {
-+execute() {abstract}
-}
-
 class VisCommand #MistyRose {
--String type
--String chart
+-type: String
+-chart: String
 +execute()
 }
 
@@ -33,9 +28,13 @@ class Visualizer #Beige {
 + <u>displayRadarChart (cashflowByCat: HashMap, type: String)
 }
 
+class "{abstract}\nCommand"  #MintCream {
++execute() {abstract}
+}
+
 "{abstract}\nCommand" <|-- VisCommand
 RawCommand <.. VisCommand
-Categorizer <.. Visualizer
+Categorizer <.. VisCommand
 Visualizer <.. VisCommand
 
 hide Circle

diff --git a/docs/diagrams/vis/visualisationSequence.puml b/docs/diagrams/vis/visualisationSequence.puml
@@ -5,15 +5,15 @@ participant ":Ui"
 participant "<<class>>\nCategorizer"
 participant "<<class>>\nVisualizer"
 
-":VisCommand"-> ":Ui": printDisplayChart(type)
+":VisCommand"-> ":Ui": printDisplayChartMessages(type)
 
 ref over "<<class>>\nCategorizer", ":VisCommand" : sort cashflow entries
 
-alt #Pink cashflowbyType.empty()
+alt #Pink cashflowbyType is empty
 
     ":VisCommand" -> ":Ui" : ui.printEmptyCashflow(type)
 
-else #LightBlue !cashflowbyType.empty()
+else #LightBlue cashflowbyType is not empty
 
     ref over "<<class>>\nVisualizer", ":VisCommand": displaying chart
 

diff --git a/docs/diagrams/vis/visualizerSequence.puml b/docs/diagrams/vis/visualizerSequence.puml
@@ -9,14 +9,16 @@ participant "<<class>>\nVisualizer"
 
 activate "<<class>>\nVisualizer"
 
-alt chart == "pie"
+alt "pie"
     "<<class>>\nVisualizer" -> "<<class>>\nVisualizer": displayPieChart(cashflowList, type)
-else chart == "bar"
+else "bar"
     "<<class>>\nVisualizer" -> "<<class>>\nVisualizer": displayBarChart(cashflowList, type)
-else chart == "radar"
+else "radar"
     "<<class>>\nVisualizer" -> "<<class>>\nVisualizer": displayRadarChart(cashflowList, type)
 end
 
+return
+
 hide footbox
 
 @enduml
diff --git a/docs/images/vis/categorizerSequence.png b/docs/images/vis/categorizerSequence.png
diff --git a/docs/images/vis/visualisationClass.png b/docs/images/vis/visualisationClass.png
diff --git a/docs/images/vis/visualisationSequence.png b/docs/images/vis/visualisationSequence.png
diff --git a/docs/images/vis/visualizerSequence.png b/docs/images/vis/visualizerSequence.png
diff --git a/src/main/java/seedu/financialplanner/commands/VisCommand.java b/src/main/java/seedu/financialplanner/commands/VisCommand.java
@@ -47,7 +47,7 @@ public void execute() throws FinancialPlannerException {
             ui.printEmptyCashFlow(type);
             return;
         }
-        ui.printDisplayChart(type, chart);
+        ui.printDisplayChartMessage(type, chart);
         Visualizer.displayChart(chart, cashflowByType, type);
     }
 }
diff --git a/src/main/java/seedu/financialplanner/utils/Ui.java b/src/main/java/seedu/financialplanner/utils/Ui.java
@@ -167,7 +167,7 @@ public void printResetBudget() {
         showMessage("Budget has been reset to " + Budget.getInitialBudgetString() + ".");
     }
 
-    public void printDisplayChart(String type, String chart) {
+    public void printDisplayChartMessage(String type, String chart) {
         showMessage("Displaying " + chart + "chart for " + type);
     }