Skip to content

Commit 6d1c332

Browse files
committed
A lot modification.
1 parent 5dc987a commit 6d1c332

78 files changed

Lines changed: 1367 additions & 580 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

config/checkstyle/checkstyle.xml

Lines changed: 130 additions & 130 deletions
Large diffs are not rendered by default.

docs/DeveloperGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The rest of the App consists of four components.
4242

4343
Each of the four components,
4444

45-
* defines its *API* in an `interface` with the same name as the Component.
45+
* defines its *API* in an `interface` with the same personName as the Component.
4646
* exposes its functionality using a concrete `{Component Name}Manager` class (which implements the corresponding API `interface` mentioned in the previous point.
4747

4848
For example, the `Logic` component (see the class diagram given below) defines its API in the `Logic.java` interface and exposes its functionality using the `LogicManager.java` class which implements the `Logic` interface.
@@ -261,10 +261,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
261261
| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
262262
| `* * *` | user | add a new person | |
263263
| `* * *` | user | delete a person | remove entries that I no longer need |
264-
| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
264+
| `* * *` | user | find a person by personName | locate details of persons without having to go through the entire list |
265265
| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
266266
| `* *` | user | assign priorities for contacts | arrange my contacts and future tasks better |
267-
| `*` | user with many persons in the MeetBuddy address book | sort persons by name | locate a person easily |
267+
| `*` | user with many persons in the MeetBuddy address book | sort persons by personName | locate a person easily |
268268

269269
*{More to be added}*
270270

@@ -319,7 +319,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
319319
New features on V1.2
320320
5. Assign priorities to contacts
321321
6. Notes about the contact.
322-
7. Sort contacts by (priorities/name/groups)
322+
7. Sort contacts by (priorities/personName/groups)
323323
8. Last meetup date for each contact
324324

325325
### Non-Functional Requirements

docs/UserGuide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,19 +117,19 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`
117117

118118
Examples:
119119
* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
120-
* `edit 2 n/Betsy Crower g/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing groups.
120+
* `edit 2 n/Betsy Crower g/` Edits the personName of the 2nd person to be `Betsy Crower` and clears all existing groups.
121121

122-
### Locating persons by name: `find`
122+
### Locating persons by personName: `find`
123123

124124
Finds persons whose names or whose groups contain any of the given keywords.
125125

126126
Format: `find KEYWORD [MORE_KEYWORDS]`
127127

128128
* The search is case-insensitive. e.g `hans` will match `Hans`
129129
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
130-
* Both the name and group are searched.
130+
* Both the personName and group are searched.
131131
* Only full words will be matched e.g. `Han` will not match `Hans`
132-
* Persons whose name or group matching at least one keyword will be returned (i.e. `OR` search).
132+
* Persons whose personName or group matching at least one keyword will be returned (i.e. `OR` search).
133133
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
134134

135135
Examples:
@@ -160,7 +160,7 @@ FormatL `sort FIELDNAME`
160160

161161
* Sorts according to the field specified by `FIELDNAME`
162162
* `FIELDNAME` is only restricted to the following cases:
163-
* Sort by name : `name`
163+
* Sort by personName : `personName`
164164
* Sort by priority (Coming in v1.3) : `priority`
165165
* Sort by last seen date (Coming in v1.3) : `lastSeenDate`
166166

docs/_includes/head.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<head>
22
<meta charset="utf-8">
33
<meta http-equiv="X-UA-Compatible" content="IE=edge">
4-
<meta name="viewport" content="width=device-width, initial-scale=1">
4+
<meta personName="viewport" content="width=device-width, initial-scale=1">
55

66
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
77

docs/_sass/minima/_base.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ table {
279279
display: block;
280280
}
281281
/**
282-
* Replaces the top navigation menu with the project name when printing
282+
* Replaces the top navigation menu with the project personName when printing
283283
*/
284284
.site-header .wrapper {
285285
display: none;

docs/tutorials/AddRemark.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For now, let’s keep `RemarkCommand` as simple as possible and print some outpu
2525
``` java
2626
package seedu.address.logic.commands;
2727

28-
import seedu.address.model.Model;
28+
import seedu.address.model.Model.Model;
2929

3030
/**
3131
* Changes the remark of an existing person in the address book.
@@ -222,7 +222,7 @@ If you are stuck, check out the sample
222222

223223
## Add `Remark` to the model
224224

225-
Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the in-memory storage of person data. We achieve that by working with the `Person` model. Each field in a Person is implemented as a separate class (e.g. a `Name` object represents the person’s name). That means we should add a `Remark` class so that we can use a `Remark` object to represent a remark given to a person.
225+
Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the in-memory storage of person data. We achieve that by working with the `Person` model. Each field in a Person is implemented as a separate class (e.g. a `Name` object represents the person’s personName). That means we should add a `Remark` class so that we can use a `Remark` object to represent a remark given to a person.
226226

227227
### Add a new `Remark` class
228228

@@ -383,7 +383,7 @@ Then, create a test for the `execute` method.
383383

384384
![Creating a test for `execute`.](../images/add-remark/CreateTest.png)
385385

386-
Following convention, let’s change the name of the generated method to `execute_addRemarkUnfilteredList_success`.
386+
Following convention, let’s change the personName of the generated method to `execute_addRemarkUnfilteredList_success`.
387387

388388
Let’s use the utility functions provided in `CommandTestUtil`. The functions ensure that commands produce the expected `CommandResult` and output the correct message. In this case, `CommandTestUtil#assertCommandSuccess` is the best fit as we are testing that a `RemarkCommand` will successfully add a `Remark`.
389389

docs/tutorials/RemovingFields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ In `src/test/data/`, data meant for testing purposes are stored. While keeping t
9292
```json
9393
{
9494
"persons": [ {
95-
"name": "Person with invalid name field: Ha!ns Mu@ster",
95+
"personName": "Person with invalid personName field: Ha!ns Mu@ster",
9696
"phone": "9482424",
9797
"email": "hans@example.com",
9898
"address": "4th street"

docs/tutorials/TracingCode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before we proceed, ensure that you have done the following:
3434

3535
As you know, the first step of debugging is to put in a breakpoint where you want the debugger to pause the execution. For example, if you are trying to understand how the App starts up, you would put a breakpoint in the first statement of the `main` method. In our case, we would want to begin the tracing at the very point where the App start processing user input (i.e., somewhere in the UI component), and then trace through how the execution proceeds through the UI component. However, the execution path through a GUI is often somewhat obscure due to various *event-driven mechanisms* used by GUI frameworks, which happens to be the case here too. Therefore, let us put the breakpoint where the UI transfers control to the Logic component. According to the sequence diagram, the UI component yields control to the Logic component through a method named `execute`. Searching through the code base for `execute()` yields a promising candidate in `seedu.address.ui.CommandBox.CommandExecutor`.
3636

37-
![Using the `Search for target by name` feature. `Navigate` \> `Symbol`.](../images/tracing/Execute.png)
37+
![Using the `Search for target by personName` feature. `Navigate` \> `Symbol`.](../images/tracing/Execute.png)
3838

3939
A quick look at the class confirms that this is indeed close to what we’re looking for. However, it is just an `Interface`. Let’s delve further and find the implementation of the interface by using the `Find Usages` feature in IntelliJ IDEA.
4040

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
import seedu.address.commons.util.StringUtil;
1616
import seedu.address.logic.Logic;
1717
import seedu.address.logic.LogicManager;
18-
import seedu.address.model.AddressBook;
1918
import seedu.address.model.Model;
2019
import seedu.address.model.ModelManager;
21-
import seedu.address.model.ReadOnlyAddressBook;
20+
import seedu.address.model.person.AddressBook;
21+
import seedu.address.model.person.ReadOnlyAddressBook;
2222
import seedu.address.model.ReadOnlyUserPrefs;
2323
import seedu.address.model.UserPrefs;
2424
import seedu.address.model.util.SampleDataUtil;

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
import seedu.address.logic.commands.CommandResult;
88
import seedu.address.logic.commands.exceptions.CommandException;
99
import seedu.address.logic.parser.exceptions.ParseException;
10-
import seedu.address.model.ReadOnlyAddressBook;
10+
import seedu.address.model.Model;
11+
import seedu.address.model.meeting.Meeting;
12+
import seedu.address.model.meeting.ReadOnlyMeetingBook;
13+
import seedu.address.model.person.ReadOnlyAddressBook;
1114
import seedu.address.model.person.Person;
1215

1316
/**
@@ -26,7 +29,7 @@ public interface Logic {
2629
/**
2730
* Returns the AddressBook.
2831
*
29-
* @see seedu.address.model.Model#getAddressBook()
32+
* @see Model#getAddressBook()
3033
*/
3134
ReadOnlyAddressBook getAddressBook();
3235

@@ -38,6 +41,16 @@ public interface Logic {
3841
*/
3942
Path getAddressBookFilePath();
4043

44+
/**
45+
* Returns the MeetingBook.
46+
*
47+
* @see Model#getMeetingBook()
48+
*/
49+
ReadOnlyMeetingBook getMeetingBook();
50+
51+
/** Returns an unmodifiable view of the filtered list of meetings */
52+
ObservableList<Meeting> getFilteredMeetingList();
53+
4154
/**
4255
* Returns the user prefs' GUI settings.
4356
*/

0 commit comments

Comments
 (0)