Merge pull request #49 from FeliciaTay/master

Create New and Refactor Old UI classes

Author: FeliciaTay

docs/DeveloperGuide.adoc

@@ -16,6 +16,10 @@ endif::[]
 
 By: `CS2103T-F10-2`      Since: `Feb 2020`      Licence: `MIT`
 
+== Introduction
+
+(to be inserted)
+
 == Setting up
 
 Refer to the guide <<SettingUp#, here>>.

docs/diagrams/tracing/LogicSequenceDiagram.puml

@@ -13,7 +13,7 @@ create ecp
 abp -> ecp
 abp -> ecp ++: parse(arguments)
 create ec
-ecp -> ec ++: index, editPersonDescriptor
+ecp -> ec ++: index, editInternshipDescriptor
 ec --> ecp --
 ecp --> abp --: command
 abp --> logic --: command

docs/tutorials/TracingCode.adoc

@@ -180,7 +180,7 @@ image::LogicSequenceDiagram.png[]
 public CommandResult execute(Model model) throws CommandException {
     ...
     Person personToEdit = lastShownList.get(index.getZeroBased());
-    Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor);
+    Person editedPerson = createEditedPerson(personToEdit, editInternshipDescriptor);
     if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) {
         throw new CommandException(MESSAGE_DUPLICATE_PERSON);
     }

src/main/java/seedu/address/MainApp.java

@@ -15,15 +15,15 @@
 import seedu.address.commons.util.StringUtil;
 import seedu.address.logic.Logic;
 import seedu.address.logic.LogicManager;
-import seedu.address.model.AddressBook;
+import seedu.address.model.InternshipDiary;
 import seedu.address.model.Model;
 import seedu.address.model.ModelManager;
-import seedu.address.model.ReadOnlyAddressBook;
+import seedu.address.model.ReadOnlyInternshipDiary;
 import seedu.address.model.ReadOnlyUserPrefs;
 import seedu.address.model.UserPrefs;
 import seedu.address.model.util.SampleDataUtil;
-import seedu.address.storage.AddressBookStorage;
-import seedu.address.storage.JsonAddressBookStorage;
+import seedu.address.storage.InternshipDiaryStorage;
+import seedu.address.storage.JsonInternshipDiaryStorage;
 import seedu.address.storage.JsonUserPrefsStorage;
 import seedu.address.storage.Storage;
 import seedu.address.storage.StorageManager;
@@ -48,16 +48,17 @@ public class MainApp extends Application {
 
     @Override
     public void init() throws Exception {
-        logger.info("=============================[ Initializing AddressBook ]===========================");
+        logger.info("=============================[ Initializing InternshipDiary ]===========================");
         super.init();
 
         AppParameters appParameters = AppParameters.parse(getParameters());
         config = initConfig(appParameters.getConfigPath());
 
         UserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(config.getUserPrefsFilePath());
         UserPrefs userPrefs = initPrefs(userPrefsStorage);
-        AddressBookStorage addressBookStorage = new JsonAddressBookStorage(userPrefs.getAddressBookFilePath());
-        storage = new StorageManager(addressBookStorage, userPrefsStorage);
+        InternshipDiaryStorage internshipDiaryStorage =
+                new JsonInternshipDiaryStorage(userPrefs.getInternshipDiaryFilePath());
+        storage = new StorageManager(internshipDiaryStorage, userPrefsStorage);
 
         initLogging(config);
 
@@ -74,20 +75,20 @@ public void init() throws Exception {
      * or an empty address book will be used instead if errors occur when reading {@code storage}'s address book.
      */
     private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
-        Optional<ReadOnlyAddressBook> addressBookOptional;
-        ReadOnlyAddressBook initialData;
+        Optional<ReadOnlyInternshipDiary> internshipDiaryOptional;
+        ReadOnlyInternshipDiary initialData;
         try {
-            addressBookOptional = storage.readAddressBook();
-            if (!addressBookOptional.isPresent()) {
-                logger.info("Data file not found. Will be starting with a sample AddressBook");
+            internshipDiaryOptional = storage.readInternshipDiary();
+            if (!internshipDiaryOptional.isPresent()) {
+                logger.info("Data file not found. Will be starting with a sample InternshipDiary");
             }
-            initialData = addressBookOptional.orElseGet(SampleDataUtil::getSampleAddressBook);
+            initialData = internshipDiaryOptional.orElseGet(SampleDataUtil::getSampleInternshipDiary);
         } catch (DataConversionException e) {
-            logger.warning("Data file not in the correct format. Will be starting with an empty AddressBook");
-            initialData = new AddressBook();
+            logger.warning("Data file not in the correct format. Will be starting with an empty InternshipDiary");
+            initialData = new InternshipDiary();
         } catch (IOException e) {
-            logger.warning("Problem while reading from the file. Will be starting with an empty AddressBook");
-            initialData = new AddressBook();
+            logger.warning("Problem while reading from the file. Will be starting with an empty InternshipDiary");
+            initialData = new InternshipDiary();
         }
 
         return new ModelManager(initialData, userPrefs);
@@ -151,7 +152,7 @@ protected UserPrefs initPrefs(UserPrefsStorage storage) {
                     + "Using default user prefs");
             initializedPrefs = new UserPrefs();
         } catch (IOException e) {
-            logger.warning("Problem while reading from the file. Will be starting with an empty AddressBook");
+            logger.warning("Problem while reading from the file. Will be starting with an empty InternshipDiary");
             initializedPrefs = new UserPrefs();
         }
 
@@ -167,13 +168,13 @@ protected UserPrefs initPrefs(UserPrefsStorage storage) {
 
     @Override
     public void start(Stage primaryStage) {
-        logger.info("Starting AddressBook " + MainApp.VERSION);
+        logger.info("Starting InternshipDiary " + MainApp.VERSION);
         ui.start(primaryStage);
     }
 
     @Override
     public void stop() {
-        logger.info("============================ [ Stopping Address Book ] =============================");
+        logger.info("============================ [ Stopping InternshipDiary ] =============================");
         try {
             storage.saveUserPrefs(model.getUserPrefs());
         } catch (IOException e) {

src/main/java/seedu/address/commons/core/Messages.java

@@ -7,7 +7,8 @@ public class Messages {
 
     public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
     public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
-    public static final String MESSAGE_INVALID_PERSON_DISPLAYED_INDEX = "The person index provided is invalid";
-    public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
+    public static final String MESSAGE_INVALID_INTERNSHIP_DISPLAYED_INDEX =
+            "The internship application index provided is invalid";
+    public static final String MESSAGE_INTERNSHIP_LISTED_OVERVIEW = "%1$d internship application listed!";
 
 }

src/main/java/seedu/address/logic/Logic.java

@@ -8,6 +8,8 @@
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.ReadOnlyAddressBook;
+import seedu.address.model.ReadOnlyInternshipDiary;
+import seedu.address.model.internship.InternshipApplication;
 import seedu.address.model.person.Person;
 
 /**
@@ -30,14 +32,30 @@ public interface Logic {
      */
     ReadOnlyAddressBook getAddressBook();
 
+    /**
+     * Returns the InternshipDiary.
+     *
+     * @see seedu.address.model.Model#getInternshipDiary()
+     */
+    ReadOnlyInternshipDiary getInternshipDiary();
+
+
     /** Returns an unmodifiable view of the filtered list of persons */
     ObservableList<Person> getFilteredPersonList();
 
+    /** Returns an unmodifiable view of the filtered list of internship applications */
+    ObservableList<InternshipApplication> getFilteredInternshipApplicationList();
+
     /**
      * Returns the user prefs' address book file path.
      */
     Path getAddressBookFilePath();
 
+    /**
+     * Returns the user prefs' internship diary file path.
+     */
+    Path getInternshipDiaryFilePath();
+
     /**
      * Returns the user prefs' GUI settings.
      */

src/main/java/seedu/address/logic/LogicManager.java

@@ -10,10 +10,12 @@
 import seedu.address.logic.commands.Command;
 import seedu.address.logic.commands.CommandResult;
 import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.logic.parser.AddressBookParser;
+import seedu.address.logic.parser.InternshipDiaryParser;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.model.Model;
 import seedu.address.model.ReadOnlyAddressBook;
+import seedu.address.model.ReadOnlyInternshipDiary;
+import seedu.address.model.internship.InternshipApplication;
 import seedu.address.model.person.Person;
 import seedu.address.storage.Storage;
 
@@ -26,24 +28,25 @@ public class LogicManager implements Logic {
 
     private final Model model;
     private final Storage storage;
-    private final AddressBookParser addressBookParser;
+    private final InternshipDiaryParser internshipDiaryParser;
 
     public LogicManager(Model model, Storage storage) {
         this.model = model;
         this.storage = storage;
-        addressBookParser = new AddressBookParser();
+        internshipDiaryParser = new InternshipDiaryParser();
     }
 
     @Override
     public CommandResult execute(String commandText) throws CommandException, ParseException {
         logger.info("----------------[USER COMMAND][" + commandText + "]");
 
         CommandResult commandResult;
-        Command command = addressBookParser.parseCommand(commandText);
+        Command command = internshipDiaryParser.parseCommand(commandText);
         commandResult = command.execute(model);
 
         try {
-            storage.saveAddressBook(model.getAddressBook());
+            //cf: Needs to be changed after storage is refactored.
+            storage.saveInternshipDiary(model.getInternshipDiary());
         } catch (IOException ioe) {
             throw new CommandException(FILE_OPS_ERROR_MESSAGE + ioe, ioe);
         }
@@ -56,16 +59,31 @@ public ReadOnlyAddressBook getAddressBook() {
         return model.getAddressBook();
     }
 
+    @Override
+    public ReadOnlyInternshipDiary getInternshipDiary() {
+        return model.getInternshipDiary();
+    }
+
     @Override
     public ObservableList<Person> getFilteredPersonList() {
         return model.getFilteredPersonList();
     }
 
+    @Override
+    public ObservableList<InternshipApplication> getFilteredInternshipApplicationList() {
+        return model.getFilteredInternshipApplicationList();
+    }
+
     @Override
     public Path getAddressBookFilePath() {
         return model.getAddressBookFilePath();
     }
 
+    @Override
+    public Path getInternshipDiaryFilePath() {
+        return model.getInternshipDiaryFilePath();
+    }
+
     @Override
     public GuiSettings getGuiSettings() {
         return model.getGuiSettings();

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

@@ -2,59 +2,69 @@
 
 import static java.util.Objects.requireNonNull;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_COMPANY;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_DATE;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_EMAIL;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PRIORITY;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_ROLE;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_STATUS;
 
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
-import seedu.address.model.person.Person;
+import seedu.address.model.internship.InternshipApplication;
 
 /**
- * Adds a person to the address book.
+ * Adds a person to the internship diary.
  */
 public class AddCommand extends Command {
 
     public static final String COMMAND_WORD = "add";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Adds an internship application to the internship diary. "
             + "Parameters: "
-            + PREFIX_NAME + "NAME "
+            + PREFIX_COMPANY + "COMPANY "
+            + PREFIX_ROLE + "ROLE "
+            + PREFIX_ADDRESS + "ADDRESS "
             + PREFIX_PHONE + "PHONE "
             + PREFIX_EMAIL + "EMAIL "
-            + PREFIX_ADDRESS + "ADDRESS "
-            + "[" + PREFIX_TAG + "TAG]...\n"
+            + PREFIX_DATE + "APPLICATION DATE "
+            + PREFIX_PRIORITY + "PRIORITY "
+            + PREFIX_STATUS + "STATUS "
             + "Example: " + COMMAND_WORD + " "
-            + PREFIX_NAME + "John Doe "
-            + PREFIX_PHONE + "98765432 "
-            + PREFIX_EMAIL + "[email protected] "
-            + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
-            + PREFIX_TAG + "friends "
-            + PREFIX_TAG + "owesMoney";
+            + PREFIX_COMPANY + "Google "
+            + PREFIX_ROLE + "Software Engineer "
+            + PREFIX_ADDRESS + "123 Kent Ridge Road "
+            + PREFIX_PHONE + "67654321 "
+            + PREFIX_EMAIL + "[email protected] "
+            + PREFIX_DATE + "10 Feb 2020 "
+            + PREFIX_PRIORITY + "5 "
+            + PREFIX_STATUS + "Active ";
 
-    public static final String MESSAGE_SUCCESS = "New person added: %1$s";
-    public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
+    public static final String MESSAGE_SUCCESS = "New internship application added: %1$s";
+    public static final String MESSAGE_DUPLICATE_INTERNSHIP =
+            "This internship application already exists in the internship diary";
 
-    private final Person toAdd;
+    private final InternshipApplication toAdd;
 
     /**
-     * Creates an AddCommand to add the specified {@code Person}
+     * Creates an AddCommand to add the specified {@code internshipApplication}
      */
-    public AddCommand(Person person) {
-        requireNonNull(person);
-        toAdd = person;
+    public AddCommand(InternshipApplication internshipApplication) {
+        requireNonNull(internshipApplication);
+        toAdd = internshipApplication;
     }
 
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
 
-        if (model.hasPerson(toAdd)) {
-            throw new CommandException(MESSAGE_DUPLICATE_PERSON);
+        if (model.hasInternshipApplication(toAdd)) {
+            throw new CommandException(MESSAGE_DUPLICATE_INTERNSHIP);
         }
 
-        model.addPerson(toAdd);
+        model.addInternshipApplication(toAdd);
         return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
     }
 

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

@@ -2,22 +2,22 @@
 
 import static java.util.Objects.requireNonNull;
 
-import seedu.address.model.AddressBook;
+import seedu.address.model.InternshipDiary;
 import seedu.address.model.Model;
 
 /**
- * Clears the address book.
+ * Clears the internship diary.
  */
 public class ClearCommand extends Command {
 
     public static final String COMMAND_WORD = "clear";
-    public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
+    public static final String MESSAGE_SUCCESS = "Internship diary has been cleared!";
 
 
     @Override
     public CommandResult execute(Model model) {
         requireNonNull(model);
-        model.setAddressBook(new AddressBook());
+        model.setInternshipDiary(new InternshipDiary());
         return new CommandResult(MESSAGE_SUCCESS);
     }
 }