Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update DG Storage #275

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,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.
Loading