Merge pull request #165 from aliciamichellew/alicia/note-delete

Add note `delete` feature

Author: aliciamichellew

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

@@ -17,7 +17,7 @@ public class NoteAddCommand extends NoteCommand {
 
     // Also available in abstract class LocalCourseCommand to support polymorphism
     public static final String NOTE_ADD_MESSAGE_USAGE = COMMAND_WORD
-            + "add [content] [tags]: Adds a local course.";
+            + "add [content] [tags]: Adds a note.";
     public static final String ACTION_WORD = "add";
 
     public static final String MESSAGE_SUCCESS = "New note added: %1$s";

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

@@ -0,0 +1,81 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.address.commons.util.ToStringBuilder;
+import seedu.address.logic.Messages;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.SeplendidModel;
+import seedu.address.model.notes.Note;
+import seedu.address.seplendidui.UiUtil;
+
+/**
+ * Deletes a note to the NoteList.
+ */
+public class NoteDeleteCommand extends NoteCommand {
+
+    // Also available in abstract class LocalCourseCommand to support polymorphism
+    public static final String NOTE_DELETE_MESSAGE_USAGE = COMMAND_WORD
+            + " delete [index]: Deletes a note.";
+    public static final String ACTION_WORD = "delete";
+
+    public static final String MESSAGE_SUCCESS = "Note deleted: %1$s";
+
+    private final Integer noteIndexToDelete;
+
+    /**
+     * Creates a NoteAddCommand to add the specified {@code Note}
+     *
+     * @param note The Note to be added into Storage.
+     */
+    public NoteDeleteCommand(int note) {
+        super();
+        requireNonNull(note);
+        noteIndexToDelete = note;
+    }
+
+    /**
+     * TBD: This stub is to be removed after morphing is complete.
+     *
+     * @param model {@code Model} which the command should operate on.
+     * @return Nothing.
+     * @throws CommandException Always.
+     */
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        throw new CommandException("TBD: this is a stub and should be removed after morph.");
+    }
+
+    @Override
+    public CommandResult execute(SeplendidModel seplendidModel) throws CommandException {
+        requireNonNull(seplendidModel);
+
+        Note deletedNote = seplendidModel.deleteNote(noteIndexToDelete);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, Messages.format(deletedNote)),
+                UiUtil.ListViewModel.NOTE_LIST);
+
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (other == this) {
+            return true;
+        }
+
+        // instanceof handles nulls
+        if (!(other instanceof NoteDeleteCommand)) {
+            return false;
+        }
+
+        NoteDeleteCommand otherNoteDeleteCommand = (NoteDeleteCommand) other;
+        return noteIndexToDelete.equals(otherNoteDeleteCommand.noteIndexToDelete);
+    }
+
+    @Override
+    public String toString() {
+        return new ToStringBuilder(this)
+                .add("noteToDelete", noteIndexToDelete)
+                .toString();
+    }
+}

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

@@ -37,5 +37,7 @@ public class CliSyntax {
     public static final SeplendidParameter PARAMETER_MAPPINGATTRIBUTE =
             new SeplendidParameter("mappingattribute");
     public static final SeplendidParameter PARAMETER_QUERY = new SeplendidParameter("query");
+    public static final SeplendidParameter PARAMETER_INDEX = new SeplendidParameter("index");
+
 
 }

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

@@ -0,0 +1,43 @@
+package seedu.address.logic.parser;
+
+import static seedu.address.logic.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.address.logic.parser.CliSyntax.PARAMETER_INDEX;
+import static seedu.address.logic.parser.ParserUtil.areValuesEnclosedAndNonEmpty;
+
+import seedu.address.logic.commands.NoteDeleteCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+
+
+/**
+ * Parses input arguments and deletes a Note object.
+ */
+public class NoteDeleteCommandParser implements Parser<NoteDeleteCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the NoteAddCommand
+     * and returns an NoteAddCommand object for execution.
+     *
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public NoteDeleteCommand parse(String args) throws ParseException {
+        if (!areValuesEnclosedAndNonEmpty(args)) {
+            throw new ParseException(
+                    String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+                            NoteDeleteCommand.NOTE_DELETE_MESSAGE_USAGE));
+        }
+
+        SeplendidArgumentMap parameterToArgMap =
+                SeplendidArgumentTokenizer.tokenize(args, PARAMETER_INDEX);
+
+        if (!ParserUtil.areArgumentsPresent(parameterToArgMap, PARAMETER_INDEX)) {
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+                    NoteDeleteCommand.NOTE_DELETE_MESSAGE_USAGE));
+        }
+
+        // All arguments should be a non-empty {@code Optional}
+        Integer noteIndex = Integer.valueOf(parameterToArgMap.getValue(PARAMETER_INDEX).get());
+
+        return new NoteDeleteCommand(noteIndex);
+    }
+
+}

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

@@ -22,6 +22,7 @@
 import seedu.address.logic.commands.MappingSearchCommand;
 import seedu.address.logic.commands.NoteAddCommand;
 import seedu.address.logic.commands.NoteCommand;
+import seedu.address.logic.commands.NoteDeleteCommand;
 import seedu.address.logic.commands.NoteListCommand;
 import seedu.address.logic.commands.NoteSearchCommand;
 import seedu.address.logic.commands.PartnerCourseAddCommand;
@@ -254,6 +255,8 @@ private NoteCommand getNoteCommandWithArg(String userInput, String actionWord, S
             return new NoteAddCommandParser().parse(arguments);
         case NoteSearchCommand.ACTION_WORD:
             return new NoteSearchCommandParser().parse(arguments);
+        case NoteDeleteCommand.ACTION_WORD:
+            return new NoteDeleteCommandParser().parse(arguments);
         default:
             logger.finer("This user input caused a ParseException: " + userInput);
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);

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

@@ -90,8 +90,8 @@ public void setNote(Note target, Note editedNote) {
      * Removes {@code toRemove} from this {@code NoteCatalogue}.
      * {@code toRemove} must exist in the note catalogue.
      */
-    public void removeNote(Note toRemove) {
-        notes.remove(toRemove);
+    public Note removeNote(int toRemove) {
+        return notes.remove(toRemove);
     }
 
     //// util methods

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

@@ -228,8 +228,10 @@ public interface SeplendidModel {
     /**
      * Deletes the given Note.
      * The note must exist in the NoteCatalogue.
+     *
+     * @return
      */
-    void deleteNote(Note note);
+    Note deleteNote(int noteIndex);
 
     /**
      * Adds the given Note.

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

@@ -449,8 +449,8 @@ public boolean hasNote(Note note) {
     }
 
     @Override
-    public void deleteNote(Note target) {
-        noteCatalogue.removeNote(target);
+    public Note deleteNote(int target) {
+        return noteCatalogue.removeNote(target);
     }
 
     @Override

src/main/java/seedu/address/model/notes/UniqueNoteList.java

@@ -73,11 +73,21 @@ public void setNote(Note target, Note editedNote) {
      * Removes the equivalent note from the list.
      * The note must exist in the list.
      */
-    public void remove(Note toRemove) {
+    public Note remove(int toRemove) {
         requireNonNull(toRemove);
-        if (!internalList.remove(toRemove)) {
+
+        for (int i = toRemove; i < internalList.size(); i++) {
+            internalList.get(i).setIndex(i);
+        }
+
+        Note deletedNote;
+        try {
+            deletedNote = internalList.remove(toRemove - 1);
+        } catch (Exception e) {
             throw new NoteNotFoundException();
         }
+
+        return deletedNote;
     }
 
     /**

src/main/java/seedu/address/model/notes/exceptions/NoteNotFoundException.java

@@ -4,4 +4,7 @@
  * Signals that the operation is unable to find the specified note.
  */
 public class NoteNotFoundException extends RuntimeException {
+    public NoteNotFoundException() {
+        super("Note is not found. Please check if the index you input is valid.");
+    }
 }

src/test/java/seedu/address/logic/commands/LocalCourseAddCommandTest.java

@@ -295,7 +295,7 @@ public boolean hasNote(Note note) {
         }
 
         @Override
-        public void deleteNote(Note note) {
+        public Note deleteNote(int noteIndex) {
             throw new AssertionError("This method should not be called.");
         }
 

src/test/java/seedu/address/logic/commands/LocalCourseDeleteCommandTest.java

@@ -303,7 +303,7 @@ public boolean hasNote(Note note) {
         }
 
         @Override
-        public void deleteNote(Note note) {
+        public Note deleteNote(int noteIndex) {
             throw new AssertionError("This method should not be called.");
         }
 

src/test/java/seedu/address/logic/commands/PartnerCourseAddCommandTest.java

@@ -298,7 +298,7 @@ public boolean hasNote(Note note) {
         }
 
         @Override
-        public void deleteNote(Note note) {
+        public Note deleteNote(int noteIndex) {
             throw new AssertionError("This method should not be called.");
         }
 

src/test/java/seedu/address/logic/commands/PartnerCourseDeleteCommandTest.java

@@ -295,7 +295,7 @@ public boolean hasNote(Note note) {
         }
 
         @Override
-        public void deleteNote(Note note) {
+        public Note deleteNote(int noteIndex) {
             throw new AssertionError("This method should not be called.");
         }