[CS2113-T16-2] Elderly In Your Hood by owensoh · Pull Request #39 · nus-cs2113-AY2122S1/tp

owensoh · 2021-09-30T08:55:16Z

Our team intends to assist the elderly helpers by automating certain tasks for them.

Fix bug in new line not found of Scanner class

Add function of viewing and adding medical history

Add function to delete medical message

Add prompt for garbage collection

Update user guide

aaapppsss · 2021-10-27T04:10:16Z


 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}

+### Elderly risk categorisation


Maybe this section should be further down instead of being the first section, as the first section is usually a brief introduction of the app/overview of architecture.

aaapppsss · 2021-10-27T04:11:10Z


+### Elderly risk categorisation
+#### Implementation
+The elderly risk categorisation is an addition to the current `Elderly` class. It utilises


Since it is an addition to the Elderly class, the section on the Elderly class should probably be above this.

The Elderly class is not described before this section, this can cause confusion.

aaapppsss · 2021-10-27T04:15:09Z

+- `Doctor` — A class that contains information about a doctor
+
+Below is a UML class diagram for the elderly risk categorisation:
+![](team/img/elderly_implementation.png)


The class diagram formatting is wrong as the attribute type is not shown, and there are no brackets behind each method (containing parameters when needed).

aaapppsss · 2021-10-27T04:17:09Z

+![](team/img/elderly_implementation.png)
+
+
+#### How the classes interact with each other


This section is comprehensive and well written :)

aaapppsss · 2021-10-27T04:20:06Z

+UML Diagram of the interaction between classes is shown below :
+![Screenshot](https://user-images.githubusercontent.com/70097982/138797711-e0545ea3-c0bd-48fc-9e28-48a2814e255f.png)
+
+#### Interaction of Classes


Would be good to add a sequence diagram here to summarise how the function works as the description is slightly lengthy.

aaapppsss · 2021-10-27T04:22:30Z

+2. The product should work on both 32-bit and 64-bit system.
+3. This version of product does not allow for addition of hospital and doctors.

 ## Glossary


In general, the DG is well written but can be organised better (the introduction seems to be at the bottom instead of the top) and have a section for the overall architecture/flow of the app. Would also be good to have a table of contents for better navigability.

nvbinh15

Overall, the DG is well-written with a lot of content included. There are some minor bugs with the class diagrams, and a table of content can be included for better navigability. Well done!

nvbinh15 · 2021-10-28T01:39:03Z


 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}

+### Elderly risk categorisation


The sections should be numbered and a table of content with links should be included so readers can navigate easily.

nvbinh15 · 2021-10-28T01:39:29Z

 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}

+### Elderly risk categorisation
+#### Implementation


There should be a blank line after the section header, same issue at line 48.

nvbinh15 · 2021-10-28T01:43:42Z

+- `Doctor` — A class that contains information about a doctor
+
+Below is a UML class diagram for the elderly risk categorisation:
+![](team/img/elderly_implementation.png)


There should be brackets () after method names. Also, the relationships between classes are already shown by the arrows, so don't need to put Doctor and Hospital in the attribute sections of MediumRiskElderly and HighRiskElderly.

For the elderly class, there should be two horizontal bars to indicate that there is no attribute and no method in this class

The association were specified with multiplicity but name of the association is not specified

The attribute data type and method return type are not specified

nvbinh15 · 2021-10-28T01:47:24Z

+This information in both classes is then stored in `Elderly` class.
+
+UML Diagram of the interaction between classes is shown below :
+![Screenshot](https://user-images.githubusercontent.com/70097982/138797711-e0545ea3-c0bd-48fc-9e28-48a2814e255f.png)


Same issue with the previous class diagram. The relationships between Elderly, Next-Of-Kin, and Record should be shown with arrows. Therefore, the attributes can be omitted.

rainish2000 · 2021-10-28T01:19:27Z

+When using the `findbymed`, `findbydiet`, `findbyname` functions, they will take generate a set of 
+medicine, diets and real names respectively. The function `checkSimilarities` in `ElderlyList.class`
+will then iterate through each item in the set and compare it with the query term. If there is a 
+similarity score of `>=0.8`, the closest match will be printed. 


perhaps you could show a diagram (sequence or class) to complement this explanation?

rainish2000 · 2021-10-28T01:26:00Z

+
+UML Diagram of the interaction between classes is shown below :
+![Screenshot](https://user-images.githubusercontent.com/70097982/138797711-e0545ea3-c0bd-48fc-9e28-48a2814e255f.png)
+


this is correct UML notation, the first diagram used in the guide can be edited to match this notation (although some standardisation is needed e.g. in Elderly members and visibility symbol have a space in between but not in the other classes)

rainish2000 · 2021-10-28T01:27:37Z

+
+#### Interaction of Classes
+`Elderly` class will interact with `Next-of-kin` class through the use of `addNok()` function. This function will
+


unsure if this blank line is intended or not, but does not seem to serve any purpose and is quite abrupt

rainish2000 · 2021-10-28T01:41:42Z

+is used to view the details that are stored.
+
+#### Future Implementation and Considerations
+


a short explanation of how exactly this can be implemented could be given (similar to proposed undo/redo feature in AB3 developer guide here)

rainish2000 · 2021-10-28T01:46:20Z

+2. The product should work on both 32-bit and 64-bit system.
+3. This version of product does not allow for addition of hospital and doctors.

 ## Glossary


Adding to the previous reviewer's feedback, your team could look into having more diagrams of different types such as sequence diagrams (currently only 2 diagrams that are both class diagrams) to show your UML and documentation skills.

ShaoYurui · 2021-10-28T06:42:49Z

+The `Elderly` class interacts with two classes, which is `Next-of-Kin` class and `Record` class. As can
+be seen by the association between the three classes, the `Elderly` class stores `Next-of-Kin` and `Record`
+as ArrayLists in its attributes.
+- `Next-of-Kin` class stores the contact information of the Next-of-Kin, such as name, phone number,
+  email, address and relationship to the Elderly
+- `Record` stores the details of the Elderly, such as the elderly phone number and address


Would a sequence diagram help to explain the process?

ShaoYurui · 2021-10-28T06:48:28Z

+#### An example of AutoSuggestions
+Assuming we have an elderly that exist in the system called `John Tan`. We, as the user, remember 
+that his name was `<SOMETHING> Tan`, and it was either `Josh` or `John`. We try `Josh`
+first.
+
+![Example of AutoSuggestions](team/img/autosuggestions_example.png)
+
+Instead of just prompting that the system could not find `Josh Tan`, the search term went through
+the Levenshtein Distance logic and the name `John Tan` returned with a result of `0.9375`. As you 
+can see, this was our intended result and showcases the intended solution to our problem.
+
+#### Potential Shortcomings of this function
+There may be two strings that have similar edit distance to each other but may not be related to 
+each other. This will include words like `sitting` and `kitten` for example. This may give 
+inaccurate suggestions. However, since this is **not a key function** and is only meant to be a 
+complementary tool, **it will not be a major problem**.
+
+### Addition of Next-of-Kin and Record Classes
+#### Implementation


Would the document look more structured if more indentation was applied or more blank spaces between paragraphs ?

…ttps://riptutorial.com/gson/example/22968/using-gson-with-inheritance]

Fixes made on load to allow for inheritance when loading from json

Support fast-typing in adding elderly

Update size of diagram

# Conflicts: # docs/DeveloperGuide.md

Changes made to DG

Changes made to DG to prevent additional line

Change made to DG to add appendixes

Add more to PPP

Update ppp

Update dg manual test

Add more regex checker

Change the regex checker to allow useful invalid risk level

Edit minor bug with doctor

Changes made to DG to finish Appendix E and update table of contents

Update PPP

ruyian and others added 16 commits October 26, 2021 16:26

Merge pull request #133 from ruyian/master

20bd903

Fix bug in new line not found of Scanner class

Add function of viewing and adding medical history

b231b21

Update javadoc

91e0c33

Merge pull request #134 from ruyian/master

b970bd1

Add function of viewing and adding medical history

Add function to delete medical message

07e8664

Fix javadoc

e69a572

Merge pull request #135 from ruyian/master

848c883

Add function to delete medical message

Add prompt for garbage collection

b968a01

Merge pull request #136 from ruyian/master

f9bf8cc

Add prompt for garbage collection

Update user guide

761ca14

Update user guide

5742ad8

Amend coding style

ea048a5

Amend coding style

93cdd3b

Update test

f566356

Merge pull request #137 from ruyian/master

2d363d4

Update user guide

Merge branch 'AY2122S1-CS2113-T16-2:master' into master

cb70f57

aaapppsss reviewed Oct 27, 2021

View reviewed changes

nvbinh15 reviewed Oct 28, 2021

View reviewed changes

rainish2000 reviewed Oct 28, 2021

View reviewed changes

ShaoYurui reviewed Oct 28, 2021

View reviewed changes

wutdequack and others added 10 commits October 28, 2021 17:15

Fixes made on load to allow for inheritance when loading from json [h…

17c4807

…ttps://riptutorial.com/gson/example/22968/using-gson-with-inheritance]

Merge pull request #138 from wutdequack/master

5bd7617

Fixes made on load to allow for inheritance when loading from json

Support fast typing in adding elderly

2e9170d

Add function to catch non-Duke exception

9a56b0f

Update userguide with new addelderly function

ebe6a79

Update user guide

8a5b808

Update test

d06c71a

Fix text ui test

2d3ffbc

Fix ui test

610b9cb

Merge pull request #139 from ruyian/master

bade6fd

Support fast-typing in adding elderly

ruyian and others added 30 commits November 7, 2021 22:10

Merge pull request #249 from ruyian/master

d76371a

Update size of diagram

Changes made to DG

41bc80f

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-2/tp

08f60b4

# Conflicts: # docs/DeveloperGuide.md

Merge pull request #250 from wutdequack/master

5cc70b9

Changes made to DG

Changes made to DG to prevent additional line

d2b9e63

Merge pull request #251 from wutdequack/master

328f971

Changes made to DG to prevent additional line

Changes made to DG to add in new appendixes

4f647f3

Merge branch 'master' of https://github.com/AY2122S1-CS2113-T16-2/tp

9cb4ae2

Merge pull request #252 from wutdequack/master

8fb0950

Change made to DG to add appendixes

Add more to PPP

efa4736

Merge pull request #253 from ruyian/master

a7a7549

Add more to PPP

Update ppp

672509b

Merge pull request #254 from ruyian/master

510f050

Update ppp

Update dg manual test

b51d68f

Merge pull request #255 from owensoh/dg-manual

5bb816d

Update dg manual test

Add more regex checks

f6d01c2

Merge branch 'master' of https://github.com/ruyian/tp

0a5f0fb

Amend InvalidInputException variable name

7594ec8

Add javadoc to the InvalidInputException class

e8dec04

Fix style

a6d0868

Fix printing statement

494b3e4

Merge pull request #256 from ruyian/master

7a61225

Add more regex checker

Change the regex checker to allow useful invalid risk level

6da302d

Merge pull request #257 from ruyian/master

9619430

Change the regex checker to allow useful invalid risk level

Edit minor bug with doctor

727daab

Merge pull request #258 from owensoh/editbug

f934db0

Edit minor bug with doctor

Changes made to DG to finish Appendix E and update table of contents

a673d2b

Merge pull request #259 from wutdequack/master

fd882ad

Changes made to DG to finish Appendix E and update table of contents

Update PPP

97f7540

Merge pull request #260 from ruyian/master

57b3e4a

Update PPP


		{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}

		### Elderly risk categorisation

		![](team/img/elderly_implementation.png)


		#### How the classes interact with each other


		UML Diagram of the interaction between classes is shown below :
		![Screenshot](https://user-images.githubusercontent.com/70097982/138797711-e0545ea3-c0bd-48fc-9e28-48a2814e255f.png)


		#### Interaction of Classes
		`Elderly` class will interact with `Next-of-kin` class through the use of `addNok()` function. This function will

		is used to view the details that are stored.

		#### Future Implementation and Considerations

Uh oh!

Conversation

owensoh commented Sep 30, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvbinh15 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rainish2000 Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

rainish2000 Oct 28, 2021 •

edited

Loading