Merge pull request #102 from KumChaiYin/101-dg-batch-delete

101 dg batch delete

Author: suryanshkushwaha

docs/DeveloperGuide.md

@@ -154,6 +154,44 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa
 
 This section describes some noteworthy details on how certain features are implemented.
 
+<br>
+
+### `batchdelete`
+
+The `batchdelete` command allows users to batch delete people whose policy expiry is in the specified month and year.
+
+<br>
+
+#### Implementation:
+The batch delete mechanism is facilitated by `DeleteMonth`
+
+It is also facilitated by the operation:
+* `ModelManager#batchDeleteWithPredicate(Predicate<Person> predicate)` - batch delete all people in address book who fulfil the given predicate.
+
+This operation is exposed in the `Model` interface as `Model# batchDeleteWithPredicate(Predicate<Person> predicate)`
+
+**The following sequence diagram shows how the batch delete operation works:**
+
+![BatchDeleteSequenceDiagram1](images/BatchDeleteSequenceDiagram1.png)
+
+* instance of DeleteMonth is constructed to construct a BatchDeleteCommand
+
+<div markdown="span" class="alert alert-info">:information_source: **Note:** The lifeline for `BatchDeleteCommand` and `BatchDeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+
+</div>
+
+![BatchDeleteSequenceDiagram2](images/BatchDeleteSequenceDiagram2.png)
+
+* Calling method updateFilteredPersonList to get all people in the addressBook
+* Using predicate p to get list of people to delete
+* Delete all people in the list and return all people left in addressBook
+
+#### Design consideration:
+* Users may use batch delete to delete all people whose policy expiry is in the specified month and year. For example, delete people didn’t contact the user to renew their policies for one year. 
+* Besides, if users leave an insurance company, they may like to delete people purchase policy from that company. 
+* Therefore, `Model# batchDeleteWithPredicate(Predicate<Person> predicate)` is introduced to allow batch delete by month or company.
+
+
 ### \[Proposed\] Undo/redo feature
 
 #### Proposed Implementation

docs/diagrams/BatchDeleteSequenceDiagram1.puml

@@ -0,0 +1,56 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant "bp:BatchDeleteCommandParser" as BatchDeleteCommandParser LOGIC_COLOR
+participant "deleteMonth:DeleteMonth" as DeleteMonth LOGIC_COLOR
+participant "b:BatchDeleteCommand" as BatchDeleteCommand LOGIC_COLOR
+end box
+
+[-> LogicManager : execute(batchDelete dm/09-2022)
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("batchdelete dm/09-2022")
+activate AddressBookParser
+
+create BatchDeleteCommandParser
+AddressBookParser -> BatchDeleteCommandParser
+activate BatchDeleteCommandParser
+BatchDeleteCommandParser --> AddressBookParser
+deactivate BatchDeleteCommandParser
+
+AddressBookParser -> BatchDeleteCommandParser : parse("batchdelete dm/09-2022")
+activate BatchDeleteCommandParser
+
+create DeleteMonth
+BatchDeleteCommandParser -> DeleteMonth
+activate DeleteMonth
+DeleteMonth --> BatchDeleteCommandParser : deleteMonth
+deactivate DeleteMonth
+
+create BatchDeleteCommand
+BatchDeleteCommandParser -> BatchDeleteCommand : BatchDeleteCommand(deleteMonth)
+activate BatchDeleteCommand
+
+BatchDeleteCommand --> BatchDeleteCommandParser : b
+deactivate BatchDeleteCommand
+BatchDeleteCommandParser --> AddressBookParser : b
+deactivate BatchDeleteCommandParser
+
+AddressBookParser --> LogicManager : b
+deactivate AddressBookParser
+
+destroy BatchDeleteCommandParser
+
+BatchDeleteCommand -[hidden]-> LogicManager : empty row
+ref over LogicManager, BatchDeleteCommand : execute BatchDeleteCommand
+
+BatchDeleteCommand -[hidden]-> LogicManager : empty row
+destroy BatchDeleteCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml

docs/diagrams/BatchDeleteSequenceDiagram2.puml

@@ -0,0 +1,54 @@
+@startuml
+mainframe **sd** execute BatchDeleteCommand
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant "b:BatchDeleteCommand" as BatchDeleteCommand LOGIC_COLOR
+participant "p:PolicyExpiryInDeleteMonthPredicate" as PolicyExpiryInDeleteMonthPredicate LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+end box
+
+LogicManager -> BatchDeleteCommand : execute()
+activate BatchDeleteCommand
+
+create PolicyExpiryInDeleteMonthPredicate
+BatchDeleteCommand -> PolicyExpiryInDeleteMonthPredicate : PolicyExpiryInDeleteMonthPredicate(month)
+activate PolicyExpiryInDeleteMonthPredicate
+
+PolicyExpiryInDeleteMonthPredicate --> BatchDeleteCommand : p
+deactivate PolicyExpiryInDeleteMonthPredicate
+
+BatchDeleteCommand -> Model : batchDeleteWithPredicate(p)
+activate Model
+
+Model -> Model : updateFilteredPersonList()
+Model -> Model : updateFilteredPersonList(predicate)
+Model -> Model : getFilteredPersonList()
+activate Model
+Model --> Model : listToDelete
+deactivate Model
+
+loop all Person in listToDelete
+    Model -> AddressBook : removePerson(person)
+    activate AddressBook
+    AddressBook --> Model :
+    deactivate AddressBook
+end
+
+Model -> Model : updateFilteredPersonList();
+
+Model --> BatchDeleteCommand
+deactivate Model
+
+BatchDeleteCommand --> LogicManager : result
+deactivate BatchDeleteCommand
+BatchDeleteCommand -[hidden]-> LogicManager : result
+
+
+@enduml

docs/images/BatchDeleteSequenceDiagram1.png

@@ -17,7 +17,7 @@
  */
 public class BatchDeleteCommand extends Command {
 
-    public static final String COMMAND_WORD = "batchDelete";
+    public static final String COMMAND_WORD = "batchdelete";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": batch delete people whose policy expiry date "
             + "is in the corresponding month and year. "

docs/images/BatchDeleteSequenceDiagram2.png

@@ -28,7 +28,6 @@ public RemindCommand parse(String args) throws ParseException {
                 throw new ParseException(String.format(Messages.MESSAGE_INVALID_COMMAND_FORMAT,
                         Messages.MESSAGE_NOT_POSITIVE_NUMBER));
             }
-            
             return new RemindCommand(new RemindPredicate(parsedArgs));
         } catch (NumberFormatException e) {
             throw new ParseException(String.format(Messages.MESSAGE_INVALID_COMMAND_FORMAT,

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

@@ -148,7 +148,7 @@ public void batchDeleteWithPredicate(Predicate<Person> predicate) {
         requireNonNull(predicate);
         updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
 
-        filteredPersons.setPredicate(predicate);
+        this.updateFilteredPersonList(predicate);
         ObservableList<Person> listToDelete = this.getFilteredPersonList();
 
         List<Person> copyList = new ArrayList<>(listToDelete);