Stephen Chua - Project Portfolio

Format: add rt/RECORD_TYPE dt/DATETIME followed by parameters that the RECORD_TYPE accepts.

There must not be any duplicate parameters. Other than "add", ordering of fields is flexible.

rt/ value is case sensitive, RECORD_TYPE must be in capital letters. dt/ value must not be in the future.

BMI must receive exactly 1 valid parameter each for height and weight: h/VALUE w/VALUE

Height input (in meters) will be rounded to 2 decimal places. This rounded value must be less than 3 to be recorded successfully.

Weight input (in kilograms) will be rounded to 2 decimal places. This rounded value must be less than 500 to be recorded successfully.

BLOODSUGAR must receive exactly 1 valid parameter for concentration: con/VALUE Concentration (mmol/L) will be rounded to 2 decimal places. This rounded value must be less than 33 to be recorded successfully.

add does not allow entries that have the same datetime and RECORD_TYPE.

Format: list

This command lists all types of recent data entries.

Format: delete INDEX

Index must be a positive integer.

The index refers to the index number shown in the displayed entries list

Format: edit INDEX

Allows users to modify existing record fields.

The multi-record data logging mechanism is facilitated by a new Record package containing BloodSugar and Bmi classes that extend an abstract Record class. Add, list and delete command classes and parsers are modified to accommodate multiple record types. Multi-record data is stored internally as a recordList where members are Records.

It modifies the following operations:

These operations are exposed in the Model interface as Model#addRecord(), Model#deleteRecord() and Model#getUniqueRecordListObject() respectively.

The internal data structure contains an ObservableList<Record> that the UI can observe to display the record list.

Below is an example usage scenario of how the data log feature behaves at each step.

Step 1. The user launches the application for the first time. If /data/recordList.json is not found, it will be produced from SampleRecordDataUtil#getSampleRecords(). If /data/recordList.json is found, the recordList will be loaded from there using UniqueRecordList#setRecord() and checked for inconsistencies e.g. missing fields, invalid fields. If inconsistencies are detected, an Exception is thrown and existing recordList.json is erased.

Step 2. The user lists all records. A new RecordListPanel is created and populates each ListViewCell with BloodSugarRecordCard and BmiRecordCard. ObservableList<Record> is used to populate the ListViewCell.

Step 3. The user executes add rt/BMI h/1 w/1 dt/2019-09-09 12:12 command. The add command parameters are parsed for validity and uniqueness. This job is delegated to the following classes: SugarMummyParser,AddCommandParser and ParserUtil. This is illustrated in SequenceDiagram below. After parsing is completed, either a complete `BloodSugar or Bmi Object is returned otherwise a ParseException will be thrown. The Record is checked against the model for uniqueness. If it is unique, it is added to the Model via Model#addRecord() (illustrated by the red portion of the sequence diagram below)

The above activity diagram illustrates step 3.

The above sequence diagram provides a in-depth look at how parsing is delegated to various classes within the blue Logic component. The calls to the red model component illustrates Step 3 adding records to the model. The final call to the yellow storage component illustrates step 5.

Step 4. The user decides to delete a record. The delete command is parsed for validity by SugarMummyParser, DeleteCommandParser and ParserUtil. ParseUtil checks whether the index is a positive number, otherwise a ParseException will be thrown. DeleteCommand checks whether the positive index points to a valid record. DeleteCommand will call Model#deleteRecord() to remove the record from the list.

Step 5. After add or delete commands have been executed in LogicManager, the Model’s recordList is written to recordList.json using Storage#saveRecordList().