Skip to content

Commit

Permalink
Merge pull request #275 from owenyeo/v1.4-updatedg-0
Browse files Browse the repository at this point in the history
Update DG Storage
  • Loading branch information
kristayeo authored Nov 10, 2023
2 parents d9c2f05 + a99ed30 commit 818fa37
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 5 deletions.
6 changes: 6 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,12 @@ The `Storage` component,
* inherits from `AddressBookStorage`, `UserPrefStorage`, and `UserDataStorage` which means it can be treated as any one (if only the functionality of only one is needed).
* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)

<img src = "images/TimetableStorageClassDiagram.png" width="550" />

The `Timetable` Classes
* Allows users to save their friends' and their own timetables in JSON format, and read them back into corresponding objects
* Depends on the related files in `Model`.

### Common classes

Classes used by multiple components are in the `seedu.addressbook.commons` package.
Expand Down
12 changes: 7 additions & 5 deletions docs/diagrams/StorageClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ package "UserData Storage" {
Class "<<interface>>\nUserDataStorage" as UserDataStorage
Class JsonUserDataStorage
Class JsonSerializableUserData
Class JsonAdaptedUser
}

Class "<<interface>>\nStorage" as Storage
Expand All @@ -26,11 +27,11 @@ Class JsonAddressBookStorage
Class JsonSerializableAddressBook
Class JsonAdaptedPerson
Class JsonAdaptedTag
Class JsonAdaptedFreeTime
}



}
package "Timetable Classes"{
}
}

Class HiddenOutside #FFFFFF
Expand All @@ -50,9 +51,10 @@ JsonUserDataStorage .up.|> UserDataStorage
JsonAddressBookStorage .up.|> AddressBookStorage
JsonUserDataStorage ..> JsonSerializableUserData
JsonAddressBookStorage ..> JsonSerializableAddressBook
JsonSerializableUserData --> "1" JsonAdaptedPerson
JsonSerializableUserData --> "1" JsonAdaptedUser
JsonSerializableAddressBook --> "*" JsonAdaptedPerson
JsonAdaptedPerson --> "*" JsonAdaptedTag
JsonAdaptedPerson --> "*" JsonAdaptedFreeTime
JsonAdaptedPerson --> "Timetable Classes"
JsonAdaptedUser --> "Timetable Classes"

@enduml
22 changes: 22 additions & 0 deletions docs/diagrams/TimetableStorageClassDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
@startuml
!include style.puml
skinparam arrowThickness 1.1
skinparam arrowColor STORAGE_COLOR
skinparam classBackgroundColor STORAGE_COLOR

Class JsonAdaptedPerson
Class JsonAdaptedUser

package "Timetable Classes"{
Class JsonAdaptedSchedule
Class JsonAdaptedModule
Class JsonAdaptedCca
Class JsonAdaptedDatedEvent

JsonAdaptedSchedule *--> "*" JsonAdaptedModule
JsonAdaptedSchedule *--> "*" JsonAdaptedCca
JsonAdaptedSchedule *--> "*" JsonAdaptedDatedEvent
}

JsonAdaptedPerson *--> "1" JsonAdaptedSchedule
JsonAdaptedUser *--> "1" JsonAdaptedSchedule
Binary file modified docs/images/StorageClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/TimetableStorageClassDiagram.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 818fa37

Please sign in to comment.