Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update DG #317

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Update DG #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f181c
Update javadoc for PersonContainsKeywordsPredicate
sopa301 Nov 13, 2023
2767544
Fix structure error in find implementation
sopa301 Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,9 @@ The following sequence diagram shows how the gather emails by financial plan ope
### Expanded Find feature

The enhanced find mechanism is facilitated by the `CombinedPredicate` and utilises the existing `FindCommand` structure.

#### Implementation Overview

Here's a sequence diagram that demonstrates how `FindCommand` works.

![FindCommandSequenceDiagram](images/FindCommandSequenceDiagram.png)
Expand Down Expand Up @@ -339,7 +342,7 @@ For now, we only allow for searching for `Name`, `FinancialPlan` and `Tag` field
searched fields, but extending the feature to search in other fields is possible by creating the appropriate
`Predicate` class and modifying the `FindCommandParser`.

#### Design Considerations:
#### Design Considerations

**Aspect: How to implement find for multiple fields**
* **Alternative 1 (current choice):** Use one unified command and format.
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/seedu/address/model/person/predicates/PersonContainsKeywordsPredicate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
import seedu.address.model.person.Person;

/**
* Tests if a {@code Person} contains certain keywords in a certain field.
* Tests if a {@code Person} contains certain keywords in a certain field. Note that the implementing predicates are not
* required to test the validity of the keywords.
*/
public interface PersonContainsKeywordsPredicate extends Predicate<Person> {

Expand Down
Loading