Denise Ng - Project Portfolio

The Calendar updates with the current ObservableList<Coupon> with commands such as the add, archive, clear, delete, edit, expiring, find, list, redo, unarchive, undo and used. The following steps describes how this behavior is implemented.

Step 1. The user launches the application for the first time.

The Calendar displayed will render the saved coupon data, triggered by the initiation of the UiManager.

Step 2. The user executes a command that alters the ObservableList<Coupon> (any command listed above).

When a command alters the observable coupon list, the listener of the observable list detects the change and the Calendar will be updated accordingly to the list by calling the CalendarPane#fillUpCalendar() method.

For example, the find command alters the observable coupon list. It calls the FindCommand#execute(Model, String) method, which calls the Model#updateFilteredCouponList(Predicate) method. It then calls the FilteredList<Coupon>#setPredicate(Predicate) method that alters the observable coupon list.

The following sequence diagram shows how the Calendar updates with the observable coupon list:

The Calendar updates with the current ObservableMonthView with commands such as goto, expiring and list or by clicking on the arrows at the sides of the calendar title. The following steps describes how this behavior is implemented.

Step 1. The user launches the application for the first time.

The Calendar displayed will render the saved coupon data, triggered by the initiation of the UiManager. The default calendar display will be set to the system’s month year.

Step 2. The user executes a command that alters the ObservableMonthView (any command listed above).

When a command alters the observable month view, the listener of the observable month view detects the change and the month view display of the calendar will be updated according by calling the CalendarPane#updateCalendarWithYearMonth method.

For example, the goto command calls the GoToCommand#execute(Model, String) method, which calls the Model#updateMonthView(String) method. It then calls the ObservableMonthView#setValue(String) method that alters the observable month view.

The following sequence diagram shows how the Calendar updates with the observable month view:

Or alternatively, instead of step 2,

Step 3. The user clicks on the arrows at the sides of the calendar title to change the month year displayed.

When a click alters the observable month view, the listener of the observable month view detects the change and the month view display of the calendar will be updated according by calling the CalendarPane#updateCalendarWithYearMonth method.

For example, clicking on the arrow on the right calls the CalendarPane#changeCalendarToNextMonth method, which calls CalendarPane#updateCalendarToNextMonth. It then calls the ObservableMonthView#setValue method that alters the observable month view.

We decided on alternative 1, to show coupons expiring on specific dates with highlights. This is because a coupon contains much information and the calendar may look cluttered and messy, which may be aesthetically unpleasant to the user. Furthermore, the user can use the expiring command to search for coupons expiring on a date or month year and have a more detailed view of the coupons in the CouponListPanel.

We decided on alternative 1, for the calendar to update with the list in the CouponListPanel. This is because this follows the Observer Pattern Design Principle. Furthermore, this will not confuse the user when the user sees a highlighted date on the Calendar when there is no coupon expiring on that date in the CouponListPanel.