Updates Model to incorporate Note

Author: hengyiqun

src/main/java/seedu/address/logic/commands/notes/AddNoteCommand.java

@@ -1,14 +1,51 @@
 package seedu.address.logic.commands.notes;
 
+import static java.util.Objects.requireNonNull;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
 
-public class AddNoteCommand {
+import seedu.address.logic.commands.Command;
+import seedu.address.logic.commands.CommandResult;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.note.Note;
+
+public class AddNoteCommand extends Command {
 
     public static final String COMMAND_WORD = "addn";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a note to the note book. "
             + "Parameters: "
             + PREFIX_NAME + "NAME ";
 
+    public static final String MESSAGE_SUCCESS = "New note added: %1$s";
+    public static final String MESSAGE_DUPLICATE_NOTE = "This note already exists in the note book";
+
+    private final Note toAdd;
+
+    /**
+     * Creates an AddNoteCommand to add the specified {@code Note}
+     */
+    public AddNoteCommand(Note note) {
+        requireNonNull(note);
+        this.toAdd = note;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        requireNonNull(model);
+
+        if (model.hasNote(toAdd)) {
+            throw new CommandException(MESSAGE_DUPLICATE_NOTE);
+        }
+
+        model.addNote(toAdd);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
+    }
 
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof AddNoteCommand // instanceof handles nulls
+                && toAdd.equals(((AddNoteCommand) other).toAdd));
+    }
 }

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

@@ -13,6 +13,7 @@
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.ListAllCommand;
 import seedu.address.logic.commands.meetings.*;
+import seedu.address.logic.commands.notes.AddNoteCommand;
 import seedu.address.logic.commands.persons.AddPersonCommand;
 import seedu.address.logic.commands.persons.ClearPersonCommand;
 import seedu.address.logic.commands.persons.DeletePersonCommand;
@@ -27,6 +28,7 @@
 import seedu.address.logic.parser.connections.DeletePersonToMeetingConnectionParser;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.logic.parser.meetings.*;
+import seedu.address.logic.parser.notes.AddNoteCommandParser;
 import seedu.address.logic.parser.persons.AddPersonCommandParser;
 import seedu.address.logic.parser.persons.DeletePersonCommandParser;
 import seedu.address.logic.parser.persons.EditPersonCommandParser;

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

@@ -16,6 +16,8 @@
 import seedu.address.model.group.Group;
 import seedu.address.model.meeting.Meeting;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
+import seedu.address.model.note.Note;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.ReadOnlyAddressBook;
 import seedu.address.model.reminder.ReadOnlyReminderBook;
@@ -27,6 +29,7 @@ public interface Model {
     /** {@code Predicate} that always evaluate to true */
     Predicate<Person> PREDICATE_SHOW_ALL_PERSONS = unused -> true;
     Predicate<Meeting> PREDICATE_SHOW_ALL_MEETINGS = unused -> true;
+    Predicate<Note> PREDICATE_SHOW_ALL_NOTES = unused -> true;
 
     /**
      * Replaces user prefs data with the data in {@code userPrefs}.
@@ -223,6 +226,50 @@ public interface Model {
      */
     ObservableList<Person> getFilteredPersonListByMeetingConnection(Meeting meeting);
 
+    // ======================= Note part of the note Model interface ============================ //
+
+    /**
+     * Replaces note book data with the data in {@code noteBook}.
+     */
+    void setNoteBook(ReadOnlyNoteBook noteBook);
+
+    /** Returns the NoteBook */
+    ReadOnlyNoteBook getNoteBook();
+
+    /**
+     * Returns true if a note with the same content as {@code note} exists in the note book.
+     */
+    boolean hasNote(Note note);
+
+
+    /**
+     * Deletes the given note.
+     * The note must exist in the note book.
+     */
+    void deleteNote(Note target);
+
+    /**
+     * Adds the given note.
+     * {@code note} must not already exist in the note book.
+     */
+    void addNote(Note note);
+
+    /**
+     * Replaces the given note {@code target} with {@code editedNote}.
+     * {@code target} must exist in the note book.
+     * The content of {@code editedNote} must not be the same as another existing note in the note book.
+     */
+    void setNote(Note target, Note editedNote);
+
+    /** Returns an unmodifiable view of the filtered note list */
+    ObservableList<Note> getFilteredNoteList();
+
+    /**
+     * Updates the filter of the filtered note list to filter by the given {@code predicate}.
+     * @throws NullPointerException if {@code predicate} is null.
+     */
+    void updateFilteredNoteList(Predicate<Note> predicate);
+
 
     //============================= Timetable settings =====================================
 

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

@@ -26,6 +26,9 @@
 import seedu.address.model.meeting.MeetingBook;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
 import seedu.address.model.meeting.UniqueMeetingList;
+import seedu.address.model.note.Note;
+import seedu.address.model.note.NoteBook;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.AddressBook;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.ReadOnlyAddressBook;
@@ -56,6 +59,10 @@ public class ModelManager implements Model {
 
     private final ReminderBook reminderBook;
 
+    //===============  Note ===========================================================
+    private final NoteBook noteBook;
+    private final FilteredList<Note> filteredNotes;
+
     //===============  Timetable ===========================================================
     private final TimetablePrefs timetablePrefs;
 
@@ -80,6 +87,10 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs
         this.connection = new PersonMeetingConnection();
         this.reminderBook = new ReminderBook(this.meetingBook);
 
+        //================== Timetable ==================================================================
+        this.noteBook = new NoteBook();
+        this.filteredNotes = new FilteredList<>(this.noteBook.getNoteList());
+
         //================== Timetable ==================================================================
         //default initializes to current localdate
         timetablePrefs = new TimetablePrefs(LocalDate.now());
@@ -89,7 +100,7 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs
      * Initializes a ModelManager with the given addressBook, meetingBOok and userPrefs
      */
     public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meetingBook,
-                        ReadOnlyUserPrefs userPrefs) {
+                        ReadOnlyNoteBook noteBook, ReadOnlyUserPrefs userPrefs) {
         super();
         requireAllNonNull(addressBook, userPrefs);
 
@@ -107,6 +118,10 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meeting
         this.connection = new PersonMeetingConnection();
         this.reminderBook = new ReminderBook(this.meetingBook);
 
+        //================== Note ==================================================================
+        this.noteBook = new NoteBook(noteBook);
+        this.filteredNotes = new FilteredList<>(this.noteBook.getNoteList());
+
         //================== Timetable ==================================================================
         //default initializes to current localdate
         timetablePrefs = new TimetablePrefs(LocalDate.now());
@@ -116,7 +131,8 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meeting
      * Initializes a ModelManager with the given addressBook, meetingBook, userPrefs and PersonMeetingConnection
      */
     public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meetingBook,
-                        ReadOnlyUserPrefs userPrefs, PersonMeetingConnection connection) {
+                        ReadOnlyNoteBook noteBook, ReadOnlyUserPrefs userPrefs,
+                        PersonMeetingConnection connection) {
         super();
         requireAllNonNull(addressBook, userPrefs);
 
@@ -133,6 +149,11 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meeting
         // TODO: Modify the signature of ModelManager so that we can add connection inside it.
         this.connection = connection;
         this.reminderBook = new ReminderBook(this.meetingBook);
+
+        //================== Note ==================================================================
+        this.noteBook = new NoteBook(noteBook);
+        this.filteredNotes = new FilteredList<>(this.noteBook.getNoteList());
+
         //================== Timetable ==================================================================
         //default initializes to current localdate
         timetablePrefs = new TimetablePrefs(LocalDate.now());
@@ -141,7 +162,7 @@ public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyMeetingBook meeting
 
 
     public ModelManager() {
-        this(new AddressBook(), new MeetingBook(), new UserPrefs());
+        this(new AddressBook(), new MeetingBook(), new NoteBook(), new UserPrefs());
     }
 
     //=========== UserPrefs ==================================================================================
@@ -425,6 +446,57 @@ public void sortFilteredMeetingList(Comparator<Meeting> comparator) {
         sortedBeforeFilterMeetings.setComparator(comparator);
     }
 
+    // ======================= Note part of the note Model interface ============================ //
+
+    @Override
+    public void setNoteBook(ReadOnlyNoteBook noteBook) {
+        this.noteBook.resetData(noteBook);
+    }
+
+    @Override
+    public ReadOnlyNoteBook getNoteBook() {
+        return noteBook;
+    }
+
+    @Override
+    public boolean hasNote(Note note) {
+        requireNonNull(note);
+        return noteBook.hasNote(note);
+    }
+
+    @Override
+    public void deleteNote(Note target) {
+        noteBook.removeNote(target);
+    }
+
+    @Override
+    public void addNote(Note note) {
+        noteBook.addNote(note);
+        updateFilteredNoteList(PREDICATE_SHOW_ALL_NOTES);
+    }
+
+    @Override
+    public void setNote(Note target, Note editedNote) {
+        requireAllNonNull(target, editedNote);
+
+        noteBook.setNote(target, editedNote);
+    }
+
+    /**
+     * Returns an unmodifiable view of the list of {@code Note} backed by the internal list of
+     * {@code versionedNoteBook}
+     */
+    @Override
+    public ObservableList<Note> getFilteredNoteList() {
+        return filteredNotes;
+    }
+
+    @Override
+    public void updateFilteredNoteList(Predicate<Note> predicate) {
+        requireNonNull(predicate);
+        filteredNotes.setPredicate(predicate);
+    }
+
     //================= Get timetable prefs methods ================================================
 
     @Override
@@ -457,7 +529,8 @@ public boolean equals(Object obj) {
                 && userPrefs.equals(other.userPrefs)
                 && filteredPersons.equals(other.filteredPersons)
                 && meetingBook.equals(other.meetingBook)
-                && filteredMeetings.equals(other.filteredMeetings);
+                && filteredMeetings.equals(other.filteredMeetings)
+                && noteBook.equals(other.noteBook);
     }
 
 }

src/main/java/seedu/address/storage/NoteBookStorage.java

@@ -0,0 +1,46 @@
+package seedu.address.storage;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Optional;
+
+import seedu.address.commons.exceptions.DataConversionException;
+import seedu.address.model.note.NoteBook;
+import seedu.address.model.note.ReadOnlyNoteBook;
+
+/**
+ * Represents a storage for {@link NoteBook}.
+ */
+public interface NoteBookStorage {
+
+    /**
+     * Returns the file path of the data file.
+     */
+    Path getNoteBookFilePath();
+
+    /**
+     * Returns NoteBook data as a {@link ReadOnlyNoteBook}.
+     *   Returns {@code Optional.empty()} if storage file is not found.
+     * @throws DataConversionException if the data in storage is not in the expected format.
+     * @throws IOException if there was any problem when reading from the storage.
+     */
+    Optional<ReadOnlyNoteBook> readNoteBook() throws DataConversionException, IOException;
+
+    /**
+     * @see #getNoteBookFilePath()
+     */
+    Optional<ReadOnlyNoteBook> readNoteBook(Path filePath) throws DataConversionException, IOException;
+
+    /**
+     * Saves the given {@link ReadOnlyNoteBook} to the storage.
+     * @param noteBook cannot be null.
+     * @throws IOException if there was any problem writing to the file.
+     */
+    void saveNoteBook(ReadOnlyNoteBook noteBook) throws IOException;
+
+    /**
+     * @see #saveNoteBook(ReadOnlyNoteBook)
+     */
+    void saveNoteBook(ReadOnlyNoteBook noteBook, Path filePath) throws IOException;
+
+}