Merge branch 'master' into 464-final-ppp-benjamin

docs/AboutUs.md

@@ -36,7 +36,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 [[github](http://github.com/zhonghan721)] [[portfolio](team/zhonghan721.md)]
 
-* Role: Member
+* Role: Developer
 
 ### Julius Gambe
 

docs/diagrams/CustomerAddSequenceDiagram.puml

@@ -62,13 +62,13 @@ activate Model
 Model --> CustomerAddCommand : isLoggedIn
 deactivate Model
 
-CustomerAddCommand -> Model : hasPerson(c)
+CustomerAddCommand -> Model : hasCustomer(c)
 activate Model
 
 Model --> CustomerAddCommand
 deactivate Model
 
-CustomerAddCommand -> Model : addPerson(c)
+CustomerAddCommand -> Model : addCustomer(c)
 activate Model
 
 Model --> CustomerAddCommand

docs/diagrams/CustomerClassDiagram.puml

@@ -3,18 +3,21 @@
 skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
+skinparam classAttributeIconSize 0
 
 Package Customer as ModelPackage <<Rectangle>>{
-Class Customer
+Class Customer {
+<color: #FFFFFF>- customerId: int
+}
 Class Address
 Class Email
 Class Name
 Class Phone
 
-Class I #FFFFFF
+Class I<<HIDDEN>> #FFFFFF
 }
 
-Class HiddenOutside #FFFFFF
+Class HiddenOutside<<HIDDEN>> #FFFFFF
 HiddenOutside .down.> Customer
 
 
@@ -23,5 +26,6 @@ Customer *--> "1" Phone
 Customer *--> "1" Email
 Customer *--> "1" Address
 
+show Customer fields
 
 @enduml

docs/diagrams/DeleteSequenceDiagram.puml

@@ -5,65 +5,65 @@ skinparam ArrowFontStyle plain
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
-participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR
-participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR
+participant ":CustomerDeleteCommandParser" as CustomerDeleteCommandParser LOGIC_COLOR
+participant "d:CustomerDeleteCommand" as CustomerDeleteCommand LOGIC_COLOR
 participant ":CommandResult" as CommandResult LOGIC_COLOR
 end box
 
 box Model MODEL_COLOR_T1
 participant ":Model" as Model MODEL_COLOR
 end box
 
-[-> LogicManager : execute("delete 1")
+[-> LogicManager : execute("customer delete 1")
 activate LogicManager
 
-LogicManager -> AddressBookParser : parseCommand("delete 1")
+LogicManager -> AddressBookParser : parseCommand("customer delete 1")
 activate AddressBookParser
 
-create DeleteCommandParser
-AddressBookParser -> DeleteCommandParser
-activate DeleteCommandParser
+create CustomerDeleteCommandParser
+AddressBookParser -> CustomerDeleteCommandParser
+activate CustomerDeleteCommandParser
 
-DeleteCommandParser --> AddressBookParser
-deactivate DeleteCommandParser
+CustomerDeleteCommandParser --> AddressBookParser
+deactivate CustomerDeleteCommandParser
 
-AddressBookParser -> DeleteCommandParser : parse("1")
-activate DeleteCommandParser
+AddressBookParser -> CustomerDeleteCommandParser : parse("1")
+activate CustomerDeleteCommandParser
 
-create DeleteCommand
-DeleteCommandParser -> DeleteCommand
-activate DeleteCommand
+create CustomerDeleteCommand
+CustomerDeleteCommandParser -> CustomerDeleteCommand
+activate CustomerDeleteCommand
 
-DeleteCommand --> DeleteCommandParser : d
-deactivate DeleteCommand
+CustomerDeleteCommand --> CustomerDeleteCommandParser : d
+deactivate CustomerDeleteCommand
 
-DeleteCommandParser --> AddressBookParser : d
-deactivate DeleteCommandParser
+CustomerDeleteCommandParser --> AddressBookParser : d
+deactivate CustomerDeleteCommandParser
 'Hidden arrow to position the destroy marker below the end of the activation bar.
-DeleteCommandParser -[hidden]-> AddressBookParser
-destroy DeleteCommandParser
+CustomerDeleteCommandParser -[hidden]-> AddressBookParser
+destroy CustomerDeleteCommandParser
 
 AddressBookParser --> LogicManager : d
 deactivate AddressBookParser
 
-LogicManager -> DeleteCommand : execute()
-activate DeleteCommand
+LogicManager -> CustomerDeleteCommand : execute()
+activate CustomerDeleteCommand
 
-DeleteCommand -> Model : deletePerson(1)
+CustomerDeleteCommand -> Model : deleteCustomer(1)
 activate Model
 
-Model --> DeleteCommand
+Model --> CustomerDeleteCommand
 deactivate Model
 
 create CommandResult
-DeleteCommand -> CommandResult
+CustomerDeleteCommand -> CommandResult
 activate CommandResult
 
-CommandResult --> DeleteCommand
+CommandResult --> CustomerDeleteCommand
 deactivate CommandResult
 
-DeleteCommand --> LogicManager : result
-deactivate DeleteCommand
+CustomerDeleteCommand --> LogicManager : result
+deactivate CustomerDeleteCommand
 
 [<--LogicManager
 deactivate LogicManager

docs/diagrams/DeliveryClassDiagram.puml

@@ -3,9 +3,12 @@
 skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
+skinparam classAttributeIconSize 0
 
 Package Delivery as DeliveryPackage <<Rectangle>>{
-Class Delivery
+Class Delivery {
+<color: #FFFFFF> - deliveryId: int
+}
 Class DeliveryName
 Class Customer
 Class OrderDate
@@ -15,10 +18,10 @@ Class Note
 
 Class DeliveryStatus <<Enumeration>>{
 }
-Class I #FFFFFF
+Class I<<HIDDEN>> #FFFFFF
 }
 
-Class HiddenOutside #FFFFFF
+Class HiddenOutside<<HIDDEN>> #FFFFFF
 HiddenOutside .down.> Delivery
 
 Delivery *--> "1" DeliveryName
@@ -28,5 +31,6 @@ Delivery *--> "1" DeliveryDate
 Delivery *--> "1" DeliveryStatus
 Delivery *--> "0..1" Note
 
+show Delivery fields
 
 @enduml

docs/diagrams/ModelClassDiagram.puml

@@ -5,61 +5,74 @@ skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
 
 Package Model as ModelPackage <<Rectangle>>{
-Class "<<interface>>\nReadOnlyBook<T>" as ReadOnlyBook
+
 Class "<<interface>>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs
 Class "<<interface>>\nModel" as Model
 Class AddressBook<Customer>
 Class DeliveryBook<Delivery>
 Class ModelManager
 Class UserPrefs
 
-Class UniqueCustomerList
 Class Customer
 
 
-Class UniqueDeliveryList
+
 Class Delivery
 
 Class User
 
 Class ListItem
 
-Class I #FFFFFF
 }
 
+Class I<<Hidden>> #FFFFFF
+Class H<<Hidden>> #FFFFFF
+Class J<<Hidden>> #FFFFFF
+Class K<<Hidden>> #FFFFFF
+
+
 Class HiddenOutside<<HIDDEN>> #FFFFFF
 HiddenOutside ..> Model
 
-AddressBook .up.|> ReadOnlyAddressBook
+
 
 Model -right-> ReadOnlyUserPrefs
-Model -left-> ReadOnlyBook
+
 ModelManager .up.|> Model
-ModelManager -left-> "1" DeliveryBook
-ModelManager -right-> "1" AddressBook
+ModelManager -up-> "1" DeliveryBook
+ModelManager -up-> "1" AddressBook
 '
 UserPrefs .up.|> ReadOnlyUserPrefs
-AddressBook .up.|> ReadOnlyBook
-DeliveryBook .up.|> ReadOnlyBook
-ModelManager --> "~* uiList" ListItem
-ModelManager --> "1" UserPrefs
-ModelManager --> "1" User
+
+ModelManager -right-> "~* uiList" ListItem
+ListItem -[hidden]down-> J
+ModelManager -right-> "1" UserPrefs
+
+ModelManager -up-> "1" User
+User -[hidden]right-> K
+ModelManager -left-> "~* filteredCustomers" Customer
+Customer-[hidden]left--> H
+
+ModelManager -down-> "~* filteredDeliveries" Delivery
+Delivery -[hidden]left--> I
+
+ModelManager -down-> "~* sortedDeliveries" Delivery
+
 '
-AddressBook *--> "1" UniqueCustomerList
-UniqueCustomerList --> "~* all" Customer
+
+
 '
 '
 '
-DeliveryBook *--> "1" UniqueDeliveryList
-UniqueDeliveryList -down-> "~* all" Delivery
+
+
 '
 '
-Customer -[hidden]down--> I
+
 '
-UniqueCustomerList -[hidden]right-> I
+
 '
 '
-ModelManager --> "~* filteredCustomers" Customer
-ModelManager --> "~* filteredDeliveries" Delivery
-ModelManager --> "~* sortedDeliveries" Delivery
+
+
 @enduml

docs/diagrams/ReadOnlyBookClassDiagram.puml

@@ -0,0 +1,27 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package ReadOnlyBook as ModelPackage <<Rectangle>>{
+Class "<<interface>>\nReadOnlyBook<T>" as ReadOnlyBook
+Class AddressBook<Customer>
+Class DeliveryBook<Delivery>
+Class UniqueCustomerList
+Class UniqueDeliveryList
+Class Customer
+Class Delivery
+}
+
+Class HiddenOutside<<HIDDEN>> #FFFFFF
+HiddenOutside ..> ReadOnlyBook
+
+AddressBook .up.|> ReadOnlyBook
+DeliveryBook .up.|> ReadOnlyBook
+AddressBook -down-> "1" UniqueCustomerList
+UniqueCustomerList -down-> "*" Customer
+DeliveryBook -down-> "1" UniqueDeliveryList
+UniqueDeliveryList -down-> "*" Delivery
+
+@enduml

docs/diagrams/UiClassDiagram.puml

@@ -12,7 +12,7 @@ Class MainWindow
 Class HelpWindow
 Class ResultDisplay
 Class ListPanel
-Class PersonCard
+Class ItemCard
 Class StatusBarFooter
 Class CommandBox
 Class ItemListViewCell
@@ -33,14 +33,14 @@ MainWindow *-down-> "1" ListPanel
 MainWindow *-down-> "1" StatusBarFooter
 MainWindow --> "0..1" HelpWindow
 
-ListPanel -down-> "*" PersonCard
+ListPanel -down-> "*" ItemCard
 
 MainWindow -left-|> UiPart
 
 ResultDisplay --|> UiPart
 CommandBox --|> UiPart
 ListPanel --|> UiPart
-PersonCard --|> UiPart
+ItemCard --|> UiPart
 StatusBarFooter --|> UiPart
 HelpWindow --|> UiPart
 

docs/diagrams/UserClassDiagram.puml

@@ -3,20 +3,26 @@
 skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
+skinparam classAttributeIconSize 0
 
 Package User as ModelPackage <<Rectangle>>{
-Class User
+Class User {
+<color: #FFFFFF>- secretQuestion: String<color: #FFFFFF>
+<color: #FFFFFF>- secretAnswer: String
+}
+
 Class Username
 Class Password
 
-Class I #FFFFFF
+Class I<<HIDDEN>> #FFFFFF
 }
 
-Class HiddenOutside #FFFFFF
+Class HiddenOutside<<HIDDEN>> #FFFFFF
 HiddenOutside .down.> User
 
-User --> "1" Username
-User --> "1" Password
+User *--> "1" Username
+User *--> "1" Password
 
+show User fields
 
 @enduml

docs/diagrams/UserLoginActivityDiagram.puml

@@ -10,19 +10,18 @@ start
 if () then ([else])
     :ParseException: Invalid Command Format;
     stop
-([all fields are filled]) elseif () then ([user is already logged in])
+( [all fields are filled]) elseif () then ([user is already logged in])
     :CommandException: Already Logged In;
     stop
-([else]) elseif () then ([else])
+( [else]) elseif () then ([else])
     :CommandException: Wrong Credentials;
     stop
-else ([fields matches
+else ( [fields matches
     stored user])
 
 endif
 :User login command is executed successfully.
 User is now logged in.;
-:Show full Customer List;
 
 stop
 @enduml