An Ruyi
Table of Contents
Overview of Project
This product, Elderly in Your Hood, is a lightweight Command Line application for the workers at the old folk’s home to record the information of the elderly who they are servicing such as their medical conditions and history, their Next-of-Kin information as well as their dietary preferences.
Summary of Contribution
Code Contribution Page
Enhancements implemented
setdiet: Setting of the dietary preference of the elderlyviewdiet: Viewing of the dietary preference of the elderlysetbloodpressure: Setting\Updating of the blood pressure of the elderlyviewbloodpressure: Viewing of blood pressure of the elderlyaddmedicalhistory: Adding additional medical history to the elderlyviewmedicalhistory: Viewing the whole medical history of the elderlydeletemedicalhistory: Clearing the whole medical history of the elderlyviewvaccination: Viewing of the vaccination status of the elderlysetvaccinated: Setting the vaccination statuts of the elderly to be vaccinatedsetbirthday: Setting of the birthday of the elderlyviewbirthday: Viewing of the birthday of the elderly- Used regex format to check for the inputs
- Apply a better way to return Objects - Optional class, and amend the code accordingly
- Define useful exception classes fit to the program
Contributions to UG
- Creation of Table of Contents
- Add hyperlinks at Table of Contents
- Add some expected outputs to commands that are not so easy to be understood
- Write up the UG details for all functions that I have implemented (vaccination, blood pressure, medical history, birthday and diet)
Contributions to the DG
- Provide skeleton structure of DG
- Amend the UML diagram
- Explain the program architecture (interaction among classes and inheritance) in detail
- Come with non-functional requirements
Contribution to the Project
- Craft the architecture of the program as well layers of abstractions (interfaces (Hostpitalisable), inheritances of Elderly classes and Exception classes)
- Think of the idea of creating the elderly catering to their risk levels
- Improve the program structure by decoupling the content coupling of Duke execution
- Make the code more defensive and more OOP-like
- Amend the naming conventions of classes, methods and fields to abide by the coding styles and provide consistency in the whole project, as well as to distinguish the methods that have similar names in different classes (e.g. deleteElderlyMedicalHistory in Elderly class and deleteMedicalHistory in ElderlyList class)
- Add javadocs to the public methods