[CS2113-F11-4] OneDoc

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# OneDoc
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "OneDoc"
 }
 
 shadowJar {
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

diagrams/PrescriptionListClassDiagram.puml

@@ -0,0 +1,20 @@
+@startuml
+class PrescriptionList {
++ void add(ui:UI, patientId:String, medicine:String, dosage:String, timeInterval:String)
++ void add(ui:UI, patientId:String, medicine:String, dosage:String, timeInterval:String, isActive:boolean)
++ void viewAll(ui:UI)
++ void viewPatientPrescription(ui:UI, patientId:String)
++ void viewActivePatientPrescription(ui:UI, patientId:String)
++ void edit(ui:UI, prescriptionNumber:int, medicine:String, dosage:String, timeInterval:String)
++ void activatePrescription(ui:UI, prescriptionNumber:String)
++ void deactivatePrescription(ui:UI, prescriptionNumber:String)
+}
+
+class Prescription {
+}
+
+class UI {}
+
+PrescriptionList *-down-> "*" Prescription : "contains" >
+PrescriptionList .right.> UI
+@enduml

diagrams/Sample.puml

@@ -0,0 +1,7 @@
+@startuml
+Class01 <|-- Class02
+Class03 *-- Class04
+Class05 o-- Class06
+Class07 .. Class08
+Class09 -- Class10
+@enduml

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |    Name    | Github Profile | Portfolio 
+--------|:----------:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) |  Dhanish   | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Don Joe   | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Ron John  | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Kasey Kwok | [Github](https://github.com/kaseykwok) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Mor Ben Ami   | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -4,11 +4,96 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
-
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+Storage class and its functions are largely adapted from Dhanish's IP on Duke.
 
+## Design & implementation
 
+The Patient and PatientList classes are used in conjunction to manage patients, and the list of patients. Each patient has a name,
+an ID, a date of birth and gender. The PatientList class holds an ArrayList of Patients and manipulates them accordingly.
+
+At the start of the program, a new PatientList object is instantiated. Through methods in the Storage class, data is read from the
+relevant text files to create Patients that existed prior to the last closure of the program, and then adds these patients to the
+ArrayList in PatientList. This finishes the initial set-up.
+
+Methods in PatientList class:
+
+addPatient - this method takes in the aforementioned variables through UI class and parses them. If they are all valid, a new
+Patient is created and added to the ArrayList in PatientList.
+
+findPatient - this method takes in an ID, iterates through the ArrayList of Patients and compares the ID with the ID of each of the
+existing Patients in the list. If there is a match, the corresponding Patient is returned. Else, returns null.
+
+retrievePatient - this method is very similar to findPatient, but instead of returning the Patient found, it prints out the details
+of the Patient using the toString method in the Patient class.
+
+listPatients - this method first checks if the ArrayList of Patients is non-empty. If not so, it prints a message that there are
+no patients in the system currently and terminates.
+Else, it iterates through the ArrayList of Patients and uses the toString method in Patient to print out the details of each Patient.
+
+modifyPatientDetails - this method takes in name, birthDate, gender and ID. It tries to find the patient with a matching ID.
+If the patient is not found, returns. Else, if the name is not an empty String, replace the existing name with the input name.
+Repeat for birthDate and gender.
+
+### VisitList Component
+The `VisitList` Component,
+* stores the list of visits
+* can add new visit to the list
+* can edit reason for an existing visit in the list
+* can view all visits in the list
+* can view all visits for a patient
+* can view a specific visit
+* depends on `UI` class (as the `VisitList` component interacts with user through the UI component, and makes use of its methods to print details)
+
+**Methods in `VisitList` class:**
+* `addVisit` - This method allows user to add a visit to the `VisitList` by specifying `id` of patient, `dateOfVisit`, and `timeOfVisit`.
+* `editReason` - This method allows user to edit reason for an existing visit, by specifying `id` of patient and `reason` for visit
+* `viewAll` - This method iterates through the list of all visits, and prints each visit record
+* `viewPatient` - This method iterates through the list of all visits, and prints the visit records that match the specified `id` of patient
+* `viewVisit` - This method iterates through the list of all visits, and prints the visit record that matches the specified `index` of the visit
+
+### PrescriptionList component
+**API**: `PrescriptionList.java`
+
+![](../diagrams/PrescriptionListClassDiagram.png)
+
+The `PrescriptionList` component,
+* stores the list of prescriptions
+* can add new prescription to the list
+* can edit existing prescriptions inside the list
+* can change the status of prescription inside the list
+* can view all prescriptions, view a patient's prescription or view a patient's active prescription 
+* depends on `UI` class (because the `PrescriptionList` component needs to interact with user through the `UI` 
+component)
+
+**Methods in `PrescriptionList` class:**
+
+* **`add`** - This method allow user to add prescription into the list by specifying `patientId`, `medicine`, `dosage` and 
+`timeInterval`.
+* **`viewAll`** - This methods iterates through the list of all prescriptions and print the details of prescriptions from
+all patients.
+* **`viewPatientPrescription`** - This method iterates through the list of prescriptions and print the details of 
+prescriptions from the specified `patientId`.
+* **`viewActivePatientPrescription`** - This method iterates through the list of prescriptions and print the details of
+all active prescriptions with the specified `patientId`
+* **`edit`** - This method allows user to edit the `medicine`, `dosage` or `timeInterval` of the prescription of the 
+specified index
+* **`activatePrescription`** - This method allows user to set the prescription of specified index as active.
+* **`deactivatePrescription`** - This method allows user to set the prescription of specified index as inactive.
+
+### Prescription component
+The `Prescription` component,
+* stores the medicine name
+* the medicines timeInterval 
+* patient ID
+* dosage
+* if the Prescription is active or not 
+
+**Methods in `Prescription` class:**
+* 'add' - creates a new Prescription - needs to insert all the components except if active or not (if not included the default is active )
+* Getters and Setters for each of the components
+* Print format
+* method that checks if a patient has the Prescription
+* method that checks if a patient has the Prescription and if the Prescription is active
 ## Product scope
 ### Target user profile
 
@@ -27,8 +112,18 @@
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+Parser:
+
+The parsing class utilizes regex for each of the commands for two main reasons: usability and error-catching.
+
+For usability, the input is automatically separated into distinct groups through the Java regex library, which allows
+input such as ID, name, etc. to be pulled out in multi-word or one word parts.
+
+For error-catching, the input is checked to be in a certain format (i.e. DOB is DD-MM-YYYY)
+or of a certain type (i.e. the ID is one word made up of letters and numbers).
 
+If there is an error, the regex also helps with identifying the exact error issue, and
+sending that back to the user.
 ## Glossary
 
 * *glossary item* - Definition

src/main/java/MainMenuState.java

@@ -0,0 +1,7 @@
+public enum MainMenuState {
+    PATIENT,
+    VISIT,
+    PRESCRIPTION,
+    INVALID,
+    EXIT
+}

src/main/java/OneDoc.java

@@ -0,0 +1,79 @@
+public class OneDoc {
+
+    private static UI ui;
+    protected PatientList patientsList;
+    protected VisitList visitsList;
+    protected PrescriptionList prescriptionsList;
+    protected static Parser parser;
+    protected static Storage storage;
+    private static MainMenuState mainMenuState;
+
+    public OneDoc() {
+        ui = new UI();
+        patientsList = new PatientList();
+        visitsList = new VisitList();
+        prescriptionsList = new PrescriptionList();
+        storage = new Storage();
+        storage.loadData(patientsList, visitsList, prescriptionsList);
+        parser = new Parser(patientsList, visitsList, prescriptionsList, ui, storage);
+        mainMenuState = MainMenuState.INVALID;
+    }
+
+    public static void main(String[] args) {
+        new OneDoc();
+        run();
+    }
+
+    public static void subMenuRun() {
+        SubMenuState subMenuState = SubMenuState.IN_SUB_MENU;
+
+        ui.printSubMenu(mainMenuState);
+        while (true) {
+            String input = ui.readLine();
+            switch (mainMenuState) {
+            case PATIENT:
+                subMenuState = parser.patientParser(input);
+                break;
+            case VISIT:
+                subMenuState = parser.visitParser(input);
+                break;
+            case PRESCRIPTION:
+                subMenuState = parser.prescriptionParser(input);
+                break;
+            default:
+                break;
+            }
+
+            if (subMenuState == SubMenuState.BACK_TO_MAIN) {
+                break;
+            } else if (subMenuState == SubMenuState.EXIT) {
+                mainMenuState = MainMenuState.EXIT;
+                break;
+            }
+        }
+    }
+
+    public static void mainMenuRun() {
+        while (mainMenuState != MainMenuState.EXIT) {
+            ui.printMainMenu();
+            String input = ui.readLine();
+            mainMenuState = parser.mainMenuParser(input);
+
+            if (mainMenuState == MainMenuState.EXIT) {
+                break;
+            } else if (mainMenuState == MainMenuState.INVALID) {
+                ui.printInvalidMainMenuErrorMessage();
+                continue;
+            }
+
+            subMenuRun();
+        }
+    }
+
+    public static void run() {
+        ui.printWelcomeMessage();
+        mainMenuRun();
+        ui.printExitMessage();
+    }
+}
+

src/main/java/OneDocException.java

@@ -0,0 +1,6 @@
+public class OneDocException extends Exception {
+
+    public OneDocException(String message) {
+        super(message);
+    }
+}