Merge pull request nus-cs2103-AY2021S1#68 from nicholasyeo/branch-timetable-delete

Add delete feature to Timetable

Author: iqbxl

src/main/java/seedu/address/logic/commands/TimetableDeleteSlotCommand.java

@@ -0,0 +1,60 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_DAY;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_TIME;
+
+import java.util.List;
+
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.person.Slot;
+
+/**
+ * Deletes a Slot from the Timetable in fitNUS.
+ */
+public class TimetableDeleteSlotCommand extends Command {
+
+    public static final String COMMAND_WORD = "timetable_delete";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Deletes the slot identified by its day and time.\n"
+            + "Parameters: "
+            + PREFIX_DAY + "DAY"
+            + PREFIX_TIME + "TIME"
+            + "\n"
+            + "Example: " + COMMAND_WORD + " "
+            + PREFIX_DAY + "Monday "
+            + PREFIX_TIME + "1600-1800";
+
+    public static final String MESSAGE_DELETE_SLOT_SUCCESS = "Deleted Slot: %1$s";
+    public static final String MESSAGE_MISSING_SLOT = "This slot does not exist in your timetable.";
+
+    private final Slot slotToFind;
+
+    public TimetableDeleteSlotCommand(Slot slot) {
+        slotToFind = slot;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        requireNonNull(model);
+
+        List<Slot> lastShownList = model.getFilteredSlotList();
+        boolean hasSlot = lastShownList.stream().anyMatch(slotToFind::isSameSlot);
+        if (!hasSlot) {
+            throw new CommandException(MESSAGE_MISSING_SLOT);
+        }
+
+        Slot slotToDelete = lastShownList.stream().filter(slotToFind::isSameSlot).findFirst().get();
+
+        model.deleteSlotFromTimetable(slotToDelete);
+        return new CommandResult(String.format(MESSAGE_DELETE_SLOT_SUCCESS, slotToDelete));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof TimetableDeleteSlotCommand // instanceof handles nulls
+                && slotToFind.equals(((TimetableDeleteSlotCommand) other).slotToFind));
+    }
+}

src/main/java/seedu/address/logic/parser/AddressBookParser.java

@@ -26,6 +26,7 @@
 import seedu.address.logic.commands.ListExercisesCommand;
 import seedu.address.logic.commands.TimetableAddLessonCommand;
 import seedu.address.logic.commands.TimetableAddRoutineCommand;
+import seedu.address.logic.commands.TimetableDeleteSlotCommand;
 import seedu.address.logic.commands.routines.RoutineAddExerciseCommand;
 import seedu.address.logic.commands.routines.RoutineCreateCommand;
 import seedu.address.logic.commands.routines.RoutineDeleteCommand;
@@ -103,6 +104,9 @@ public Command parseCommand(String userInput) throws ParseException {
         case RoutineCreateCommand.COMMAND_WORD:
             return new RoutineCreateCommandParser().parse(arguments);
 
+        case RoutineDeleteCommand.COMMAND_WORD:
+            return new RoutineDeleteCommandParser().parse(arguments);
+
         case RoutineViewCommand.COMMAND_WORD:
             return new RoutineViewCommandParser().parse(arguments);
 
@@ -127,15 +131,15 @@ public Command parseCommand(String userInput) throws ParseException {
         case TimetableAddLessonCommand.COMMAND_WORD:
             return new TimetableAddLessonCommandParser().parse(arguments);
 
+        case TimetableDeleteSlotCommand.COMMAND_WORD:
+            return new TimetableDeleteSlotCommandParser().parse(arguments);
+
         case AddHeightCommand.COMMAND_WORD:
             return new AddHeightCommandParser().parse(arguments);
 
         case AddWeightCommand.COMMAND_WORD:
             return new AddWeightCommandParser().parse(arguments);
 
-        case RoutineDeleteCommand.COMMAND_WORD:
-            return new RoutineDeleteCommandParser().parse(arguments);
-
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }

src/main/java/seedu/address/logic/parser/TimetableDeleteSlotCommandParser.java

@@ -0,0 +1,50 @@
+package seedu.address.logic.parser;
+
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_DAY;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_TIME;
+
+import java.util.stream.Stream;
+
+import seedu.address.logic.commands.TimetableAddRoutineCommand;
+import seedu.address.logic.commands.TimetableDeleteSlotCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.person.Day;
+import seedu.address.model.person.Duration;
+import seedu.address.model.person.Slot;
+
+/**
+ * Parses input arguments and creates a new TimetableDeleteSlotCommand object
+ */
+public class TimetableDeleteSlotCommandParser implements Parser<TimetableDeleteSlotCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the RoutineAddExerciseCommand
+     * and returns an RoutineAddExerciseCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public TimetableDeleteSlotCommand parse(String args) throws ParseException {
+        ArgumentMultimap argMultimap =
+                ArgumentTokenizer.tokenize(args, PREFIX_DAY, PREFIX_TIME);
+
+        if (!arePrefixesPresent(argMultimap, PREFIX_DAY, PREFIX_TIME)
+                || !argMultimap.getPreamble().isEmpty()) {
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+                    TimetableAddRoutineCommand.MESSAGE_USAGE));
+        }
+
+        Day day = ParserUtil.parseDay(argMultimap.getValue(PREFIX_DAY).get());
+        Duration duration = ParserUtil.parseDuration(argMultimap.getValue(PREFIX_TIME).get());
+
+        Slot slotToFind = new Slot(day, duration);
+        return new TimetableDeleteSlotCommand(slotToFind);
+    }
+
+    /**
+     * Returns true if none of the prefixes contains empty {@code Optional} values in the given
+     * {@code ArgumentMultimap}.
+     */
+    private static boolean arePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
+        return Stream.of(prefixes).allMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
+    }
+}

src/main/java/seedu/address/model/AddressBook.java

@@ -245,6 +245,14 @@ public void removeRoutine(Routine key) {
         routines.remove(key);
     }
 
+    /**
+     * Removes {@code key} from timetable in {@code fitNUS}.
+     * {@code key} must exist in timetable.
+     */
+    public void removeSlotFromTimetable(Slot key) {
+        timetable.deleteSlot(key);
+    }
+
     //// util methods
 
     @Override
@@ -273,6 +281,11 @@ public ObservableList<Lesson> getLessonList() {
         return lessons.asUnmodifiableObservableList();
     }
 
+    @Override
+    public ObservableList<Slot> getSlotList() {
+        return timetable.getSlotList();
+    }
+
     @Override
     public boolean equals(Object other) {
         return other == this // short circuit if same object

src/main/java/seedu/address/model/Model.java

@@ -119,6 +119,11 @@ public interface Model {
     /** Returns an unmodifiable view of the filtered lesson list */
     ObservableList<Lesson> getFilteredLessonList();
 
+    /**
+     * Returns an unmodifiable view of the filtered slot list
+     */
+    ObservableList<Slot> getFilteredSlotList();
+
     /**
      * Updates the filter of the filtered person list to filter by the given {@code predicate}.
      *
@@ -189,6 +194,7 @@ public interface Model {
     boolean hasSlot(Slot slot);
     boolean hasOverlappingSlot(Slot slot);
     void addSlotToTimetable(Slot slot);
+    void deleteSlotFromTimetable(Slot target);
 
     void addHeight(int height);
 

src/main/java/seedu/address/model/ModelManager.java

@@ -29,6 +29,7 @@ public class ModelManager implements Model {
     private final FilteredList<Exercise> filteredExercises;
     private final FilteredList<Routine> filteredRoutine;
     private final FilteredList<Lesson> filteredLessons;
+    private final FilteredList<Slot> filteredSlots;
 
     /**
      * Initializes a ModelManager with the given addressBook and userPrefs.
@@ -45,6 +46,7 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs
         filteredExercises = new FilteredList<>(this.addressBook.getExerciseList());
         filteredRoutine = new FilteredList<>(this.addressBook.getRoutineList());
         filteredLessons = new FilteredList<>(this.addressBook.getLessonList());
+        filteredSlots = new FilteredList<>(this.addressBook.getSlotList());
     }
 
     public ModelManager() {
@@ -124,6 +126,11 @@ public void deleteRoutine(Routine target) {
         addressBook.removeRoutine(target);
     }
 
+    @Override
+    public void deleteSlotFromTimetable(Slot target) {
+        addressBook.removeSlotFromTimetable(target);
+    }
+
     @Override
     public void addPerson(Person person) {
         addressBook.addPerson(person);
@@ -256,11 +263,7 @@ public ObservableList<Person> getFilteredPersonList() {
     public ObservableList<Exercise> getFilteredExerciseList() {
         return filteredExercises;
     }
-    @Override
-    public void updateFilteredRoutineList(Predicate<Routine> predicate) {
-        requireNonNull(predicate);
-        filteredRoutine.setPredicate(predicate);
-    }
+
 
     /**
      * Returns an unmodifiable view of the list of {@code Lesson} backed by the internal list of
@@ -271,6 +274,16 @@ public ObservableList<Lesson> getFilteredLessonList() {
         return filteredLessons;
     }
 
+    @Override
+    public ObservableList<Slot> getFilteredSlotList() {
+        return filteredSlots;
+    }
+
+    @Override
+    public void updateFilteredRoutineList(Predicate<Routine> predicate) {
+        requireNonNull(predicate);
+        filteredRoutine.setPredicate(predicate);
+    }
     @Override
     public void updateFilteredPersonList(Predicate<Person> predicate) {
         requireNonNull(predicate);

src/main/java/seedu/address/model/ReadOnlyAddressBook.java

@@ -5,6 +5,7 @@
 import seedu.address.model.person.Lesson;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.Routine;
+import seedu.address.model.person.Slot;
 
 /**
  * Unmodifiable view of an address book
@@ -34,4 +35,10 @@ public interface ReadOnlyAddressBook {
      * This list will not contain any duplicate lessons.
      */
     ObservableList<Lesson> getLessonList();
+
+    /**
+     * Returns an unmodifiable view of the slots list.
+     * This list will not contain any duplicate slots.
+     */
+    ObservableList<Slot> getSlotList();
 }

src/main/java/seedu/address/model/person/Activity.java

@@ -4,6 +4,13 @@
 
 public abstract class Activity {
 
+    private static final Activity EMPTY_ACTIVITY = new Activity(new Name("Empty Activity")) {
+        @Override
+        public boolean isSameActivity(Activity otherActivity) {
+            return false;
+        }
+    };
+
     protected final Name name;
 
     /**
@@ -15,6 +22,10 @@ public Activity(Name name) {
         this.name = name;
     }
 
+    public static Activity empty() {
+        return EMPTY_ACTIVITY;
+    }
+
     public Name getName() {
         return name;
     }

src/main/java/seedu/address/model/person/Slot.java

@@ -12,6 +12,17 @@ public class Slot {
 
     private final Duration duration;
 
+    /**
+     * Constructs a new Slot object with an empty Activity. This is used to identify the slot to delete in timetable.
+     * @param day The day of the slot.
+     * @param duration The timeslot.
+     */
+    public Slot(Day day, Duration duration) {
+        activity = Activity.empty();
+        this.day = day;
+        this.duration = duration;
+    }
+
     /**
      * Constructs a new Slot object.
      * @param activity The activity to be added to timetable.

src/main/java/seedu/address/model/person/Timetable.java

@@ -2,6 +2,8 @@
 
 import static java.util.Objects.requireNonNull;
 
+import javafx.collections.ObservableList;
+
 public class Timetable {
 
     private final UniqueSlotList slots;
@@ -37,4 +39,8 @@ public void addSlot(Slot slot) {
     public void deleteSlot(Slot slot) {
         slots.remove(slot);
     }
+
+    public ObservableList<Slot> getSlotList() {
+        return slots.asUnmodifiableObservableList();
+    }
 }