Skip to content

Commit

Permalink
Merge pull request #219 from biinnnggggg/improve-dg-model-class-diagram
Browse files Browse the repository at this point in the history
Update ModelClassDiagram in the DG
  • Loading branch information
JonChong98 authored Apr 15, 2024
2 parents b909776 + 8833cf9 commit 73f3113
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 0 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,6 @@ and all associated `Appointment` objects (which are contained in a `DisjointAppo
* stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects.
* does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components)

<div markdown="span" class="alert alert-info">:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.<br>

<img src="images/BetterModelClassDiagram.png" width="450" />

</div>


### Storage component

Expand Down
8 changes: 7 additions & 1 deletion docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Class Phone
Class Tag
Class Appointment
Class Note
class Subject
class Level

Class I #FFFFFF
}
Expand All @@ -48,7 +50,9 @@ Person *--> Phone
Person *--> Email
Person *--> Address
Person *--> "*" Tag
Person *--> "*" Note
Person *--> Note
Person *--> Level
Person *--> "0...4" Subject

Person -[hidden]up--> I
UniquePersonList -[hidden]right-> I
Expand All @@ -61,6 +65,8 @@ Name -[hidden]right-> Phone
Phone -[hidden]right-> Address
Address -[hidden]right-> Email
Email -[hidden]right-> Tag
Tag -[hidden]right-> Subject
Subject -[hidden]right-> Level

ModelManager --> "~* filtered" Person
@enduml
Binary file modified docs/images/ModelClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 73f3113

Please sign in to comment.