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 #129

Merged
merged 4 commits into from
Oct 27, 2020
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
299 changes: 219 additions & 80 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

43 changes: 41 additions & 2 deletions docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ Interface ReadOnlyAddressBook <<Interface>>
Interface Model <<Interface>>
Interface ObservableList <<Interface>>
Class AddressBook
Class ReadOnlyAddressBook
Interface ReadOnlyAddressBook <<Interface>>
Class BookingBook
Interface ReadOnlyBookingBook <<Interface>>
Class RoomBook
Interface ReadOnlyRoomBook <<Interface>>
Class RoomServiceBook
Interface ReadOnlyRoomServiceBook <<Interface>>
Class Model
Class ModelManager
Class UserPrefs
Expand All @@ -28,17 +34,38 @@ Package Tag {
Class Tag
}

Package Booking {
Class Booking
Class UniqueBookingList
}

Package Room {
Abstract Room
Class Single
Class Double
Class Suite
Class UniqueRoomList
}

Package RoomService {
Class RoomService
}
}

Class HiddenOutside #FFFFFF
HiddenOutside ..> Model

AddressBook .up.|> ReadOnlyAddressBook
AddressBook ..|> ReadOnlyAddressBook
RoomServiceBook ..|> ReadOnlyRoomServiceBook
BookingBook ..|> ReadOnlyBookingBook
RoomBook ..|> ReadOnlyRoomBook

ModelManager .up.|> Model
Model .right.> ObservableList
ModelManager o--> "1" AddressBook
ModelManager o------> "1" RoomBook
ModelManager o--> "1" BookingBook
ModelManager o-------> "1" RoomServiceBook
ModelManager o-left-> "1" UserPrefs
UserPrefs .up.|> ReadOnlyUserPrefs

Expand All @@ -50,9 +77,21 @@ Person *--> Email
Person *--> Address
Person *--> "*" Tag

BookingBook *--> "1" UniqueBookingList
UniqueBookingList o--> "*" Booking

RoomBook *--> "1" UniqueRoomList
UniqueRoomList o--> "*" Room
Single .up.|> Room
Double .up.|> Room
Suite .up.|> Room

RoomServiceBook *--> "*" RoomService

Name -[hidden]right-> Phone
Phone -[hidden]right-> Address
Address -[hidden]right-> Email

ModelManager -->"1" Person : filtered list
ModelManager -->"1" Booking : filtered list
@enduml
42 changes: 38 additions & 4 deletions docs/diagrams/StorageClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,55 @@ skinparam arrowThickness 1.1
skinparam arrowColor STORAGE_COLOR
skinparam classBackgroundColor STORAGE_COLOR

Package Storage {
Interface Storage <<Interface>>
Interface UserPrefsStorage <<Interface>>
Interface AddressBookStorage <<Interface>>

Class StorageManager
Class JsonUserPrefsStorage

Package AddressBookStorage {
Interface AddressBookStorage <<Interface>>
Class JsonAddressBookStorage
Class JsonSerializableAddressBookStorage
Class JsonAdaptedPerson
Class JsonAdaptedTag
}

Package BookingBookStorage {
Interface BookingBookStorage <<Interface>>
Class JsonBookingBookStorage
Class JsonSerializableBookingBookStorage
Class JsonAdaptedBooking
}

Package RoomServiceStorage {
Interface RoomServiceBookStorage <<Interface>>
Class JsonRoomServiceBookStorage
Class JsonSerializableRoomServiceBook
Class JsonAdaptedRoomService
}
}

StorageManager .left.|> Storage
StorageManager o-right-> UserPrefsStorage
StorageManager o--> AddressBookStorage
StorageManager o--> BookingBookStorage
StorageManager o--> RoomServiceBookStorage

JsonUserPrefsStorage .left.|> UserPrefsStorage
JsonAddressBookStorage .left.|> AddressBookStorage

JsonAddressBookStorage .up.|> AddressBookStorage
JsonAddressBookStorage .down.> JsonSerializableAddressBookStorage
JsonSerializableAddressBookStorage .right.> JsonSerializablePerson
JsonSerializablePerson .right.> JsonAdaptedTag
JsonSerializableAddressBookStorage .down.> JsonAdaptedPerson
JsonAdaptedPerson .right.> JsonAdaptedTag

JsonBookingBookStorage .up.|> BookingBookStorage
JsonBookingBookStorage .down.> JsonSerializableBookingBookStorage
JsonSerializableBookingBookStorage .down.> JsonAdaptedBooking

JsonRoomServiceBookStorage .up.|> RoomServiceBookStorage
JsonRoomServiceBookStorage .down.> JsonSerializableRoomServiceBook
JsonSerializableRoomServiceBook .down.> JsonAdaptedRoomService

@enduml
5 changes: 5 additions & 0 deletions docs/diagrams/UiClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Class HelpWindow
Class ResultDisplay
Class PersonListPanel
Class PersonCard
Class BookingListPanel
Class BookingCard
Class StatusBarFooter
Class CommandBox
}
Expand All @@ -34,9 +36,11 @@ MainWindow --> HelpWindow
MainWindow *-down-> CommandBox
MainWindow *-down-> ResultDisplay
MainWindow *-down-> PersonListPanel
MainWindow *-down-> BookingListPanel
MainWindow *-down-> StatusBarFooter

PersonListPanel -down-> PersonCard
BookingListPanel -down-> BookingCard

MainWindow -left-|> UiPart

Expand All @@ -48,6 +52,7 @@ StatusBarFooter --|> UiPart
HelpWindow -down-|> UiPart

PersonCard ..> Model
BookingCard ..> Model
UiManager -right-> Logic
MainWindow -left-> Logic

Expand Down
Binary file modified docs/images/ModelClassDiagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/StorageClassDiagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: page
title: ConciergeBook
---

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103-W14-2/tp/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)

![Ui](images/Ui.png)
Expand Down