[W7.7][T10-B1] AcquaiNote

README.adoc

@@ -1,4 +1,4 @@
-= Address Book (Level 4)
+= AddressBook
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 ifdef::env-github,env-browser[:outfilesuffix: .adoc]
 
@@ -27,7 +27,6 @@ endif::[]
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -36,4 +35,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_.
 
+* AddressBook-Level4 project created by https://se-edu.github.io/docs/Team.html[SE-EDU] initiative at https://github.com/se-edu/
+
 == Licence : link:LICENSE[MIT]

docs/AboutUs.adoc

@@ -5,52 +5,41 @@ ifdef::env-github,env-browser[:outfilesuffix: .adoc]
 :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. +
+It is further enhanced and modified by the following Project Team.
 {empty} +
 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>>]
+=== Aaron
+image::aaronyhsoh.png[width="150", align="left"]
 
-Role: Project Advisor
-
-'''
-
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
-
-Role: Team Lead +
+Role: Developer +
 Responsibilities: UI
 
-'''
+...
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Wu Qihao
+image::qihao27.png[width="150", align="left"]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Storage
 
-'''
+...
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Valensia
+image::valensia0711.png[width="150", align="left"]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Model
 
-'''
+...
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Xiang Hailin
+image::Hailinx.png[width="150", align="left"]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Logic
+
+...
 
-'''

docs/DeveloperGuide.adoc

@@ -760,7 +760,27 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 (For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
 
 [discrete]
-=== Use case: Delete person
+=== Use case: Delete person using index
+
+*MSS*
+
+1.  User requests to delete a specific person
+2.  AddressBook deletes the person
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 1a. The given name is absent.
++
+[none]
+** 1a1. AddressBook shows an error message.
++
+Use case ends.
+
+[discrete]
+=== Use case: Delete person using index
 
 *MSS*
 
@@ -851,43 +871,6 @@ Use case ends.
 +
 Use case ends.
 
-[discrete]
-=== Use case: Delete confirmation
-
-*MSS*
-
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User requests to delete a specific person in the list
-4.  AddressBook displays a dialogue window asking user to confirm deletion
-5.  User confirms deletion request
-6.  AddressBook deletes the person
-+
-Use case ends.
-
-*Extensions*
-
-[none]
-* 1a. The given index is invalid.
-+
-[none]
-** 1a1. AddressBook shows an error message.
-+
-Use case ends.
-
-[none]
-* 3a. The given index is invalid.
-+
-[none]
-** 3a1. AddressBook shows an error message.
-+
-Use case resumes at step 2.
-
-[none]
-* 5a. User cancels deletion.
-+
-Use case ends.
-
 [discrete]
 === Use case: Flexible contact addition
 

docs/UserGuide.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 4 - User Guide
+= AddressBook - User Guide
 :toc:
 :toc-title:
 :toc-placement: preamble
@@ -92,8 +92,9 @@ Edits the phone number and email address of the 1st person to be `91234567` and
 * `edit 2 n/Betsy Crower t/` +
 Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
 
-=== Locating persons by name: `find`
+=== Locating persons : `find`
 
+==== Default
 Finds persons whose names contain any of the given keywords. +
 Format: `find KEYWORD [MORE_KEYWORDS]`
 
@@ -112,9 +113,47 @@ Returns `john` and `John Doe`
 * `find Betsy Tim John` +
 Returns any person having names `Betsy`, `Tim`, or `John`
 
+==== Option1
+
+Conducts fuzzy search for persons whose any detail contain the given keywords. +
+Format: `find -u KEYWORD`
+
+****
+* The search is case insensitive. e.g `hans` will match `Hans`
+* All details are searched, including name, phone, email, address, tag and so on
+****
+
+Examples:
+
+* `find -u jo` +
+Returns `john` and `John Doe`
+* `find -u 999` +
+Returns any person containing number `999`
+
+==== Option2
+
+Finds by the specific details. +
+Format: `find -d [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]...`
+
+****
+* The search is case insensitive. e.g `hans` will match `Hans`
+* At lease one argument must be given. e.g `find -d` will not work
+* Returns any person whose name contains the given name if name is specified, phone number contains +
+the given phone number if it is specified and so on to all details
+****
+
+Examples:
+
+* `find -d n/jo` +
+Returns `john` and `John Doe`
+* `find -d p/999 e/nus` +
+Returns any person whose phone number contains number `999` and email address contains `nus`
+
 === Deleting a person : `delete`
 
-Deletes the specified person from the address book. +
+==== Option1
+
+Deletes the specified person from the address book using his/her corresponding index. +
 Format: `delete INDEX`
 
 ****
@@ -132,6 +171,25 @@ Deletes the 2nd person in the address book.
 `delete 1` +
 Deletes the 1st person in the results of the `find` command.
 
+==== Option2
+
+Deletes the specified person from the address book using his/her name. +
+Format: `del NAME`
+
+****
+* Deletes the person with the first occurrence of the specified `NAME`.
+* The name refers to the name shown in the contact list (case sensitive temporarily).
+* The name *must be a alphabets* john, Jane, Bob ...
+****
+
+Examples:
+
+* `del Alex` +
+Deletes the first person named Alex in the address book contact list.
+* `find Betsy` +
+`del Betsy` +
+Deletes the 1st person in the results of the `find` command.
+
 === Selecting a person : `select`
 
 Selects the person identified by the index number used in the last person listing. +
@@ -227,6 +285,34 @@ Format: `exit`
 Address book data are saved in the hard disk automatically after any command that changes the data. +
 There is no need to save manually.
 
+== Coming in v2.0
+
+=== Sorting all contacts : `sort`
+
+Sorts all persons alphabetically. +
+Format: `sort`
+
+=== Right click menu
+
+A right click drop down list consisting some commonly used commands in UI. +
+There is no need to type in commands.
+
+=== Popup dialog window during editing
+
+A dialog window pops up during contact editing.
+
+=== To-do list: `sch`
+
+Attach a To-do list to a specified person to manage schedule with that person. +
+Format: `sch INDEX`
+
+Examples:
+
+* `sch 1 s/dinner at 7` +
+Adds schedule with the 1st person: `dinner at 7`.
+* `sch 2 s/` +
+Clears all existing schedules with the 2nd person.
+
 == FAQ
 
 *Q*: How do I transfer my data to another Computer? +
@@ -237,8 +323,8 @@ There is no need to save manually.
 * *Add* `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...` +
 e.g. `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
 * *Clear* : `clear`
-* *Delete* : `delete INDEX` +
-e.g. `delete 3`
+* *Delete* : `delete INDEX` or `del NAME` +
+e.g. `delete 3`, `del john`
 * *Edit* : `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]...` +
 e.g. `edit 2 n/James Lee e/[email protected]`
 * *Find* : `find KEYWORD [MORE_KEYWORDS]` +

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

@@ -8,6 +8,7 @@ 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_PERSON_NAME_ABSENT = "The person name provided is absent";
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
 
 }

src/main/java/seedu/address/commons/util/StringUtil.java

@@ -13,14 +13,15 @@ public class StringUtil {
 
     /**
      * Returns true if the {@code sentence} contains the {@code word}.
-     *   Ignores case, but a full word match is required.
-     *   <br>examples:<pre>
+     * Ignores case, but a full word match is required.
+     * <br>examples:<pre>
      *       containsWordIgnoreCase("ABc def", "abc") == true
      *       containsWordIgnoreCase("ABc def", "DEF") == true
      *       containsWordIgnoreCase("ABc def", "AB") == false //not a full word match
      *       </pre>
+     *
      * @param sentence cannot be null
-     * @param word cannot be null, cannot be empty, must be a single word
+     * @param word     cannot be null, cannot be empty, must be a single word
      */
     public static boolean containsWordIgnoreCase(String sentence, String word) {
         requireNonNull(sentence);
@@ -33,7 +34,7 @@ public static boolean containsWordIgnoreCase(String sentence, String word) {
         String preppedSentence = sentence;
         String[] wordsInPreppedSentence = preppedSentence.split("\\s+");
 
-        for (String wordInSentence: wordsInPreppedSentence) {
+        for (String wordInSentence : wordsInPreppedSentence) {
             if (wordInSentence.equalsIgnoreCase(preppedWord)) {
                 return true;
             }
@@ -56,6 +57,7 @@ public static String getDetails(Throwable t) {
      * e.g. 1, 2, 3, ..., {@code Integer.MAX_VALUE} <br>
      * Will return false for any other non-null string input
      * e.g. empty string, "-1", "0", "+1", and " 2 " (untrimmed), "3 0" (contains whitespace), "1 a" (contains letters)
+     *
      * @throws NullPointerException if {@code s} is null.
      */
     public static boolean isNonZeroUnsignedInteger(String s) {
@@ -68,4 +70,22 @@ public static boolean isNonZeroUnsignedInteger(String s) {
             return false;
         }
     }
+
+    /**
+     * Returns true if {@code s} represents alphabets
+     * e.g. abc, asfa, gg, ..., <br>
+     * Will return false for any other non-alphabet string input
+     * e.g. empty string, " abc " (untrimmed), "1 a" (contains number)
+     * Will return false if the input string case does not match the string stored (case sensitive)
+     * @throws NullPointerException if {@code s} is null.
+     */
+    public static boolean isLettersOnly(String s) {
+        requireNonNull(s);
+
+        try {
+            return s.matches("[\\p{Alpha}][\\p{Alpha} ]*");
+        } catch (IllegalArgumentException iae) {
+            return false;
+        }
+    }
 }