nus-cs2103-AY1819S2 · roanurquhart · Apr 1, 2019 · Apr 1, 2019 · Apr 1, 2019 · Apr 1, 2019
diff --git a/README.adoc b/README.adoc
@@ -1,10 +1,8 @@
-= Address Book (Level 4)
+= Marketing Morph
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
 https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -14,19 +12,14 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+* This is a desktop marketing application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+* It is meant to be utilized by a marketing company in order to effectively organize *potential targets* and *potential clients*.
+* It is *written in OOP fashion*.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -35,5 +28,6 @@ endif::[]
 * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
 * Libraries used: https://github.com/TestFX/TestFX[TextFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
+* AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/
 
 == Licence : link:LICENSE[MIT]
diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc
@@ -4,53 +4,43 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+Marketing Morph was developed by the https://github.com/orgs/cs2103-ay1819s2-w16-3/teams/developers[w16-3] team. +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Dongzhe Fan
+image::FanDongzhe.jpg[width="150", align="left"]
+{empty}[http://github.com/yijinl[github]]
 
-Role: Project Advisor
-
-'''
-
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities: TBD
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Jiayu Zhang
+image::zhangjiayu0303.png[width="150", align="left"]
+{empty}[http://github.com/ZhangJiayu0303[github]]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: TBD
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Jitesh Khiani
+image::jkhiani.png[width="150", align="left"]
+{empty}[https://github.com/jkhiani[github]]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: TBD
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Roan Urquhart
+image::roanurquhart.png[width="150", align="left"]
+{empty}[https://github.com/roanurquhart[github]]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: TBD
 
 '''
diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -1,4 +1,4 @@
-= AddressBook Level 4 - User Guide
+= Marketing Morph - User Guide
 :site-section: UserGuide
 :toc:
 :toc-title:
@@ -14,11 +14,11 @@ ifdef::env-github[]
 endif::[]
 :repoURL: https://github.com/se-edu/addressbook-level4
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Sky Walker`      Since: `Feb 2019`      Licence: `NUS`
 
 == Introduction
 
-AddressBook Level 4 (AB4) is for those who *prefer to use a desktop app for managing contacts*. More importantly, AB4 is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB4 can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the <<Quick Start>> to get started. Enjoy!
+Marketing Morph is for marketers who want to organize consumer data. More importantly, Marketing Morph will allow marketers to use a GUI to keep track of different consumers, maintain client lists, and perform market analysis and research in one simple interface.
 
 == Quick Start
 
@@ -58,7 +58,7 @@ Format: `help`
 
 === Adding a person: `add`
 
-Adds a person to the address book +
+Adds a person to the consumer list. +
 Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...`
 
 [TIP]
@@ -71,12 +71,12 @@ Examples:
 
 === Listing all persons : `list`
 
-Shows a list of all persons in the address book. +
+Shows a list of all persons in the consumer list. +
 Format: `list`
 
 === Editing a person : `edit`
 
-Edits an existing person in the address book. +
+Edits an existing person in the consumer list. +
 Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...`
 
 ****
@@ -149,7 +149,7 @@ Examples:
 
 * `list` +
 `select 2` +
-Selects the 2nd person in the address book.
+Selects the 2nd person in the consumer list.
 * `find Betsy` +
 `select 1` +
 Selects the 1st person in the results of the `find` command.
@@ -224,6 +224,90 @@ Format: `clear`
 Exits the program. +
 Format: `exit`
 
+=== Listing persons by name/salary/occupation/residential area/group : `list`
+
+Lists all people that meet the specified filter requirement.
+
+Format: list [ALL] [s/ >N] [s/ <= N] [n/ NAME] [o/ OCCUPATION] [a/ STREET NAME] [GROUPS]
+
+Examples:
+
+`list` s/ > 50000     (list all persons with income greater than $50000)
+
+`list` ALL            (list all persons in the consumer list)
+
+`list` o/ Plumber			(list all persons who’s occupation is plumber)
+
+=== Adding a company : `add`
+
+Adds a company to the client list
+
+Format: `add` n/NAME p/NUMBER e/AVG$$ a/ADRESS s/SECTOR n/#EMPS r/REVENUES [t/TAG]…
+
+Examples:
+
+`add` n/Walmart p/98765432 e/low a/John street, block 123, #01-01  s/Retail n/500
+
+`add` n/Betsy Cakes e/medium a/Bob street, block 232 n p/1234567 s/Bakery n/20 t/popular t/local
+
+=== Find clients: `find`
+
+Lists all persons deemed capable of affording a specific product based on salary
+
+Format: `find` PRICE
+
+Examples:
+
+find 100
+
+find 20
+
+=== Find shops: `find`
+
+Lists all stores a person is deemed capable of visiting based on salary and store pricing
+
+Format: `find` [n/NAME] [s/SALARY]
+
+Examples:
+
+`find` n/steve smith
+
+`find` s/25000
+
+=== Add to favorite list: `favorite`
+
+Adds a person to the  “favorite” list (favorites etc.)
+
+Format: `favorite` [NAME]
+
+=== Create group: `group`
+
+Creates a group of persons
+
+Format: `group` GROUPNAME [[n/NAME] [a/ADDRESS]]...
+
+Examples:
+
+`group` g1 n/bob a/123 streets n/steve a/456 main n/smith a/111 abc st
+
+`group` winners n/jacob a/1 queen st n/adam a/10 north st
+
+=== Export data as CSV: `export`
+
+Exports the data to a CSV file
+
+Format: `export` [CLIENTS] [CONSUMERS] [ALL]
+
+Examples:
+
+`export` clients
+
+`export` all
+
+
+
+
+
 === Saving the data
 
 Address book data are saved in the hard disk automatically after any command that changes the data. +
@@ -258,3 +342,5 @@ e.g.`select 2`
 * *History* : `history`
 * *Undo* : `undo`
 * *Redo* : `redo`
+* *group* : `group` GROUPNAME [[n/NAME] [a/ADDRESS]]...
+* *export* : `export` [CLIENTS] [CONSUMERS] [ALL]
diff --git a/docs/images/FanDongzhe.png b/docs/images/FanDongzhe.png
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/jkhiani.png b/docs/images/jkhiani.png
diff --git a/docs/images/roanurquhart.png b/docs/images/roanurquhart.png
diff --git a/docs/images/zhangjiayu0303.png b/docs/images/zhangjiayu0303.png
diff --git a/src/main/java/seedu/address/logic/commands/AddCommand.java b/src/main/java/seedu/address/logic/commands/AddCommand.java
@@ -5,6 +5,9 @@
 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_SALARY;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_OCCUPATION;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_RELATIONSHIP;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 
 import seedu.address.logic.CommandHistory;
@@ -25,12 +28,18 @@ public class AddCommand extends Command {
             + PREFIX_PHONE + "PHONE "
             + PREFIX_EMAIL + "EMAIL "
             + PREFIX_ADDRESS + "ADDRESS "
+            + PREFIX_SALARY + "SALARY"
+            + PREFIX_OCCUPATION + "OCCUPATION"
+            + PREFIX_RELATIONSHIP + "RELATIONSHIP"
             + "[" + PREFIX_TAG + "TAG]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_NAME + "John Doe "
             + PREFIX_PHONE + "98765432 "
             + PREFIX_EMAIL + "[email protected] "
             + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
+            + PREFIX_SALARY + "100000"
+            + PREFIX_OCCUPATION + "banker"
+            + PREFIX_RELATIONSHIP + "single"
             + PREFIX_TAG + "friends "
             + PREFIX_TAG + "owesMoney";
 

diff --git a/src/main/java/seedu/address/logic/commands/FavoriteCommand.java b/src/main/java/seedu/address/logic/commands/FavoriteCommand.java
@@ -0,0 +1,57 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.address.logic.CommandHistory;
+import seedu.address.model.Model;
+import seedu.address.model.person.NameContainsKeywordsPredicate;
+
+
+/**
+ * Finds and adds all persons in address book whose name contains any of the argument keywords to a favorites list.
+ * Keyword matching is case sensitive.
+ */
+public class FavoriteCommand extends Command {
+
+    public static final String COMMAND_WORD = "favorite";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain\n"
+            + "any of the specified \"\n"
+            + "keywords (case-sensitive) and adds them to a list of favorite contacts.\n"
+            + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
+            + "Example: " + COMMAND_WORD
+            + " John";
+
+    public static final String MESSAGE_SUCCESS = "New person added: %1$s";
+    public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the favorite list";
+    public static final String MESSAGE_COMPLETE = "Adding to favorite list completed.";
+
+
+    private final NameContainsKeywordsPredicate predicate;
+
+    public FavoriteCommand(NameContainsKeywordsPredicate predicate) {
+        this.predicate = predicate;
+    }
+
+
+
+    @Override
+    public CommandResult execute(Model model, CommandHistory history) {
+        requireNonNull(model);
+        model.updateFilteredPersonList(predicate);
+        model.addFavorites(model.getFilteredPersonList().get(0));
+        model.commitAddressBook();
+        return new CommandResult(
+                String.format(MESSAGE_SUCCESS, model.getFilteredPersonList().get(0).getName()));
+    }
+
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof FavoriteCommand // instanceof handles nulls
+                && predicate.equals(((FavoriteCommand) other).predicate)); // state check
+    }
+
+}
+
diff --git a/src/main/java/seedu/address/logic/commands/HelpCommand.java b/src/main/java/seedu/address/logic/commands/HelpCommand.java
@@ -9,6 +9,7 @@
 public class HelpCommand extends Command {
 
     public static final String COMMAND_WORD = "help";
+    public static final String COMMAND_ALIAS = "h";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
             + "Example: " + COMMAND_WORD;