Ng Ming Liang - Project Portfolio

This section acts as a summary of the important things to note when using edit-c and its parameters. The square bracket shows that it is optional and your command will still execute even if you do not enter them. However, at least one of them have to be specified. The ellipsis after a parameter …​ means that there can be multiple of that same type of parameter.

*The set of special characters are !#$%&'*+/=?{|}~^.-`

Let’s say you want to edit the address and assign 3 sports (Tennis, Hockey, Badminton) to client Irfan Ibrahim. From the Client List, you can see that his client INDEX is 3.

Next, you can enter the command edit-c 3 a/New Address #123456 s/Tennis s/Hockey s/Badminton in the Command Box.

Enter the command, and you should see that the Result Box displays the edited client’s information, and that the Client List has updated Irfan Ibrahim to show the new changes.

You might face some errors or difficulties when you use edit-e. In this section, you will be able to understand these errors and resolve them.

Result box not displaying updated client’s information

When you use edit-c, instead of seeing the updated client’s information in the Result Box, you might sometimes encounter an error message informing you about the specifications for the format of the command. This error message varies according to the mistake detected in the parameters given. For simplicity, let’s look at one example scenario.

Let’s say you attempt to edit the email of Irfan Ibrahim and happen to give an incorrect format of the email that does not follow the rules given in the parameters table above for EMAIL. Consider the following command: edit-c 3 e/invalidEmail.

As seen above, the EMAIL is of the wrong format as it does not include the @ symbol and not of the xxx@yyy format.

In the example above, the EMAIL field was faulty. This behaviour of FitBiz also applies to other faulty parameters for the edit-c command, where FitBiz will display information relevant to the faulty parameter, to help you troubleshoot and correct your input.

This section acts as a summary of the important things to note when using schedule. The square bracket shows that it is optional and your command will still execute even if you do not enter them.

Let’s say you want to schedule a weekly Monday 11:00am to 12:00pm slot for your client Alex Yeoh. Alex Yeoh is the first client on your Client List.

You can see that Alex Yeoh’s client index is 1. Therefore, you can proceed to type the schedule command in the Command Box to assign a schedule slot to him.

After you enter the command, you can see that the Result Box has notified you of the new overwritten schedule, and that Alex Yeoh’s schedule slot has appeared on the Schedule Panel on Monday.

Now let’s say you want to add multiple schedules to Bernice Yu: Monday 8:00am to 10:00pm and Tuesday 4:00pm to 6:00pm. You can do that by adding both of these timings into the schedule command following the same format as above.

Now enter the command, and you’ll see that Bernice’s schedules also show up on the Schedule Panel.

Finally, let’s say Alex no longer has any schedule slots, and you want to clear it. Simply type in schedule 1 sch/ in the Command Box to clear his schedule, and you should see this.

You might face some errors or difficulties when you use schedule. In this section, you will be able to understand these errors and resolve them.

Overlapping schedules

You might encounter the message that "One or more of your input schedules have overlapping time periods. Please check again." This means that there is a overlapping time period between at least two of your input schedules. In this case as shown below, the first schedule sch/MON-1100-1200 conflicts with the second schedule sch/MON-1200-1300 because the end time of the first schedule overlaps with the start time of the second schedule.

Invalid command format

You might encounter the error message from the Result Box specifying the format that you should be using for the schedule command. This means that there are one or more errors in the format of your input for the schedule command. In the example input shown below, schedule 2 sch/TUESDAY-800-1:00, there are multiple errors. First, the DAY should be three letters. Next, the STARTTIME and ENDTIME should follow the HHmm format. The correct input for this should be schedule 2 sch/TUE-0800-1300.

The command is simply list-c, and has no additional parameters.

Let’s say you start off with the full Client List as shown below.

Now, let’s say you use the command filter-c to filter the clients with the Paleo tag as such:

Your Client List will now display only the clients that have the Paleo tag. In this example, the only client that fit this requirement is Alex Yeoh.

Let’s say you are done with the filter, and want to list all your clients on the Client List again. Simply enter `list-c`into the Command Box and you should be able to see the following:

No clients shown on the Client List

You may be greeted with the following scene. This means that there are no clients in your FitBiz. You can begin adding clients by using the add-c command. Do refer to the add-c section in this document for help regarding add-c.

This scheduling mechanism is facilitated by ScheduleCommand which extends Command. The format of the command is given by:

schedule INDEX sch/DAY-STARTTIME-ENDTIME [sch/DAY-STARTTIME-ENDTIME] …​

When using this command, at least one valid complete schedule parameter must be specified. The user can follow up with additional optional valid schedule parameters in order to assign more schedules to the same client. The following 3 examples are all valid usages of the schedule command:

Example Commands

Elaboration on Example Commands

Do note that the schedule parameters given in the schedule command will entirely overwrite the client’s current list of schedules.

The list of schedules of each client are structured as a ScheduleList, which is a wrapper class for an ArrayList of Schedule objects. Each Client contains one ScheduleList attribute to keep track of all Schedule assigned to it. If there are no assigned Schedule for the Client, then the ScheduleList simply contains an empty ArrayList of Schedule.

Schedule comprises three attributes:

Day wraps the enum DayEnum.Weekday and represents the day of the week the schedule takes place on.

StartTime and EndTime represent the start time and end time of the schedule in the "HHmm" format respectively.

The relations between these classes are shown in the class diagram below.

These attributes are bounded by these characteristics:

Here is an activity diagram displaying the steps taken when FitBiz receives a user input for the schedule command:

In the following sequence diagram, we trace the execution for when the user decides to enter the command schedule 1 day/mon st/1100 et/1200 into FitBiz. For simplicity, we will refer to this command input as commandText:

This sequence diagram shows how the schedule command is processed in FitBiz. The LogicManager receives the input commandText and parses it with FitBizParser to obtain arguments that are then parsed into ScheduleCommandParser to construct a ScheduleCommand. This ScheduleCommand is returned back up to the LogicManager which then executes it with reference to the model argument. Subsequently, the Model is updated with a new Client with the schedule changes through a series of commands as shown in the right hand side of the sequence diagram, and control is return back to LogicManager.

In designing this feature, we had to consider the alternative ways in which we can choose to store the information of a schedule. One option of storing the relevant information (day, start, end times) for a schedule was simply to concatenate these values into a single String, for example, monday-1100-1200. However, we found that this did not exploit the desirable principles of Object-Oriented Programming. As respective sanity checks had to be done for the day and timing, wrapping each of these properties into their wrapper classes allowed for better modularity and organisation of these attributes. For example, Day#isValidDay handles the validation of the input for day and Time#isValidTimingFormat handles the validation of time.

Considerations also then had to be made for how to contain multiple Schedule. The current implementation uses the ArrayList data structure to hold multiple Schedule. Other considered alternative for ScheduleList was HashSet.

Displaying the Schedule Panel

The schedules of all the clients are displayed in a time-sorted manner on the SchedulePanel of the main FitBiz GUI as shown in the picture below, demarcated by the red rectangle:

The SchedulePanel extends UiPart<Region> and takes in a ScheduleDay class. ScheduleDay is similar to ScheduleList, the difference being:

As the nature of the SchedulePanel was to display a sorted collection of Schedule, we chose ArrayList as the underlying data structure, due to the ability to sort the ArrayList via a comparator that compares Schedule according to their Day and StartTime. The code snippet below shows how the Schedule are being sorted using an anonymous comparator in the constructor for ScheduleDay:

In addition, we also harnessed the capability of the HashSet to ensure no overlaps between Schedule within each Client, which is implemented by ScheduleCommandParser#checkIfOverlaps. As the ArrayList of Schedule is being populated in the constructor of ScheduleDay, we used a HashSet to check for any overlapping Schedule. The equals method of Schedule was overriden to consider overlapping timeframes between StartTime and EndTime to be equal.