-
+[[github](https://github.com/bernardwan)]
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[portfolio](team/bernardwan.md)]
-* Role: Project Advisor
+Personal email: bernardwan99@gmail.com
+
+[[github](https://github.com/softmagnet)]
+
+[[portfolio](team/softmagnet.md)]
+
+Personal email: zhiwei3141@gmail.com
-
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+[[github](https://github.com/yourally2)]
-### James Doe
+[[portfolio](team/yourally2.md)]
-
+
+[[github](https://github.com/s7u4rt99)]
+
+[[portfolio](team/s7u4rt99.md)]
+
+Personal email: stuartlongchayboon@gmail.com
-The ***Architecture Diagram*** given above explains the high-level design of the App.
+The **_Architecture Diagram_** given above explains the high-level design of the App.
Given below is a quick overview of main components and how they interact with each other.
**Main components of the architecture**
-**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
-* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
-* At shut down: Shuts down the components and invokes cleanup methods where necessary.
+**`Main`** has two classes called [`Main`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/Main.java) and [`MainApp`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/MainApp.java). It is responsible for,
+
+- At app launch: Initializes the components in the correct sequence, and connects them up with each other.
+- At shut down: Shuts down the components and invokes cleanup methods where necessary.
[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.
The rest of the App consists of four components.
-* [**`UI`**](#ui-component): The UI of the App.
-* [**`Logic`**](#logic-component): The command executor.
-* [**`Model`**](#model-component): Holds the data of the App in memory.
-* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+- [**`UI`**](#ui-component): The UI of the App.
+- [**`Logic`**](#logic-component): The command executor.
+- [**`Model`**](#model-component): Holds the data of the App in memory.
+- [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+
**How the architecture components interact with each other**
-The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
+The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
Each of the four main components (also shown in the diagram above),
-* defines its *API* in an `interface` with the same name as the Component.
-* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.
+- defines its _API_ in an `interface` with the same name as the Component.
+- implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.
+
+
For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
+
+
The sections below give more details of each component.
+
### UI component
-The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
+The **API** of this component is specified in [`Ui.java`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/ui/Ui.java)
-The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
+The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `StatusBarFooter` etc, and a TabPane consisting of `StudentsUi`, `ClassesUi` and `TimetableUi`. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
-The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
+The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/resources/view/MainWindow.fxml)
The `UI` component,
-* executes user commands using the `Logic` component.
-* listens for changes to `Model` data so that the UI can be updated with the modified data.
-* keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
-* depends on some classes in the `Model` component, as it displays `Person` object residing in the `Model`.
+- executes user commands using the `Logic` component.
+- listens for changes to `Model` data so that the UI can be updated with the modified data.
+- keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
+- observes the `Command` abstract class in the `Logic` component, because it needs to update when certain commands are run.
+- depends on some classes in the `Model` component, as it displays `Student` and `TuitionClass` objects residing in the `Model`.
+
+#### Students UI
+
+
+
+The `StudentListPanel` consists of `StudentCard`s, which displays information about the `Students`. The `StudentListPanel` takes in an `ObservableList
+
+
+[comment]: <> ()
How the `Logic` component works:
-1. When `Logic` is called upon to execute a command, it uses the `AddressBookParser` class to parse the user command.
-1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `AddCommand`) which is executed by the `LogicManager`.
-1. The command can communicate with the `Model` when it is executed (e.g. to add a person).
+
+1. When `Logic` is called upon to execute a command, it uses the `TimesTableParser` class to parse the user command.
+1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `AddCommand`) which is executed by the `LogicManager`. The `Command` object may call the `CommandObserver` to update the `UI` if necessary.
+1. The command can communicate with the `Model` when it is executed (e.g. to add a `Student`).
1. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`.
The Sequence Diagram below illustrates the interactions within the `Logic` component for the `execute("delete 1")` API call.
@@ -105,151 +157,463 @@ The Sequence Diagram below illustrates the interactions within the `Logic` compo
:information_source: **Note:** The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+
+
Here are the other classes in `Logic` (omitted from the class diagram above) that are used for parsing a user command:
How the parsing works:
-* When called upon to parse a user command, the `AddressBookParser` class creates an `XYZCommandParser` (`XYZ` is a placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `AddressBookParser` returns back as a `Command` object.
-* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
+
+- When called upon to parse a user command, the `TimesTableParser` class creates an `XYZCommandParser` (`XYZ` is a
+ placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to
+ parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `TimesTableParser` returns
+ back as a `Command` object.
+- All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
+
+
### Model component
-**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
-
+**API** : [`Model.java`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/model/Model.java)
+
The `Model` component,
-* stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
-* stores the currently 'selected' `Person` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
+ -
+
+
The `Storage` component,
-* can save both address book data and user preference data in json format, and read them back into corresponding objects.
-* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
-* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
+
+- can save both TimesTable data and user preference data in json format, and read them back into corresponding objects.
+- inherits from both `TimesTableStorage` and `UserPrefStorage`, which means it can be treated as either one (if only
+ the functionality of only one is needed).
+- depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`).
+- `JsonAdaptedStudent` are saved in a `List` and `JsonAdaptedTuitionClass` are saved in a
+ `List`.
+- `JsonAdaptedTag`s are stored in `JsonAdaptedStudent` as a `List`.
### Common classes
-Classes used by multiple components are in the `seedu.addressbook.commons` package.
+Classes used by multiple components are in the `seedu.times.commons` package.
+
+---
---------------------------------------------------------------------------------------------------------------------
+
## **Implementation**
This section describes some noteworthy details on how certain features are implemented.
-### \[Proposed\] Undo/redo feature
+### Classes Tab feature
-#### Proposed Implementation
+The Classes Tab feature allows one to see the user's classes and each class' corresponding students.
-The proposed undo/redo mechanism is facilitated by `VersionedAddressBook`. It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`. Additionally, it implements the following operations:
+#### Implementation
-* `VersionedAddressBook#commit()` — Saves the current address book state in its history.
-* `VersionedAddressBook#undo()` — Restores the previous address book state from its history.
-* `VersionedAddressBook#redo()` — Restores a previously undone address book state from its history.
+
-These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
+The class diagram for the Classes Tab feature as shown in the [Classes Ui component](#classes-ui) is replicated here for convenience.
+`TuitionClassPanel` and `StudentClassPanel` are both contained in their respective `StackPane` located below their respective `Label`s.
-Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.
+
-Step 1. The user launches the application for the first time. The `VersionedAddressBook` will be initialized with the initial address book state, and the `currentStatePointer` pointing to that single address book state.
+1. `MainWindow#fillInnerParts()` creates a new `ClassPanel` using the `ObservableList` and the `ObservableList` from `Logic`.
+2. A `StudentClassPanel` and a `TuitionClassPanel` is created using the `ObservableList` and `ObservableList`.
+3. `StudentClassPanel` and `TuitionClassPanel` create their respective cells for each `Student`/`TuitionClass` present.
+4. `TuitionClassPanel#setStudentClassList()` is run by taking in the `ListView` from the `StudentClassPanel`. This is to render the students in the `StudentClassPanel` in the `TuitionClassPanel` as well.
+5. Afterwards, when a `TuitionClassCard` is double clicked, `TuitionClassCard#onMouseClick()` bound to the fxml file is called, calling `TuitionClassCard#selectTuitionClass()`.
+6. The `filtered` method is then run on the `studentList` to return a `newStudentList` which is filtered by all the students belonging to the `tuitionClass`.
+7. The `tuitionClassListView` is set to the `newStudentList` created and thus rendered.
-
+
-Step 2. The user executes `delete 5` command to delete the 5th person in the address book. The `delete` command calls `Model#commitAddressBook()`, causing the modified state of the address book after the `delete 5` command executes to be saved in the `addressBookStateList`, and the `currentStatePointer` is shifted to the newly inserted address book state.
+### Timetable Tab feature
-
+The Timetable Tab feature is a feature which displays the user's classes in a visual timetable format.
-Step 3. The user executes `add n/David …` to add a new person. The `add` command also calls `Model#commitAddressBook()`, causing another modified address book state to be saved into the `addressBookStateList`.
+#### Implementation
-
+The class diagram for Timetable as shown in the [TimetableUI component](#timetable-ui) is replicated here for convenience.
+
-`.
+
+
+
+4.Based on the `Timetable#buildHeader()` reference frame above, it builds the `TimetableHeaderLabel` first, followed by the `TimetableHeaderTiming`s, starting from the earliest start time of the `ObservableList` until the latest end time of the `ObservableList` in 30 minutes interval.
+
+
+
+5.After `TimetablePanel#buildHeader()` is called, it would call `TimetablePanel#buildDays()`, which builds 7 `TimetableDay` objects to represent the 7 days of the week.
-The `redo` command does the opposite — it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.
+
-
+ -
+:information_source:
+
+**Note about the model design:**
+ +The `StudentNameList` contains a `List`, and the diagram omits the relationship that `Student` and `NOK` are subclasses of the abstract class `Person`.
+
### Storage component
-**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
+**API** : [`Storage.java`](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/storage/Storage.java)
-+ +The `StudentNameList` contains a `List
+
The `Storage` component,
-* can save both address book data and user preference data in json format, and read them back into corresponding objects.
-* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
-* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
+
+- can save both TimesTable data and user preference data in json format, and read them back into corresponding objects.
+- inherits from both `TimesTableStorage` and `UserPrefStorage`, which means it can be treated as either one (if only
+ the functionality of only one is needed).
+- depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`).
+- `JsonAdaptedStudent` are saved in a `List:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
+
-
+The image below shows the respective parts of the `TimetablePanel`:
-Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state.
+
-
+- The green box represents the `TimetableDay`, and there are 7 `TimetableDay` parts to represent the 7 days of the week.
+- The yellow box represents the `TimetableHeader`, with the box all the way at the left with the label "Time Slots" representing the `TimetableHeaderLabel`, and the others representing the `TimetableHeaderTiming`. There is always 1 `TimetableHeaderLabel` but can have many `TimetableHeaderTiming` parts depending on the earliest start time and latest end time of the week.
+- The dark blue box represents the `TimetableEmptySlot`.
+- The light blue box represents the `TimetableTuitionClassSlot`.
-:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
+[comment]: <> (Due to the limited size of the application's window, the Timetable UI would adjust itself and starts the days of the Timetable UI with the)
-
+[comment]: <> (earliest start timing and ends with the latest end timing so that the timetable is not cluttered. There is a time panel at the top to indicate what)
+
-The following sequence diagram shows how the undo operation works:
+The sequence diagrams below illustrate how the Timetable UI is built.
-
+
-:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+1.`MainWindow#fillInnerParts()` creates a new `TimetablePanel` using the `ObservableList` from `Logic`.
-
+2.`TimetablePanel#build()` is called in the constructor of `TimetablePanel` to build the Timetable Ui.
+
+3.`TimetablePanel#build()` starts building the Timetable Ui by first calling `TimetablePanel#buildHeader()` which takes in the `ObservableList:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+6.Finally, the `TimetablePanel#buildClasses()` is called, which takes in the same `ObservableList` as step 3. It iterates through the _sorted_ `ObservableList`, building a `TimetableTuitionClassSlot` for each of the `TuitionClass`, and placing `TimetableEmptySlot`s in between the `TimetableTuitionClassSlot`s.
+7.A listener is attached to the `ObservableList` which updates the Timetable UI whenever there are changes to the `ObservableList`,
+ such as when a new `TuitionClass` is added, or an existing `TuitionClass` is edited in the `ObservableList`.
+
+` or `ObservableList` that is bound to the
+UI such that UI is responsive to any changes in the list and these changes can be brought forward by setting a new
+`Predicate`. One should also note that the default `Predicate` always returns a boolean `true` which means no `Student`
+or `TuitionClass`is filtered out at the start.
-Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all address book states after the `currentStatePointer` will be purged. Reason: It no longer makes sense to redo the `add n/David …` command. This is the behavior that most modern desktop applications follow.
+The sequence diagram when a `findtag` command is executed is as follows:
-
+
-The following activity diagram summarizes what happens when a user executes a new command:
+The rest of the find command works the same way but note that for `findclass` and `findclassname`, they are calling the
+`setPredicate` method of `filteredTuitionClass` instead.
-
+#### Implementation of find predicates
-#### Design considerations:
+Furthermore, to fully understand the find command, we also have to understand how `Predicate` works. The `Predicate`s used
+that filters out students or classes are typical java `Predicate`. For each searchable attribute, a new class must be
+created that implements `Predicate` with the right generic type (i.e. predicate class for filtering `Student` must
+implement `Predicate`, and predicate class for filtering `TuitionClass` must implement `Predicate`).
+Each custom predicate class contains a `List` of search strings that would be used to match against the tested items
+in the search.
-**Aspect: How undo & redo executes:**
+
-* **Alternative 1 (current choice):** Saves the entire address book.
- * Pros: Easy to implement.
- * Cons: May have performance issues in terms of memory usage.
+### View feature
-* **Alternative 2:** Individual command knows how to undo/redo by
- itself.
- * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
- * Cons: We must ensure that the implementation of each individual command are correct.
+The `Students` tab, `Classes` tab and `Timetable` tab, are parts of the [`UI Component`](#ui-component).
+Navigation between these tabs without the mouse is crucial for our application as the target audience are people who prefer keyboard to mouse or voice commands.
-_{more aspects and alternatives to be added}_
+The `view` feature is facilitated by the `ViewCommand`, which extends the abstract `Command` class. The `ViewCommand` sets the displayed tab to be the tab specified by the user.
-### \[Proposed\] Data archiving
+#### Implementation
-_{Explain here how the data archiving feature will be implemented}_
+The sequence diagram for the `view` command is shown below.
+
---------------------------------------------------------------------------------------------------------------------
+The `ViewCommand` calls the `CommandObserver#updateView(TabName)`, which updates the view of the `CommandObserver`s watching the `Command` abstract class to the `TabName` specified.
+In this case, the only `CommandObserver` is the `MainWindow`, thus it updates the view of the `MainWindow` to display the `TIMETABLE` Tab at index 2.
+
+`TabName` is an enumeration which represents the three tabs (`Students`, `Classes`, and `Timetable`), and their respective tab index (0 for `Students`, 1 for `Classes` and 2 for `Timetable`).
+
+
+
+### Sort feature
+
+The `sort` feature allows sorting of the `Student`s and `TuitionClass`es. It is able to sort it by `Student` name or `ClassTiming`, in ascending or descending order.
+
+The `sort` feature is facilitated by the `SortCommand`, which extends the abstract `Command` class.
+
+#### Implementation
+
+The sequence diagram for the `sort` command is shown below.
+
+
+
+The `sort` command sorts the `ObservableList` or the `ObservableList` in the `Model` component, whose results gets immediately reflected in their respective `Students` tab or `Classes` Tab.
+After sorting, the `Command` sets the view to switch to their respective tabs, so that the user would be able to see the changes.
+
+
+
+### Adding a Student to a class
+
+`addtoclass` command adds an existing `Student` into an existing `TuitionClass`.
+
+#### Implementation of the parser
+
+`addtoclass` command's parser `AddToClassCommandParser` works by parsing indexes in the user input and
+generating a `List` whereby the first index will be for the `TuitionClass` receiving the `Student`s and the rest
+of the index being the `Student`s to be added into the `TuitionClass`. The only thing to note is that the parser
+will only see zero and negative indices as invalid and not
+out-of-range indices. This is because at the time of parsing, the model is not accessed to check if the indices are
+out-of-range. The reason for this design is to reduce dependency and keep to the single responsibility principle. The
+job of the parser should be separated from checking in with the model.
+
+#### Implementation of the command
+
+The `addtoclass` command follows an index based format and the `TuitionClass` contains the `Index` of the class to add
+the new students to and a `List` of `Index` of students to be added. The command's execution is composed of various
+smaller steps. The steps are listed below:
+
+1. Check indices are not out-of-range
+2. Generate a list of `Name`s to be added to the class
+3. Produce the new student `StudentNameList` based on the class's existing `StudentNameList` and the list of `Name`s to
+ be added
+4. Creating the right `EditClassDescriptor`
+5. Updating the `Model` with updated `TuitionClass`
+
+(Note that updating view action is omitted)
+
+
+
+The following sequence diagram gives an overview of the execution:
+
+
+
+The sequence diagram for the first reference frame from above:
+
+ 
+
+The sequence diagram for the second reference frame from above:
+
+
+
+
+
+### Removing Student(s) from a Tuition Class
+Allows the user to remove one or more `Student`s from a selected `TuitionClass`.
+
+#### Implementation
+The `removefromclass` command follows a similar execution path as other commands. The user input is passed to
+the `LogicManager`, which parses the input using the `TimesTableParser` and `RemoveFromClassCommandParser`.
+A `RemoveFromClassCommand` is then created with the class and student indices involved in the command.
+The command is then executed, interacting with the `Model`.
+
+An overview of how the `RemoveFromClassCommand` is created is shown by this sequence diagram:
+
+
+
+
+
+#### Challenges faced
+
+The challenging aspect in removing students from a tuition class is in figuring out which students to remove.
+
+The `RemoveFromClassCommandParser` parses the user input to obtain a list of indexes to be passed to the `RemoveFromClassCommand`.
+As such, the `RemoveFromClassCommand` only has access to a list of indices. We can easily obtain the `TuitionClass` object by
+simply using the class index with `Model#getFilteredTuitionClassList()`.
+
+On the other hand, the `TuitionClass` object only stores
+the `Name` of each `Student` in the `TuitionClass`. This was done as we use immutable objects throughout TimesTable. As such, if the user
+modifies any of the fields of a `Student` using the `edit` command, then we would have to reflect the change throughout all the tuition classes
+of the student. By only storing the `Name` of the `Student` in the `TuitionClass` object, then we only have to update all the `TuitionClass`
+objects if the user modifies the `Name` field of the `Student`.
+
+However, this decision results in added complexity when removing students from tuition classes. This is due to the fact that the `Name`s
+stored in the `TuitionClass` object are in the order in which the students were added, but the order of the students as displayed in the
+GUI is dependent on the `sort` and `find` commands used by the user. As such, the indices entered by the user do not correspond with the
+actual `Names` stored in the `TuitionClass` object.
+
+To solve this problem, we have to obtain the list of students in the order displayed by the GUI. To obtain this list,
+we use the same method that the GUI uses to display the list in the first place. We use `Model#getFilteredStudentList()`,
+then filter it to the students whose `Name`s are in the `TuitionClass` that we are concerned with. From here, we can now use the
+student indices entered by the user to obtain the `Name`s of the corresponding `Students` in the filtered list. Then we can create
+a new `TuitionClass` object with an updated list of `Name`s and replace the old `TuitionClass` with this new one.
+
+An overview of the process is shown below:
+
+
+
+
+
+### Deleting Tuition Class
+
+Deletes a `TuitionClass` from the `classes` list in the `Classes` tab, to delete a tuition class, the `deleteclass`
+command is used.
+
+#### Implementation
+
+1. The `DeleteCommandParser` parses the user input to obtain the index of the class to be deleted.
+2. A `DeleteCommand` is created with the index of the tuition class to be deleted.
+3. The `DeleteCommand#execute()` is run, the TimesTable is searched to find the tuition class to be deleted.
+4. That tuition class is then deleted from the `Model` and the `UniqueClassList` by extension.
+
+A diagram of the procedure is shown below:
+
+
+
+
+
+### Adding Tuition Class
+
+Adds a new tuition class into the `classes` list in the `Classes` tab with all the relevant detail, to add a tuition
+class, the `addclass` command is used.
+
+#### Implementation
+
+1. The `AddClassCommandParser` parses the user input to obtain 4 parameters: `ClassName`, `ClassTiming`, `Rate` and
+ `Location`.
+2. The parser checks if the user has inputted valid value for these 4 parameter.
+3. These 4 parameters and a new empty`StudentNameList` are then used to create a new `TuitionClass` to be passed into a new `AddClassCommand(TuitionClass)`
+ as an argument.
+4. This command is then executed and the new `TuitionClass` is added into the `Model` and into the
+ `UniqueClassList`, where further checks are done to ensure that there is no overlapping timing between the new
+ `TuitionClass` that is to be added and other already existing `TuitionClass`es in the list, as TimesTable is made for a
+ single user and thus designed to not allow overlapping `TuitionClass`es
+
+The sequence diagram when a `AddClass` command is executed by the LogicManager is as follows:
+
+
+
+
+
+The sequence diagram when a new `TuitionClass` is added to the `Model` is as follows
+
+
+
+
+
+#### Challenges faced
+
+The challenging aspect when adding a tuition class to the `UniqueClassList` was making sure that no overlapping
+classes were added.
+
+Initially, the `equals()` method of `TuitionClass` was used to compare `TuitionClass`es, and `ClassTiming` was the
+only comparator in the `equals()` method, but this proved problematic later on due to comparing `ClassTiming`
+using only the `equals()` method and comparing `TuitionClass`es using only `ClassTiming`. We realized that classes
+would still be added even though they overlap as they were not strictly equals and this method of comparison was
+very naive.
+
+After some trial and error with quite a lot of developer's testing, we created a `isOverlapping()` in `TuitionClass`
+that checks for overlaps which checks for any overlap where either class will be within the timeframe of one another,
+or where the start or end time of one class was within the timeframe of another. This made sure that we had a method
+to check for any overlap between classes when adding new class to the `UniqueClassList`, ensuring that no new
+classes would be added to the `UniqueClassList` when adding a tuition class to TimesTable. This check also served to
+make sure that there would be no overlapping classes resulting from an `editclass` command.
+
+---
## **Documentation, logging, testing, configuration, dev-ops**
-* [Documentation guide](Documentation.md)
-* [Testing guide](Testing.md)
-* [Logging guide](Logging.md)
-* [Configuration guide](Configuration.md)
-* [DevOps guide](DevOps.md)
+- [Documentation guide](Documentation.md)
+- [Testing guide](Testing.md)
+- [Logging guide](Logging.md)
+- [Configuration guide](Configuration.md)
+- [DevOps guide](DevOps.md)
---------------------------------------------------------------------------------------------------------------------
+---
+
+
## **Appendix: Requirements**
@@ -257,73 +621,371 @@ _{Explain here how the data archiving feature will be implemented}_
**Target user profile**:
-* has a need to manage a significant number of contacts
-* prefer desktop apps over other types
-* can type fast
-* prefers typing to mouse interactions
-* is reasonably comfortable using CLI apps
-
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
-
+- Name: Kevin Bernard Long Zheng Wei
+- Age: 28
+- Gender: Male
+- Marital status: Single
+- Country: Singapore
+- Habits: Sleeping, Netflix, Gym, Gaming
+- Lifestyle: Code, eat, sleep, gives freelance tuition.
+ - prefer desktop apps over other types
+ - can type fast
+ - prefers typing to mouse interactions
+ - is reasonably comfortable using CLI apps
+- Interest: Loves coding and building apps during his free time with friends. Loves teaching people.
+- Values: Work hard play hard.
+- Salary: $12000/mth
+- Job: Full time freelance A-levels Mathematics tuition teacher (Size of class: group and one-to-one)
+ - Has a need to manage a significant number of contacts
+- Car: Owns 2 Teslas.
+- Home Environment: Lives with parents, older brother and dog.
+- Education: NIE graduate.
+- Household Description: Sentosa Cove landed property with rich parents.
+
+**Value proposition**:
+A busy tutor who has a large number of students can find it extremely difficult to + +- manage and organize student information +- schedule according to student class timing + +This is where Timestable comes in. It improves two main areas: + +- querying + - student information + - parent information + - class timing +- data manipulation + - add + - edit + - delete + +By improving the data manipulation process, the tutor can organize student information more easily.
+By improving the querying process, the tutor can make scheduling less painstaking and time-consuming. + + ### User stories Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -| Priority | As a … | I want to … | So that I can… | -| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- | -| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App | -| `* * *` | user | add a new person | | -| `* * *` | user | delete a person | remove entries that I no longer need | -| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list | -| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident | -| `*` | user with many persons in the address book | sort persons by name | locate a person easily | - -*{More to be added}* +| Priority | As a … | I want to … | So that I can… | +| -------- | -------------- | ----------------------------------------------------------- | --------------------------------------------------- | +| `* ` | Careless User | Be notified if there was a clash in timing | I can have peace of mind | +| `* ` | User | View schedule for a specific day | Can prepare for lesson and won't be absent | +| `* *` | User | Save class rates | Keep track of how much to charge each class | +| `* *` | User | Edit my student details | Keep track of changes of my students | +| `* *` | Organised user | Sort my students and classes | Arrange them the way I want to organise them | +| `* * *` | Forgetful user | Save their contacts | I can remember them | +| `* * *` | Organised User | View my class timings in a time table | Know how my weekly schedule looks like | +| `* * *` | User | Record parent contact of my students | Contact the student's parent in case of emergencies | +| `* * *` | User | Delete my student's contacts and information | I can declutter my contacts. | +| `* * *` | User | Record locations of classes | Knows where to go | +| `* * *` | User | Find a student or class with a specific name | Find details of a specific class or student quickly | + + ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) +(For all use cases below, the **System** is the `TimesTable` and the **Actor** is the `user`, unless specified otherwise) -**Use case: Delete a person** +**Use case: Delete a student** **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 deletes the person +1. User requests to list students. +2. TimesTable shows a list of students. +3. User requests to delete a specific student in the list. +4. TimesTable deletes the student. Use case ends. **Extensions** -* 2a. The list is empty. +- 1a. The list is empty. Use case ends. -* 3a. The given index is invalid. +- 3a. The given index is invalid. - * 3a1. AddressBook shows an error message. + - 3a1. TimesTable shows an error message. - Use case resumes at step 2. + Use case resumes at step 3. -*{More to be added}* +- 3b. The given delete command has a typo. + + - 3b1. TimesTable shows an error message. + + Use case resumes at step 3. + +**Use case: Add a student** + +**MSS** + +1. User input details of new person to be added to TimesTable. +2. TimesTable adds new person with relevant details. + + Use case ends. + +**Extension** + +- 1a. User keys in add command with invalid format(missing compulsory fields). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in add command with valid format but invalid String format for certain fields. + + - 1b1. TimesTable shows an error message saying which field contains the invalid format. + + Use case resumes at step 1. + +**Use case: Edit student details** + +**MSS** + +1. User edits details of existing student. +2. TimesTable updates the student with the added details. + + Use case ends. + +**Extension** + +- 1a. User keys in field with invalid format. + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +**Use case: Find student by name** + +**MSS** + +1. User input name of student that user wants to find. +2. TimesTable shows the student that has the same name. + + Use case ends. + +**Extension** + +- 1a. No student name matches the name keyword inputted. + + - 1a1. TimesTable shows no student listed. + + Use case ends. + +**Use case: Find student by tag** + +**MSS** + +1. User input tag of student that user wants to find. +2. TimesTable shows the student that has the same tag. + + Use case ends. + +**Extension** + +- 1a. No student tag matches the tag keyword inputted. + + - 1a1. TimesTable shows no student listed. + + Use case ends. + +**Use case: Add a tuition class** + +**MSS** + +1. User input details of new tuition class to be added to TimesTable. +2. TimesTable adds new tuition class with relevant details. + + Use case ends. + +**Extension** + +- 1a. User keys in addclass command with invalid format(missing compulsory fields). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in addclass command with valid format but invalid String format for certain field. + + - 1b1. TimesTable shows an error message saying which field contains the invalid format. + + Use case resumes at step 1. + +- 1c. User keys in addclass command with valid format, valid String format for all fields, but class timing overlaps + with other classes already in TimesTable. + + - 1c1. TimesTable shows an error message saying that this operation would cause a clash in class timing. + + Use case resumes at step 1. + +**Use case: Delete a tuition class** + +**MSS** + +1. User requests to list classes. +2. TimesTable shows a list of classes. +3. User requests to delete a specific class in the list. +4. TimesTable deletes the class. + + Use case ends. + +**Extensions** + +- 1a. The list is empty. + + Use case ends. + +- 3a. The given index is invalid. + + - 3a1. TimesTable shows an error message. + + Use case resumes at step 3. + +- 3b. The given deleteclass command has a typo. + + - 3b1. TimesTable shows an error message. + + Use case resumes at step 3. + +**Use case: Add students to a tuition class** + +**MSS** + +1. User input index of class(in `classes` tab) to be added to and index of students(in `students` tab) to be added. +2. TimesTable adds students selected into class selected. + + Use case ends. + +**Extension** + +- 1a. User keys in addtoclass command with invalid index(student or class or both). + + - 1a1. TimesTable shows an error message citing which index is invalid. + + Use case resumes at step 1. + +- 1b. User attempts to add student to a class where the student is already in. + + - 1b1. TimesTable shows an error message saying that student is already in the class. + + Use case resumes at step 1. + +**Use case: Remove students from a tuition class** + +**MSS** + +1. User input index of class(in `classes` tab) to be added to and index of students(in `classes` tab) to be removed. +2. TimesTable removes students from the class selected. + + Use case ends. + +**Extension** + +- 1a. User keys in removefromclass command with invalid index(student or class or both). + + - 1a1. TimesTable shows an error message citing which index is invalid. + + Use case resumes at step 1. + +**Use case: Edit tuition class details** + +**MSS** + +1. User edits details of existing tuition class. +2. TimesTable updates the tuition class with the added details. + + Use case ends. + +**Extension** + +- 1a. User keys in field with invalid format(wrong field name). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in invalid index. + + - 1b1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1c. User keys in class timing that overlaps with other class's class timing. + + - 1c1. TimesTable shows an error message saying that this operation would cause a clash in class timing. + + Use case resumes at step 1. + +**Use case: Find tuition class by class timing** + +**MSS** + +1. User input class timing of tuition class that user wants to find. +2. TimesTable shows the tuition classes that has similar class timing. + + Use case ends. + +**Extension** + +- 1a. No tuition class timing matches the class timing keyword inputted. + + - 1a1. TimesTable shows no tuition classes listed. + + Use case ends. + +**Use case: Find tuition class by name** + +**MSS** + +1. User input name of tuition class that user wants to find. +2. TimesTable shows the tuition class that has similar name. + + Use case ends. + +**Extension** + +- 1a. No tuition class name matches the name keyword inputted. + + - 1a1. TimesTable shows no tuition class listed. + + Use case ends. + + ### Non-Functional Requirements 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. -2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. +2. Should be able to hold up to 1000 students without a noticeable sluggishness in performance for typical usage. 3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. - -*{More to be added}* +4. The data should be stored locally in a human editable text file +5. Should not use a database management system to store data +6. Should follow OOP paradigm primarily +7. Should work without requiring an installer +8. Should not depend on a remote server +9. Project should simulate a brownfield project by evolving the code base with each iteration incrementally (breadth-first) +10. Should be for a single user +11. Third-party frameworks, libraries and services should be free, open-source, do not require any installation by the user, and do not violate other requirements. +12. GUI should work well for + - Standard screen resolutions of 1920x1080 and higher + - Screen scales 100% and 125% +13. GUI should be usable for + - Resolutions 1280x720 and higher + - Screen scales 150% +14. Should package everything into a single JAR file +15. Product should not exceed 100 MB and documents should not exceed 15 MB/file +16. Developer Guide and User Guide should be PDF-friendly ### Glossary -* **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Private contact detail**: A contact detail that is not meant to be shared with others +- **Mainstream OS**: Windows, Linux, Unix, OS-X +- **Private contact detail**: A contact detail that is not meant to be shared with others + +--- --------------------------------------------------------------------------------------------------------------------- + ## **Appendix: Instructions for manual testing** @@ -347,31 +1009,363 @@ testers are expected to do more *exploratory* testing. 1. Resize the window to an optimum size. Move the window to a different location. Close the window. 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. - -1. _{ more test cases … }_ - -### Deleting a person - -1. Deleting a person while all persons are being shown - - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. - - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. - - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. - -1. _{ more test cases … }_ - -### Saving data - -1. Dealing with missing/corrupted data files - - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ - -1. _{ more test cases … }_ + Expected: The most recent window size and location is retained. + +### Clearing data: `clear` + +1. Test case: Clear all `Student`s and `TuitionClass`es in TimesTable. + 1. Prerequisite: TimesTable contains `Student`s and `TuitionClass`es. Steps to do this are below: + 1. (You may skip this if you already have `Student`s) Add a student: `add n/Amber p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. (You may skip this if you already have `TuitionClass`es) Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Clear all data: `clear` + 3. Expected: `TimesTable has been cleared!` and all `Student`s and `TuitionClass`es are removed from TimesTable. + +2. Test case: Clear empty TimesTable. + 1. Prerequisite: TimesTable does not contain `Student`s and `TuitionClass`es. Steps to do remove them are below: + 1. (You may skip this if you do not have `Student`s) Delete a student: `delete INDEX` for all `Student`s in TimesTable. + 2. (You may skip this if you do not have `TuitionClass`es) Delete a class: `deleteclass INDEX` for all `TuitionClass`es in TimesTable. + 2. Clear all data: `clear` + 3. Expected: `TimesTable has been cleared!` and all `Student`s and `TuitionClass`es are removed from TimesTable. + + +### Adding a Student: `add` +1. Test case 1: Add a `Student` successfully + 1. Add a `Student` to TimesTable: `add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 + nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Expected message: `New Student added: John Doe; Phone: 98765432; Email: johnd@example.com; Address: 311, Clementi Ave 2, #02-25; Tags: [Chemistry][Sec 3] + Next-of-Kin: Jack Doe; Phone: 10987654; Email: jackd@example.com; Address: 311, Clementi Ave 2, #02-25` +2. Test case 2: Cannot add duplicate `Student` + 1. Prerequisite: TimesTable contains the sample `Student`s. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Add a `Student` with a clash in `NAME` with an existing `Student`: `add n/Alex Yeoh p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 + nok/ n/Elise Yeoh p/10987654 e/eliseyeoh@gmail.com a/311, Clementi Ave 2, #02-25` + 3. Expected: `This person already exists in the address book` message shown. + + +### Adding a class: `addclass` + +1. Test case: Adding a `TuitionClass` successfully - no clash in `CLASS_TIMING` with existing `TuitionClass`es. + 1. Prerequisite: TimesTable does not have any `TuitionClass`es. If you have any `TuitionClass`, steps to remove them are below: + 1. (You may skip this if you do not have `TuitionClass`es) Delete a class: `deleteclass INDEX` for all `TuitionClass`es in TimesTable. + 2. Add a `TuitionClass`: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 3. Expected: `New class added: Class Timing: MON 11:30-13:30 Class Name: Sec 4 A Maths Location: Nex Tuition Center Rate: 70` and switched to `Classes` Tab. The `Classes` Tab now shows the `TuitionClass` you added. The `Timetable` Tab also shows your `TuitionClass` on `MON 11:30-13:30`. + +2. Test case: Adding a `TuitionClass` unsuccessfully - clash in `CLASS_TIMING` with existing `TuitionClass`. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Add a `TuitionClass` with a clash in `CLASS_TIMING` with an existing `TuitionClass`: `addclass cn/CS2103T ct/MON 10:30-12:30 r/70 l/Nex Tuition Center` + 3. Expected: `The operation aborted because it will introduce a clash in class timing.` and the `TuitionClass` does not get added to the `Classes` Tab. + +### Deleting a student: `delete` + +1. Test case: Delete a student successfully + 1. Prerequisites: Student to delete must be present. Steps to do this are below: + 1. Add student: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Note the students in the student list. + 2. Delete the student: `delete INDEX`. `INDEX` is the index of the student shown in the student list. If there were no other student present before, this would be 1. Otherwise, it would be the number shown at the top left corner of the student card. + 3. Expected: `Deleted Person: Student; Phone: 98765432; Email: johnd@example.com; Address: 311, Clementi Ave 2, #02-25; Tags: [Chemistry][Sec 3] Next-of-Kin: Jack Doe; Phone: 10987654; Email: jackd@example.com; Address: 311, Clementi Ave 2, #02-25` message shown. + Class no longer belongs in the class list noted in (ia). +1. Test case: Cannot delete a student that doesn't exist + 1. Prerequisites: Student at the student index to be deleted must not exist. + 1. Easiest way to ensure that this happens: run `clear` + 2. Note that the student list is empty. + 2. Delete the student at index 1: `deleteclass 1`. + 3. Expected: `The student index provided is invalid` message shown. + +### Deleting a tuition class: `deleteclass` + +1. Test case: Deleting a class successfully + + 1. Prerequisites: Class to delete must be present. Steps to do this are below: + 1. Add class: addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center + 2. Note the classes in the class list. + + 2. Delete the class: `deleteclass INDEX`. `INDEX` is the index of the class shown in the class list. If there + were no other classes present before, this would be 1. Otherwise, it would be the number shown at the top left corner of the class card. + (eg. `deleteclass 1`). + + 3. Expected: `Class deleted: Class Timing: FRI 11:30-13:30 Class Name: Sec 4 A Maths Location: Nex Tuition + Center Rate: 70` message shown. Class no longer belongs in the class list noted in (ib). + +2. Test case: Cannot delete a class that does not exist + + 1. Prerequisites: Class at the class index to be deleted must not exist. Steps to do this are below: + 1. Easiest way to ensure that this happens: run clear + 2. Note that the class list is empty. + + 2. Delete the class at index 1: `deleteclass 1`.
+ 3. Expected: `The class index provided is invalid` message shown. + +### Adding a Student to a Class: `addtoclass` + +1. Test case 1: Add a `Student` to a `TuitionClass` successfully + 1. Prerequisites: You don't have any `Student`s or `TuitionClass`es. If you have at least _one_ `Student` or `TuitionClass`, you can skip adding a `Student` / `TuitionClass` respectively. + 2. Add a `Student` to TimesTable: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 3. Add a `TuitionClass` to TimesTable: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 4. Add the `Student` to the `TuitionClass`: `addtoclass 1 1` + Expected: `Successfully added students to class` message shown +2. Test case 2: Cannot add to a class that does not exist + 1. Prerequisites: You don't have any classes. If you have any, you can remove them using the `deleteclass INDEX` command or run `clear`. + 2. If you already have a student, you can skip this step. + Add a student to TimesTable: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 3. Add the student to non-existing class: `addtoclass 1 1` + Expected: `The class index provided is invalid` message shown +3. Test case 2: Cannot add to a student that does not exist to a class + 1. Prerequisites: You don't have any students. If you have any, you can remove them using the `delete INDEX` command or run `clear`. + 2. If you already have a class, you can skip this step. + Add a class to TimesTable: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 3. Add non-existing student to the class: `addtoclass 1 1` + Expected: `The student index provided is invalid` message shown + +### Removing Student(s) from a class : `removefromclass` + +1. Test case: Removing a student from a class that doesn't currently exist + 1. Prerequisites: Class at the class index must not exist. Steps to do this are below: + 1. Run command `listclass` and note the index of the last class. + 2. Remove students from non-existing class at index (max index + 1): `removefromclass 5 1 2 3 `.
+ Where last class is at index 4 from (ib). + 3. Expected: `The class index provided is invalid` message shown. + +2. Test case: Removing a student from a class that has no student + 1. Prerequisites: There must be a class with 0 students in it. Steps to do this are below: + 1. Clear TimesTable usiing: `clear`. + 2. Add a new class: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center`. + 2. Remove student(s) from empty class: `removefromclass 1 1 2 3`. + 3. Expected: `The student index provided is invalid` message shown. + + +### Editing a student: `edit` + +1. Test case 1: Editing an existing student's own detail + 1. Prerequisites + 1. Add student: `add n/John p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Note the student and his or her index in the displayed list in the `Student` tab. + 2. Edit the student (assuming the student's index is 1): `edit 1 n/updated student p/99993293 e/edited@gmail.com a/edited address t/` + 3. Expected: All fields are changed according to `edit` command inputs and all tags are removed. +2. Test case 2: Edit an existing student's NOK detail + 1. Prerequisites: Same as above + 2. Edit the student's NOK (assuming the student's index is 1): `edit 1 nok/ n/edited NOK name e/editedNOK@gmail.com a/edited address p/92393932` + 3. Expected: All NOK fields are changed according to `edit` command inputs +3. Negative test cases + 1. Out of range + 1. (assuming the student list does not have 100 students) enter `edit 100 n/edited name` + 2. Expected: "The student index provided is invalid" is displayed + 2. No fields provided + 1. enter `edit 1` + 2. Expected: "At least one field to edit must be provided." is displayed + 3. invalid prefix provided + 1. enter `edit 1 prefix/` + 2. Expected: Invalid command format message is displayed + +### Editing a class: `editclass` + +1. Test case 1: Editing an existing class + 1. Prerequisites + 1. Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the class and its index in the displayed list in the `Class` tab + 2. Edit the class (assuming the class's index is 1): `editclass 1 cn/edited classname ct/MON 09:00-11:00 r/90 l/edited location` + 3. Expected: All fields are changed according to `editclass` command's inputs +2. Negative test cases: + 1. Out of range + 1. (assuming the class list does not have 100 classes) enter `editclass 100 cn/edited class name` + 2. Expected: "The class index provided is invalid" is displayed + 2. No fields provided + 1. enter `editclass 1` + 2. Expected: "At least one field to editclass must be provided." is displayed + 3. invalid prefix provided + 1. enter `editclass 1 prefix/` + 2. Expected: Invalid command format message is displayed + +### Sorting classes and students: `sort` + +1. Test case: Sort classes in ascending order. + 1. Prerequisites: Add more than 1 class in non-sorted order by timing. Steps to do this are below: + 1. Add later class first: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Add earlier class second: `addclass cn/Sec 5 A Maths ct/FRI 10:30-11:30 r/70 l/Nex Tuition Center` + 3. Note that 'Sec 4 A Maths' comes _before_ 'Sec 5 A Maths' + 2. Sort classes: `sort timing asc`. + 3. Expected: `Sorted classes based on timing in asc direction` message shown, 'Sec 5 A Maths' now comes _before_ 'Sec 4 A Maths' in the class list. +2. Test case: Sort students in descending order. + 1. Prerequisites: Add more than 1 student in non-sorted order by name. Steps to do this are below: + 1. Add earlier student first: `add n/Amber p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25 ` + 2. Add later student second: `add n/Zebra p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25 ` + 3. Note that 'Amber' comes _before_ 'Zebra' + 2. Sort students: `sort name desc`. + 3. Expected: `Sorted students based on name in desc direction` message shown, 'Zebra' now comes _before_ 'Amber' in the Student list. + + +### Locating a student by name: `findname` +1. Test case: No students has a name that matches the search term used + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a name that currently do not exist: `findname Jennifer`. + 3. Expected: `0 persons listed!` message shown and no students shown in `Students` tab. + +2. Test case: A student is found with name that matches search term. + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a single name that currently exists: `findname alex`. + 3. Expected: `1 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh` and + `David Li`. +3. Test case: Multiple students have names that matches search term. + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using part of a name that currently exists: `findname li`. + 3. Expected: `3 persons listed!` message shown and 3 students shown in `Students` tab, namely + `Charlotte Oliveiro`, `David Li` and `Angelica Holcomb`. + +### Locating a class by class timing: `findclass` +1. Test case: No `TuitionClass` matches the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of `WED`: `findclass WED` + 3. Expected: `0 classes listed!` and tab switched to `Classes` tab. + +2. Test case: `TuitionClass`es match the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of 'MON': `findclass mon` + 3. Expected: `2 classes listed!` and tab switched to `Classes` tab. The `Classes` Tab contains 2 `TuitionClass`es with `CLASS_TIMING` of `MON`. + +3. Test case: `TuitionClass`es match the multiple search terms used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of `MON` and `11:30-13:30`: `findclass mon 11:30-13:30` + 3. Expected: `1 classes listed!` and tab switched to `Classes` tab. The `Classes` Tab contains 1 `TuitionClass` with `CLASS_TIMING` of `MON` and `11:30-13:30`. + + + +### Locating a class by name: `findclassname` + +1. Test case: No `TuitionClass` matches the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of `CS2103T`: `findclassname CS2103T` + 3. Expected: `0 classes listed!` and tab switched to `Classes` tab. + +2. Test case: `TuitionClass`es match the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of 'math': `findclassname math` + 3. Expected: `7 classes listed!` and tab switched to `Classes` tab. The `TuitionClass`es shown in the `Classes` Tab contains 7 `TuitionClass`es with `CLASS_NAME` of `math` (case insensitive). + +3. Test case: `TuitionClass`es match the multiple search terms used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of `math` and `jc`: `findclassname math, jc` + 3. Expected: `8 classes listed!` and tab switched to `Classes` tab. The `TuitionClass`es shown in the `Classes` Tab contains 8 `TuitionClass`es with `CLASS_NAME` of `math` or `jc` or both (case insensitive). + + +### Finding Student(s) by tag : `findtag` + +1. Test case: No students have tags that matches the search term used + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using tag that currently do not exist: `findtag social studies`. + 3. Expected: `0 persons listed!` message shown and no students shown in `Students` tab. + +2. Test case: Students have tags that matches search term(single) + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a single tag that currently exists: `findtag a math`. + 3. Expected: `2 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh` and + `David Li`. +3. Test case: Students have tags that matches search terms(multiple) + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using multiple tag that currently exists: `findtag a math, physic, sec 4`. + 3. Expected: `4 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh`, + `Charlotte Oliveiro`, `David Li` and `Illana Page`. + +### Changing tabs: `view` + +1. Test case: View `Classes` tab, but command has a typo error + 1. View `Classes` tab with typo: `view clases`. + 2. Expected: `Invalid command format!This tab doesn't exists. You can only switch to students, timetable or + classes.` message show. + +2. Test case: View `Classes` tab, but user is already on `Classes` tab + 1. View `Classes` tab: `view classes`. + 2. Expected: `Successfully switched to CLASSES tab` and remains on `Classes` tab. + +3. Test case: View `Timetable` tab, user is on `Classes` tab + 1. View `Timetable` tab: `view timetable`. + 2. Expected: `Successfully switched to TIMETABLE tab` and switched to `TimeTable` tab. + +### Selecting a class: `class` +1. Test case 1: viewing an existing class + 1. Prerequisites + 1. Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the class and its index in the displayed list in the `Class` tab + 3. Adding students to the class (assuming the class's index is 1 and there are at least 2 students in Timestable): `addtoclass 1 1 2 ` + 2. view the class (assuming the class's index is 1): `class 1` + 3. Expected: the students list in `Classes` tab is showing students belonging to that class +2. Negative test cases: + 1. Out of range + 1. (assuming the class list does not have 100 classes) enter `class 100` + 2. Expected: "The class index provided is invalid" is displayed + +### Listing all students: `list` + +1. Test case: All `Student`s are listed and focus is moved to the `Students` tab. All previous filtering is reset. + 1. Prerequisite: `Student` filter must be present. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Filter `Student`s: `findname alex`. One `Student` with the name `Alex Yeoh` should be listed. + 3. Go to `Classes` tab: `view classes` + 4. List all `Student`s: `list` + 5. Expected: `Listed all students` message shown and tab is changed to the `Students` tab. The list of `Student`s should be the same as before filtering (Step 2). + + +### Listing all classes: `listclass` + +1. Test case: All `TuitionClass`es are listed and focus is moved to `Classes` tab. All previous filtering is reset. + 1. Prerequisites: `TuitionClass` to filter must be present. Steps to do this are below: + 1. Add `TuitionClass`: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the `TuitionClass`es in the class list. + 2. Filter classes: `findclassname hello`. No `TuitionClass`es should be listed. + 3. Go to `Students` tab: `view students` + 4. List `TuitionClass`es: `listclass` + 5. Expected: `Listed all classes` message shown and tab is moved to `Classes` tab. Class list noted in (ib) is shown. + + + +## Appendix: Effort + +The effort required to evolve `AB3` to `TimesTable` could be estimated to be approximately the effort required to create `AB3`. Our team have contributed roughly 15k lines of functional code, automated unit and integration testing, and documentation. + +### Addition of Tabs +* `AB3` did not have any different tabs. There was only one page showing the `Person`'s contacts. +* Addition of tabs was the start of the evolution from `AB3` into `TimesTable`. +* By adding tabs, we could implement different UIs into each tab to give the user a better experience. +* The effort to add tabs was not very high, as we only had to add an additional JavaFx control. +* Building the contents of the Tabs was the difficult portion as we had to design the entire layout of the tabs by ourselves. + +### Addition of Timetable Tab +* Adding the Timetable Tab was difficult, as it was our first time building an interface like this. +* However, we were inspired by [Pet Store Helper](#acknowledgements), and adapted some of their basic ui components for our application. +* Despite, adapting some of their basic ui components, the effort to build the Timetable Tab was still high, as we implemented the [building process](#timetable-tab-feature) from scratch. +* We had to account for many JavaFx issues, alignments and row and column spans to build the slots, which was relatively hard as it was something new to us. + +### Addition of Classes Tab +* Adding the Classes Tab was difficult as we had to design an entire user interface from the ground up to both contain details of the `TuitionClass`es in TimesTable and details of the `Student`s in each class. +* We faced exceptional difficulty when making sure that the details of the `TuitionClass`, such as size of the class, and the list of `Student`s in each class, was being updated when `Student`(s) were being added or removed from any particular class, or when any `Student`'s or `TuitionClass`'s details were being edited. +* The very design of the Classes Tab itself also necessitates a lot of coupling, because the view in the `StudentClassPanel` depended on the view in the `ClassListPanel` as it changes based on what was clicked. + +### Addition of new fields +* `AB3` initially had the `Name`, `Phone Number`, `Email`, `Address`, and `Tag` categories. +* For `TimesTable`, we added additional fields like `ClassTiming`, `ClassName`, `Rate`, `Location` and `Nok`. + +### Addition of Tuition Class +* While AB3 only tracks persons, TimesTable also keeps track of Tuition Classes. +* The addition of the `TuitionClass` required a great deal of effort as it brought a lot of problems at the start, such as `TuitionClass`es overlapping with one another when being added into the `UniqueClassList` that contained all `TuitionClass`es in TimesTable, creating a clash in class timing that was undesirable for our intended user's purpose. Another example is the problem of integrating `TuitionClass` and `Student` which is further discussed below. + + +### Addition of Commands +* TimesTable added many new commands: `addclass`, `deleteclass`, `addtoclass`, `removefromclass`, `editclass`, `findclass`, `findclassname`, `listclass`, `selectclass`, `findtag`, `sort` and `view` +* In addition, the `add` and `edit` commands were modified with the addition of TimesTable's new Next-of-Kin field. The `find` command was also modified to allow for multi-word and partial matches. +* Many of these commands required a lot of restructuring and addition of code. For instance, the class commands have to interact with both Tuition Classes and Students. + +### Integration of Classes and Students +* Integration of classes and students was difficult because it required `TuitionClass`es to store references to the `Student`s. The simple solution would be to just store a list of `Student` in each `TuitionClass` and store a list of `TuitionClass` in each `Student`. However, we quickly found out that it was not the ideal design.This is because it would increase the overall level of dependencies in the project drastically mainly due to the fact that `TuitionClass` and `Student` are so tightly coupled together. It also decreased the overall testability due to high dependency. +* Integration of classes and students was also cause storing and reading properly difficult due to their high degree of coupling and was very prone to error, resulting in a very large amounts of checks needed when reading from the data JSON file. +* The design that we eventually implemented was to use a list of `Name`s instead which effectively reduced overall dependency and the number of bugs that we had. It also reduced the number of lines in our codebase by hundreds which is great since we were able to achieve the same desired result with less code. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..77244c21177 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -23,7 +23,7 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.
:exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. 1. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. + 1. Run the `seedu.times.Main` and try a few commands. 1. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- diff --git a/docs/Testing.md b/docs/Testing.md index 8a99e82438a..2f80e71f618 100644 --- a/docs/Testing.md +++ b/docs/Testing.md @@ -29,8 +29,8 @@ There are two ways to run tests. This project has three types of tests: 1. *Unit tests* targeting the lowest level methods/classes.
- e.g. `seedu.address.commons.StringUtilTest` + e.g. `seedu.times.commons.StringUtilTest` 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
- e.g. `seedu.address.storage.StorageManagerTest` + e.g. `seedu.times.storage.StorageManagerTest` 1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
- e.g. `seedu.address.logic.LogicManagerTest` + e.g. `seedu.times.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3716f3ca8a4..540aae89ecc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,190 +3,770 @@ layout: page title: User Guide --- -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. + +## Introduction + +**TimesTable** is a **tuition management** desktop app for tutors who prefer to use a Command Line Interface (CLI) over a +Graphical User Interface (GUI). **TimesTable** allows you to manage and keep track of your tuition students and classes. +The app stores basic information about your students and classes, such as `Name`, `Email`, `Address`, `Class Timing`, and more. +You can add the students to classes to organise them. + +**TimesTable** also automatically generates a TimeTable for you based on your created classes so you can visualise +your schedule at a glance. + +**TimesTable** uses the CLI to enter commands, which means you control the application by typing in commands into the +command box. Other GUI applications are controlled by clicking on buttons and boxes. +If you can type fast, TimesTable can get your class management tasks done faster than traditional GUI applications. +Using the CLI allows you to control the application quickly while still having the visual benefits of a GUI. + +This guide will take you through the commands of **TimesTable** step by step. For more information about how to use the +guide, head to the [Reading this User Guide](#reading-this-user-guide) section. To get started with using **TimesTable**, +jump to the [Quick Start](#quick-start) section. For a full list of commands and detailed instructions on each one, head to the +[Features](#features) section. + + + +## Table of Contents * Table of Contents {:toc} -------------------------------------------------------------------------------------------------------------------- -## Quick start +## Quick Start +### Set Up + +1. Ensure you have Java `11` or above installed in your Computer, if you do not, you can download it from [here](https://www.oracle.com/java/technologies/downloads/#java11-windows). + +2. Download the latest `timestable.jar` from [here](https://github.com/AY2122S1-CS2103T-F11-1/tp/releases). +  +3. Copy the file to the folder you want to use as the _home folder_ for your TimesTable. + -1. Ensure you have Java `11` or above installed in your Computer. -1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). +4. For `Windows`, double-click the file to start the app. + For `Mac`, you need to open `TimesTable` using terminal. You can right-click on the folder and click on New Terminal at Folder to bring up your terminal, and key in `java -jar timestable.jar`. Press Enter to launch the application. +  + -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. -1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+5. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample student data.
 + + + +### Tutorial + +1. Before we begin, note that we are at the Students Tab, where we show all the students that you are teaching. Other tabs will be explained later. +2. To get started, lets add a student using the [`add`](#adding-a-student-add) command. +First type `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` +into the command box to add 'John Doe' using the parameter `n/`, with his specified phone number using the `p/` parameter, and email using the `e/` parameter and so on (for more details refer to the [`add`](#adding-a-student-add) command). If you're wondering, the text after +`nok/` specifies all the information for his _next-of-kin_, and uses the similar parameters. + +Press enter afterwards to execute the command which adds a student to our TimesTable. + + +3. Next, we can try creating a class! Similar to before, we run the [`addclass`](#adding-a-class-addclass) command. +Type `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` into the command box. +We are adding a class 'Sec 4 A Maths' using the `cn/` parameter, at 11:30am to 1:30pm using the `ct/` parameter, together with the rate and the location. + +Again, press enter to add the class to our TimesTable. + + +4. Oh! Notice that you have been transported to another tab. This is known as the Classes Tab, +which shows you all the information about the Classes you are teaching. + +When we scroll down, you can see that 'Sec 4 A Maths' is added at the bottom. + +5. See that blank space on the right? It is where all the students who are under that class go to. +I will now show you how to add students to a class! Here, we are using the [`addtoclass`](#adding-studentstudents-to-a-class-addtoclass) +command, which takes in the index of the class, followed by the indexes of the students. +Type `addtoclass 13 10` to add the student that you just added (in index 10) to the class that you just added (in index 13). +As shown, you can see the students that are added to the class. How cool is that? + + +6. Continuing on, let me introduce you to the Timetable tab! Here, we are using the [`view`](#viewing-of-different-tabs-view) command. +Type `view timetable` and press enter. + +Here, you can see all the classes that you are teaching in a nice, visual, weekly timetable format! On the first row which is Monday, you can see the 'Sec 4 A Math' class that you just added, with the correct timing. + + +7. Now that you have experienced the core functionality, you are all ready to explore the other commands. +To delete, we have commands like [`delete`](#deleting-a-student--delete) and [`deleteclass`](#delete-a-class-deleteclass) for students and classes respectively, and even commands to [`find`](#locating-students-by-name-findname) and [`sort`](#sorting-students-and-classes-sort) classes and students when you have become more familiar with the app, just refer to the [Features](#features) below for details of each command. +Lastly, if you would like to fill in Timestable with your own students, simply use the [`clear`](#clearing-all-entries--clear) command to delete all the sample students and classes. + + + +## Reading this User Guide +### General Symbols and Syntax + +Syntax | Definition +--------|------------------ +`UPPER_CASE` | Words in `UPPER_CASE` are the inputs to be supplied by the user.
e.g. in `add n/NAME`, `NAME` is an input which can be used as `add n/John Doe`. +`a/` | Signifies a field. The user inputs the field after the signifier. Also known as a parameter. (see [Glossary](#glossary)) +`[a/UPPER_CASE]` | Items in square brackets refer to optional fields.
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or just `n/John Doe`. +`...` | Indicates that the preceding field can be used multiple times.
e.g. `[t/TAG]…` can be used multiple times, such as`t/friend` or `t/friend t/family`. -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +### Glossary - * **`list`** : Lists all contacts. +Term | Definition +--------|------------------ +NOK | Next-of-kin. Refers to the student's guardian, parent or perhaps close friend to be contacted regarding admin matters like payment. +PARAMETERS | The inputs before the `/` are known as _parameters_.
e.g `n/NAME` (`n/` is the parameter for name).
e.g `a/ADDRESS` (`a/` is the parameter for name). +INDEX | The number next to the Student/Class that shows its postion on the list. - * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +
- * **`delete`**`3` : Deletes the 3rd contact shown in the current list. + - * **`clear`** : Deletes all contacts. +## Features - * **`exit`** : Exits the app. +
-
- +Edits an existing student in the TimesTable. -Format: `help` +Format: +`edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [nok/ [n/NOK_NAME] [p/NOK_PHONE] [e/NOK_EMAIL] [a/NOK_ADDRESS]]` +` + +* Edits the student at the specified `INDEX`. The index refers to the index number shown in the displayed student + list. The index **must be a positive integer** 1, 2, 3, … +* At least one of the optional fields must be provided. +* An optional `nok/` (next-of-kin) field can be provided to edit the student's next-of-kin (NOK). All fields that come after `nok/` + will be for the student's next-of-kin. (same rule from `add` command applies) + * If `nok/` is provided, at least one of the optional fields belonging to NOK must be provided. + * Inputs in the first segment are about student information whereas inputs in the second segment are about NOK's information. +* The order of input within its own segment is swappable, but the segments themselves are not. +* When editing tags, the existing tags of the student will be removed i.e adding of tags is not cumulative. + * You can remove all the student's tags by typing `t/` without + specifying any tags after it. +* `NAME` can have a maximum of 120 characters. +* `PHONE_NUMBER` has to be between 3-25 numbers. +* `TAG` can have a maximum of 15 characters per tag, with a maximum of 5 tags. + +Examples (editing student information only): +1. `edit 1 p/91234567 e/johndoe@example.com` Edits the `PHONE` and `EMAIL` of the 1st student to be `91234567` and `johndoe@example.com` respectively. +2. `edit 2 n/Betsy Crower t/` Edits the `NAME` of the 2nd student to be `Betsy Crower` and clears all existing `TAG`s. +3. `edit 1 n/kevin p/12345678` Edits the `NAME` and `PHONE` of student 1 to become `kevin` and `12345678`. +4. `edit 4 n/John Walker a/4 Petir Road #16-04 Singapore 657891` Edits the `NAME` and `ADDRESS` of the 4th person to be + `John Walker` and `4 Petir Road #16-04 Singapore 657891` respectively. + + +
+ +Finds students whose `NAME` contain any of the given keywords. +Note that if you want to display the entire list of students again, run `list`. + +Format: +`findname NAME [, [NAME]...]` + +* The search is case-insensitive. e.g. `hans` will match `Hans`. +* The search terms are split by commas. e.g. `findname alex lim, bernice yu` +* Only the student's `NAME` is searched. +* Partial matches will still be matched e.g. `Han` will match `Hans`. +* Persons matching at least one search term will be returned (i.e. `OR` search). + e.g. `findname alex lim, bernice yu` will return `Alex Lim`, `Bernice Yu`. +* The entire search term is used for matching e.g. `findname Alex L` will match `Alex Lim` + but not `Alex Yu` + + +Examples: +1. `findname John` returns `john` and `John Doe` in both `Students` and `Classes` tab. +2. `findname alex, david` returns `Alex Yeoh`, `David Li` in both `Students` and `Classes` tab.
-### Adding a person: `add` + + lastShownList = model.getFilteredPersonList();
-
- if (index.getZeroBased() >= lastShownList.size()) {
- throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
- }
-
- Person personToEdit = lastShownList.get(index.getZeroBased());
- Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor);
-
- if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) {
- throw new CommandException(MESSAGE_DUPLICATE_PERSON);
- }
-
- model.setPerson(personToEdit, editedPerson);
- model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
- return new CommandResult(String.format(MESSAGE_EDIT_PERSON_SUCCESS, editedPerson));
- }
-
- /**
- * Creates and returns a {@code Person} with the details of {@code personToEdit}
- * edited with {@code editPersonDescriptor}.
- */
- private static Person createEditedPerson(Person personToEdit, EditPersonDescriptor editPersonDescriptor) {
- assert personToEdit != null;
-
- Name updatedName = editPersonDescriptor.getName().orElse(personToEdit.getName());
- Phone updatedPhone = editPersonDescriptor.getPhone().orElse(personToEdit.getPhone());
- Email updatedEmail = editPersonDescriptor.getEmail().orElse(personToEdit.getEmail());
- Address updatedAddress = editPersonDescriptor.getAddress().orElse(personToEdit.getAddress());
- Set updatedTags = editPersonDescriptor.getTags().orElse(personToEdit.getTags());
-
- return new Person(updatedName, updatedPhone, updatedEmail, updatedAddress, updatedTags);
- }
-
- @Override
- public boolean equals(Object other) {
- // short circuit if same object
- if (other == this) {
- return true;
- }
-
- // instanceof handles nulls
- if (!(other instanceof EditCommand)) {
- return false;
- }
-
- // state check
- EditCommand e = (EditCommand) other;
- return index.equals(e.index)
- && editPersonDescriptor.equals(e.editPersonDescriptor);
- }
-
- /**
- * Stores the details to edit the person with. Each non-empty field value will replace the
- * corresponding field value of the person.
- */
- public static class EditPersonDescriptor {
- private Name name;
- private Phone phone;
- private Email email;
- private Address address;
- private Set tags;
-
- public EditPersonDescriptor() {}
-
- /**
- * Copy constructor.
- * A defensive copy of {@code tags} is used internally.
- */
- public EditPersonDescriptor(EditPersonDescriptor toCopy) {
- setName(toCopy.name);
- setPhone(toCopy.phone);
- setEmail(toCopy.email);
- setAddress(toCopy.address);
- setTags(toCopy.tags);
- }
-
- /**
- * Returns true if at least one field is edited.
- */
- public boolean isAnyFieldEdited() {
- return CollectionUtil.isAnyNonNull(name, phone, email, address, tags);
- }
-
- public void setName(Name name) {
- this.name = name;
- }
-
- public Optional getName() {
- return Optional.ofNullable(name);
- }
-
- public void setPhone(Phone phone) {
- this.phone = phone;
- }
-
- public Optional getPhone() {
- return Optional.ofNullable(phone);
- }
-
- public void setEmail(Email email) {
- this.email = email;
- }
-
- public Optional getEmail() {
- return Optional.ofNullable(email);
- }
-
- public void setAddress(Address address) {
- this.address = address;
- }
-
- public Optional getAddress() {
- return Optional.ofNullable(address);
- }
-
- /**
- * Sets {@code tags} to this object's {@code tags}.
- * A defensive copy of {@code tags} is used internally.
- */
- public void setTags(Set tags) {
- this.tags = (tags != null) ? new HashSet<>(tags) : null;
- }
-
- /**
- * Returns an unmodifiable tag set, which throws {@code UnsupportedOperationException}
- * if modification is attempted.
- * Returns {@code Optional#empty()} if {@code tags} is null.
- */
- public Optional> getTags() {
- return (tags != null) ? Optional.of(Collections.unmodifiableSet(tags)) : Optional.empty();
- }
-
- @Override
- public boolean equals(Object other) {
- // short circuit if same object
- if (other == this) {
- return true;
- }
-
- // instanceof handles nulls
- if (!(other instanceof EditPersonDescriptor)) {
- return false;
- }
-
- // state check
- EditPersonDescriptor e = (EditPersonDescriptor) other;
-
- return getName().equals(e.getName())
- && getPhone().equals(e.getPhone())
- && getEmail().equals(e.getEmail())
- && getAddress().equals(e.getAddress())
- && getTags().equals(e.getTags());
- }
- }
-}
diff --git a/src/main/java/seedu/address/logic/commands/FindCommand.java b/src/main/java/seedu/address/logic/commands/FindCommand.java
deleted file mode 100644
index d6b19b0a0de..00000000000
--- a/src/main/java/seedu/address/logic/commands/FindCommand.java
+++ /dev/null
@@ -1,42 +0,0 @@
-package seedu.address.logic.commands;
-
-import static java.util.Objects.requireNonNull;
-
-import seedu.address.commons.core.Messages;
-import seedu.address.model.Model;
-import seedu.address.model.person.NameContainsKeywordsPredicate;
-
-/**
- * Finds and lists all persons in address book whose name contains any of the argument keywords.
- * Keyword matching is case insensitive.
- */
-public class FindCommand extends Command {
-
- public static final String COMMAND_WORD = "find";
-
- public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of "
- + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
- + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
- + "Example: " + COMMAND_WORD + " alice bob charlie";
-
- private final NameContainsKeywordsPredicate predicate;
-
- public FindCommand(NameContainsKeywordsPredicate predicate) {
- this.predicate = predicate;
- }
-
- @Override
- public CommandResult execute(Model model) {
- requireNonNull(model);
- model.updateFilteredPersonList(predicate);
- return new CommandResult(
- String.format(Messages.MESSAGE_PERSONS_LISTED_OVERVIEW, model.getFilteredPersonList().size()));
- }
-
- @Override
- public boolean equals(Object other) {
- return other == this // short circuit if same object
- || (other instanceof FindCommand // instanceof handles nulls
- && predicate.equals(((FindCommand) other).predicate)); // state check
- }
-}
diff --git a/src/main/java/seedu/address/logic/commands/ListCommand.java b/src/main/java/seedu/address/logic/commands/ListCommand.java
deleted file mode 100644
index 84be6ad2596..00000000000
--- a/src/main/java/seedu/address/logic/commands/ListCommand.java
+++ /dev/null
@@ -1,24 +0,0 @@
-package seedu.address.logic.commands;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS;
-
-import seedu.address.model.Model;
-
-/**
- * Lists all persons in the address book to the user.
- */
-public class ListCommand extends Command {
-
- public static final String COMMAND_WORD = "list";
-
- public static final String MESSAGE_SUCCESS = "Listed all persons";
-
-
- @Override
- public CommandResult execute(Model model) {
- requireNonNull(model);
- model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
- return new CommandResult(MESSAGE_SUCCESS);
- }
-}
diff --git a/src/main/java/seedu/address/logic/parser/AddCommandParser.java b/src/main/java/seedu/address/logic/parser/AddCommandParser.java
deleted file mode 100644
index 3b8bfa035e8..00000000000
--- a/src/main/java/seedu/address/logic/parser/AddCommandParser.java
+++ /dev/null
@@ -1,60 +0,0 @@
-package seedu.address.logic.parser;
-
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
-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_TAG;
-
-import java.util.Set;
-import java.util.stream.Stream;
-
-import seedu.address.logic.commands.AddCommand;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.person.Address;
-import seedu.address.model.person.Email;
-import seedu.address.model.person.Name;
-import seedu.address.model.person.Person;
-import seedu.address.model.person.Phone;
-import seedu.address.model.tag.Tag;
-
-/**
- * Parses input arguments and creates a new AddCommand object
- */
-public class AddCommandParser implements Parser {
-
- /**
- * Parses the given {@code String} of arguments in the context of the AddCommand
- * and returns an AddCommand object for execution.
- * @throws ParseException if the user input does not conform the expected format
- */
- public AddCommand parse(String args) throws ParseException {
- ArgumentMultimap argMultimap =
- ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS, PREFIX_TAG);
-
- if (!arePrefixesPresent(argMultimap, PREFIX_NAME, PREFIX_ADDRESS, PREFIX_PHONE, PREFIX_EMAIL)
- || !argMultimap.getPreamble().isEmpty()) {
- throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
- }
-
- Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());
- Phone phone = ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get());
- Email email = ParserUtil.parseEmail(argMultimap.getValue(PREFIX_EMAIL).get());
- Address address = ParserUtil.parseAddress(argMultimap.getValue(PREFIX_ADDRESS).get());
- Set tagList = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
-
- Person person = new Person(name, phone, email, address, tagList);
-
- return new AddCommand(person);
- }
-
- /**
- * Returns true if none of the prefixes contains empty {@code Optional} values in the given
- * {@code ArgumentMultimap}.
- */
- private static boolean arePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
- return Stream.of(prefixes).allMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
- }
-
-}
diff --git a/src/main/java/seedu/address/logic/parser/AddressBookParser.java b/src/main/java/seedu/address/logic/parser/AddressBookParser.java
deleted file mode 100644
index 1e466792b46..00000000000
--- a/src/main/java/seedu/address/logic/parser/AddressBookParser.java
+++ /dev/null
@@ -1,76 +0,0 @@
-package seedu.address.logic.parser;
-
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import static seedu.address.commons.core.Messages.MESSAGE_UNKNOWN_COMMAND;
-
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import seedu.address.logic.commands.AddCommand;
-import seedu.address.logic.commands.ClearCommand;
-import seedu.address.logic.commands.Command;
-import seedu.address.logic.commands.DeleteCommand;
-import seedu.address.logic.commands.EditCommand;
-import seedu.address.logic.commands.ExitCommand;
-import seedu.address.logic.commands.FindCommand;
-import seedu.address.logic.commands.HelpCommand;
-import seedu.address.logic.commands.ListCommand;
-import seedu.address.logic.parser.exceptions.ParseException;
-
-/**
- * Parses user input.
- */
-public class AddressBookParser {
-
- /**
- * Used for initial separation of command word and args.
- */
- private static final Pattern BASIC_COMMAND_FORMAT = Pattern.compile("(?\\S+)(?.*)");
-
- /**
- * Parses user input into command for execution.
- *
- * @param userInput full user input string
- * @return the command based on the user input
- * @throws ParseException if the user input does not conform the expected format
- */
- public Command parseCommand(String userInput) throws ParseException {
- final Matcher matcher = BASIC_COMMAND_FORMAT.matcher(userInput.trim());
- if (!matcher.matches()) {
- throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, HelpCommand.MESSAGE_USAGE));
- }
-
- final String commandWord = matcher.group("commandWord");
- final String arguments = matcher.group("arguments");
- switch (commandWord) {
-
- case AddCommand.COMMAND_WORD:
- return new AddCommandParser().parse(arguments);
-
- case EditCommand.COMMAND_WORD:
- return new EditCommandParser().parse(arguments);
-
- case DeleteCommand.COMMAND_WORD:
- return new DeleteCommandParser().parse(arguments);
-
- case ClearCommand.COMMAND_WORD:
- return new ClearCommand();
-
- case FindCommand.COMMAND_WORD:
- return new FindCommandParser().parse(arguments);
-
- case ListCommand.COMMAND_WORD:
- return new ListCommand();
-
- case ExitCommand.COMMAND_WORD:
- return new ExitCommand();
-
- case HelpCommand.COMMAND_WORD:
- return new HelpCommand();
-
- default:
- throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
- }
- }
-
-}
diff --git a/src/main/java/seedu/address/logic/parser/EditCommandParser.java b/src/main/java/seedu/address/logic/parser/EditCommandParser.java
deleted file mode 100644
index 845644b7dea..00000000000
--- a/src/main/java/seedu/address/logic/parser/EditCommandParser.java
+++ /dev/null
@@ -1,82 +0,0 @@
-package seedu.address.logic.parser;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
-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_TAG;
-
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Optional;
-import java.util.Set;
-
-import seedu.address.commons.core.index.Index;
-import seedu.address.logic.commands.EditCommand;
-import seedu.address.logic.commands.EditCommand.EditPersonDescriptor;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.tag.Tag;
-
-/**
- * Parses input arguments and creates a new EditCommand object
- */
-public class EditCommandParser implements Parser {
-
- /**
- * Parses the given {@code String} of arguments in the context of the EditCommand
- * and returns an EditCommand object for execution.
- * @throws ParseException if the user input does not conform the expected format
- */
- public EditCommand parse(String args) throws ParseException {
- requireNonNull(args);
- ArgumentMultimap argMultimap =
- ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS, PREFIX_TAG);
-
- Index index;
-
- try {
- index = ParserUtil.parseIndex(argMultimap.getPreamble());
- } catch (ParseException pe) {
- throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, EditCommand.MESSAGE_USAGE), pe);
- }
-
- EditPersonDescriptor editPersonDescriptor = new EditPersonDescriptor();
- if (argMultimap.getValue(PREFIX_NAME).isPresent()) {
- editPersonDescriptor.setName(ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get()));
- }
- if (argMultimap.getValue(PREFIX_PHONE).isPresent()) {
- editPersonDescriptor.setPhone(ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get()));
- }
- if (argMultimap.getValue(PREFIX_EMAIL).isPresent()) {
- editPersonDescriptor.setEmail(ParserUtil.parseEmail(argMultimap.getValue(PREFIX_EMAIL).get()));
- }
- if (argMultimap.getValue(PREFIX_ADDRESS).isPresent()) {
- editPersonDescriptor.setAddress(ParserUtil.parseAddress(argMultimap.getValue(PREFIX_ADDRESS).get()));
- }
- parseTagsForEdit(argMultimap.getAllValues(PREFIX_TAG)).ifPresent(editPersonDescriptor::setTags);
-
- if (!editPersonDescriptor.isAnyFieldEdited()) {
- throw new ParseException(EditCommand.MESSAGE_NOT_EDITED);
- }
-
- return new EditCommand(index, editPersonDescriptor);
- }
-
- /**
- * Parses {@code Collection tags} into a {@code Set} if {@code tags} is non-empty.
- * If {@code tags} contain only one element which is an empty string, it will be parsed into a
- * {@code Set} containing zero tags.
- */
- private Optional> parseTagsForEdit(Collection tags) throws ParseException {
- assert tags != null;
-
- if (tags.isEmpty()) {
- return Optional.empty();
- }
- Collection tagSet = tags.size() == 1 && tags.contains("") ? Collections.emptySet() : tags;
- return Optional.of(ParserUtil.parseTags(tagSet));
- }
-
-}
diff --git a/src/main/java/seedu/address/logic/parser/FindCommandParser.java b/src/main/java/seedu/address/logic/parser/FindCommandParser.java
deleted file mode 100644
index 4fb71f23103..00000000000
--- a/src/main/java/seedu/address/logic/parser/FindCommandParser.java
+++ /dev/null
@@ -1,33 +0,0 @@
-package seedu.address.logic.parser;
-
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-
-import java.util.Arrays;
-
-import seedu.address.logic.commands.FindCommand;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.person.NameContainsKeywordsPredicate;
-
-/**
- * Parses input arguments and creates a new FindCommand object
- */
-public class FindCommandParser implements Parser {
-
- /**
- * Parses the given {@code String} of arguments in the context of the FindCommand
- * and returns a FindCommand object for execution.
- * @throws ParseException if the user input does not conform the expected format
- */
- public FindCommand parse(String args) throws ParseException {
- String trimmedArgs = args.trim();
- if (trimmedArgs.isEmpty()) {
- throw new ParseException(
- String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindCommand.MESSAGE_USAGE));
- }
-
- String[] nameKeywords = trimmedArgs.split("\\s+");
-
- return new FindCommand(new NameContainsKeywordsPredicate(Arrays.asList(nameKeywords)));
- }
-
-}
diff --git a/src/main/java/seedu/address/logic/parser/ParserUtil.java b/src/main/java/seedu/address/logic/parser/ParserUtil.java
deleted file mode 100644
index b117acb9c55..00000000000
--- a/src/main/java/seedu/address/logic/parser/ParserUtil.java
+++ /dev/null
@@ -1,124 +0,0 @@
-package seedu.address.logic.parser;
-
-import static java.util.Objects.requireNonNull;
-
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.Set;
-
-import seedu.address.commons.core.index.Index;
-import seedu.address.commons.util.StringUtil;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.person.Address;
-import seedu.address.model.person.Email;
-import seedu.address.model.person.Name;
-import seedu.address.model.person.Phone;
-import seedu.address.model.tag.Tag;
-
-/**
- * Contains utility methods used for parsing strings in the various *Parser classes.
- */
-public class ParserUtil {
-
- public static final String MESSAGE_INVALID_INDEX = "Index is not a non-zero unsigned integer.";
-
- /**
- * Parses {@code oneBasedIndex} into an {@code Index} and returns it. Leading and trailing whitespaces will be
- * trimmed.
- * @throws ParseException if the specified index is invalid (not non-zero unsigned integer).
- */
- public static Index parseIndex(String oneBasedIndex) throws ParseException {
- String trimmedIndex = oneBasedIndex.trim();
- if (!StringUtil.isNonZeroUnsignedInteger(trimmedIndex)) {
- throw new ParseException(MESSAGE_INVALID_INDEX);
- }
- return Index.fromOneBased(Integer.parseInt(trimmedIndex));
- }
-
- /**
- * Parses a {@code String name} into a {@code Name}.
- * Leading and trailing whitespaces will be trimmed.
- *
- * @throws ParseException if the given {@code name} is invalid.
- */
- public static Name parseName(String name) throws ParseException {
- requireNonNull(name);
- String trimmedName = name.trim();
- if (!Name.isValidName(trimmedName)) {
- throw new ParseException(Name.MESSAGE_CONSTRAINTS);
- }
- return new Name(trimmedName);
- }
-
- /**
- * Parses a {@code String phone} into a {@code Phone}.
- * Leading and trailing whitespaces will be trimmed.
- *
- * @throws ParseException if the given {@code phone} is invalid.
- */
- public static Phone parsePhone(String phone) throws ParseException {
- requireNonNull(phone);
- String trimmedPhone = phone.trim();
- if (!Phone.isValidPhone(trimmedPhone)) {
- throw new ParseException(Phone.MESSAGE_CONSTRAINTS);
- }
- return new Phone(trimmedPhone);
- }
-
- /**
- * Parses a {@code String address} into an {@code Address}.
- * Leading and trailing whitespaces will be trimmed.
- *
- * @throws ParseException if the given {@code address} is invalid.
- */
- public static Address parseAddress(String address) throws ParseException {
- requireNonNull(address);
- String trimmedAddress = address.trim();
- if (!Address.isValidAddress(trimmedAddress)) {
- throw new ParseException(Address.MESSAGE_CONSTRAINTS);
- }
- return new Address(trimmedAddress);
- }
-
- /**
- * Parses a {@code String email} into an {@code Email}.
- * Leading and trailing whitespaces will be trimmed.
- *
- * @throws ParseException if the given {@code email} is invalid.
- */
- public static Email parseEmail(String email) throws ParseException {
- requireNonNull(email);
- String trimmedEmail = email.trim();
- if (!Email.isValidEmail(trimmedEmail)) {
- throw new ParseException(Email.MESSAGE_CONSTRAINTS);
- }
- return new Email(trimmedEmail);
- }
-
- /**
- * Parses a {@code String tag} into a {@code Tag}.
- * Leading and trailing whitespaces will be trimmed.
- *
- * @throws ParseException if the given {@code tag} is invalid.
- */
- public static Tag parseTag(String tag) throws ParseException {
- requireNonNull(tag);
- String trimmedTag = tag.trim();
- if (!Tag.isValidTagName(trimmedTag)) {
- throw new ParseException(Tag.MESSAGE_CONSTRAINTS);
- }
- return new Tag(trimmedTag);
- }
-
- /**
- * Parses {@code Collection tags} into a {@code Set}.
- */
- public static Set parseTags(Collection tags) throws ParseException {
- requireNonNull(tags);
- final Set tagSet = new HashSet<>();
- for (String tagName : tags) {
- tagSet.add(parseTag(tagName));
- }
- return tagSet;
- }
-}
diff --git a/src/main/java/seedu/address/model/AddressBook.java b/src/main/java/seedu/address/model/AddressBook.java
deleted file mode 100644
index 1a943a0781a..00000000000
--- a/src/main/java/seedu/address/model/AddressBook.java
+++ /dev/null
@@ -1,120 +0,0 @@
-package seedu.address.model;
-
-import static java.util.Objects.requireNonNull;
-
-import java.util.List;
-
-import javafx.collections.ObservableList;
-import seedu.address.model.person.Person;
-import seedu.address.model.person.UniquePersonList;
-
-/**
- * Wraps all data at the address-book level
- * Duplicates are not allowed (by .isSamePerson comparison)
- */
-public class AddressBook implements ReadOnlyAddressBook {
-
- private final UniquePersonList persons;
-
- /*
- * The 'unusual' code block below is a non-static initialization block, sometimes used to avoid duplication
- * between constructors. See https://docs.oracle.com/javase/tutorial/java/javaOO/initial.html
- *
- * Note that non-static init blocks are not recommended to use. There are other ways to avoid duplication
- * among constructors.
- */
- {
- persons = new UniquePersonList();
- }
-
- public AddressBook() {}
-
- /**
- * Creates an AddressBook using the Persons in the {@code toBeCopied}
- */
- public AddressBook(ReadOnlyAddressBook toBeCopied) {
- this();
- resetData(toBeCopied);
- }
-
- //// list overwrite operations
-
- /**
- * Replaces the contents of the person list with {@code persons}.
- * {@code persons} must not contain duplicate persons.
- */
- public void setPersons(List persons) {
- this.persons.setPersons(persons);
- }
-
- /**
- * Resets the existing data of this {@code AddressBook} with {@code newData}.
- */
- public void resetData(ReadOnlyAddressBook newData) {
- requireNonNull(newData);
-
- setPersons(newData.getPersonList());
- }
-
- //// person-level operations
-
- /**
- * Returns true if a person with the same identity as {@code person} exists in the address book.
- */
- public boolean hasPerson(Person person) {
- requireNonNull(person);
- return persons.contains(person);
- }
-
- /**
- * Adds a person to the address book.
- * The person must not already exist in the address book.
- */
- public void addPerson(Person p) {
- persons.add(p);
- }
-
- /**
- * Replaces the given person {@code target} in the list with {@code editedPerson}.
- * {@code target} must exist in the address book.
- * The person identity of {@code editedPerson} must not be the same as another existing person in the address book.
- */
- public void setPerson(Person target, Person editedPerson) {
- requireNonNull(editedPerson);
-
- persons.setPerson(target, editedPerson);
- }
-
- /**
- * Removes {@code key} from this {@code AddressBook}.
- * {@code key} must exist in the address book.
- */
- public void removePerson(Person key) {
- persons.remove(key);
- }
-
- //// util methods
-
- @Override
- public String toString() {
- return persons.asUnmodifiableObservableList().size() + " persons";
- // TODO: refine later
- }
-
- @Override
- public ObservableList getPersonList() {
- return persons.asUnmodifiableObservableList();
- }
-
- @Override
- public boolean equals(Object other) {
- return other == this // short circuit if same object
- || (other instanceof AddressBook // instanceof handles nulls
- && persons.equals(((AddressBook) other).persons));
- }
-
- @Override
- public int hashCode() {
- return persons.hashCode();
- }
-}
diff --git a/src/main/java/seedu/address/model/Model.java b/src/main/java/seedu/address/model/Model.java
deleted file mode 100644
index d54df471c1f..00000000000
--- a/src/main/java/seedu/address/model/Model.java
+++ /dev/null
@@ -1,87 +0,0 @@
-package seedu.address.model;
-
-import java.nio.file.Path;
-import java.util.function.Predicate;
-
-import javafx.collections.ObservableList;
-import seedu.address.commons.core.GuiSettings;
-import seedu.address.model.person.Person;
-
-/**
- * The API of the Model component.
- */
-public interface Model {
- /** {@code Predicate} that always evaluate to true */
- Predicate PREDICATE_SHOW_ALL_PERSONS = unused -> true;
-
- /**
- * Replaces user prefs data with the data in {@code userPrefs}.
- */
- void setUserPrefs(ReadOnlyUserPrefs userPrefs);
-
- /**
- * Returns the user prefs.
- */
- ReadOnlyUserPrefs getUserPrefs();
-
- /**
- * Returns the user prefs' GUI settings.
- */
- GuiSettings getGuiSettings();
-
- /**
- * Sets the user prefs' GUI settings.
- */
- void setGuiSettings(GuiSettings guiSettings);
-
- /**
- * Returns the user prefs' address book file path.
- */
- Path getAddressBookFilePath();
-
- /**
- * Sets the user prefs' address book file path.
- */
- void setAddressBookFilePath(Path addressBookFilePath);
-
- /**
- * Replaces address book data with the data in {@code addressBook}.
- */
- void setAddressBook(ReadOnlyAddressBook addressBook);
-
- /** Returns the AddressBook */
- ReadOnlyAddressBook getAddressBook();
-
- /**
- * Returns true if a person with the same identity as {@code person} exists in the address book.
- */
- boolean hasPerson(Person person);
-
- /**
- * Deletes the given person.
- * The person must exist in the address book.
- */
- void deletePerson(Person target);
-
- /**
- * Adds the given person.
- * {@code person} must not already exist in the address book.
- */
- void addPerson(Person person);
-
- /**
- * Replaces the given person {@code target} with {@code editedPerson}.
- * {@code target} must exist in the address book.
- * The person identity of {@code editedPerson} must not be the same as another existing person in the address book.
- */
- void setPerson(Person target, Person editedPerson);
-
- /** Returns an unmodifiable view of the filtered person list */
- ObservableList getFilteredPersonList();
-
- /**
- * Updates the filter of the filtered person list to filter by the given {@code predicate}.
- * @throws NullPointerException if {@code predicate} is null.
- */
- void updateFilteredPersonList(Predicate predicate);
-}
diff --git a/src/main/java/seedu/address/model/ModelManager.java b/src/main/java/seedu/address/model/ModelManager.java
deleted file mode 100644
index 0650c954f5c..00000000000
--- a/src/main/java/seedu/address/model/ModelManager.java
+++ /dev/null
@@ -1,151 +0,0 @@
-package seedu.address.model;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
-
-import java.nio.file.Path;
-import java.util.function.Predicate;
-import java.util.logging.Logger;
-
-import javafx.collections.ObservableList;
-import javafx.collections.transformation.FilteredList;
-import seedu.address.commons.core.GuiSettings;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.model.person.Person;
-
-/**
- * Represents the in-memory model of the address book data.
- */
-public class ModelManager implements Model {
- private static final Logger logger = LogsCenter.getLogger(ModelManager.class);
-
- private final AddressBook addressBook;
- private final UserPrefs userPrefs;
- private final FilteredList filteredPersons;
-
- /**
- * Initializes a ModelManager with the given addressBook and userPrefs.
- */
- public ModelManager(ReadOnlyAddressBook addressBook, ReadOnlyUserPrefs userPrefs) {
- super();
- requireAllNonNull(addressBook, userPrefs);
-
- logger.fine("Initializing with address book: " + addressBook + " and user prefs " + userPrefs);
-
- this.addressBook = new AddressBook(addressBook);
- this.userPrefs = new UserPrefs(userPrefs);
- filteredPersons = new FilteredList<>(this.addressBook.getPersonList());
- }
-
- public ModelManager() {
- this(new AddressBook(), new UserPrefs());
- }
-
- //=========== UserPrefs ==================================================================================
-
- @Override
- public void setUserPrefs(ReadOnlyUserPrefs userPrefs) {
- requireNonNull(userPrefs);
- this.userPrefs.resetData(userPrefs);
- }
-
- @Override
- public ReadOnlyUserPrefs getUserPrefs() {
- return userPrefs;
- }
-
- @Override
- public GuiSettings getGuiSettings() {
- return userPrefs.getGuiSettings();
- }
-
- @Override
- public void setGuiSettings(GuiSettings guiSettings) {
- requireNonNull(guiSettings);
- userPrefs.setGuiSettings(guiSettings);
- }
-
- @Override
- public Path getAddressBookFilePath() {
- return userPrefs.getAddressBookFilePath();
- }
-
- @Override
- public void setAddressBookFilePath(Path addressBookFilePath) {
- requireNonNull(addressBookFilePath);
- userPrefs.setAddressBookFilePath(addressBookFilePath);
- }
-
- //=========== AddressBook ================================================================================
-
- @Override
- public void setAddressBook(ReadOnlyAddressBook addressBook) {
- this.addressBook.resetData(addressBook);
- }
-
- @Override
- public ReadOnlyAddressBook getAddressBook() {
- return addressBook;
- }
-
- @Override
- public boolean hasPerson(Person person) {
- requireNonNull(person);
- return addressBook.hasPerson(person);
- }
-
- @Override
- public void deletePerson(Person target) {
- addressBook.removePerson(target);
- }
-
- @Override
- public void addPerson(Person person) {
- addressBook.addPerson(person);
- updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
- }
-
- @Override
- public void setPerson(Person target, Person editedPerson) {
- requireAllNonNull(target, editedPerson);
-
- addressBook.setPerson(target, editedPerson);
- }
-
- //=========== Filtered Person List Accessors =============================================================
-
- /**
- * Returns an unmodifiable view of the list of {@code Person} backed by the internal list of
- * {@code versionedAddressBook}
- */
- @Override
- public ObservableList getFilteredPersonList() {
- return filteredPersons;
- }
-
- @Override
- public void updateFilteredPersonList(Predicate predicate) {
- requireNonNull(predicate);
- filteredPersons.setPredicate(predicate);
- }
-
- @Override
- public boolean equals(Object obj) {
- // short circuit if same object
- if (obj == this) {
- return true;
- }
-
- // instanceof handles nulls
- if (!(obj instanceof ModelManager)) {
- return false;
- }
-
- // state check
- ModelManager other = (ModelManager) obj;
- return addressBook.equals(other.addressBook)
- && userPrefs.equals(other.userPrefs)
- && filteredPersons.equals(other.filteredPersons);
- }
-
-}
diff --git a/src/main/java/seedu/address/model/ReadOnlyAddressBook.java b/src/main/java/seedu/address/model/ReadOnlyAddressBook.java
deleted file mode 100644
index 6ddc2cd9a29..00000000000
--- a/src/main/java/seedu/address/model/ReadOnlyAddressBook.java
+++ /dev/null
@@ -1,17 +0,0 @@
-package seedu.address.model;
-
-import javafx.collections.ObservableList;
-import seedu.address.model.person.Person;
-
-/**
- * Unmodifiable view of an address book
- */
-public interface ReadOnlyAddressBook {
-
- /**
- * Returns an unmodifiable view of the persons list.
- * This list will not contain any duplicate persons.
- */
- ObservableList getPersonList();
-
-}
diff --git a/src/main/java/seedu/address/model/person/UniquePersonList.java b/src/main/java/seedu/address/model/person/UniquePersonList.java
deleted file mode 100644
index 0fee4fe57e6..00000000000
--- a/src/main/java/seedu/address/model/person/UniquePersonList.java
+++ /dev/null
@@ -1,137 +0,0 @@
-package seedu.address.model.person;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
-
-import java.util.Iterator;
-import java.util.List;
-
-import javafx.collections.FXCollections;
-import javafx.collections.ObservableList;
-import seedu.address.model.person.exceptions.DuplicatePersonException;
-import seedu.address.model.person.exceptions.PersonNotFoundException;
-
-/**
- * A list of persons that enforces uniqueness between its elements and does not allow nulls.
- * A person is considered unique by comparing using {@code Person#isSamePerson(Person)}. As such, adding and updating of
- * persons uses Person#isSamePerson(Person) for equality so as to ensure that the person being added or updated is
- * unique in terms of identity in the UniquePersonList. However, the removal of a person uses Person#equals(Object) so
- * as to ensure that the person with exactly the same fields will be removed.
- *
- * Supports a minimal set of list operations.
- *
- * @see Person#isSamePerson(Person)
- */
-public class UniquePersonList implements Iterable {
-
- private final ObservableList internalList = FXCollections.observableArrayList();
- private final ObservableList internalUnmodifiableList =
- FXCollections.unmodifiableObservableList(internalList);
-
- /**
- * Returns true if the list contains an equivalent person as the given argument.
- */
- public boolean contains(Person toCheck) {
- requireNonNull(toCheck);
- return internalList.stream().anyMatch(toCheck::isSamePerson);
- }
-
- /**
- * Adds a person to the list.
- * The person must not already exist in the list.
- */
- public void add(Person toAdd) {
- requireNonNull(toAdd);
- if (contains(toAdd)) {
- throw new DuplicatePersonException();
- }
- internalList.add(toAdd);
- }
-
- /**
- * Replaces the person {@code target} in the list with {@code editedPerson}.
- * {@code target} must exist in the list.
- * The person identity of {@code editedPerson} must not be the same as another existing person in the list.
- */
- public void setPerson(Person target, Person editedPerson) {
- requireAllNonNull(target, editedPerson);
-
- int index = internalList.indexOf(target);
- if (index == -1) {
- throw new PersonNotFoundException();
- }
-
- if (!target.isSamePerson(editedPerson) && contains(editedPerson)) {
- throw new DuplicatePersonException();
- }
-
- internalList.set(index, editedPerson);
- }
-
- /**
- * Removes the equivalent person from the list.
- * The person must exist in the list.
- */
- public void remove(Person toRemove) {
- requireNonNull(toRemove);
- if (!internalList.remove(toRemove)) {
- throw new PersonNotFoundException();
- }
- }
-
- public void setPersons(UniquePersonList replacement) {
- requireNonNull(replacement);
- internalList.setAll(replacement.internalList);
- }
-
- /**
- * Replaces the contents of this list with {@code persons}.
- * {@code persons} must not contain duplicate persons.
- */
- public void setPersons(List persons) {
- requireAllNonNull(persons);
- if (!personsAreUnique(persons)) {
- throw new DuplicatePersonException();
- }
-
- internalList.setAll(persons);
- }
-
- /**
- * Returns the backing list as an unmodifiable {@code ObservableList}.
- */
- public ObservableList asUnmodifiableObservableList() {
- return internalUnmodifiableList;
- }
-
- @Override
- public Iterator iterator() {
- return internalList.iterator();
- }
-
- @Override
- public boolean equals(Object other) {
- return other == this // short circuit if same object
- || (other instanceof UniquePersonList // instanceof handles nulls
- && internalList.equals(((UniquePersonList) other).internalList));
- }
-
- @Override
- public int hashCode() {
- return internalList.hashCode();
- }
-
- /**
- * Returns true if {@code persons} contains only unique persons.
- */
- private boolean personsAreUnique(List persons) {
- for (int i = 0; i < persons.size() - 1; i++) {
- for (int j = i + 1; j < persons.size(); j++) {
- if (persons.get(i).isSamePerson(persons.get(j))) {
- return false;
- }
- }
- }
- return true;
- }
-}
diff --git a/src/main/java/seedu/address/model/util/SampleDataUtil.java b/src/main/java/seedu/address/model/util/SampleDataUtil.java
deleted file mode 100644
index 1806da4facf..00000000000
--- a/src/main/java/seedu/address/model/util/SampleDataUtil.java
+++ /dev/null
@@ -1,60 +0,0 @@
-package seedu.address.model.util;
-
-import java.util.Arrays;
-import java.util.Set;
-import java.util.stream.Collectors;
-
-import seedu.address.model.AddressBook;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.person.Address;
-import seedu.address.model.person.Email;
-import seedu.address.model.person.Name;
-import seedu.address.model.person.Person;
-import seedu.address.model.person.Phone;
-import seedu.address.model.tag.Tag;
-
-/**
- * Contains utility methods for populating {@code AddressBook} with sample data.
- */
-public class SampleDataUtil {
- public static Person[] getSamplePersons() {
- return new Person[] {
- new Person(new Name("Alex Yeoh"), new Phone("87438807"), new Email("alexyeoh@example.com"),
- new Address("Blk 30 Geylang Street 29, #06-40"),
- getTagSet("friends")),
- new Person(new Name("Bernice Yu"), new Phone("99272758"), new Email("berniceyu@example.com"),
- new Address("Blk 30 Lorong 3 Serangoon Gardens, #07-18"),
- getTagSet("colleagues", "friends")),
- new Person(new Name("Charlotte Oliveiro"), new Phone("93210283"), new Email("charlotte@example.com"),
- new Address("Blk 11 Ang Mo Kio Street 74, #11-04"),
- getTagSet("neighbours")),
- new Person(new Name("David Li"), new Phone("91031282"), new Email("lidavid@example.com"),
- new Address("Blk 436 Serangoon Gardens Street 26, #16-43"),
- getTagSet("family")),
- new Person(new Name("Irfan Ibrahim"), new Phone("92492021"), new Email("irfan@example.com"),
- new Address("Blk 47 Tampines Street 20, #17-35"),
- getTagSet("classmates")),
- new Person(new Name("Roy Balakrishnan"), new Phone("92624417"), new Email("royb@example.com"),
- new Address("Blk 45 Aljunied Street 85, #11-31"),
- getTagSet("colleagues"))
- };
- }
-
- public static ReadOnlyAddressBook getSampleAddressBook() {
- AddressBook sampleAb = new AddressBook();
- for (Person samplePerson : getSamplePersons()) {
- sampleAb.addPerson(samplePerson);
- }
- return sampleAb;
- }
-
- /**
- * Returns a tag set containing the list of strings given.
- */
- public static Set getTagSet(String... strings) {
- return Arrays.stream(strings)
- .map(Tag::new)
- .collect(Collectors.toSet());
- }
-
-}
diff --git a/src/main/java/seedu/address/storage/AddressBookStorage.java b/src/main/java/seedu/address/storage/AddressBookStorage.java
deleted file mode 100644
index 4599182b3f9..00000000000
--- a/src/main/java/seedu/address/storage/AddressBookStorage.java
+++ /dev/null
@@ -1,45 +0,0 @@
-package seedu.address.storage;
-
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Optional;
-
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.model.ReadOnlyAddressBook;
-
-/**
- * Represents a storage for {@link seedu.address.model.AddressBook}.
- */
-public interface AddressBookStorage {
-
- /**
- * Returns the file path of the data file.
- */
- Path getAddressBookFilePath();
-
- /**
- * Returns AddressBook data as a {@link ReadOnlyAddressBook}.
- * Returns {@code Optional.empty()} if storage file is not found.
- * @throws DataConversionException if the data in storage is not in the expected format.
- * @throws IOException if there was any problem when reading from the storage.
- */
- Optional readAddressBook() throws DataConversionException, IOException;
-
- /**
- * @see #getAddressBookFilePath()
- */
- Optional readAddressBook(Path filePath) throws DataConversionException, IOException;
-
- /**
- * Saves the given {@link ReadOnlyAddressBook} to the storage.
- * @param addressBook cannot be null.
- * @throws IOException if there was any problem writing to the file.
- */
- void saveAddressBook(ReadOnlyAddressBook addressBook) throws IOException;
-
- /**
- * @see #saveAddressBook(ReadOnlyAddressBook)
- */
- void saveAddressBook(ReadOnlyAddressBook addressBook, Path filePath) throws IOException;
-
-}
diff --git a/src/main/java/seedu/address/storage/JsonAddressBookStorage.java b/src/main/java/seedu/address/storage/JsonAddressBookStorage.java
deleted file mode 100644
index dfab9daaa0d..00000000000
--- a/src/main/java/seedu/address/storage/JsonAddressBookStorage.java
+++ /dev/null
@@ -1,80 +0,0 @@
-package seedu.address.storage;
-
-import static java.util.Objects.requireNonNull;
-
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Optional;
-import java.util.logging.Logger;
-
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.commons.exceptions.IllegalValueException;
-import seedu.address.commons.util.FileUtil;
-import seedu.address.commons.util.JsonUtil;
-import seedu.address.model.ReadOnlyAddressBook;
-
-/**
- * A class to access AddressBook data stored as a json file on the hard disk.
- */
-public class JsonAddressBookStorage implements AddressBookStorage {
-
- private static final Logger logger = LogsCenter.getLogger(JsonAddressBookStorage.class);
-
- private Path filePath;
-
- public JsonAddressBookStorage(Path filePath) {
- this.filePath = filePath;
- }
-
- public Path getAddressBookFilePath() {
- return filePath;
- }
-
- @Override
- public Optional readAddressBook() throws DataConversionException {
- return readAddressBook(filePath);
- }
-
- /**
- * Similar to {@link #readAddressBook()}.
- *
- * @param filePath location of the data. Cannot be null.
- * @throws DataConversionException if the file is not in the correct format.
- */
- public Optional readAddressBook(Path filePath) throws DataConversionException {
- requireNonNull(filePath);
-
- Optional jsonAddressBook = JsonUtil.readJsonFile(
- filePath, JsonSerializableAddressBook.class);
- if (!jsonAddressBook.isPresent()) {
- return Optional.empty();
- }
-
- try {
- return Optional.of(jsonAddressBook.get().toModelType());
- } catch (IllegalValueException ive) {
- logger.info("Illegal values found in " + filePath + ": " + ive.getMessage());
- throw new DataConversionException(ive);
- }
- }
-
- @Override
- public void saveAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
- saveAddressBook(addressBook, filePath);
- }
-
- /**
- * Similar to {@link #saveAddressBook(ReadOnlyAddressBook)}.
- *
- * @param filePath location of the data. Cannot be null.
- */
- public void saveAddressBook(ReadOnlyAddressBook addressBook, Path filePath) throws IOException {
- requireNonNull(addressBook);
- requireNonNull(filePath);
-
- FileUtil.createIfMissing(filePath);
- JsonUtil.saveJsonFile(new JsonSerializableAddressBook(addressBook), filePath);
- }
-
-}
diff --git a/src/main/java/seedu/address/storage/JsonSerializableAddressBook.java b/src/main/java/seedu/address/storage/JsonSerializableAddressBook.java
deleted file mode 100644
index 5efd834091d..00000000000
--- a/src/main/java/seedu/address/storage/JsonSerializableAddressBook.java
+++ /dev/null
@@ -1,60 +0,0 @@
-package seedu.address.storage;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.stream.Collectors;
-
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonRootName;
-
-import seedu.address.commons.exceptions.IllegalValueException;
-import seedu.address.model.AddressBook;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.person.Person;
-
-/**
- * An Immutable AddressBook that is serializable to JSON format.
- */
-@JsonRootName(value = "addressbook")
-class JsonSerializableAddressBook {
-
- public static final String MESSAGE_DUPLICATE_PERSON = "Persons list contains duplicate person(s).";
-
- private final List persons = new ArrayList<>();
-
- /**
- * Constructs a {@code JsonSerializableAddressBook} with the given persons.
- */
- @JsonCreator
- public JsonSerializableAddressBook(@JsonProperty("persons") List persons) {
- this.persons.addAll(persons);
- }
-
- /**
- * Converts a given {@code ReadOnlyAddressBook} into this class for Jackson use.
- *
- * @param source future changes to this will not affect the created {@code JsonSerializableAddressBook}.
- */
- public JsonSerializableAddressBook(ReadOnlyAddressBook source) {
- persons.addAll(source.getPersonList().stream().map(JsonAdaptedPerson::new).collect(Collectors.toList()));
- }
-
- /**
- * Converts this address book into the model's {@code AddressBook} object.
- *
- * @throws IllegalValueException if there were any data constraints violated.
- */
- public AddressBook toModelType() throws IllegalValueException {
- AddressBook addressBook = new AddressBook();
- for (JsonAdaptedPerson jsonAdaptedPerson : persons) {
- Person person = jsonAdaptedPerson.toModelType();
- if (addressBook.hasPerson(person)) {
- throw new IllegalValueException(MESSAGE_DUPLICATE_PERSON);
- }
- addressBook.addPerson(person);
- }
- return addressBook;
- }
-
-}
diff --git a/src/main/java/seedu/address/storage/Storage.java b/src/main/java/seedu/address/storage/Storage.java
deleted file mode 100644
index beda8bd9f11..00000000000
--- a/src/main/java/seedu/address/storage/Storage.java
+++ /dev/null
@@ -1,32 +0,0 @@
-package seedu.address.storage;
-
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Optional;
-
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.ReadOnlyUserPrefs;
-import seedu.address.model.UserPrefs;
-
-/**
- * API of the Storage component
- */
-public interface Storage extends AddressBookStorage, UserPrefsStorage {
-
- @Override
- Optional readUserPrefs() throws DataConversionException, IOException;
-
- @Override
- void saveUserPrefs(ReadOnlyUserPrefs userPrefs) throws IOException;
-
- @Override
- Path getAddressBookFilePath();
-
- @Override
- Optional readAddressBook() throws DataConversionException, IOException;
-
- @Override
- void saveAddressBook(ReadOnlyAddressBook addressBook) throws IOException;
-
-}
diff --git a/src/main/java/seedu/address/storage/StorageManager.java b/src/main/java/seedu/address/storage/StorageManager.java
deleted file mode 100644
index 79868290974..00000000000
--- a/src/main/java/seedu/address/storage/StorageManager.java
+++ /dev/null
@@ -1,79 +0,0 @@
-package seedu.address.storage;
-
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Optional;
-import java.util.logging.Logger;
-
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.ReadOnlyUserPrefs;
-import seedu.address.model.UserPrefs;
-
-/**
- * Manages storage of AddressBook data in local storage.
- */
-public class StorageManager implements Storage {
-
- private static final Logger logger = LogsCenter.getLogger(StorageManager.class);
- private AddressBookStorage addressBookStorage;
- private UserPrefsStorage userPrefsStorage;
-
- /**
- * Creates a {@code StorageManager} with the given {@code AddressBookStorage} and {@code UserPrefStorage}.
- */
- public StorageManager(AddressBookStorage addressBookStorage, UserPrefsStorage userPrefsStorage) {
- super();
- this.addressBookStorage = addressBookStorage;
- this.userPrefsStorage = userPrefsStorage;
- }
-
- // ================ UserPrefs methods ==============================
-
- @Override
- public Path getUserPrefsFilePath() {
- return userPrefsStorage.getUserPrefsFilePath();
- }
-
- @Override
- public Optional readUserPrefs() throws DataConversionException, IOException {
- return userPrefsStorage.readUserPrefs();
- }
-
- @Override
- public void saveUserPrefs(ReadOnlyUserPrefs userPrefs) throws IOException {
- userPrefsStorage.saveUserPrefs(userPrefs);
- }
-
-
- // ================ AddressBook methods ==============================
-
- @Override
- public Path getAddressBookFilePath() {
- return addressBookStorage.getAddressBookFilePath();
- }
-
- @Override
- public Optional readAddressBook() throws DataConversionException, IOException {
- return readAddressBook(addressBookStorage.getAddressBookFilePath());
- }
-
- @Override
- public Optional readAddressBook(Path filePath) throws DataConversionException, IOException {
- logger.fine("Attempting to read data from file: " + filePath);
- return addressBookStorage.readAddressBook(filePath);
- }
-
- @Override
- public void saveAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
- saveAddressBook(addressBook, addressBookStorage.getAddressBookFilePath());
- }
-
- @Override
- public void saveAddressBook(ReadOnlyAddressBook addressBook, Path filePath) throws IOException {
- logger.fine("Attempting to write to data file: " + filePath);
- addressBookStorage.saveAddressBook(addressBook, filePath);
- }
-
-}
diff --git a/src/main/java/seedu/address/ui/PersonListPanel.java b/src/main/java/seedu/address/ui/PersonListPanel.java
deleted file mode 100644
index f4c501a897b..00000000000
--- a/src/main/java/seedu/address/ui/PersonListPanel.java
+++ /dev/null
@@ -1,49 +0,0 @@
-package seedu.address.ui;
-
-import java.util.logging.Logger;
-
-import javafx.collections.ObservableList;
-import javafx.fxml.FXML;
-import javafx.scene.control.ListCell;
-import javafx.scene.control.ListView;
-import javafx.scene.layout.Region;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.model.person.Person;
-
-/**
- * Panel containing the list of persons.
- */
-public class PersonListPanel extends UiPart {
- private static final String FXML = "PersonListPanel.fxml";
- private final Logger logger = LogsCenter.getLogger(PersonListPanel.class);
-
- @FXML
- private ListView personListView;
-
- /**
- * Creates a {@code PersonListPanel} with the given {@code ObservableList}.
- */
- public PersonListPanel(ObservableList personList) {
- super(FXML);
- personListView.setItems(personList);
- personListView.setCellFactory(listView -> new PersonListViewCell());
- }
-
- /**
- * Custom {@code ListCell} that displays the graphics of a {@code Person} using a {@code PersonCard}.
- */
- class PersonListViewCell extends ListCell {
- @Override
- protected void updateItem(Person person, boolean empty) {
- super.updateItem(person, empty);
-
- if (empty || person == null) {
- setGraphic(null);
- setText(null);
- } else {
- setGraphic(new PersonCard(person, getIndex() + 1).getRoot());
- }
- }
- }
-
-}
diff --git a/src/main/java/seedu/address/AppParameters.java b/src/main/java/seedu/times/AppParameters.java
similarity index 93%
rename from src/main/java/seedu/address/AppParameters.java
rename to src/main/java/seedu/times/AppParameters.java
index ab552c398f3..e6b0ddc6c08 100644
--- a/src/main/java/seedu/address/AppParameters.java
+++ b/src/main/java/seedu/times/AppParameters.java
@@ -1,4 +1,4 @@
-package seedu.address;
+package seedu.times;
import java.nio.file.Path;
import java.nio.file.Paths;
@@ -7,8 +7,8 @@
import java.util.logging.Logger;
import javafx.application.Application;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.util.FileUtil;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.commons.util.FileUtil;
/**
* Represents the parsed command-line parameters given to the application.
diff --git a/src/main/java/seedu/address/Main.java b/src/main/java/seedu/times/Main.java
similarity index 97%
rename from src/main/java/seedu/address/Main.java
rename to src/main/java/seedu/times/Main.java
index 052a5068631..0ccb791c394 100644
--- a/src/main/java/seedu/address/Main.java
+++ b/src/main/java/seedu/times/Main.java
@@ -1,4 +1,4 @@
-package seedu.address;
+package seedu.times;
import javafx.application.Application;
diff --git a/src/main/java/seedu/address/MainApp.java b/src/main/java/seedu/times/MainApp.java
similarity index 71%
rename from src/main/java/seedu/address/MainApp.java
rename to src/main/java/seedu/times/MainApp.java
index 4133aaa0151..0e8ca0517bd 100644
--- a/src/main/java/seedu/address/MainApp.java
+++ b/src/main/java/seedu/times/MainApp.java
@@ -1,4 +1,4 @@
-package seedu.address;
+package seedu.times;
import java.io.IOException;
import java.nio.file.Path;
@@ -7,36 +7,36 @@
import javafx.application.Application;
import javafx.stage.Stage;
-import seedu.address.commons.core.Config;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.core.Version;
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.commons.util.ConfigUtil;
-import seedu.address.commons.util.StringUtil;
-import seedu.address.logic.Logic;
-import seedu.address.logic.LogicManager;
-import seedu.address.model.AddressBook;
-import seedu.address.model.Model;
-import seedu.address.model.ModelManager;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.ReadOnlyUserPrefs;
-import seedu.address.model.UserPrefs;
-import seedu.address.model.util.SampleDataUtil;
-import seedu.address.storage.AddressBookStorage;
-import seedu.address.storage.JsonAddressBookStorage;
-import seedu.address.storage.JsonUserPrefsStorage;
-import seedu.address.storage.Storage;
-import seedu.address.storage.StorageManager;
-import seedu.address.storage.UserPrefsStorage;
-import seedu.address.ui.Ui;
-import seedu.address.ui.UiManager;
+import seedu.times.commons.core.Config;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.commons.core.Version;
+import seedu.times.commons.exceptions.DataConversionException;
+import seedu.times.commons.util.ConfigUtil;
+import seedu.times.commons.util.StringUtil;
+import seedu.times.logic.Logic;
+import seedu.times.logic.LogicManager;
+import seedu.times.model.Model;
+import seedu.times.model.ModelManager;
+import seedu.times.model.ReadOnlyTimesTable;
+import seedu.times.model.ReadOnlyUserPrefs;
+import seedu.times.model.TimesTable;
+import seedu.times.model.UserPrefs;
+import seedu.times.model.util.SampleDataUtil;
+import seedu.times.storage.JsonTimesTableStorage;
+import seedu.times.storage.JsonUserPrefsStorage;
+import seedu.times.storage.Storage;
+import seedu.times.storage.StorageManager;
+import seedu.times.storage.TimesTableStorage;
+import seedu.times.storage.UserPrefsStorage;
+import seedu.times.ui.Ui;
+import seedu.times.ui.UiManager;
/**
* Runs the application.
*/
public class MainApp extends Application {
- public static final Version VERSION = new Version(0, 2, 0, true);
+ public static final Version VERSION = new Version(1, 3, 0, true);
private static final Logger logger = LogsCenter.getLogger(MainApp.class);
@@ -48,7 +48,7 @@ public class MainApp extends Application {
@Override
public void init() throws Exception {
- logger.info("=============================[ Initializing AddressBook ]===========================");
+ logger.info("=============================[ Initializing TimesTable ]===========================");
super.init();
AppParameters appParameters = AppParameters.parse(getParameters());
@@ -56,8 +56,8 @@ public void init() throws Exception {
UserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(config.getUserPrefsFilePath());
UserPrefs userPrefs = initPrefs(userPrefsStorage);
- AddressBookStorage addressBookStorage = new JsonAddressBookStorage(userPrefs.getAddressBookFilePath());
- storage = new StorageManager(addressBookStorage, userPrefsStorage);
+ TimesTableStorage timesTableStorage = new JsonTimesTableStorage(userPrefs.getTimesTableFilePath());
+ storage = new StorageManager(timesTableStorage, userPrefsStorage);
initLogging(config);
@@ -74,20 +74,20 @@ public void init() throws Exception {
* or an empty address book will be used instead if errors occur when reading {@code storage}'s address book.
*/
private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
- Optional addressBookOptional;
- ReadOnlyAddressBook initialData;
+ Optional timesTableOptional;
+ ReadOnlyTimesTable initialData;
try {
- addressBookOptional = storage.readAddressBook();
- if (!addressBookOptional.isPresent()) {
- logger.info("Data file not found. Will be starting with a sample AddressBook");
+ timesTableOptional = storage.readTimesTable();
+ if (!timesTableOptional.isPresent()) {
+ logger.info("Data file not found. Will be starting with a sample TimesTable");
}
- initialData = addressBookOptional.orElseGet(SampleDataUtil::getSampleAddressBook);
+ initialData = timesTableOptional.orElseGet(SampleDataUtil::getSampleTimesTable);
} catch (DataConversionException e) {
- logger.warning("Data file not in the correct format. Will be starting with an empty AddressBook");
- initialData = new AddressBook();
+ logger.warning("Data file not in the correct format. Will be starting with an empty TimesTable");
+ initialData = new TimesTable();
} catch (IOException e) {
- logger.warning("Problem while reading from the file. Will be starting with an empty AddressBook");
- initialData = new AddressBook();
+ logger.warning("Problem while reading from the file. Will be starting with an empty TimesTable");
+ initialData = new TimesTable();
}
return new ModelManager(initialData, userPrefs);
@@ -151,7 +151,7 @@ protected UserPrefs initPrefs(UserPrefsStorage storage) {
+ "Using default user prefs");
initializedPrefs = new UserPrefs();
} catch (IOException e) {
- logger.warning("Problem while reading from the file. Will be starting with an empty AddressBook");
+ logger.warning("Problem while reading from the file. Will be starting with an empty TimesTable");
initializedPrefs = new UserPrefs();
}
@@ -167,13 +167,13 @@ protected UserPrefs initPrefs(UserPrefsStorage storage) {
@Override
public void start(Stage primaryStage) {
- logger.info("Starting AddressBook " + MainApp.VERSION);
+ logger.info("Starting TimesTable " + MainApp.VERSION);
ui.start(primaryStage);
}
@Override
public void stop() {
- logger.info("============================ [ Stopping Address Book ] =============================");
+ logger.info("============================ [ Stopping TimesTable ] =============================");
try {
storage.saveUserPrefs(model.getUserPrefs());
} catch (IOException e) {
diff --git a/src/main/java/seedu/address/commons/core/Config.java b/src/main/java/seedu/times/commons/core/Config.java
similarity index 97%
rename from src/main/java/seedu/address/commons/core/Config.java
rename to src/main/java/seedu/times/commons/core/Config.java
index 91145745521..f41d64fadd1 100644
--- a/src/main/java/seedu/address/commons/core/Config.java
+++ b/src/main/java/seedu/times/commons/core/Config.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.core;
+package seedu.times.commons.core;
import java.nio.file.Path;
import java.nio.file.Paths;
diff --git a/src/main/java/seedu/address/commons/core/GuiSettings.java b/src/main/java/seedu/times/commons/core/GuiSettings.java
similarity index 98%
rename from src/main/java/seedu/address/commons/core/GuiSettings.java
rename to src/main/java/seedu/times/commons/core/GuiSettings.java
index ba33653be67..f94111a4d32 100644
--- a/src/main/java/seedu/address/commons/core/GuiSettings.java
+++ b/src/main/java/seedu/times/commons/core/GuiSettings.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.core;
+package seedu.times.commons.core;
import java.awt.Point;
import java.io.Serializable;
diff --git a/src/main/java/seedu/address/commons/core/LogsCenter.java b/src/main/java/seedu/times/commons/core/LogsCenter.java
similarity index 97%
rename from src/main/java/seedu/address/commons/core/LogsCenter.java
rename to src/main/java/seedu/times/commons/core/LogsCenter.java
index 431e7185e76..5603edaeebe 100644
--- a/src/main/java/seedu/address/commons/core/LogsCenter.java
+++ b/src/main/java/seedu/times/commons/core/LogsCenter.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.core;
+package seedu.times.commons.core;
import java.io.IOException;
import java.util.Arrays;
@@ -18,7 +18,7 @@
public class LogsCenter {
private static final int MAX_FILE_COUNT = 5;
private static final int MAX_FILE_SIZE_IN_BYTES = (int) (Math.pow(2, 20) * 5); // 5MB
- private static final String LOG_FILE = "addressbook.log";
+ private static final String LOG_FILE = "timestable.log";
private static Level currentLogLevel = Level.INFO;
private static final Logger logger = LogsCenter.getLogger(LogsCenter.class);
private static FileHandler fileHandler;
diff --git a/src/main/java/seedu/times/commons/core/Messages.java b/src/main/java/seedu/times/commons/core/Messages.java
new file mode 100644
index 00000000000..b587cbcfc40
--- /dev/null
+++ b/src/main/java/seedu/times/commons/core/Messages.java
@@ -0,0 +1,17 @@
+package seedu.times.commons.core;
+
+/**
+ * Container for user visible messages.
+ */
+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_STUDENT_DISPLAYED_INDEX = "The student index provided is invalid";
+ public static final String MESSAGE_INVALID_CLASS_DISPLAYED_INDEX = "The class index provided is invalid";
+ public static final String MESSAGE_CLASHING_CLASS_TIMING = "The operation aborted because it will introduce a clash"
+ + " in class timing.";
+ public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
+ public static final String MESSAGE_CLASSES_LISTED_OVERVIEW = "%1$d classes listed!";
+ public static final String MESSAGE_NO_SEARCH_TERMS_ENTERED = "You have not entered any search term!";
+}
diff --git a/src/main/java/seedu/address/commons/core/Version.java b/src/main/java/seedu/times/commons/core/Version.java
similarity index 98%
rename from src/main/java/seedu/address/commons/core/Version.java
rename to src/main/java/seedu/times/commons/core/Version.java
index 12142ec1e32..e5c2382ceb4 100644
--- a/src/main/java/seedu/address/commons/core/Version.java
+++ b/src/main/java/seedu/times/commons/core/Version.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.core;
+package seedu.times.commons.core;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
diff --git a/src/main/java/seedu/address/commons/core/index/Index.java b/src/main/java/seedu/times/commons/core/index/Index.java
similarity index 97%
rename from src/main/java/seedu/address/commons/core/index/Index.java
rename to src/main/java/seedu/times/commons/core/index/Index.java
index 19536439c09..6ead768d156 100644
--- a/src/main/java/seedu/address/commons/core/index/Index.java
+++ b/src/main/java/seedu/times/commons/core/index/Index.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.core.index;
+package seedu.times.commons.core.index;
/**
* Represents a zero-based or one-based index.
diff --git a/src/main/java/seedu/address/commons/exceptions/DataConversionException.java b/src/main/java/seedu/times/commons/exceptions/DataConversionException.java
similarity index 84%
rename from src/main/java/seedu/address/commons/exceptions/DataConversionException.java
rename to src/main/java/seedu/times/commons/exceptions/DataConversionException.java
index 1f689bd8e3f..f5cee7e4b1d 100644
--- a/src/main/java/seedu/address/commons/exceptions/DataConversionException.java
+++ b/src/main/java/seedu/times/commons/exceptions/DataConversionException.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.exceptions;
+package seedu.times.commons.exceptions;
/**
* Represents an error during conversion of data from one format to another
diff --git a/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java b/src/main/java/seedu/times/commons/exceptions/IllegalValueException.java
similarity index 93%
rename from src/main/java/seedu/address/commons/exceptions/IllegalValueException.java
rename to src/main/java/seedu/times/commons/exceptions/IllegalValueException.java
index 19124db485c..9658fff87e5 100644
--- a/src/main/java/seedu/address/commons/exceptions/IllegalValueException.java
+++ b/src/main/java/seedu/times/commons/exceptions/IllegalValueException.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.exceptions;
+package seedu.times.commons.exceptions;
/**
* Signals that some given data does not fulfill some constraints.
diff --git a/src/main/java/seedu/address/commons/util/AppUtil.java b/src/main/java/seedu/times/commons/util/AppUtil.java
similarity index 76%
rename from src/main/java/seedu/address/commons/util/AppUtil.java
rename to src/main/java/seedu/times/commons/util/AppUtil.java
index 87aa89c0326..da3201aa0cc 100644
--- a/src/main/java/seedu/address/commons/util/AppUtil.java
+++ b/src/main/java/seedu/times/commons/util/AppUtil.java
@@ -1,9 +1,9 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import static java.util.Objects.requireNonNull;
import javafx.scene.image.Image;
-import seedu.address.MainApp;
+import seedu.times.MainApp;
/**
* A container for App specific utility functions
@@ -39,4 +39,14 @@ public static void checkArgument(Boolean condition, String errorMessage) {
throw new IllegalArgumentException(errorMessage);
}
}
+
+ /**
+ * Checks that {@code test} doesn't exceed {@code maxLength}. Part of argument validation.
+ */
+ public static boolean isWithinLength(String test, int maxLength) {
+ if (test.length() <= maxLength) {
+ return true;
+ }
+ return false;
+ }
}
diff --git a/src/main/java/seedu/address/commons/util/CollectionUtil.java b/src/main/java/seedu/times/commons/util/CollectionUtil.java
similarity index 96%
rename from src/main/java/seedu/address/commons/util/CollectionUtil.java
rename to src/main/java/seedu/times/commons/util/CollectionUtil.java
index eafe4dfd681..2e2a7763d4b 100644
--- a/src/main/java/seedu/address/commons/util/CollectionUtil.java
+++ b/src/main/java/seedu/times/commons/util/CollectionUtil.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import static java.util.Objects.requireNonNull;
diff --git a/src/main/java/seedu/address/commons/util/ConfigUtil.java b/src/main/java/seedu/times/commons/util/ConfigUtil.java
similarity index 77%
rename from src/main/java/seedu/address/commons/util/ConfigUtil.java
rename to src/main/java/seedu/times/commons/util/ConfigUtil.java
index f7f8a2bd44c..68668c9e6ba 100644
--- a/src/main/java/seedu/address/commons/util/ConfigUtil.java
+++ b/src/main/java/seedu/times/commons/util/ConfigUtil.java
@@ -1,11 +1,11 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Optional;
-import seedu.address.commons.core.Config;
-import seedu.address.commons.exceptions.DataConversionException;
+import seedu.times.commons.core.Config;
+import seedu.times.commons.exceptions.DataConversionException;
/**
* A class for accessing the Config File.
diff --git a/src/main/java/seedu/address/commons/util/FileUtil.java b/src/main/java/seedu/times/commons/util/FileUtil.java
similarity index 98%
rename from src/main/java/seedu/address/commons/util/FileUtil.java
rename to src/main/java/seedu/times/commons/util/FileUtil.java
index b1e2767cdd9..86511f30490 100644
--- a/src/main/java/seedu/address/commons/util/FileUtil.java
+++ b/src/main/java/seedu/times/commons/util/FileUtil.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import java.io.IOException;
import java.nio.file.Files;
diff --git a/src/main/java/seedu/address/commons/util/JsonUtil.java b/src/main/java/seedu/times/commons/util/JsonUtil.java
similarity index 97%
rename from src/main/java/seedu/address/commons/util/JsonUtil.java
rename to src/main/java/seedu/times/commons/util/JsonUtil.java
index 8ef609f055d..9d47884fb12 100644
--- a/src/main/java/seedu/address/commons/util/JsonUtil.java
+++ b/src/main/java/seedu/times/commons/util/JsonUtil.java
@@ -1,4 +1,4 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import static java.util.Objects.requireNonNull;
@@ -20,8 +20,8 @@
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.exceptions.DataConversionException;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.commons.exceptions.DataConversionException;
/**
* Converts a Java object instance to JSON and vice versa
diff --git a/src/main/java/seedu/address/commons/util/StringUtil.java b/src/main/java/seedu/times/commons/util/StringUtil.java
similarity index 95%
rename from src/main/java/seedu/address/commons/util/StringUtil.java
rename to src/main/java/seedu/times/commons/util/StringUtil.java
index 61cc8c9a1cb..5c4a4def8dd 100644
--- a/src/main/java/seedu/address/commons/util/StringUtil.java
+++ b/src/main/java/seedu/times/commons/util/StringUtil.java
@@ -1,7 +1,7 @@
-package seedu.address.commons.util;
+package seedu.times.commons.util;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
import java.io.PrintWriter;
import java.io.StringWriter;
diff --git a/src/main/java/seedu/times/logic/CommandObserver.java b/src/main/java/seedu/times/logic/CommandObserver.java
new file mode 100644
index 00000000000..b9d2b2fb3a2
--- /dev/null
+++ b/src/main/java/seedu/times/logic/CommandObserver.java
@@ -0,0 +1,28 @@
+package seedu.times.logic;
+
+import seedu.times.ui.TabName;
+
+/**
+ * Interface to represent the observers of command class.
+ */
+public interface CommandObserver {
+
+ /**
+ * Updates the view of the observer.
+ *
+ * @param tabToView tab to change the view to.
+ */
+ public void updateView(TabName tabToView);
+
+ /**
+ * Updates the class selected of the observer.
+ *
+ * @param indexOfClassToSelect class index to change the selected to.
+ */
+ public void updateClass(Integer indexOfClassToSelect);
+
+ /**
+ * Hides the tuition class student list.
+ */
+ public void hideTuitionClassStudentList();
+}
diff --git a/src/main/java/seedu/address/logic/Logic.java b/src/main/java/seedu/times/logic/Logic.java
similarity index 56%
rename from src/main/java/seedu/address/logic/Logic.java
rename to src/main/java/seedu/times/logic/Logic.java
index 92cd8fa605a..37e94cb67fa 100644
--- a/src/main/java/seedu/address/logic/Logic.java
+++ b/src/main/java/seedu/times/logic/Logic.java
@@ -1,14 +1,15 @@
-package seedu.address.logic;
+package seedu.times.logic;
import java.nio.file.Path;
import javafx.collections.ObservableList;
-import seedu.address.commons.core.GuiSettings;
-import seedu.address.logic.commands.CommandResult;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.person.Person;
+import seedu.times.commons.core.GuiSettings;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.ReadOnlyTimesTable;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.TuitionClass;
/**
* API of the Logic component
@@ -24,19 +25,19 @@ public interface Logic {
CommandResult execute(String commandText) throws CommandException, ParseException;
/**
- * Returns the AddressBook.
+ * Returns the TimesTable.
*
- * @see seedu.address.model.Model#getAddressBook()
+ * @see seedu.times.model.Model#getTimesTable()
*/
- ReadOnlyAddressBook getAddressBook();
+ ReadOnlyTimesTable getTimesTable();
/** Returns an unmodifiable view of the filtered list of persons */
- ObservableList getFilteredPersonList();
+ ObservableList getFilteredStudentList();
/**
* Returns the user prefs' address book file path.
*/
- Path getAddressBookFilePath();
+ Path getTimesTableFilePath();
/**
* Returns the user prefs' GUI settings.
@@ -47,4 +48,9 @@ public interface Logic {
* Set the user prefs' GUI settings.
*/
void setGuiSettings(GuiSettings guiSettings);
+
+
+ ObservableList getFilteredTuitionClassList();
+
+ void setCommandObserver(CommandObserver commandObserver);
}
diff --git a/src/main/java/seedu/address/logic/LogicManager.java b/src/main/java/seedu/times/logic/LogicManager.java
similarity index 50%
rename from src/main/java/seedu/address/logic/LogicManager.java
rename to src/main/java/seedu/times/logic/LogicManager.java
index 9d9c6d15bdc..ee89e18d7db 100644
--- a/src/main/java/seedu/address/logic/LogicManager.java
+++ b/src/main/java/seedu/times/logic/LogicManager.java
@@ -1,21 +1,22 @@
-package seedu.address.logic;
+package seedu.times.logic;
import java.io.IOException;
import java.nio.file.Path;
import java.util.logging.Logger;
import javafx.collections.ObservableList;
-import seedu.address.commons.core.GuiSettings;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.logic.commands.Command;
-import seedu.address.logic.commands.CommandResult;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.logic.parser.AddressBookParser;
-import seedu.address.logic.parser.exceptions.ParseException;
-import seedu.address.model.Model;
-import seedu.address.model.ReadOnlyAddressBook;
-import seedu.address.model.person.Person;
-import seedu.address.storage.Storage;
+import seedu.times.commons.core.GuiSettings;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.logic.parser.TimesTableParser;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.Model;
+import seedu.times.model.ReadOnlyTimesTable;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.storage.Storage;
/**
* The main LogicManager of the app.
@@ -26,7 +27,7 @@ public class LogicManager implements Logic {
private final Model model;
private final Storage storage;
- private final AddressBookParser addressBookParser;
+ private final TimesTableParser timesTableParser;
/**
* Constructs a {@code LogicManager} with the given {@code Model} and {@code Storage}.
@@ -34,7 +35,7 @@ public class LogicManager implements Logic {
public LogicManager(Model model, Storage storage) {
this.model = model;
this.storage = storage;
- addressBookParser = new AddressBookParser();
+ timesTableParser = new TimesTableParser();
}
@Override
@@ -42,11 +43,11 @@ public CommandResult execute(String commandText) throws CommandException, ParseE
logger.info("----------------[USER COMMAND][" + commandText + "]");
CommandResult commandResult;
- Command command = addressBookParser.parseCommand(commandText);
+ Command command = timesTableParser.parseCommand(commandText);
commandResult = command.execute(model);
try {
- storage.saveAddressBook(model.getAddressBook());
+ storage.saveTimesTable(model.getTimesTable());
} catch (IOException ioe) {
throw new CommandException(FILE_OPS_ERROR_MESSAGE + ioe, ioe);
}
@@ -55,18 +56,28 @@ public CommandResult execute(String commandText) throws CommandException, ParseE
}
@Override
- public ReadOnlyAddressBook getAddressBook() {
- return model.getAddressBook();
+ public void setCommandObserver(CommandObserver commandObserver) {
+ Command.setCommandObserver(commandObserver);
}
@Override
- public ObservableList getFilteredPersonList() {
- return model.getFilteredPersonList();
+ public ReadOnlyTimesTable getTimesTable() {
+ return model.getTimesTable();
}
@Override
- public Path getAddressBookFilePath() {
- return model.getAddressBookFilePath();
+ public ObservableList getFilteredStudentList() {
+ return model.getFilteredStudentList();
+ }
+
+ @Override
+ public ObservableList getFilteredTuitionClassList() {
+ return model.getFilteredTuitionClassList();
+ }
+
+ @Override
+ public Path getTimesTableFilePath() {
+ return model.getTimesTableFilePath();
}
@Override
diff --git a/src/main/java/seedu/times/logic/commands/AddCommand.java b/src/main/java/seedu/times/logic/commands/AddCommand.java
new file mode 100644
index 00000000000..56076c47754
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/AddCommand.java
@@ -0,0 +1,84 @@
+package seedu.times.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_EMAIL;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_NOK;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_TAG;
+
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.person.Student;
+import seedu.times.ui.TabName;
+
+/**
+ * Adds a person to the Timestable.
+ */
+public class AddCommand extends Command {
+
+ public static final String COMMAND_WORD = "add";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book.\n"
+ + "Parameters: "
+ + PREFIX_NAME + "NAME "
+ + PREFIX_PHONE + "PHONE "
+ + PREFIX_EMAIL + "EMAIL "
+ + PREFIX_ADDRESS + "ADDRESS "
+ + "[" + PREFIX_TAG + "TAG]...\n"
+ + PREFIX_NOK + " "
+ + PREFIX_NAME + "NAME "
+ + PREFIX_PHONE + "PHONE "
+ + PREFIX_EMAIL + "EMAIL "
+ + PREFIX_ADDRESS + "ADDRESS \n"
+ + "Example: " + COMMAND_WORD + " "
+ + PREFIX_NAME + "John Doe "
+ + PREFIX_PHONE + "98765432 "
+ + PREFIX_EMAIL + "johnd@example.com "
+ + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
+ + PREFIX_TAG + "Chemistry "
+ + PREFIX_TAG + "Sec 3 \n"
+ + PREFIX_NOK + " "
+ + PREFIX_NAME + "Jack Doe "
+ + PREFIX_PHONE + "10987654 "
+ + PREFIX_EMAIL + "jackd@example.com "
+ + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 ";
+
+ public static final String MESSAGE_SUCCESS = "New Student added: %1$s";
+ public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
+
+ private final Student studentToAdd;
+
+ /**
+ * Creates an AddCommand to add the specified {@code Person}.
+ * We always pass in a new {@code TuitionClass}, and check if it alr exists
+ */
+ public AddCommand(Student student) {
+ requireNonNull(student);
+ studentToAdd = student;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+
+ if (model.hasStudent(studentToAdd)) {
+ throw new CommandException(MESSAGE_DUPLICATE_PERSON);
+ }
+
+ model.addStudent(studentToAdd);
+
+ updateView(TabName.STUDENTS);
+
+ return new CommandResult(String.format(MESSAGE_SUCCESS, studentToAdd));
+
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof AddCommand // instanceof handles nulls
+ && studentToAdd.equals(((AddCommand) other).studentToAdd));
+ }
+}
diff --git a/src/main/java/seedu/address/logic/commands/ClearCommand.java b/src/main/java/seedu/times/logic/commands/ClearCommand.java
similarity index 53%
rename from src/main/java/seedu/address/logic/commands/ClearCommand.java
rename to src/main/java/seedu/times/logic/commands/ClearCommand.java
index 9c86b1fa6e4..16547dac3ff 100644
--- a/src/main/java/seedu/address/logic/commands/ClearCommand.java
+++ b/src/main/java/seedu/times/logic/commands/ClearCommand.java
@@ -1,23 +1,23 @@
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
import static java.util.Objects.requireNonNull;
-import seedu.address.model.AddressBook;
-import seedu.address.model.Model;
+import seedu.times.model.Model;
+import seedu.times.model.TimesTable;
/**
- * Clears the address book.
+ * Clears the Timestable.
*/
public class ClearCommand extends Command {
public static final String COMMAND_WORD = "clear";
- public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
+ public static final String MESSAGE_SUCCESS = "TimesTable has been cleared!";
@Override
public CommandResult execute(Model model) {
requireNonNull(model);
- model.setAddressBook(new AddressBook());
+ model.setTimesTable(new TimesTable());
return new CommandResult(MESSAGE_SUCCESS);
}
}
diff --git a/src/main/java/seedu/times/logic/commands/Command.java b/src/main/java/seedu/times/logic/commands/Command.java
new file mode 100644
index 00000000000..fd86a00fe3f
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/Command.java
@@ -0,0 +1,61 @@
+package seedu.times.logic.commands;
+
+import java.util.ArrayList;
+
+import seedu.times.logic.CommandObserver;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.ui.TabName;
+
+/**
+ * Represents a command with hidden internal logic and the ability to be executed.
+ */
+public abstract class Command {
+
+ private static final ArrayList commandObservers = new ArrayList<>();
+
+ public static void setCommandObserver(CommandObserver commandObserver) {
+ commandObservers.add(commandObserver);
+ }
+
+ /**
+ * Updates the CommandObservers by calling the updateView method for each of them.
+ *
+ * @param tabToView Tab to be viewed.
+ */
+ public void updateView(TabName tabToView) {
+ for (CommandObserver commandObserver : commandObservers) {
+ commandObserver.updateView(tabToView);
+ }
+ }
+
+ /**
+ * Updates the CommandObservers by calling the updateClass command.
+ *
+ * @param indexOfClassToSelect index of class to be selected.
+ */
+ public void updateClass(Integer indexOfClassToSelect) {
+ for (CommandObserver commandObserver : commandObservers) {
+ commandObserver.updateClass(indexOfClassToSelect);
+ }
+ }
+
+ /**
+ * Updates the CommandObservers by calling the hideTuitionClassStudentList command.
+ */
+ public void hideTuitionClassStudentList() {
+ for (CommandObserver commandObserver : commandObservers) {
+ commandObserver.hideTuitionClassStudentList();
+ }
+ }
+
+ /**
+ * Executes the command and returns the result message.
+ *
+ * @param model {@code Model} which the command should operate on.
+ * @return feedback message of the operation result for display
+ * @throws CommandException If an error occurs during command execution.
+ */
+ public abstract CommandResult execute(Model model) throws CommandException;
+
+}
diff --git a/src/main/java/seedu/address/logic/commands/CommandResult.java b/src/main/java/seedu/times/logic/commands/CommandResult.java
similarity index 97%
rename from src/main/java/seedu/address/logic/commands/CommandResult.java
rename to src/main/java/seedu/times/logic/commands/CommandResult.java
index 92f900b7916..20ad800806f 100644
--- a/src/main/java/seedu/address/logic/commands/CommandResult.java
+++ b/src/main/java/seedu/times/logic/commands/CommandResult.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
import static java.util.Objects.requireNonNull;
diff --git a/src/main/java/seedu/address/logic/commands/DeleteCommand.java b/src/main/java/seedu/times/logic/commands/DeleteCommand.java
similarity index 71%
rename from src/main/java/seedu/address/logic/commands/DeleteCommand.java
rename to src/main/java/seedu/times/logic/commands/DeleteCommand.java
index 02fd256acba..ddc22fc9664 100644
--- a/src/main/java/seedu/address/logic/commands/DeleteCommand.java
+++ b/src/main/java/seedu/times/logic/commands/DeleteCommand.java
@@ -1,17 +1,17 @@
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
import static java.util.Objects.requireNonNull;
import java.util.List;
-import seedu.address.commons.core.Messages;
-import seedu.address.commons.core.index.Index;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.model.Model;
-import seedu.address.model.person.Person;
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.person.Student;
/**
- * Deletes a person identified using it's displayed index from the address book.
+ * Deletes a person identified using it's displayed index from the Timestable.
*/
public class DeleteCommand extends Command {
@@ -33,15 +33,15 @@ public DeleteCommand(Index targetIndex) {
@Override
public CommandResult execute(Model model) throws CommandException {
requireNonNull(model);
- List lastShownList = model.getFilteredPersonList();
+ List lastShownList = model.getFilteredStudentList();
if (targetIndex.getZeroBased() >= lastShownList.size()) {
- throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
+ throw new CommandException(Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX);
}
- Person personToDelete = lastShownList.get(targetIndex.getZeroBased());
- model.deletePerson(personToDelete);
- return new CommandResult(String.format(MESSAGE_DELETE_PERSON_SUCCESS, personToDelete));
+ Student studentToDelete = lastShownList.get(targetIndex.getZeroBased());
+ model.deleteStudent(studentToDelete);
+ return new CommandResult(String.format(MESSAGE_DELETE_PERSON_SUCCESS, studentToDelete));
}
@Override
diff --git a/src/main/java/seedu/times/logic/commands/EditCommand.java b/src/main/java/seedu/times/logic/commands/EditCommand.java
new file mode 100644
index 00000000000..f62f2a21765
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/EditCommand.java
@@ -0,0 +1,296 @@
+package seedu.times.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_EMAIL;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_TAG;
+import static seedu.times.model.Model.PREDICATE_SHOW_ALL_PERSONS;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.commons.util.CollectionUtil;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.person.Address;
+import seedu.times.model.person.Email;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Nok;
+import seedu.times.model.person.Phone;
+import seedu.times.model.person.Student;
+import seedu.times.model.tag.Tag;
+import seedu.times.ui.TabName;
+
+/**
+ * Edits the details of an existing person in the Timestable.
+ */
+public class EditCommand extends Command {
+
+ public static final String COMMAND_WORD = "edit";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the student identified "
+ + "by the index number used in the displayed student list. "
+ + "Existing values will be overwritten by the input values.\n"
+ + "Parameters: INDEX (must be a positive integer) "
+ + "[" + PREFIX_NAME + "NAME] "
+ + "[" + PREFIX_PHONE + "PHONE] "
+ + "[" + PREFIX_EMAIL + "EMAIL] "
+ + "[" + PREFIX_ADDRESS + "ADDRESS] "
+ + "[" + PREFIX_TAG + "TAG]...\n"
+ + "Example: " + COMMAND_WORD + " 1 "
+ + PREFIX_PHONE + "91234567 "
+ + PREFIX_EMAIL + "johndoe@example.com";
+
+ public static final String MESSAGE_EDIT_STUDENT_SUCCESS = "Edited Student: %1$s";
+ public static final String MESSAGE_NOT_EDITED = "At least one field to edit must be provided.";
+ public static final String MESSAGE_DUPLICATE_STUDENT = "This student already exists in the address book.";
+
+ private final Index index;
+ private final EditStudentDescriptor editStudentDescriptor;
+
+ /**
+ * @param index of the person in the filtered person list to edit
+ * @param editStudentDescriptor details to edit the person with
+ */
+ public EditCommand(Index index, EditStudentDescriptor editStudentDescriptor) {
+ requireNonNull(index);
+ requireNonNull(editStudentDescriptor);
+
+ this.index = index;
+ this.editStudentDescriptor = new EditStudentDescriptor(editStudentDescriptor);
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+
+ List lastShownList = model.getFilteredStudentList();
+
+ if (index.getZeroBased() >= lastShownList.size()) {
+ throw new CommandException(Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX);
+ }
+
+ Student studentToEdit = lastShownList.get(index.getZeroBased());
+
+ //execute update scade, change name in student name list in tuitionclass
+ editStudentDescriptor.getName().ifPresent(name -> {
+ model.updateClassStudentLists(name, studentToEdit.getName());
+ });
+
+ Student editedStudent = createEditedStudent(studentToEdit, editStudentDescriptor);
+
+
+ if (!studentToEdit.isSamePerson(editedStudent) && model.hasStudent(editedStudent)) {
+ throw new CommandException(MESSAGE_DUPLICATE_STUDENT);
+ }
+
+ model.setStudent(studentToEdit, editedStudent);
+ model.updateFilteredStudentList(PREDICATE_SHOW_ALL_PERSONS);
+ updateView(TabName.STUDENTS);
+
+ return new CommandResult(String.format(MESSAGE_EDIT_STUDENT_SUCCESS, editedStudent));
+ }
+
+ /**
+ * Creates and returns a {@code Person} with the details of {@code personToEdit}
+ * edited with {@code editPersonDescriptor}.
+ */
+ private static Student createEditedStudent(Student studentToEdit, EditStudentDescriptor editStudentDescriptor)
+ throws CommandException {
+ assert studentToEdit != null;
+
+ Name updatedName = editStudentDescriptor.getName().orElse(studentToEdit.getName());
+ Phone updatedPhone = editStudentDescriptor.getPhone().orElse(studentToEdit.getPhone());
+ Email updatedEmail = editStudentDescriptor.getEmail().orElse(studentToEdit.getEmail());
+ Address updatedAddress = editStudentDescriptor.getAddress().orElse(studentToEdit.getAddress());
+ Set updatedTags = editStudentDescriptor.getTags().orElse(studentToEdit.getTags());
+
+ // Nok
+ Name nokName = editStudentDescriptor.getNokName().orElse(studentToEdit.getNok().getName());
+ Phone nokPhone = editStudentDescriptor.getNokPhone().orElse(studentToEdit.getNok().getPhone());
+ Email nokEmail = editStudentDescriptor.getNokEmail().orElse(studentToEdit.getNok().getEmail());
+ Address nokAddress = editStudentDescriptor.getNokAddress().orElse(studentToEdit.getNok().getAddress());
+ Nok nok = new Nok(nokName, nokPhone, nokEmail, nokAddress);
+
+ return new Student(updatedName, updatedPhone, updatedEmail, updatedAddress, nok, updatedTags);
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ // short circuit if same object
+ if (other == this) {
+ return true;
+ }
+
+ // instanceof handles nulls
+ if (!(other instanceof EditCommand)) {
+ return false;
+ }
+
+ // state check
+ EditCommand e = (EditCommand) other;
+ return index.equals(e.index)
+ && editStudentDescriptor.equals(e.editStudentDescriptor);
+ }
+
+ /**
+ * Stores the details to edit the student with. Each non-empty field value will replace the
+ * corresponding field value of the student.
+ */
+ public static class EditStudentDescriptor {
+ private Name name;
+ private Phone phone;
+ private Email email;
+ private Address address;
+ private Set tags;
+
+ private Name nokName;
+ private Phone nokPhone;
+ private Email nokEmail;
+ private Address nokAddress;
+
+ public EditStudentDescriptor() {}
+
+ /**
+ * Copy constructor.
+ * A defensive copy of {@code tags} is used internally.
+ */
+ public EditStudentDescriptor(EditStudentDescriptor toCopy) {
+ setName(toCopy.name);
+ setPhone(toCopy.phone);
+ setEmail(toCopy.email);
+ setAddress(toCopy.address);
+
+ setNokName(toCopy.nokName);
+ setNokPhone(toCopy.nokPhone);
+ setNokEmail(toCopy.nokEmail);
+ setNokAddress(toCopy.nokAddress);
+
+ setTags(toCopy.tags);
+ }
+
+ /**
+ * Returns true if at least one field is edited.
+ */
+ public boolean isAnyFieldEdited() {
+ return CollectionUtil.isAnyNonNull(name, phone, email, address, tags, nokAddress, nokEmail, nokName,
+ nokPhone);
+ }
+
+ public void setName(Name name) {
+ this.name = name;
+ }
+
+ public Optional getName() {
+ return Optional.ofNullable(name);
+ }
+
+ public void setPhone(Phone phone) {
+ this.phone = phone;
+ }
+
+ public Optional getPhone() {
+ return Optional.ofNullable(phone);
+ }
+
+ public void setEmail(Email email) {
+ this.email = email;
+ }
+
+ public Optional getEmail() {
+ return Optional.ofNullable(email);
+ }
+
+ public void setAddress(Address address) {
+ this.address = address;
+ }
+
+ public Optional getAddress() {
+ return Optional.ofNullable(address);
+ }
+
+ //// nok
+
+ public void setNokName(Name nokName) {
+ this.nokName = nokName;
+ }
+
+ public Optional getNokName() {
+ return Optional.ofNullable(nokName);
+ }
+ public void setNokPhone(Phone nokPhone) {
+ this.nokPhone = nokPhone;
+ }
+
+ public Optional getNokPhone() {
+ return Optional.ofNullable(nokPhone);
+ }
+
+ public void setNokEmail(Email nokEmail) {
+ this.nokEmail = nokEmail;
+ }
+
+ public Optional getNokEmail() {
+ return Optional.ofNullable(nokEmail);
+ }
+
+ public void setNokAddress(Address nokAddress) {
+ this.nokAddress = nokAddress;
+ }
+
+ public Optional getNokAddress() {
+ return Optional.ofNullable(nokAddress);
+ }
+
+ /**
+ * Sets {@code tags} to this object's {@code tags}.
+ * A defensive copy of {@code tags} is used internally.
+ */
+ public void setTags(Set tags) {
+ this.tags = (tags != null) ? new HashSet<>(tags) : null;
+ }
+
+ /**
+ * Returns an unmodifiable tag set, which throws {@code UnsupportedOperationException}
+ * if modification is attempted.
+ * Returns {@code Optional#empty()} if {@code tags} is null.
+ */
+ public Optional> getTags() {
+ return (tags != null) ? Optional.of(Collections.unmodifiableSet(tags)) : Optional.empty();
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ // short circuit if same object
+ if (other == this) {
+ return true;
+ }
+
+ // instanceof handles nulls
+ if (!(other instanceof EditStudentDescriptor)) {
+ return false;
+ }
+
+ // state check
+ EditStudentDescriptor e = (EditStudentDescriptor) other;
+
+ return getName().equals(e.getName())
+ && getPhone().equals(e.getPhone())
+ && getEmail().equals(e.getEmail())
+ && getAddress().equals(e.getAddress())
+ && getTags().equals(e.getTags())
+ && getNokAddress().equals(e.getNokAddress())
+ && getNokEmail().equals(e.getNokEmail())
+ && getNokName().equals(e.getNokName())
+ && getNokPhone().equals(e.getNokPhone());
+
+ }
+ }
+}
diff --git a/src/main/java/seedu/address/logic/commands/ExitCommand.java b/src/main/java/seedu/times/logic/commands/ExitCommand.java
similarity index 84%
rename from src/main/java/seedu/address/logic/commands/ExitCommand.java
rename to src/main/java/seedu/times/logic/commands/ExitCommand.java
index 3dd85a8ba90..f43e86b2b59 100644
--- a/src/main/java/seedu/address/logic/commands/ExitCommand.java
+++ b/src/main/java/seedu/times/logic/commands/ExitCommand.java
@@ -1,6 +1,6 @@
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
-import seedu.address.model.Model;
+import seedu.times.model.Model;
/**
* Terminates the program.
diff --git a/src/main/java/seedu/times/logic/commands/FindNameCommand.java b/src/main/java/seedu/times/logic/commands/FindNameCommand.java
new file mode 100644
index 00000000000..96cd371ded3
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/FindNameCommand.java
@@ -0,0 +1,44 @@
+package seedu.times.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.model.Model;
+import seedu.times.model.person.predicates.NameContainsKeywordsPredicate;
+import seedu.times.ui.TabName;
+
+/**
+ * Finds and lists all persons in Timestable whose name contains any of the search terms.
+ * Keyword matching is case insensitive.
+ */
+public class FindNameCommand extends Command {
+
+ public static final String COMMAND_WORD = "findname";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain all of "
+ + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+ + "Parameters: NAME [, [NAME]...]\n"
+ + "Example: " + COMMAND_WORD + " alice, bob lim, charlie";
+
+ private final NameContainsKeywordsPredicate predicate;
+
+ public FindNameCommand(NameContainsKeywordsPredicate predicate) {
+ this.predicate = predicate;
+ }
+
+ @Override
+ public CommandResult execute(Model model) {
+ requireNonNull(model);
+ model.updateFilteredStudentList(predicate);
+ updateView(TabName.STUDENTS);
+ return new CommandResult(
+ String.format(Messages.MESSAGE_PERSONS_LISTED_OVERVIEW, model.getFilteredStudentList().size()));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof FindNameCommand // instanceof handles nulls
+ && predicate.equals(((FindNameCommand) other).predicate)); // state check
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/FindTagCommand.java b/src/main/java/seedu/times/logic/commands/FindTagCommand.java
new file mode 100644
index 00000000000..309224e8ed6
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/FindTagCommand.java
@@ -0,0 +1,46 @@
+package seedu.times.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.model.Model;
+import seedu.times.model.person.predicates.TagsContainsKeywordsPredicate;
+import seedu.times.ui.TabName;
+
+/**
+ * Finds and lists all persons in Timestable whose list of tags contains any of the search terms.
+ * Keyword matching is case insensitive.
+ */
+public class FindTagCommand extends Command {
+
+ public static final String COMMAND_WORD = "findtag";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose list of tags contains any of "
+ + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+ + "Parameters: KEYWORD [, [KEYWORD]...]\n"
+ + "Example: " + COMMAND_WORD + " Maths, Physics";
+
+ private final TagsContainsKeywordsPredicate predicate;
+
+ public FindTagCommand(TagsContainsKeywordsPredicate predicate) {
+ this.predicate = predicate;
+ }
+
+ @Override
+ public CommandResult execute(Model model) {
+ requireNonNull(model);
+ model.updateFilteredStudentList(predicate);
+
+ updateView(TabName.STUDENTS);
+
+ return new CommandResult(
+ String.format(Messages.MESSAGE_PERSONS_LISTED_OVERVIEW, model.getFilteredStudentList().size()));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof FindTagCommand // instanceof handles nulls
+ && predicate.equals(((FindTagCommand) other).predicate)); // state check
+ }
+}
diff --git a/src/main/java/seedu/address/logic/commands/HelpCommand.java b/src/main/java/seedu/times/logic/commands/HelpCommand.java
similarity index 88%
rename from src/main/java/seedu/address/logic/commands/HelpCommand.java
rename to src/main/java/seedu/times/logic/commands/HelpCommand.java
index bf824f91bd0..b45c6ef0e45 100644
--- a/src/main/java/seedu/address/logic/commands/HelpCommand.java
+++ b/src/main/java/seedu/times/logic/commands/HelpCommand.java
@@ -1,6 +1,6 @@
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
-import seedu.address.model.Model;
+import seedu.times.model.Model;
/**
* Format full help instructions for every command for display.
diff --git a/src/main/java/seedu/times/logic/commands/ListCommand.java b/src/main/java/seedu/times/logic/commands/ListCommand.java
new file mode 100644
index 00000000000..d06a3ee3842
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/ListCommand.java
@@ -0,0 +1,26 @@
+package seedu.times.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.model.Model.PREDICATE_SHOW_ALL_PERSONS;
+
+import seedu.times.model.Model;
+import seedu.times.ui.TabName;
+
+/**
+ * Lists all persons in the Timestable to the user.
+ */
+public class ListCommand extends Command {
+
+ public static final String COMMAND_WORD = "list";
+
+ public static final String MESSAGE_SUCCESS = "Listed all students";
+
+
+ @Override
+ public CommandResult execute(Model model) {
+ requireNonNull(model);
+ updateView(TabName.STUDENTS);
+ model.updateFilteredStudentList(PREDICATE_SHOW_ALL_PERSONS);
+ return new CommandResult(MESSAGE_SUCCESS);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/SortCommand.java b/src/main/java/seedu/times/logic/commands/SortCommand.java
new file mode 100644
index 00000000000..bf9c18e157c
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/SortCommand.java
@@ -0,0 +1,95 @@
+package seedu.times.logic.commands;
+
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.ui.TabName;
+
+/**
+ * Sorts either the students or tuition class in Timestable.
+ */
+public class SortCommand extends Command {
+ public static final String COMMAND_WORD = "sort";
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Sorts students/classes by specified"
+ + " parameter and order\n"
+ + "Parameters: PARAMETER_TO_SORT_BY DIRECTION_OF_SORT\n"
+ + "Example: " + COMMAND_WORD + " name asc";
+ public static final String INVALID_SORTBY = "The parameter to sort by can only be: name or timing";
+ public static final String INVALID_DIRECTIONOFSORT = "The direction of sort can only be asc or desc";
+ public static final String MESSAGE_SUCCESS = "Sorted %s based on %s in %s direction";
+
+ // input keywords
+ public static final String SORT_BY_NAME = "name";
+ public static final String SORT_BY_CLASS_TIMING = "timing";
+ public static final String DIRECTION_OF_SORT_ASC = "asc";
+ public static final String DIRECTION_OF_SORT_DESC = "desc";
+ public static final String STUDENT_TAB_SORTED = "students";
+ public static final String CLASSES_TAB_SORTED = "classes";
+
+ private final String sortBy;
+
+ private final String directionOfSort;
+
+ /**
+ * Constructs a new SortCommand.
+ *
+ * @param sortBy sortBy keyword.
+ * @param directionOfSort directionOfSort keyword.
+ */
+ public SortCommand(String sortBy, String directionOfSort) {
+ this.sortBy = sortBy;
+ this.directionOfSort = directionOfSort;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+
+ // sort the StudentNameList;
+ if (sortBy.equals(SORT_BY_NAME)) {
+
+ if (directionOfSort.equals(DIRECTION_OF_SORT_ASC)) {
+ model.sortStudents((student1, student2) ->
+ student1.getName().toString().compareTo(student2.getName().toString()));
+ } else {
+ model.sortStudents((student1, student2) ->
+ student2.getName().toString().compareTo(student1.getName().toString()));
+ }
+
+ updateView(TabName.STUDENTS);
+
+ return new CommandResult(String.format(MESSAGE_SUCCESS, STUDENT_TAB_SORTED, sortBy, directionOfSort));
+
+ } else if (sortBy.equals(SORT_BY_CLASS_TIMING)) {
+
+ if (directionOfSort.equals(DIRECTION_OF_SORT_ASC)) {
+ model.sortClasses((class1, class2) ->
+ class1.getClassTiming().compareTo(class2.getClassTiming()));
+ } else {
+ model.sortClasses((class1, class2) ->
+ class2.getClassTiming().compareTo(class1.getClassTiming()));
+ }
+
+ updateView(TabName.CLASSES);
+
+ hideTuitionClassStudentList();
+
+ return new CommandResult(String.format(MESSAGE_SUCCESS, CLASSES_TAB_SORTED, sortBy, directionOfSort));
+ } else {
+ return new CommandResult("sort by" + sortBy
+ + " has not been implemented by the developers");
+ }
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == null) {
+ return false;
+ } else if (this == obj) {
+ return true;
+ } else if (obj instanceof SortCommand) {
+ SortCommand sortCommand = (SortCommand) obj;
+ return this.directionOfSort.equals(sortCommand.directionOfSort) && this.sortBy.equals(sortCommand.sortBy);
+ } else {
+ return false;
+ }
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/ViewCommand.java b/src/main/java/seedu/times/logic/commands/ViewCommand.java
new file mode 100644
index 00000000000..2185a77d9a2
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/ViewCommand.java
@@ -0,0 +1,50 @@
+package seedu.times.logic.commands;
+
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.ui.TabName;
+
+/**
+ * Sets the UI to View the tab selected.
+ */
+public class ViewCommand extends Command {
+
+ public static final String COMMAND_WORD = "view";
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Switches tab to specified tab\n"
+ + "Parameters: TAB_TO_VIEW\n"
+ + "Example: " + COMMAND_WORD + " timetable";
+ public static final String INVALID_TAB = "This tab doesn't exists.\n"
+ + "You can only switch to students, timetable or classes.";
+
+ private final TabName tabToView;
+
+ /**
+ * Creates a ViewCommand to view the specified tab index.
+ */
+ public ViewCommand(TabName tab) {
+ this.tabToView = tab;
+ }
+
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+
+ updateView(tabToView);
+
+ return new CommandResult("Successfully switched to " + tabToView + " tab",
+ false, false);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ } else if (obj instanceof ViewCommand) {
+ ViewCommand viewCommand = (ViewCommand) obj;
+ return this.tabToView == viewCommand.tabToView;
+ } else {
+ return false;
+ }
+ }
+
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/AddClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/AddClassCommand.java
new file mode 100644
index 00000000000..fc7548fefa1
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/AddClassCommand.java
@@ -0,0 +1,69 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASSTIMING;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASS_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_LOCATION;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_RATE;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.model.tuitionclass.exceptions.OverlappingClassException;
+import seedu.times.ui.TabName;
+
+/**
+ * Adds a tuition class to Timestable.
+ */
+public class AddClassCommand extends Command {
+
+ public static final String COMMAND_WORD = "addclass";
+
+ public static final String MESSAGE_SUCCESS = "New class added: %1$s";
+ public static final Object MESSAGE_USAGE = COMMAND_WORD + ": Adds a class to the address book.\n"
+ + "Parameters: "
+ + PREFIX_CLASS_NAME + "CLASS NAME "
+ + PREFIX_CLASSTIMING + "CLASS TIMING "
+ + PREFIX_RATE + "RATE "
+ + PREFIX_LOCATION + "LOCATION\n"
+ + "Example: " + COMMAND_WORD + " "
+ + PREFIX_CLASS_NAME + "Sec 4 A Maths "
+ + PREFIX_CLASSTIMING + "MON 11:30-13:30 "
+ + PREFIX_RATE + "70 "
+ + PREFIX_LOCATION + "Nex Tuition Center";
+
+ private final TuitionClass tuitionClass;
+
+ /**
+ * Creates an AddToClassCommand to add the specified tuitionClass.
+ *
+ * @param tuitionClass TuitionClass to be added.
+ */
+ public AddClassCommand(TuitionClass tuitionClass) {
+ requireNonNull(tuitionClass);
+ this.tuitionClass = tuitionClass;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+
+ try {
+ model.addTuitionClass(tuitionClass);
+ } catch (OverlappingClassException ice) {
+ throw new CommandException(Messages.MESSAGE_CLASHING_CLASS_TIMING);
+ }
+
+ updateView(TabName.CLASSES);
+ return new CommandResult(String.format(MESSAGE_SUCCESS, tuitionClass));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof AddClassCommand // instanceof handles nulls
+ && tuitionClass.equals(((AddClassCommand) other).tuitionClass));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/AddToClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/AddToClassCommand.java
new file mode 100644
index 00000000000..bca3c65c7ec
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/AddToClassCommand.java
@@ -0,0 +1,147 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.logic.commands.classcommands.EditClassCommand.EditClassDescriptor;
+import static seedu.times.logic.commands.classcommands.EditClassCommand.MESSAGE_DUPLICATE_STUDENT;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.StudentNameList;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.model.tuitionclass.exceptions.DuplicateStudentInClassException;
+import seedu.times.ui.TabName;
+
+/**
+ * Adds existing students to existing tuition class.
+ */
+public class AddToClassCommand extends Command {
+
+ public static final String COMMAND_WORD = "addtoclass";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds students to a class by the index number used "
+ + "in the displayed class and student list in students tab.\n"
+ + "Indexes must be non-zero positive integers.\n"
+ + "Parameters: CLASS_INDEX "
+ + "STUDENT_INDEX...\n"
+ + "Example: " + COMMAND_WORD + " "
+ + "1 "
+ + "2 3 5 "
+ + "(adds students indexed 2, 3 and 5 to class indexed 1)";
+
+ public static final String MESSAGE_ADD_SUCCESS = "Successfully added students to class ";
+ public static final String NO_STUDENT_INDEX_PROVIDED_MESSAGE = "No student index is provided!";
+ public static final String INVALID_OR_MISSING_CLASS_INDEX = "Class index is invalid or is not provided";
+ public static final int CLASS_INDEX_POSITION = 0;
+ public static final int STUDENT_INDEX_STARTING_POSITION = 1;
+
+ private final Index toEditClassIndex;
+ private final List studentIndices;
+
+ /**
+ * Constructs AddToClassCommand.
+ *
+ * @param indexArray ArrayList of index.
+ */
+ public AddToClassCommand(List indexArray) {
+ requireNonNull(indexArray);
+
+ //the first index is the index of class in filtered class list that students would be added to
+ toEditClassIndex = indexArray.get(CLASS_INDEX_POSITION);
+
+ //the remaining indices are those of the students in filtered student list
+ studentIndices = indexArray.subList(STUDENT_INDEX_STARTING_POSITION, indexArray.size());
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+
+ //check indices are not out-of-range
+ List lastShownStudentList = model.getFilteredStudentList();
+ List lastShownTuitionClassList = model.getFilteredTuitionClassList();
+ checkIndicesAreInRange(lastShownStudentList, lastShownTuitionClassList);
+
+ //get names to be added and class to add to
+ ArrayList namesToAdd = createNameList(studentIndices, lastShownStudentList);
+ TuitionClass classToAddTo = lastShownTuitionClassList.get(toEditClassIndex.getZeroBased());
+
+ //get updated student list
+ StudentNameList currentStudentNameList = classToAddTo.getStudentList();
+ StudentNameList updatedStudentNameList = new StudentNameList();
+ try {
+ updatedStudentNameList.addAll(currentStudentNameList);
+ updatedStudentNameList.addAll(namesToAdd);
+ } catch (DuplicateStudentInClassException e) {
+ throw new CommandException(MESSAGE_DUPLICATE_STUDENT + e.getMessage());
+ }
+
+ //create edit class descriptor
+ EditClassDescriptor editClassDescriptor = new EditClassDescriptor();
+ editClassDescriptor.setStudentList(updatedStudentNameList);
+
+ //swap out old tuition class with new tuition class
+ TuitionClass editedClass = EditClassCommand.createEditedClass(classToAddTo, editClassDescriptor);
+ model.setClass(classToAddTo, editedClass);
+
+ // Switches the view to the class view and updates the class
+ updateView(TabName.CLASSES);
+ updateClass(toEditClassIndex.getZeroBased());
+
+ return new CommandResult(String.format(MESSAGE_ADD_SUCCESS, editedClass));
+ }
+
+ private ArrayList createNameList(List studentIndices, List lastShownStudentList) {
+ ArrayList nameList = new ArrayList<>();
+ studentIndices.stream().forEach(index -> {
+ Student student = lastShownStudentList.get(index.getZeroBased());
+ nameList.add(student.getName());
+ });
+ return nameList;
+ }
+
+ private void checkIndicesAreInRange(List lastShownStudentList, List lastShownTuitionClass)
+ throws CommandException {
+ int studentListSize = lastShownStudentList.size();
+ int classListSize = lastShownTuitionClass.size();
+
+ if (studentListSize == 0) {
+ throw new CommandException(Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX);
+ }
+
+ assert studentListSize > 0;
+ assert classListSize >= 0;
+
+ if (toEditClassIndex.getZeroBased() >= classListSize) {
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ }
+
+ for (Index index : studentIndices) {
+ if (index.getZeroBased() >= studentListSize) {
+ throw new CommandException(Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX);
+ }
+ }
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (o == this) {
+ return true;
+ }
+
+ if (!(o instanceof AddToClassCommand)) {
+ return false;
+ }
+
+ AddToClassCommand other = ((AddToClassCommand) o);
+ return other.toEditClassIndex.equals(toEditClassIndex)
+ && other.studentIndices.equals(studentIndices);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/DeleteClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/DeleteClassCommand.java
new file mode 100644
index 00000000000..0fadfc08fe1
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/DeleteClassCommand.java
@@ -0,0 +1,77 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.ui.TabName;
+
+/**
+ * Deletes a class from Timestable.
+ */
+public class DeleteClassCommand extends Command {
+ public static final String COMMAND_WORD = "deleteclass";
+
+ public static final String MESSAGE_SUCCESS = "Class deleted: %1$s";
+ public static final String MESSAGE_MISSING_CLASS = "This class does not exist in the address book";
+
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD
+ + ": Deletes the class identified by the index in class list.\n"
+ + "Parameters: INDEX (must be a positive integer)\n"
+ + "Example: " + COMMAND_WORD + " 1";
+
+ private static Logger logger = Logger.getLogger("DeleteClassCommand");
+
+ private final Index index;
+
+ /**
+ * Create a DeleteClassCommand with the specified index.
+ * @param index The index of the class to be deleted.
+ */
+ public DeleteClassCommand(Index index) {
+ assert index.getOneBased() > 0;
+ this.index = index;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+
+ List lastShownClassList = model.getFilteredTuitionClassList();
+ if (index.getOneBased() > lastShownClassList.size()) {
+ logger.log(Level.INFO, "There are only " + lastShownClassList.size() + " classes displayed");
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ }
+ TuitionClass tuitionClass = lastShownClassList.get(index.getZeroBased());
+
+ if (!model.hasTuitionClass(tuitionClass)) {
+ throw new CommandException(MESSAGE_MISSING_CLASS);
+ }
+
+ model.deleteTuitionClass(tuitionClass);
+ logger.log(Level.INFO, "Class deleted");
+
+ updateView(TabName.CLASSES);
+
+ hideTuitionClassStudentList();
+
+ return new CommandResult(String.format(MESSAGE_SUCCESS, tuitionClass));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof DeleteClassCommand // instanceof handles nulls
+ && index.equals(((DeleteClassCommand) other).index)); // state check
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/EditClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/EditClassCommand.java
new file mode 100644
index 00000000000..e18ab446ca2
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/EditClassCommand.java
@@ -0,0 +1,208 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASSTIMING;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASS_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_LOCATION;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_RATE;
+
+import java.util.List;
+import java.util.Optional;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.commons.util.CollectionUtil;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.ClassName;
+import seedu.times.model.tuitionclass.ClassTiming;
+import seedu.times.model.tuitionclass.Location;
+import seedu.times.model.tuitionclass.Rate;
+import seedu.times.model.tuitionclass.StudentNameList;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.model.tuitionclass.exceptions.DuplicateClassException;
+import seedu.times.model.tuitionclass.exceptions.OverlappingClassException;
+import seedu.times.ui.TabName;
+
+/**
+ * Edits a class in Timestable.
+ */
+public class EditClassCommand extends Command {
+
+ public static final String COMMAND_WORD = "editclass";
+
+ public static final String MESSAGE_EDIT_CLASS_SUCCESS = "Edited class: %1$s";
+ public static final String MESSAGE_NO_FIELD_PROVIDED = "At least one field to editclass must be provided.";
+ public static final String MESSAGE_DUPLICATE_STUDENT = "This student already exists in this class:\n";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the class identified "
+ + "by the index number used in the displayed person list "
+ + "(adding or removing students is done with separate commands!)\n"
+ + "Parameters: INDEX (must be a positive integer) "
+ + "[" + PREFIX_CLASS_NAME + "CLASS NAME] "
+ + "[" + PREFIX_CLASSTIMING + "CLASS TIMING] "
+ + "[" + PREFIX_RATE + "RATE] "
+ + "[" + PREFIX_LOCATION + "LOCATION]\n"
+ + "Example: " + COMMAND_WORD + " 1 "
+ + PREFIX_CLASSTIMING + "MON 13:30-15:30 "
+ + PREFIX_RATE + "100";
+
+
+ private final Index index;
+ private final EditClassDescriptor editClassDescriptor;
+
+ /**
+ * Constructs a new EditClassCommand.
+ *
+ * @param index of class to be edited.
+ * @param editClassDescriptor descriptor of new class.
+ */
+ public EditClassCommand(Index index, EditClassDescriptor editClassDescriptor) {
+ requireAllNonNull(index, editClassDescriptor);
+ this.index = index;
+ this.editClassDescriptor = editClassDescriptor;
+ }
+
+ /**
+ * Creates EditedClass.
+ *
+ * @param classToEdit to be editted.
+ * @param editClassDescriptor to replace.
+ * @return edited TuitionClass.
+ */
+ public static TuitionClass createEditedClass(TuitionClass classToEdit, EditClassDescriptor editClassDescriptor) {
+ assert classToEdit != null;
+
+ ClassName className = editClassDescriptor.getClassName().orElse(classToEdit.getClassName());
+ ClassTiming classTiming = editClassDescriptor.getClassTiming().orElse(classToEdit.getClassTiming());
+ Location location = editClassDescriptor.getLocation().orElse(classToEdit.getLocation());
+ Rate rate = editClassDescriptor.getRate().orElse(classToEdit.getRate());
+ StudentNameList studentNameList = editClassDescriptor.getStudentList().orElse(classToEdit.getStudentList());
+
+ return new TuitionClass(className, classTiming, location, rate, studentNameList);
+
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+
+ List lastShownClassList = model.getFilteredTuitionClassList();
+ if (index.getZeroBased() >= lastShownClassList.size()) {
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ }
+
+ TuitionClass classToEdit = lastShownClassList.get(index.getZeroBased());
+ TuitionClass editedClass = createEditedClass(classToEdit, editClassDescriptor);
+
+ try {
+ model.setClass(classToEdit, editedClass);
+ model.updateFilteredClassList(Model.PREDICATE_SHOW_ALL_CLASS);
+ } catch (OverlappingClassException | DuplicateClassException e) {
+ throw new CommandException(e.getMessage());
+ }
+
+ updateView(TabName.CLASSES);
+ return new CommandResult(String.format(MESSAGE_EDIT_CLASS_SUCCESS, editedClass));
+ }
+
+ /**
+ * Stores the names of the student and the class involved in an addToClassCommand.
+ */
+ public static class EditClassDescriptor {
+ private ClassName className;
+ private ClassTiming classTiming;
+ private Location location;
+ private Rate rate;
+ private StudentNameList studentNameList;
+
+ public EditClassDescriptor() {
+ }
+
+ /**
+ * Constructs a copy of the given EditClassDescriptor.
+ *
+ * @param toCopy The EditClassDescriptor to copy.
+ */
+ public EditClassDescriptor(EditClassDescriptor toCopy) {
+ setClassName(toCopy.className);
+ setClassTiming(toCopy.classTiming);
+ setLocation(toCopy.location);
+ setRate(toCopy.rate);
+ setStudentList(toCopy.studentNameList);
+ }
+
+ public Optional getClassName() {
+ return Optional.ofNullable(className);
+ }
+
+ public void setClassName(ClassName className) {
+ this.className = className;
+ }
+
+ public Optional getClassTiming() {
+ return Optional.ofNullable(classTiming);
+ }
+
+ public void setClassTiming(ClassTiming classTiming) {
+ this.classTiming = classTiming;
+ }
+
+ public Optional getLocation() {
+ return Optional.ofNullable(location);
+ }
+
+ public void setLocation(Location location) {
+ this.location = location;
+ }
+
+ public Optional getRate() {
+ return Optional.ofNullable(rate);
+ }
+
+ public void setRate(Rate rate) {
+ this.rate = rate;
+ }
+
+ public Optional getStudentList() {
+ return Optional.ofNullable(studentNameList);
+ }
+
+ public void setStudentList(StudentNameList studentNameList) {
+ this.studentNameList = studentNameList;
+ }
+
+ public boolean isAnyFieldEdited() {
+ return CollectionUtil.isAnyNonNull(className, classTiming, rate, location, studentNameList);
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (other == this) {
+ return true;
+ }
+
+ if (!(other instanceof EditClassDescriptor)) {
+ return false;
+ }
+
+ EditClassDescriptor e = (EditClassDescriptor) other;
+ return getClassName().equals(e.getClassName())
+ && getClassTiming().equals(e.getClassTiming())
+ && getRate().equals(e.getRate())
+ && getLocation().equals(e.getLocation())
+ && getStudentList().equals(e.getStudentList());
+ }
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ return this == o
+ || ((o instanceof EditClassCommand)
+ && index.equals(((EditClassCommand) o).index)
+ && editClassDescriptor.equals(((EditClassCommand) o).editClassDescriptor));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/FindClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/FindClassCommand.java
new file mode 100644
index 00000000000..73ad4a6e938
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/FindClassCommand.java
@@ -0,0 +1,60 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.ClassTiming;
+import seedu.times.model.tuitionclass.predicates.ClassTimingContainsKeywordsPredicate;
+import seedu.times.ui.TabName;
+
+/**
+ * Finds a tuition class in Timestable by its class timing.
+ */
+public class FindClassCommand extends Command {
+
+ public static final String COMMAND_WORD = "findclass";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all classes whose class timing contains all of "
+ + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+ + "Valid keywords are limited to:\n"
+ + " 1) 3 letter abbreviation for day of the week\n"
+ + " 2) time expressed in HH:MM-HH:MM format.\n"
+ + "(" + ClassTiming.MESSAGE_CONSTRAINTS + ")\n"
+ + "Parameters: CLASS_TIMING\n"
+ + "Example: " + COMMAND_WORD + " Mon 11:30-12:30";
+
+ private final ClassTimingContainsKeywordsPredicate predicate;
+
+ /**
+ * Constructs a new FindClassCommand.
+ *
+ * @param predicate The predicate to filter the classes by.
+ */
+ public FindClassCommand(ClassTimingContainsKeywordsPredicate predicate) {
+ requireNonNull(predicate);
+ this.predicate = predicate;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+ model.updateFilteredClassList(predicate);
+
+ updateView(TabName.CLASSES);
+ hideTuitionClassStudentList();
+
+ return new CommandResult(
+ String.format(Messages.MESSAGE_CLASSES_LISTED_OVERVIEW, model.getFilteredTuitionClassList().size()));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof FindClassCommand // instanceof handles nulls
+ && predicate.equals(((FindClassCommand) other).predicate)); // state check
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/FindClassNameCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/FindClassNameCommand.java
new file mode 100644
index 00000000000..3fa440052bd
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/FindClassNameCommand.java
@@ -0,0 +1,55 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.predicates.ClassNameContainsKeywordsPredicate;
+import seedu.times.ui.TabName;
+
+/**
+ * Finds a tuition class in Timestable by its class name.
+ */
+public class FindClassNameCommand extends Command {
+
+ public static final String COMMAND_WORD = "findclassname";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all classes whose class name contains all of "
+ + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+ + "Parameters: CLASS_NAME [, [CLASS_NAME]...]\n"
+ + "Example: " + COMMAND_WORD + " sec4 physics";
+
+ private final ClassNameContainsKeywordsPredicate predicate;
+
+ public FindClassNameCommand(ClassNameContainsKeywordsPredicate predicate) {
+ this.predicate = predicate;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ requireNonNull(model);
+ model.updateFilteredClassList(predicate);
+
+ updateView(TabName.CLASSES);
+ hideTuitionClassStudentList();
+
+ return new CommandResult(
+ String.format(Messages.MESSAGE_CLASSES_LISTED_OVERVIEW, model.getFilteredTuitionClassList().size()));
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+
+ if (!(o instanceof FindClassNameCommand)) {
+ return false;
+ }
+
+ return ((FindClassNameCommand) o).predicate.equals(predicate);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/ListClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/ListClassCommand.java
new file mode 100644
index 00000000000..b43c1893f58
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/ListClassCommand.java
@@ -0,0 +1,27 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.model.Model.PREDICATE_SHOW_ALL_CLASS;
+
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.model.Model;
+import seedu.times.ui.TabName;
+
+/**
+ * Lists all tuition classes in the Timestable to the user.
+ */
+public class ListClassCommand extends Command {
+
+ public static final String COMMAND_WORD = "listclass";
+
+ public static final String MESSAGE_SUCCESS = "Listed all classes";
+
+ @Override
+ public CommandResult execute(Model model) {
+ requireNonNull(model);
+ updateView(TabName.CLASSES);
+ model.updateFilteredClassList(PREDICATE_SHOW_ALL_CLASS);
+ return new CommandResult(MESSAGE_SUCCESS);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/RemoveFromClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/RemoveFromClassCommand.java
new file mode 100644
index 00000000000..4208ad6341d
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/RemoveFromClassCommand.java
@@ -0,0 +1,141 @@
+package seedu.times.logic.commands.classcommands;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.StudentNameList;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.ui.TabName;
+
+/**
+ * Removes students from a tuition class.
+ */
+public class RemoveFromClassCommand extends Command {
+ public static final String COMMAND_WORD = "removefromclass";
+
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Removes students from a class by the index"
+ + " number used "
+ + "in the displayed class and student list in classes tab.\n"
+ + "Parameters: CLASS_INDEX "
+ + "STUDENT_INDEX... (Indexes must be non-zero positive integers)\n"
+ + "Example: " + COMMAND_WORD + " "
+ + "2 "
+ + "3 4 5 "
+ + "(removes students indexed 3, 4 and 5 from class indexed 2)";
+
+ public static final String NO_STUDENT_INDEX_PROVIDED_MESSAGE = "No student index is provided!";
+ public static final String MESSAGE_REMOVE_SUCCESS = "Successfully removed students from class ";
+
+ private static Logger logger = Logger.getLogger("RemoveFromClassCommand");
+
+ private final Index toEditClassIndex;
+ private final List studentIndicesToRemove;
+
+ /**
+ * Constructs a remove from class command.
+ *
+ * @param indexArray Array with index of class to remove from and index of students.
+ */
+ public RemoveFromClassCommand(List indexArray) {
+ requireNonNull(indexArray);
+
+ //the first index is the index of class in filtered class list that students would be removed from
+ toEditClassIndex = indexArray.get(0);
+ assert toEditClassIndex.getOneBased() > 0;
+
+ //the remaining indices are those of the students in filtered student list
+ studentIndicesToRemove = indexArray.subList(1, indexArray.size());
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+
+ //get class to remove from
+ List lastShownClassList = model.getFilteredTuitionClassList();
+ if (lastShownClassList.size() == 0) {
+ logger.log(Level.INFO, "There are no classes displayed.");
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ } else if (toEditClassIndex.getOneBased() > lastShownClassList.size()) {
+ logger.log(Level.INFO, "There are only " + lastShownClassList.size() + " classes displayed.");
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ }
+ TuitionClass classToRemoveFrom = lastShownClassList.get(toEditClassIndex.getZeroBased());
+
+ //get names to be removed
+ StudentNameList currentStudentNameList = classToRemoveFrom.getStudentList();
+ List filteredStudentList = model.getFilteredStudentList().filtered(student ->
+ classToRemoveFrom.containsStudent(student.getName()));
+ checkIndicesAreValid(studentIndicesToRemove, filteredStudentList);
+ ArrayList namesToRemove = createNewNameList(studentIndicesToRemove, filteredStudentList);
+
+
+ //get updated student list
+ StudentNameList updatedStudentNameList = new StudentNameList();
+ updatedStudentNameList.addAll(currentStudentNameList);
+ updatedStudentNameList.removeAll(namesToRemove);
+
+ //create edit class descriptor
+ EditClassCommand.EditClassDescriptor editClassDescriptor = new EditClassCommand.EditClassDescriptor();
+ editClassDescriptor.setStudentList(updatedStudentNameList);
+
+ //swap out old tuition class with new tuition class
+ TuitionClass editedClass = EditClassCommand.createEditedClass(classToRemoveFrom, editClassDescriptor);
+ model.setClass(classToRemoveFrom, editedClass);
+
+ // Switches the view to the class view and updates the class
+ updateView(TabName.CLASSES);
+ updateClass(toEditClassIndex.getZeroBased());
+
+ logger.log(Level.INFO, "Class name list updated.");
+
+ return new CommandResult(String.format(MESSAGE_REMOVE_SUCCESS, editedClass));
+ }
+
+ private ArrayList createNewNameList(List studentIndices, List studentList) {
+ ArrayList newNameList = new ArrayList<>();
+ studentIndices.stream().forEach(index -> {
+ Name name = studentList.get(index.getZeroBased()).getName();
+ newNameList.add(name);
+ });
+ return newNameList;
+ }
+
+ private void checkIndicesAreValid(List studentIndices, List studentList)
+ throws CommandException {
+ int size = studentList.size();
+ for (Index index : studentIndices) {
+ if (index.getZeroBased() >= size) {
+ logger.log(Level.INFO, "There are only " + size + " students displayed.");
+ throw new CommandException(Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX);
+ }
+ }
+ logger.log(Level.INFO, "All indices are valid.");
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (o == this) {
+ return true;
+ }
+
+ if (!(o instanceof RemoveFromClassCommand)) {
+ return false;
+ }
+
+ RemoveFromClassCommand other = ((RemoveFromClassCommand) o);
+ return other.toEditClassIndex.equals(toEditClassIndex)
+ && other.studentIndicesToRemove.equals(studentIndicesToRemove);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/commands/classcommands/SelectClassCommand.java b/src/main/java/seedu/times/logic/commands/classcommands/SelectClassCommand.java
new file mode 100644
index 00000000000..548e056a7ba
--- /dev/null
+++ b/src/main/java/seedu/times/logic/commands/classcommands/SelectClassCommand.java
@@ -0,0 +1,63 @@
+package seedu.times.logic.commands.classcommands;
+
+import java.util.List;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.CommandResult;
+import seedu.times.logic.commands.exceptions.CommandException;
+import seedu.times.model.Model;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.ui.TabName;
+
+/**
+ * Selects the class to view its students.
+ */
+public class SelectClassCommand extends Command {
+ public static final String COMMAND_WORD = "class";
+ public static final String MESSAGE_USAGE = COMMAND_WORD + ": Selects the appropriate class\n"
+ + "Parameters: CLASS_INDEX\n"
+ + "Example: " + COMMAND_WORD + " 1";
+ public static final String INVALID_TAB = "This class doesn't exists.\n"
+ + "You can only switch to indexes shown in the Classlist.";
+
+ private final Index targetIndex;
+
+
+ public SelectClassCommand(Index targetIndex) {
+ this.targetIndex = targetIndex;
+ }
+
+ @Override
+ public CommandResult execute(Model model) throws CommandException {
+ List lastShownList = model.getFilteredTuitionClassList();
+
+ if (targetIndex.getZeroBased() >= lastShownList.size()) {
+ throw new CommandException(Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX);
+ }
+
+ TuitionClass tuitionClass = lastShownList.get(targetIndex.getZeroBased());
+
+ // Switches the view to the class view and updates the class
+ updateView(TabName.CLASSES);
+ updateClass(targetIndex.getZeroBased());
+
+ return new CommandResult("Viewing class " + tuitionClass.toString(),
+ false, false);
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (o == this) {
+ return true;
+ }
+
+ if (!(o instanceof SelectClassCommand)) {
+ return false;
+ }
+
+ SelectClassCommand other = ((SelectClassCommand) o);
+ return other.targetIndex.equals(targetIndex);
+ }
+}
diff --git a/src/main/java/seedu/address/logic/commands/exceptions/CommandException.java b/src/main/java/seedu/times/logic/commands/exceptions/CommandException.java
similarity index 89%
rename from src/main/java/seedu/address/logic/commands/exceptions/CommandException.java
rename to src/main/java/seedu/times/logic/commands/exceptions/CommandException.java
index a16bd14f2cd..0373bb6041d 100644
--- a/src/main/java/seedu/address/logic/commands/exceptions/CommandException.java
+++ b/src/main/java/seedu/times/logic/commands/exceptions/CommandException.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.commands.exceptions;
+package seedu.times.logic.commands.exceptions;
/**
* Represents an error which occurs during execution of a {@link Command}.
diff --git a/src/main/java/seedu/times/logic/parser/AddCommandParser.java b/src/main/java/seedu/times/logic/parser/AddCommandParser.java
new file mode 100644
index 00000000000..be6b5ccf2ac
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/AddCommandParser.java
@@ -0,0 +1,90 @@
+package seedu.times.logic.parser;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_EMAIL;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_TAG;
+import static seedu.times.logic.parser.ParserUtil.arePrefixesPresent;
+
+import java.util.Set;
+
+import seedu.times.logic.commands.AddCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.person.Address;
+import seedu.times.model.person.Email;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Nok;
+import seedu.times.model.person.Phone;
+import seedu.times.model.person.Student;
+import seedu.times.model.tag.Tag;
+
+/**
+ * Parses input arguments and creates a new AddCommand object
+ */
+public class AddCommandParser implements Parser {
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the AddCommand
+ * and returns an AddCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ public AddCommand parse(String args) throws ParseException {
+ requireNonNull(args);
+
+ String argsBeforeNok = args;
+ String argsAfterNok = "";
+
+ if (args.contains("nok/")) {
+ String[] splitArgs = args.split("nok/");
+ if (splitArgs.length != 2) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
+ }
+ argsBeforeNok = splitArgs[0];
+ argsAfterNok = splitArgs[1];
+ }
+
+ Student student = parseStudent(argsBeforeNok);
+ Nok nok = parseNok(argsAfterNok);
+ student.setNok(nok);
+ return new AddCommand(student);
+ }
+
+ private Student parseStudent(String args) throws ParseException {
+ ArgumentMultimap argMultimap =
+ ArgumentTokenizer
+ .tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS, PREFIX_TAG);
+
+ if (!arePrefixesPresent(argMultimap, PREFIX_NAME, PREFIX_ADDRESS, PREFIX_PHONE, PREFIX_EMAIL)
+ || !argMultimap.getPreamble().isEmpty()) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
+ }
+
+ Name name = ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get());
+ Phone phone = ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get());
+ Email email = ParserUtil.parseEmail(argMultimap.getValue(PREFIX_EMAIL).get());
+ Address address = ParserUtil.parseAddress(argMultimap.getValue(PREFIX_ADDRESS).get());
+ Set tagList = ParserUtil.parseTags(argMultimap.getAllValues(PREFIX_TAG));
+
+ return new Student(name, phone, email, address, null , tagList);
+ }
+
+ private Nok parseNok(String args) throws ParseException {
+ requireNonNull(args);
+ ArgumentMultimap argMultimap =
+ ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS);
+
+ if (!arePrefixesPresent(argMultimap, PREFIX_NAME, PREFIX_ADDRESS, PREFIX_PHONE, PREFIX_EMAIL)) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
+ }
+
+ return new Nok(
+ ParserUtil.parseName(argMultimap.getValue(PREFIX_NAME).get()),
+ ParserUtil.parsePhone(argMultimap.getValue(PREFIX_PHONE).get()),
+ ParserUtil.parseEmail(argMultimap.getValue(PREFIX_EMAIL).get()),
+ ParserUtil.parseAddress(argMultimap.getValue(PREFIX_ADDRESS).get())
+ );
+ }
+}
diff --git a/src/main/java/seedu/address/logic/parser/ArgumentMultimap.java b/src/main/java/seedu/times/logic/parser/ArgumentMultimap.java
similarity index 98%
rename from src/main/java/seedu/address/logic/parser/ArgumentMultimap.java
rename to src/main/java/seedu/times/logic/parser/ArgumentMultimap.java
index 954c8e18f8e..a6e52db3d06 100644
--- a/src/main/java/seedu/address/logic/parser/ArgumentMultimap.java
+++ b/src/main/java/seedu/times/logic/parser/ArgumentMultimap.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
import java.util.ArrayList;
import java.util.HashMap;
diff --git a/src/main/java/seedu/address/logic/parser/ArgumentTokenizer.java b/src/main/java/seedu/times/logic/parser/ArgumentTokenizer.java
similarity index 99%
rename from src/main/java/seedu/address/logic/parser/ArgumentTokenizer.java
rename to src/main/java/seedu/times/logic/parser/ArgumentTokenizer.java
index 5c9aebfa488..f5f37218720 100644
--- a/src/main/java/seedu/address/logic/parser/ArgumentTokenizer.java
+++ b/src/main/java/seedu/times/logic/parser/ArgumentTokenizer.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
import java.util.ArrayList;
import java.util.Arrays;
diff --git a/src/main/java/seedu/address/logic/parser/CliSyntax.java b/src/main/java/seedu/times/logic/parser/CliSyntax.java
similarity index 56%
rename from src/main/java/seedu/address/logic/parser/CliSyntax.java
rename to src/main/java/seedu/times/logic/parser/CliSyntax.java
index 75b1a9bf119..8391d32856b 100644
--- a/src/main/java/seedu/address/logic/parser/CliSyntax.java
+++ b/src/main/java/seedu/times/logic/parser/CliSyntax.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
/**
* Contains Command Line Interface (CLI) syntax definitions common to multiple commands
@@ -7,9 +7,14 @@ public class CliSyntax {
/* Prefix definitions */
public static final Prefix PREFIX_NAME = new Prefix("n/");
+ public static final Prefix PREFIX_CLASS_NAME = new Prefix("cn/");
public static final Prefix PREFIX_PHONE = new Prefix("p/");
public static final Prefix PREFIX_EMAIL = new Prefix("e/");
public static final Prefix PREFIX_ADDRESS = new Prefix("a/");
+ public static final Prefix PREFIX_RATE = new Prefix("r/");
+ public static final Prefix PREFIX_NOK = new Prefix("nok/");
public static final Prefix PREFIX_TAG = new Prefix("t/");
+ public static final Prefix PREFIX_CLASSTIMING = new Prefix("ct/");
+ public static final Prefix PREFIX_LOCATION = new Prefix("l/");
}
diff --git a/src/main/java/seedu/address/logic/parser/DeleteCommandParser.java b/src/main/java/seedu/times/logic/parser/DeleteCommandParser.java
similarity index 73%
rename from src/main/java/seedu/address/logic/parser/DeleteCommandParser.java
rename to src/main/java/seedu/times/logic/parser/DeleteCommandParser.java
index 522b93081cc..9af89a113e9 100644
--- a/src/main/java/seedu/address/logic/parser/DeleteCommandParser.java
+++ b/src/main/java/seedu/times/logic/parser/DeleteCommandParser.java
@@ -1,10 +1,10 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
-import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
-import seedu.address.commons.core.index.Index;
-import seedu.address.logic.commands.DeleteCommand;
-import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.DeleteCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
/**
* Parses input arguments and creates a new DeleteCommand object
diff --git a/src/main/java/seedu/times/logic/parser/EditCommandParser.java b/src/main/java/seedu/times/logic/parser/EditCommandParser.java
new file mode 100644
index 00000000000..58f6dd5f4ff
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/EditCommandParser.java
@@ -0,0 +1,120 @@
+package seedu.times.logic.parser;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_EMAIL;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_TAG;
+import static seedu.times.logic.parser.ParserUtil.checkTagsAreValid;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
+import java.util.Set;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.AddCommand;
+import seedu.times.logic.commands.EditCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.tag.Tag;
+
+/**
+ * Parses input arguments and creates a new EditCommand object
+ */
+public class EditCommandParser implements Parser {
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the EditCommand
+ * and returns an EditCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ public EditCommand parse(String args) throws ParseException {
+ requireNonNull(args);
+
+ // Tokenize twice, once for everything before nok and everything after it
+ String argsBeforeNok = args;
+ String argsAfterNok = "";
+
+ if (args.contains("nok/")) {
+ String[] splitArgs = args.split("nok/");
+ if (splitArgs.length != 2) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddCommand.MESSAGE_USAGE));
+ }
+ argsBeforeNok = splitArgs[0];
+ argsAfterNok = splitArgs[1];
+ }
+
+ ArgumentMultimap argMultimapBeforeNok =
+ ArgumentTokenizer
+ .tokenize(argsBeforeNok, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS, PREFIX_TAG);
+
+ ArgumentMultimap argMultimapAfterNok =
+ ArgumentTokenizer.tokenize(argsAfterNok, PREFIX_NAME, PREFIX_PHONE, PREFIX_EMAIL, PREFIX_ADDRESS);
+
+ Index index;
+
+ try {
+ index = ParserUtil.parseIndex(argMultimapBeforeNok.getPreamble());
+ } catch (ParseException pe) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, EditCommand.MESSAGE_USAGE), pe);
+ }
+ EditCommand.EditStudentDescriptor editStudentDescriptor = new EditCommand.EditStudentDescriptor();
+
+ // For before nok
+ if (argMultimapBeforeNok.getValue(PREFIX_NAME).isPresent()) {
+ editStudentDescriptor.setName(ParserUtil.parseName(argMultimapBeforeNok.getValue(PREFIX_NAME).get()));
+ }
+ if (argMultimapBeforeNok.getValue(PREFIX_PHONE).isPresent()) {
+ editStudentDescriptor.setPhone(ParserUtil.parsePhone(argMultimapBeforeNok.getValue(PREFIX_PHONE).get()));
+ }
+ if (argMultimapBeforeNok.getValue(PREFIX_EMAIL).isPresent()) {
+ editStudentDescriptor.setEmail(ParserUtil.parseEmail(argMultimapBeforeNok.getValue(PREFIX_EMAIL).get()));
+ }
+ if (argMultimapBeforeNok.getValue(PREFIX_ADDRESS).isPresent()) {
+ editStudentDescriptor
+ .setAddress(ParserUtil.parseAddress(argMultimapBeforeNok.getValue(PREFIX_ADDRESS).get()));
+ }
+
+ parseTagsForEdit(argMultimapBeforeNok.getAllValues(PREFIX_TAG)).ifPresent(editStudentDescriptor::setTags);
+
+ // For after nok
+ if (argMultimapAfterNok.getValue(PREFIX_NAME).isPresent()) {
+ editStudentDescriptor.setNokName(ParserUtil.parseName(argMultimapAfterNok.getValue(PREFIX_NAME).get()));
+ }
+ if (argMultimapAfterNok.getValue(PREFIX_PHONE).isPresent()) {
+ editStudentDescriptor.setNokPhone(ParserUtil.parsePhone(argMultimapAfterNok.getValue(PREFIX_PHONE).get()));
+ }
+ if (argMultimapAfterNok.getValue(PREFIX_EMAIL).isPresent()) {
+ editStudentDescriptor.setNokEmail(ParserUtil.parseEmail(argMultimapAfterNok.getValue(PREFIX_EMAIL).get()));
+ }
+ if (argMultimapAfterNok.getValue(PREFIX_ADDRESS).isPresent()) {
+ editStudentDescriptor
+ .setNokAddress(ParserUtil.parseAddress(argMultimapAfterNok.getValue(PREFIX_ADDRESS).get()));
+ }
+
+ if (!editStudentDescriptor.isAnyFieldEdited()) {
+ throw new ParseException(EditCommand.MESSAGE_NOT_EDITED);
+ }
+
+ return new EditCommand(index, editStudentDescriptor);
+ }
+
+ /**
+ * Parses {@code Collection tags} into a {@code Set} if {@code tags} is non-empty.
+ * If {@code tags} contain only one element which is an empty string, it will be parsed into a
+ * {@code Set} containing zero tags.
+ */
+ private Optional> parseTagsForEdit(Collection tags) throws ParseException {
+ assert tags != null;
+
+ checkTagsAreValid(tags);
+ if (tags.isEmpty()) {
+ return Optional.empty();
+ }
+ Collection tagSet = tags.size() == 1 && tags.contains("") ? Collections.emptySet() : tags;
+ return Optional.of(ParserUtil.parseTags(tagSet));
+ }
+
+}
diff --git a/src/main/java/seedu/times/logic/parser/FindNameCommandParser.java b/src/main/java/seedu/times/logic/parser/FindNameCommandParser.java
new file mode 100644
index 00000000000..b9e1962f960
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/FindNameCommandParser.java
@@ -0,0 +1,32 @@
+package seedu.times.logic.parser;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.ParserUtil.FIND_REGEX_WITH_COMMA_DELIMITER;
+import static seedu.times.logic.parser.ParserUtil.getSearchTermList;
+
+import seedu.times.logic.commands.FindNameCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.person.predicates.NameContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new FindNameCommand object
+ */
+public class FindNameCommandParser implements Parser {
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the FindNameCommand
+ * and returns a FindNameCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ @Override
+ public FindNameCommand parse(String args) throws ParseException {
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindNameCommand.MESSAGE_USAGE));
+ }
+
+ return new FindNameCommand(new NameContainsKeywordsPredicate(getSearchTermList(trimmedArgs,
+ FIND_REGEX_WITH_COMMA_DELIMITER)));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/FindTagCommandParser.java b/src/main/java/seedu/times/logic/parser/FindTagCommandParser.java
new file mode 100644
index 00000000000..75ba4915fcb
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/FindTagCommandParser.java
@@ -0,0 +1,32 @@
+package seedu.times.logic.parser;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.ParserUtil.FIND_REGEX_WITH_COMMA_DELIMITER;
+import static seedu.times.logic.parser.ParserUtil.getSearchTermList;
+
+import seedu.times.logic.commands.FindTagCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.person.predicates.TagsContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new {@code FindTagCommand} object
+ */
+public class FindTagCommandParser implements Parser {
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the FindTagCommand
+ * and returns a FindTagCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ @Override
+ public FindTagCommand parse(String args) throws ParseException {
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindTagCommand.MESSAGE_USAGE));
+ }
+
+ return new FindTagCommand(new TagsContainsKeywordsPredicate(getSearchTermList(trimmedArgs,
+ FIND_REGEX_WITH_COMMA_DELIMITER)));
+ }
+}
diff --git a/src/main/java/seedu/address/logic/parser/Parser.java b/src/main/java/seedu/times/logic/parser/Parser.java
similarity index 72%
rename from src/main/java/seedu/address/logic/parser/Parser.java
rename to src/main/java/seedu/times/logic/parser/Parser.java
index d6551ad8e3f..8aa8d5ebf5f 100644
--- a/src/main/java/seedu/address/logic/parser/Parser.java
+++ b/src/main/java/seedu/times/logic/parser/Parser.java
@@ -1,7 +1,7 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
-import seedu.address.logic.commands.Command;
-import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.parser.exceptions.ParseException;
/**
* Represents a Parser that is able to parse user input into a {@code Command} of type {@code T}.
diff --git a/src/main/java/seedu/times/logic/parser/ParserUtil.java b/src/main/java/seedu/times/logic/parser/ParserUtil.java
new file mode 100644
index 00000000000..2703f7ee284
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/ParserUtil.java
@@ -0,0 +1,252 @@
+package seedu.times.logic.parser;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.model.tag.Tag.MAX_TAG_LENGTH;
+import static seedu.times.model.tag.Tag.MAX_TAG_NUMBER;
+import static seedu.times.model.tag.Tag.MESSAGE_CONSTRAINTS_TOO_LONG;
+import static seedu.times.model.tag.Tag.MESSAGE_CONSTRAINTS_TOO_MANY;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Stream;
+
+import seedu.times.commons.core.Messages;
+import seedu.times.commons.core.index.Index;
+import seedu.times.commons.util.StringUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.person.Address;
+import seedu.times.model.person.Email;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Phone;
+import seedu.times.model.tag.Tag;
+import seedu.times.model.tuitionclass.ClassName;
+import seedu.times.model.tuitionclass.ClassTiming;
+import seedu.times.model.tuitionclass.Location;
+import seedu.times.model.tuitionclass.Rate;
+
+/**
+ * Contains utility methods used for parsing strings in the various *Parser classes.
+ */
+public class ParserUtil {
+
+ public static final String MESSAGE_INVALID_INDEX = "Index is not a non-zero unsigned integer.";
+ public static final String FIND_REGEX_WITH_COMMA_DELIMITER = ",\\s*";
+
+ /**
+ * Parses {@code oneBasedIndex} into an {@code Index} and returns it. Leading and trailing whitespaces will be
+ * trimmed.
+ *
+ * @throws ParseException if the specified index is invalid (not non-zero unsigned integer).
+ */
+ public static Index parseIndex(String oneBasedIndex) throws ParseException {
+ String trimmedIndex = oneBasedIndex.trim();
+ if (!StringUtil.isNonZeroUnsignedInteger(trimmedIndex)) {
+ throw new ParseException(MESSAGE_INVALID_INDEX);
+ }
+ return Index.fromOneBased(Integer.parseInt(trimmedIndex));
+ }
+
+ /**
+ * Parses a {@code String name} into a {@code Name}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code name} is invalid.
+ */
+ public static Name parseName(String name) throws ParseException {
+ requireNonNull(name);
+ String trimmedName = name.trim();
+ if (!Name.isValidName(trimmedName)) {
+ throw new ParseException(Name.MESSAGE_CONSTRAINTS);
+ }
+ return new Name(trimmedName);
+ }
+
+ /**
+ * Parses a {@code String phone} into a {@code Phone}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code phone} is invalid.
+ */
+ public static Phone parsePhone(String phone) throws ParseException {
+ requireNonNull(phone);
+ String trimmedPhone = phone.trim();
+ if (!Phone.isValidPhone(trimmedPhone)) {
+ throw new ParseException(Phone.MESSAGE_CONSTRAINTS);
+ }
+ return new Phone(trimmedPhone);
+ }
+
+ /**
+ * Parses a {@code String address} into an {@code Address}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code address} is invalid.
+ */
+ public static Address parseAddress(String address) throws ParseException {
+ requireNonNull(address);
+ String trimmedAddress = address.trim();
+ if (!Address.isValidAddress(trimmedAddress)) {
+ throw new ParseException(Address.MESSAGE_CONSTRAINTS);
+ }
+ return new Address(trimmedAddress);
+ }
+
+ /**
+ * Parses a {@code String classTiming} into an {@code ClassTiming}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code classTiming} is invalid.
+ */
+ public static ClassTiming parseClassTiming(String classTiming) throws ParseException {
+ requireNonNull(classTiming);
+ String trimmedClassTiming = classTiming.trim();
+ if (!ClassTiming.isValidClassTiming(trimmedClassTiming)) {
+ throw new ParseException(ClassTiming.MESSAGE_CONSTRAINTS);
+ }
+ return new ClassTiming(trimmedClassTiming);
+ }
+
+ /**
+ * Parses a {@code String location} into an {@code Location}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code location} is invalid.
+ */
+ public static Location parseLocation(String location) throws ParseException {
+ requireNonNull(location);
+ String trimmedAddress = location.trim();
+ if (!Location.isValidLocation(trimmedAddress)) {
+ throw new ParseException(Location.MESSAGE_CONSTRAINTS);
+ }
+ return new Location(trimmedAddress);
+ }
+
+ /**
+ * Parses a {@code String nok} into an {@code Nok}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code nok} is invalid.
+ */
+ public static Address parseNok(String nok) throws ParseException {
+ requireNonNull(nok);
+ String trimmedAddress = nok.trim();
+ if (!Address.isValidAddress(trimmedAddress)) {
+ throw new ParseException(Address.MESSAGE_CONSTRAINTS);
+ }
+ return new Address(trimmedAddress);
+ }
+
+ /**
+ * Parses a {@code String email} into an {@code Email}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code email} is invalid.
+ */
+ public static Email parseEmail(String email) throws ParseException {
+ requireNonNull(email);
+ String trimmedEmail = email.trim();
+ if (!Email.isValidEmail(trimmedEmail)) {
+ throw new ParseException(Email.MESSAGE_CONSTRAINTS);
+ }
+ return new Email(trimmedEmail);
+ }
+
+ /**
+ * Parses a {@code String tag} into a {@code Tag}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code tag} is invalid.
+ */
+ public static Tag parseTag(String tag) throws ParseException {
+ requireNonNull(tag);
+ String trimmedTag = tag.trim();
+ if (!Tag.isValidTagName(trimmedTag)) {
+ throw new ParseException(Tag.MESSAGE_CONSTRAINTS);
+ }
+ return new Tag(trimmedTag);
+ }
+
+ /**
+ * Parses a {@code String rate} into a {@code Rate}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code rate} is invalid.
+ */
+ public static Rate parseRate(String rate) throws ParseException {
+ requireNonNull(rate);
+ String trimmedRate = rate.trim();
+ if (!Rate.isValidRate(trimmedRate)) {
+ throw new ParseException(Rate.MESSAGE_CONSTRAINTS);
+ }
+ return new Rate(trimmedRate);
+ }
+
+ /**
+ * Parses {@code Collection tags} into a {@code Set}.
+ */
+ public static Set parseTags(Collection tags) throws ParseException {
+ requireNonNull(tags);
+ checkTagsAreValid(tags);
+ final Set tagSet = new HashSet<>();
+ for (String tagName : tags) {
+ tagSet.add(parseTag(tagName));
+ }
+ return tagSet;
+ }
+
+ /**
+ * Checks whether the tags are within the constraints.
+ *
+ * @param tags The tags to check.
+ * @throws ParseException if the given tags are invalid.
+ */
+ public static void checkTagsAreValid(Collection tags) throws ParseException {
+ if (tags.size() > MAX_TAG_NUMBER) {
+ throw new ParseException(MESSAGE_CONSTRAINTS_TOO_MANY);
+ }
+ for (String tagName : tags) {
+ if (tagName.length() > MAX_TAG_LENGTH) {
+ throw new ParseException(MESSAGE_CONSTRAINTS_TOO_LONG);
+ }
+ }
+ }
+
+ /**
+ * Returns true if none of the prefixes contains empty {@code Optional} values in the given
+ * {@code ArgumentMultimap}.
+ */
+ public static boolean arePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
+ return Stream.of(prefixes).allMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
+ }
+
+ /**
+ * Parses a {@code String className} into a {@code ClassName}.
+ * Leading and trailing whitespaces will be trimmed.
+ *
+ * @throws ParseException if the given {@code className} is invalid.
+ */
+ public static ClassName parseClassName(String className) throws ParseException {
+ requireNonNull(className);
+ String trimmedClassName = className.trim();
+ if (!ClassName.isValidClassName(trimmedClassName)) {
+ throw new ParseException(ClassName.MESSAGE_CONSTRAINTS);
+ }
+ return new ClassName(trimmedClassName);
+ }
+
+ /**
+ * Returns a list of search terms to be used for filtering student or class list.
+ *
+ * @throws ParseException if given {@code trimmedArgs} does not have any search term
+ */
+ public static List getSearchTermList(String trimmedArgs, String regex) throws ParseException {
+ String[] searchTerms = trimmedArgs.split(regex);
+ if (searchTerms.length == 0) {
+ throw new ParseException(Messages.MESSAGE_NO_SEARCH_TERMS_ENTERED);
+ }
+ return Arrays.asList(searchTerms);
+ }
+}
diff --git a/src/main/java/seedu/address/logic/parser/Prefix.java b/src/main/java/seedu/times/logic/parser/Prefix.java
similarity index 95%
rename from src/main/java/seedu/address/logic/parser/Prefix.java
rename to src/main/java/seedu/times/logic/parser/Prefix.java
index c859d5fa5db..6277421317f 100644
--- a/src/main/java/seedu/address/logic/parser/Prefix.java
+++ b/src/main/java/seedu/times/logic/parser/Prefix.java
@@ -1,4 +1,4 @@
-package seedu.address.logic.parser;
+package seedu.times.logic.parser;
/**
* A prefix that marks the beginning of an argument in an arguments string.
diff --git a/src/main/java/seedu/times/logic/parser/SortCommandParser.java b/src/main/java/seedu/times/logic/parser/SortCommandParser.java
new file mode 100644
index 00000000000..442d3ea71f7
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/SortCommandParser.java
@@ -0,0 +1,80 @@
+package seedu.times.logic.parser;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import seedu.times.logic.commands.SortCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new SortCommand object
+ */
+public class SortCommandParser implements Parser {
+
+ private final String[] validSortByKeywords = new String[]{"name", "timing"};
+ private final String[] validDirectionOfSortKeywords = new String[]{"asc", "desc"};
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the SortCommand.
+ * and returns an SortCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ @Override
+ public SortCommand parse(String args) throws ParseException {
+
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, SortCommand.MESSAGE_USAGE));
+ }
+
+ String[] splitArgs = trimmedArgs.split(" ");
+ if (splitArgs.length != 2) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, SortCommand.MESSAGE_USAGE));
+ }
+
+ String sortBy = splitArgs[0];
+ checkSortBy(sortBy);
+
+ // sort by asc or desc
+ String directionOfSort = splitArgs[1];
+ checkDirectionOfSort(directionOfSort);
+
+ return new SortCommand(sortBy, directionOfSort);
+ }
+
+ /**
+ * Checks the string to see if it is a valid sortBy keyword.
+ *
+ * @param sortBy String to check.
+ * @throws ParseException If it is not a valid sortBy keyword.
+ */
+ public void checkSortBy(String sortBy) throws ParseException {
+ requireNonNull(sortBy);
+ for (String validSortByKeyword : validSortByKeywords) {
+ if (sortBy.equals(validSortByKeyword)) {
+ return;
+ }
+ }
+
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, SortCommand.INVALID_SORTBY));
+ }
+
+ /**
+ * Checks the string to see if its a valid direction of sort keyword.
+ *
+ * @param directionOfSort String to check.
+ * @throws ParseException If it is not a valid directionOfSort keyword.
+ */
+ public void checkDirectionOfSort(String directionOfSort) throws ParseException {
+ requireNonNull(directionOfSort);
+ for (String validDirectionOfSortKeyword : validDirectionOfSortKeywords) {
+ if (directionOfSort.equals(validDirectionOfSortKeyword)) {
+ return;
+ }
+ }
+
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, SortCommand.INVALID_DIRECTIONOFSORT));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/TimesTableParser.java b/src/main/java/seedu/times/logic/parser/TimesTableParser.java
new file mode 100644
index 00000000000..2bd2264c571
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/TimesTableParser.java
@@ -0,0 +1,137 @@
+package seedu.times.logic.parser;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.commons.core.Messages.MESSAGE_UNKNOWN_COMMAND;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import seedu.times.logic.commands.AddCommand;
+import seedu.times.logic.commands.ClearCommand;
+import seedu.times.logic.commands.Command;
+import seedu.times.logic.commands.DeleteCommand;
+import seedu.times.logic.commands.EditCommand;
+import seedu.times.logic.commands.ExitCommand;
+import seedu.times.logic.commands.FindNameCommand;
+import seedu.times.logic.commands.FindTagCommand;
+import seedu.times.logic.commands.HelpCommand;
+import seedu.times.logic.commands.ListCommand;
+import seedu.times.logic.commands.SortCommand;
+import seedu.times.logic.commands.ViewCommand;
+import seedu.times.logic.commands.classcommands.AddClassCommand;
+import seedu.times.logic.commands.classcommands.AddToClassCommand;
+import seedu.times.logic.commands.classcommands.DeleteClassCommand;
+import seedu.times.logic.commands.classcommands.EditClassCommand;
+import seedu.times.logic.commands.classcommands.FindClassCommand;
+import seedu.times.logic.commands.classcommands.FindClassNameCommand;
+import seedu.times.logic.commands.classcommands.ListClassCommand;
+import seedu.times.logic.commands.classcommands.RemoveFromClassCommand;
+import seedu.times.logic.commands.classcommands.SelectClassCommand;
+import seedu.times.logic.parser.classcommandparsers.AddClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.AddToClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.DeleteClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.EditClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.FindClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.FindClassNameCommandParser;
+import seedu.times.logic.parser.classcommandparsers.RemoveFromClassCommandParser;
+import seedu.times.logic.parser.classcommandparsers.SelectClassCommandParser;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses user input.
+ */
+public class TimesTableParser {
+
+ /**
+ * Used for initial separation of command word and args.
+ */
+ private static final Pattern BASIC_COMMAND_FORMAT = Pattern.compile("(?\\S+)(?.*)");
+
+ /**
+ * Parses user input into command for execution.
+ *
+ * @param userInput full user input string
+ * @return the command based on the user input
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ public Command parseCommand(String userInput) throws ParseException {
+ final Matcher matcher = BASIC_COMMAND_FORMAT.matcher(userInput.trim());
+ if (!matcher.matches()) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, HelpCommand.MESSAGE_USAGE));
+ }
+
+ final String commandWord = matcher.group("commandWord");
+ final String arguments = matcher.group("arguments");
+ switch (commandWord) {
+
+ //// student commands
+
+ case AddCommand.COMMAND_WORD:
+ return new AddCommandParser().parse(arguments);
+
+ case EditCommand.COMMAND_WORD:
+ return new EditCommandParser().parse(arguments);
+
+ case DeleteCommand.COMMAND_WORD:
+ return new DeleteCommandParser().parse(arguments);
+
+ case FindNameCommand.COMMAND_WORD:
+ return new FindNameCommandParser().parse(arguments);
+
+ case FindTagCommand.COMMAND_WORD:
+ return new FindTagCommandParser().parse(arguments);
+
+ case ListCommand.COMMAND_WORD:
+ return new ListCommand();
+
+ //// tuition class commands
+
+ case ListClassCommand.COMMAND_WORD:
+ return new ListClassCommand();
+
+ case AddClassCommand.COMMAND_WORD:
+ return new AddClassCommandParser().parse(arguments);
+
+ case AddToClassCommand.COMMAND_WORD:
+ return new AddToClassCommandParser().parse(arguments);
+
+ case RemoveFromClassCommand.COMMAND_WORD:
+ return new RemoveFromClassCommandParser().parse(arguments);
+
+ case EditClassCommand.COMMAND_WORD:
+ return new EditClassCommandParser().parse(arguments);
+
+ case SelectClassCommand.COMMAND_WORD:
+ return new SelectClassCommandParser().parse(arguments);
+
+ case DeleteClassCommand.COMMAND_WORD:
+ return new DeleteClassCommandParser().parse(arguments);
+
+ case FindClassCommand.COMMAND_WORD:
+ return new FindClassCommandParser().parse(arguments);
+
+ case FindClassNameCommand.COMMAND_WORD:
+ return new FindClassNameCommandParser().parse(arguments);
+
+ //// general application command
+ case ViewCommand.COMMAND_WORD:
+ return new ViewCommandParser().parse(arguments);
+
+ case SortCommand.COMMAND_WORD:
+ return new SortCommandParser().parse(arguments);
+
+ case ExitCommand.COMMAND_WORD:
+ return new ExitCommand();
+
+ case ClearCommand.COMMAND_WORD:
+ return new ClearCommand();
+
+ case HelpCommand.COMMAND_WORD:
+ return new HelpCommand();
+
+ default:
+ throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
+ }
+ }
+
+}
diff --git a/src/main/java/seedu/times/logic/parser/ViewCommandParser.java b/src/main/java/seedu/times/logic/parser/ViewCommandParser.java
new file mode 100644
index 00000000000..2c3a97300d0
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/ViewCommandParser.java
@@ -0,0 +1,54 @@
+package seedu.times.logic.parser;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import seedu.times.logic.commands.ViewCommand;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.ui.TabName;
+
+/**
+ * Parses input command and returns ViewCommand.
+ */
+public class ViewCommandParser implements Parser {
+
+ /**
+ * Parses the given {@code String} of arguments in the context of the ViewCommand
+ * and returns an ViewCommand object for execution.
+ * @throws ParseException if the user input does not conform the expected format
+ */
+ @Override
+ public ViewCommand parse(String args) throws ParseException {
+
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, ViewCommand.MESSAGE_USAGE));
+ }
+
+ String[] splitArgs = trimmedArgs.split(" ");
+ if (splitArgs.length > 1) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, ViewCommand.MESSAGE_USAGE));
+ }
+
+ String tabToView = splitArgs[0];
+ TabName tab;
+
+ switch (tabToView) {
+ case "students":
+ tab = TabName.STUDENTS;
+ break;
+ case "classes":
+ tab = TabName.CLASSES;
+ break;
+ case "timetable":
+ tab = TabName.TIMETABLE;
+ break;
+ default:
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, ViewCommand.INVALID_TAB));
+ }
+
+ return new ViewCommand(tab);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/AddClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/AddClassCommandParser.java
new file mode 100644
index 00000000000..c0748943055
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/AddClassCommandParser.java
@@ -0,0 +1,45 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASSTIMING;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASS_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_LOCATION;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_RATE;
+import static seedu.times.logic.parser.ParserUtil.arePrefixesPresent;
+
+import seedu.times.logic.commands.classcommands.AddClassCommand;
+import seedu.times.logic.parser.ArgumentMultimap;
+import seedu.times.logic.parser.ArgumentTokenizer;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.tuitionclass.ClassName;
+import seedu.times.model.tuitionclass.ClassTiming;
+import seedu.times.model.tuitionclass.Location;
+import seedu.times.model.tuitionclass.Rate;
+import seedu.times.model.tuitionclass.StudentNameList;
+import seedu.times.model.tuitionclass.TuitionClass;
+
+/**
+ * Parses input arguments and creates a new AddClassCommand object
+ */
+public class AddClassCommandParser implements Parser {
+ @Override
+ public AddClassCommand parse(String args) throws ParseException {
+ ArgumentMultimap argMultimap =
+ ArgumentTokenizer
+ .tokenize(args, PREFIX_CLASS_NAME, PREFIX_RATE, PREFIX_CLASSTIMING, PREFIX_LOCATION);
+
+ if (!arePrefixesPresent(argMultimap, PREFIX_CLASS_NAME, PREFIX_RATE, PREFIX_CLASSTIMING, PREFIX_LOCATION)
+ || !argMultimap.getPreamble().isEmpty()) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddClassCommand.MESSAGE_USAGE));
+ }
+
+ ClassName className = ParserUtil.parseClassName(argMultimap.getValue(PREFIX_CLASS_NAME).get());
+ Rate rate = ParserUtil.parseRate(argMultimap.getValue(PREFIX_RATE).get());
+ ClassTiming classTiming = ParserUtil.parseClassTiming(argMultimap.getValue(PREFIX_CLASSTIMING).get());
+ Location location = ParserUtil.parseLocation(argMultimap.getValue(PREFIX_LOCATION).get());
+
+ return new AddClassCommand(new TuitionClass(className, classTiming, location, rate, new StudentNameList()));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/AddToClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/AddToClassCommandParser.java
new file mode 100644
index 00000000000..0c008f4789e
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/AddToClassCommandParser.java
@@ -0,0 +1,69 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.classcommands.AddToClassCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+
+/**
+ * Parses input arguments and creates a new AddToClassCommand object
+ */
+public class AddToClassCommandParser implements Parser {
+
+
+ @Override
+ public AddToClassCommand parse(String args) throws ParseException {
+ requireNonNull(args);
+
+ String[] argsArray = args.trim().split("\\s+");
+ List indexArray = mapToIndexArray(argsArray);
+
+ return new AddToClassCommand(indexArray);
+ }
+
+ private List mapToIndexArray(String[] str) throws ParseException {
+ ArrayList indexArray = new ArrayList<>();
+ for (int i = 0; i < str.length; i++) {
+ try {
+ Index currentIndex = ParserUtil.parseIndex(str[i]);
+ indexArray.add(currentIndex);
+ } catch (ParseException pe) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+ AddToClassCommand.MESSAGE_USAGE), pe);
+ }
+ }
+
+ if (indexArray.size() < 2) {
+ throw new ParseException(AddToClassCommand.NO_STUDENT_INDEX_PROVIDED_MESSAGE);
+ }
+
+ return copyWithoutDuplicateExcludeFirst(indexArray);
+ }
+
+ private List copyWithoutDuplicateExcludeFirst(List indexArray) {
+ int size = indexArray.size();
+ assert size >= 2 : "Should have thrown ParseException.";
+
+ List res = new ArrayList<>();
+
+ for (int i = 1; i < size; i++) {
+ Index currentIndex = indexArray.get(i);
+ if (!res.contains(currentIndex)) {
+ res.add(currentIndex);
+ }
+ }
+
+ res.add(0, indexArray.get(0));
+ return res;
+ }
+
+
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/DeleteClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/DeleteClassCommandParser.java
new file mode 100644
index 00000000000..74403e56d65
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/DeleteClassCommandParser.java
@@ -0,0 +1,27 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.classcommands.DeleteClassCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+
+/**
+ * Parses input arguments and creates a new DeleteClassCommand object
+ */
+public class DeleteClassCommandParser implements Parser {
+
+ @Override
+ public DeleteClassCommand parse(String args) throws ParseException {
+ try {
+ Index index = ParserUtil.parseIndex(args);
+ return new DeleteClassCommand(index);
+ } catch (ParseException pe) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, DeleteClassCommand.MESSAGE_USAGE), pe);
+ }
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/EditClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/EditClassCommandParser.java
new file mode 100644
index 00000000000..00e39ad7d4c
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/EditClassCommandParser.java
@@ -0,0 +1,62 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASSTIMING;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_CLASS_NAME;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_LOCATION;
+import static seedu.times.logic.parser.CliSyntax.PREFIX_RATE;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.classcommands.EditClassCommand;
+import seedu.times.logic.commands.classcommands.EditClassCommand.EditClassDescriptor;
+import seedu.times.logic.parser.ArgumentMultimap;
+import seedu.times.logic.parser.ArgumentTokenizer;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new EditClassCommand object
+ */
+public class EditClassCommandParser implements Parser {
+ @Override
+ public EditClassCommand parse(String args) throws ParseException {
+ requireNonNull(args);
+
+ ArgumentMultimap argMultimap =
+ ArgumentTokenizer
+ .tokenize(args, PREFIX_CLASS_NAME, PREFIX_CLASSTIMING, PREFIX_RATE, PREFIX_LOCATION);
+
+ Index index;
+
+ try {
+ index = ParserUtil.parseIndex(argMultimap.getPreamble());
+ } catch (ParseException pe) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+ EditClassCommand.MESSAGE_USAGE));
+ }
+
+ EditClassDescriptor editClassDescriptor = new EditClassDescriptor();
+
+ if (argMultimap.getValue(PREFIX_CLASS_NAME).isPresent()) {
+ editClassDescriptor.setClassName(ParserUtil.parseClassName(argMultimap.getValue(PREFIX_CLASS_NAME).get()));
+ }
+ if (argMultimap.getValue(PREFIX_CLASSTIMING).isPresent()) {
+ editClassDescriptor.setClassTiming(ParserUtil
+ .parseClassTiming(argMultimap.getValue(PREFIX_CLASSTIMING).get()));
+ }
+ if (argMultimap.getValue(PREFIX_RATE).isPresent()) {
+ editClassDescriptor.setRate(ParserUtil.parseRate(argMultimap.getValue(PREFIX_RATE).get()));
+ }
+ if (argMultimap.getValue(PREFIX_LOCATION).isPresent()) {
+ editClassDescriptor.setLocation(ParserUtil.parseLocation(argMultimap.getValue(PREFIX_LOCATION).get()));
+ }
+
+ if (!editClassDescriptor.isAnyFieldEdited()) {
+ throw new ParseException(EditClassCommand.MESSAGE_NO_FIELD_PROVIDED);
+ }
+
+ return new EditClassCommand(index, editClassDescriptor);
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassCommandParser.java
new file mode 100644
index 00000000000..29ce0a71276
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassCommandParser.java
@@ -0,0 +1,50 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import java.util.Arrays;
+
+import seedu.times.logic.commands.classcommands.FindClassCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.tuitionclass.predicates.ClassTimingContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new FindClassCommand object
+ */
+public class FindClassCommandParser implements Parser {
+
+ private static final String VALIDATION_REGEX_DAY = "(?i)(MON|TUE|WED|THU|FRI|SAT|SUN){1}";
+ private static final String VALIDATION_REGEX_TIME = "([01][0-9]|2[0-3]):[03]0-(([01][0-9]|2[0-3])"
+ + ":[03]0|23:59){1}";
+ private static final String FIND_REGEX = "\\s+";
+
+ /**
+ * Returns true if all keywords contained in {@code classTimingKeywords} is a three-letter abbreviation
+ * for day of the week or in a valid time format, HH:MM-HH:MM.
+ *
+ * @param classTimingKeywords Array of string keywords.
+ */
+ private static boolean isAllValidKeyword(String[] classTimingKeywords) {
+ return Arrays.stream(classTimingKeywords).allMatch(keyword -> {
+ return keyword.matches(VALIDATION_REGEX_TIME) || keyword.matches(VALIDATION_REGEX_DAY);
+ });
+ }
+
+ @Override
+ public FindClassCommand parse(String args) throws ParseException {
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindClassCommand.MESSAGE_USAGE));
+ }
+
+ String[] classTimingKeywords = trimmedArgs.split(FIND_REGEX);
+
+ if (!isAllValidKeyword(classTimingKeywords)) {
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindClassCommand.MESSAGE_USAGE));
+ }
+
+ return new FindClassCommand(new ClassTimingContainsKeywordsPredicate(Arrays.asList(classTimingKeywords)));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassNameCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassNameCommandParser.java
new file mode 100644
index 00000000000..471a1a8c66f
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/FindClassNameCommandParser.java
@@ -0,0 +1,28 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.logic.parser.ParserUtil.FIND_REGEX_WITH_COMMA_DELIMITER;
+import static seedu.times.logic.parser.ParserUtil.getSearchTermList;
+
+import seedu.times.logic.commands.classcommands.FindClassNameCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.exceptions.ParseException;
+import seedu.times.model.tuitionclass.predicates.ClassNameContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new FindClassNameCommand object
+ */
+public class FindClassNameCommandParser implements Parser {
+
+ @Override
+ public FindClassNameCommand parse(String args) throws ParseException {
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindClassNameCommand.MESSAGE_USAGE));
+ }
+
+ return new FindClassNameCommand(new ClassNameContainsKeywordsPredicate(getSearchTermList(trimmedArgs,
+ FIND_REGEX_WITH_COMMA_DELIMITER)));
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/RemoveFromClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/RemoveFromClassCommandParser.java
new file mode 100644
index 00000000000..2c9cc73a432
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/RemoveFromClassCommandParser.java
@@ -0,0 +1,50 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX;
+import static seedu.times.logic.commands.classcommands.AddToClassCommand.CLASS_INDEX_POSITION;
+
+import java.util.ArrayList;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.classcommands.AddToClassCommand;
+import seedu.times.logic.commands.classcommands.RemoveFromClassCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new RemoveFromClassCommand object
+ */
+public class RemoveFromClassCommandParser implements Parser {
+
+ @Override
+ public RemoveFromClassCommand parse(String args) throws ParseException {
+ requireNonNull(args);
+
+ String[] argsArray = args.trim().split("\\s+");
+ ArrayList indexArray = mapToIndex(argsArray);
+
+ return new RemoveFromClassCommand(indexArray);
+ }
+
+ private ArrayList mapToIndex(String[] str) throws ParseException {
+ ArrayList indexArray = new ArrayList<>();
+ for (int i = 0; i < str.length; i++) {
+ try {
+ indexArray.add(ParserUtil.parseIndex(str[i]));
+ } catch (ParseException pe) {
+ String errorMessage = i == CLASS_INDEX_POSITION
+ ? AddToClassCommand.INVALID_OR_MISSING_CLASS_INDEX
+ : MESSAGE_INVALID_STUDENT_DISPLAYED_INDEX;
+ throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT,
+ RemoveFromClassCommand.MESSAGE_USAGE), pe);
+ }
+ }
+ if (indexArray.size() < 2) {
+ throw new ParseException(RemoveFromClassCommand.NO_STUDENT_INDEX_PROVIDED_MESSAGE);
+ }
+ return indexArray;
+ }
+}
diff --git a/src/main/java/seedu/times/logic/parser/classcommandparsers/SelectClassCommandParser.java b/src/main/java/seedu/times/logic/parser/classcommandparsers/SelectClassCommandParser.java
new file mode 100644
index 00000000000..81554316413
--- /dev/null
+++ b/src/main/java/seedu/times/logic/parser/classcommandparsers/SelectClassCommandParser.java
@@ -0,0 +1,43 @@
+package seedu.times.logic.parser.classcommandparsers;
+
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_CLASS_DISPLAYED_INDEX;
+import static seedu.times.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import seedu.times.commons.core.index.Index;
+import seedu.times.logic.commands.classcommands.EditClassCommand;
+import seedu.times.logic.commands.classcommands.SelectClassCommand;
+import seedu.times.logic.parser.Parser;
+import seedu.times.logic.parser.ParserUtil;
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new SelectClassCommand object
+ */
+public class SelectClassCommandParser implements Parser {
+
+ @Override
+ public SelectClassCommand parse(String args) throws ParseException {
+ String trimmedArgs = args.trim();
+ if (trimmedArgs.isEmpty()) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, SelectClassCommand.MESSAGE_USAGE));
+ }
+
+ String[] splitArgs = trimmedArgs.split(" ");
+ if (splitArgs.length > 1) {
+ throw new ParseException(
+ String.format(MESSAGE_INVALID_COMMAND_FORMAT, SelectClassCommand.MESSAGE_USAGE));
+ }
+
+ Index indexOfClassToView;
+
+ try {
+ indexOfClassToView = ParserUtil.parseIndex(splitArgs[0]);
+ } catch (ParseException | ArrayIndexOutOfBoundsException err) {
+ throw new ParseException(String.format(MESSAGE_INVALID_CLASS_DISPLAYED_INDEX,
+ EditClassCommand.MESSAGE_USAGE));
+ }
+
+ return new SelectClassCommand(indexOfClassToView);
+ }
+}
diff --git a/src/main/java/seedu/address/logic/parser/exceptions/ParseException.java b/src/main/java/seedu/times/logic/parser/exceptions/ParseException.java
similarity index 73%
rename from src/main/java/seedu/address/logic/parser/exceptions/ParseException.java
rename to src/main/java/seedu/times/logic/parser/exceptions/ParseException.java
index 158a1a54c1c..e1f38df166e 100644
--- a/src/main/java/seedu/address/logic/parser/exceptions/ParseException.java
+++ b/src/main/java/seedu/times/logic/parser/exceptions/ParseException.java
@@ -1,6 +1,6 @@
-package seedu.address.logic.parser.exceptions;
+package seedu.times.logic.parser.exceptions;
-import seedu.address.commons.exceptions.IllegalValueException;
+import seedu.times.commons.exceptions.IllegalValueException;
/**
* Represents a parse error encountered by a parser.
diff --git a/src/main/java/seedu/times/model/Model.java b/src/main/java/seedu/times/model/Model.java
new file mode 100644
index 00000000000..c1dcde2cf25
--- /dev/null
+++ b/src/main/java/seedu/times/model/Model.java
@@ -0,0 +1,148 @@
+package seedu.times.model;
+
+import java.nio.file.Path;
+import java.util.Comparator;
+import java.util.List;
+import java.util.function.Predicate;
+
+import javafx.collections.ObservableList;
+import seedu.times.commons.core.GuiSettings;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.TuitionClass;
+
+/**
+ * The API of the Model component.
+ */
+public interface Model {
+ /** {@code Predicate} that always evaluate to true */
+ Predicate PREDICATE_SHOW_ALL_PERSONS = unused -> true;
+
+ /** {@code Predicate} that always evaluate to true */
+ Predicate PREDICATE_SHOW_ALL_CLASS = unused -> true;
+
+
+
+ /**
+ * Replaces user prefs data with the data in {@code userPrefs}.
+ */
+ void setUserPrefs(ReadOnlyUserPrefs userPrefs);
+
+ /**
+ * Returns the user prefs.
+ */
+ ReadOnlyUserPrefs getUserPrefs();
+
+ /**
+ * Returns the user prefs' GUI settings.
+ */
+ GuiSettings getGuiSettings();
+
+ /**
+ * Sets the user prefs' GUI settings.
+ */
+ void setGuiSettings(GuiSettings guiSettings);
+
+ /**
+ * Returns the user prefs' address book file path.
+ */
+ Path getTimesTableFilePath();
+
+ /**
+ * Sets the user prefs' address book file path.
+ */
+ void setTimesTableFilePath(Path timesTableFilePath);
+
+ /**
+ * Replaces address book data with the data in {@code timestable}.
+ */
+ void setTimesTable(ReadOnlyTimesTable timesTable);
+
+ /** Returns the TimesTable */
+ ReadOnlyTimesTable getTimesTable();
+
+ /**
+ * Returns true if a student with the same identity as {@code student} exists in the TimesTable.
+ */
+ boolean hasStudent(Student student);
+
+ /**
+ * Deletes the given student.
+ * The person must exist in the TimesTable.
+ */
+ void deleteStudent(Student target);
+
+ /**
+ * Adds the given person.
+ * {@code person} must not already exist in the TimesTable.
+ */
+ void addStudent(Student student);
+
+ /**
+ * Returns true if a class with the same identity as {@code TuitionClass} exists in the TimesTable.
+ */
+ boolean hasTuitionClass(TuitionClass tuitionClass);
+
+ /**
+ * Adds the given tuition class.
+ * {@code TuitionClass} must not already exist in the address book.
+ */
+ void addTuitionClass(TuitionClass tuitionClass);
+
+ /**
+ * Deletes the given tuition class.
+ * The class must exist in the TimesTable.
+ */
+ void deleteTuitionClass(TuitionClass target);
+
+ /**
+ * Replaces the given student {@code target} with {@code editedStudent}.
+ * {@code target} must exist in the TimesTable.
+ * The person identity of {@code editedPerson} must not be the same as another existing person in the TimesTable.
+ */
+ void setStudent(Student target, Student editedStudent);
+
+ /** Returns an unmodifiable view of the filtered student list */
+ ObservableList getFilteredStudentList();
+
+ /**
+ * Updates the filter of the filtered student list to filter by the given {@code predicate}.
+ * @throws NullPointerException if {@code predicate} is null.
+ */
+ void updateFilteredStudentList(Predicate predicate);
+
+ void updateFilteredClassList(Predicate predicate);
+
+ /** Returns an unmodifiable view of the filtered tuition class list */
+ ObservableList getFilteredTuitionClassList();
+
+ /**
+ * Replaces the given class {@code target} with {@code editedPerson}.
+ * {@code target} must exist in the address book.
+ * The Class identity of {@code editedClass} must not be the same as another existing class in the address book.
+ */
+ void setClass(TuitionClass target, TuitionClass editedClass);
+
+ /**
+ * Replaces the filteredTuitionClass with the classes.
+ */
+ void setClasses(List classes);
+
+ /**
+ * Replaces the filtered student list with the classes.
+ */
+ void setStudents(List students);
+
+ /** Executes update cascade after change of student name for {@code StudentNameList}. */
+ void updateClassStudentLists(Name newName, Name oldName);
+
+ /**
+ * Sorts the {@code Student} according to comparator c.
+ */
+ void sortStudents(Comparator c);
+
+ /**
+ * Sorts the {@code TuitionClass} according to comparator c.
+ */
+ void sortClasses(Comparator c);
+}
diff --git a/src/main/java/seedu/times/model/ModelManager.java b/src/main/java/seedu/times/model/ModelManager.java
new file mode 100644
index 00000000000..9f8ad1b6b53
--- /dev/null
+++ b/src/main/java/seedu/times/model/ModelManager.java
@@ -0,0 +1,231 @@
+package seedu.times.model;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
+
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.logging.Logger;
+
+import javafx.collections.ObservableList;
+import javafx.collections.transformation.FilteredList;
+import seedu.times.commons.core.GuiSettings;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.TuitionClass;
+
+/**
+ * Represents the in-memory model of the timestable data.
+ */
+public class ModelManager implements Model {
+ private static final Logger logger = LogsCenter.getLogger(ModelManager.class);
+
+ private final TimesTable timesTable;
+ private final UserPrefs userPrefs;
+ private FilteredList filteredStudents;
+ private FilteredList filteredTuitionClass;
+
+
+ /**
+ * Initializes a ModelManager with the given timestable and userPrefs.
+ */
+ public ModelManager(ReadOnlyTimesTable timestable, ReadOnlyUserPrefs userPrefs) {
+ super();
+ requireAllNonNull(timestable, userPrefs);
+
+ logger.fine("Initializing with timestable: " + timestable + " and user prefs " + userPrefs);
+
+ this.timesTable = new TimesTable(timestable);
+ this.userPrefs = new UserPrefs(userPrefs);
+ filteredStudents = new FilteredList<>(this.timesTable.getStudentList());
+ filteredTuitionClass =
+ new FilteredList<>(this.timesTable.getTuitionClassList());
+ }
+
+ public ModelManager() {
+ this(new TimesTable(), new UserPrefs());
+ }
+
+ //=========== UserPrefs ==================================================================================
+
+ @Override
+ public ReadOnlyUserPrefs getUserPrefs() {
+ return userPrefs;
+ }
+
+ @Override
+ public void setUserPrefs(ReadOnlyUserPrefs userPrefs) {
+ requireNonNull(userPrefs);
+ this.userPrefs.resetData(userPrefs);
+ }
+
+ @Override
+ public GuiSettings getGuiSettings() {
+ return userPrefs.getGuiSettings();
+ }
+
+ @Override
+ public void setGuiSettings(GuiSettings guiSettings) {
+ requireNonNull(guiSettings);
+ userPrefs.setGuiSettings(guiSettings);
+ }
+
+ @Override
+ public Path getTimesTableFilePath() {
+ return userPrefs.getTimesTableFilePath();
+ }
+
+ @Override
+ public void setTimesTableFilePath(Path timesTableFilePath) {
+ requireNonNull(timesTableFilePath);
+ userPrefs.setTimesTableFilePath(timesTableFilePath);
+ }
+
+ //=========== TimesTable ================================================================================
+
+ @Override
+ public ReadOnlyTimesTable getTimesTable() {
+ return timesTable;
+ }
+
+ @Override
+ public void setTimesTable(ReadOnlyTimesTable timestable) {
+ this.timesTable.resetData(timestable);
+ }
+
+ @Override
+ public boolean hasStudent(Student student) {
+ requireNonNull(student);
+ return timesTable.hasPerson(student);
+ }
+
+ @Override
+ public boolean hasTuitionClass(TuitionClass tuitionClass) {
+ requireNonNull(tuitionClass);
+ return timesTable.hasTuitionClass(tuitionClass);
+ }
+
+ @Override
+ public void deleteStudent(Student target) {
+ timesTable.removePerson(target);
+ }
+
+ @Override
+ public void addStudent(Student student) {
+ timesTable.addStudent(student);
+ updateFilteredStudentList(PREDICATE_SHOW_ALL_PERSONS);
+ }
+
+ @Override
+ public void addTuitionClass(TuitionClass tuitionClass) {
+ timesTable.addTuitionClass(tuitionClass);
+ updateFilteredClassList(PREDICATE_SHOW_ALL_CLASS);
+ }
+
+ @Override
+ public void deleteTuitionClass(TuitionClass tuitionClass) {
+ timesTable.deleteTuitionClass(tuitionClass);
+ }
+
+ @Override
+ public void setStudent(Student target, Student editedStudent) {
+ requireAllNonNull(target, editedStudent);
+
+ timesTable.setPerson(target, editedStudent);
+ }
+
+ //=========== Filtered Person List Accessors =============================================================
+
+ /**
+ * Returns an unmodifiable view of the list of {@code Person} backed by the internal list of
+ * {@code versionedTimesTable}
+ */
+ @Override
+ public ObservableList getFilteredStudentList() {
+ return filteredStudents;
+ }
+
+ @Override
+ public void updateFilteredStudentList(Predicate predicate) {
+ requireNonNull(predicate);
+ filteredStudents.setPredicate(predicate);
+ }
+
+ @Override
+ public void updateFilteredClassList(Predicate predicate) {
+ requireNonNull(predicate);
+ filteredTuitionClass.setPredicate(predicate);
+ }
+
+ @Override
+ public void updateClassStudentLists(Name newName, Name oldName) {
+ requireAllNonNull(newName, oldName);
+ if (newName.equals(oldName)) {
+ return;
+ }
+ timesTable.updateClassStudentLists(newName, oldName);
+ }
+
+ @Override
+ public ObservableList getFilteredTuitionClassList() {
+ return filteredTuitionClass;
+ }
+
+ @Override
+ public void setClass(TuitionClass target, TuitionClass editedClass) {
+ requireAllNonNull(target, editedClass);
+ timesTable.setClass(target, editedClass);
+ updateFilteredClassList(PREDICATE_SHOW_ALL_CLASS);
+ }
+
+ @Override
+ public void setClasses(List classes) {
+ timesTable.setClasses(classes);
+ }
+
+ @Override
+ public void setStudents(List studentsList) {
+ timesTable.setStudents(studentsList);
+ }
+
+ @Override
+ public void sortStudents(Comparator c) {
+ updateFilteredStudentList(PREDICATE_SHOW_ALL_PERSONS);
+ ArrayList studentsToSort = new ArrayList<>(getFilteredStudentList());
+ studentsToSort.sort(c);
+ setStudents(studentsToSort);
+ }
+
+ @Override
+ public void sortClasses(Comparator c) {
+ updateFilteredClassList(PREDICATE_SHOW_ALL_CLASS);
+ ArrayList classesToSort = new ArrayList<>(getFilteredTuitionClassList());
+ classesToSort.sort(c);
+ setClasses(classesToSort);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ // short circuit if same object
+ if (obj == this) {
+ return true;
+ }
+
+ // instanceof handles nulls
+ if (!(obj instanceof ModelManager)) {
+ return false;
+ }
+
+ // state check
+ ModelManager other = (ModelManager) obj;
+ return timesTable.equals(other.timesTable)
+ && userPrefs.equals(other.userPrefs)
+ && filteredStudents.equals(other.filteredStudents)
+ && filteredTuitionClass.equals(other.filteredTuitionClass);
+ }
+
+}
diff --git a/src/main/java/seedu/times/model/ReadOnlyTimesTable.java b/src/main/java/seedu/times/model/ReadOnlyTimesTable.java
new file mode 100644
index 00000000000..71929b0cebe
--- /dev/null
+++ b/src/main/java/seedu/times/model/ReadOnlyTimesTable.java
@@ -0,0 +1,25 @@
+package seedu.times.model;
+
+import javafx.collections.ObservableList;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.TuitionClass;
+
+/**
+ * Unmodifiable view of an address book
+ */
+public interface ReadOnlyTimesTable {
+
+ /**
+ * Returns an unmodifiable view of the persons list.
+ * This list will not contain any duplicate persons.
+ */
+ ObservableList getStudentList();
+
+ /**
+ * Returns an unmodifiable view of the class list.
+ * This list will not contain any duplicate classes.
+ * @return
+ */
+ ObservableList getTuitionClassList();
+
+}
diff --git a/src/main/java/seedu/address/model/ReadOnlyUserPrefs.java b/src/main/java/seedu/times/model/ReadOnlyUserPrefs.java
similarity index 57%
rename from src/main/java/seedu/address/model/ReadOnlyUserPrefs.java
rename to src/main/java/seedu/times/model/ReadOnlyUserPrefs.java
index befd58a4c73..67ebef39511 100644
--- a/src/main/java/seedu/address/model/ReadOnlyUserPrefs.java
+++ b/src/main/java/seedu/times/model/ReadOnlyUserPrefs.java
@@ -1,8 +1,8 @@
-package seedu.address.model;
+package seedu.times.model;
import java.nio.file.Path;
-import seedu.address.commons.core.GuiSettings;
+import seedu.times.commons.core.GuiSettings;
/**
* Unmodifiable view of user prefs.
@@ -11,6 +11,6 @@ public interface ReadOnlyUserPrefs {
GuiSettings getGuiSettings();
- Path getAddressBookFilePath();
+ Path getTimesTableFilePath();
}
diff --git a/src/main/java/seedu/times/model/TimesTable.java b/src/main/java/seedu/times/model/TimesTable.java
new file mode 100644
index 00000000000..fcb8fed32f0
--- /dev/null
+++ b/src/main/java/seedu/times/model/TimesTable.java
@@ -0,0 +1,173 @@
+package seedu.times.model;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.List;
+
+import javafx.collections.ObservableList;
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Student;
+import seedu.times.model.person.UniqueStudentList;
+import seedu.times.model.tuitionclass.TuitionClass;
+import seedu.times.model.tuitionclass.UniqueClassList;
+
+/**
+ * Wraps all data at the address-book level
+ * Duplicates are not allowed (by .isSamePerson comparison)
+ */
+public class TimesTable implements ReadOnlyTimesTable {
+
+ private final UniqueStudentList students;
+ private final UniqueClassList classes;
+
+ /*
+ * The 'unusual' code block below is a non-static initialization block, sometimes used to avoid duplication
+ * between constructors. See https://docs.oracle.com/javase/tutorial/java/javaOO/initial.html
+ *
+ * Note that non-static init blocks are not recommended to use. There are other ways to avoid duplication
+ * among constructors.
+ */
+ {
+ students = new UniqueStudentList();
+ classes = new UniqueClassList();
+ }
+
+ public TimesTable() {}
+
+ /**
+ * Creates a TimesTable using the Persons in the {@code toBeCopied}
+ */
+ public TimesTable(ReadOnlyTimesTable toBeCopied) {
+ this();
+ resetData(toBeCopied);
+ }
+
+ //// list overwrite operations
+
+ /**
+ * Replaces the contents of the person list with {@code persons}.
+ * {@code persons} must not contain duplicate persons.
+ */
+ public void setStudents(List students) {
+ this.students.setPersons(students);
+ }
+
+ public void setClasses(List classes) {
+ this.classes.setClasses(classes);
+ }
+
+ /**
+ * Resets the existing data of this {@code TimesTable} with {@code newData}.
+ */
+ public void resetData(ReadOnlyTimesTable newData) {
+ requireNonNull(newData);
+
+ setStudents(newData.getStudentList());
+ setClasses(newData.getTuitionClassList());
+ }
+
+ //// person-level operations
+
+ /**
+ * Returns true if a person with the same identity as {@code person} exists in the address book.
+ */
+ public boolean hasPerson(Student student) {
+ requireNonNull(student);
+ return students.contains(student);
+ }
+
+ /**
+ * Returns true if a tuition class with the same identity as {@code TuitionClass} exists in the address book.
+ */
+ public boolean hasTuitionClass(TuitionClass tuitionClass) {
+ requireNonNull(tuitionClass);
+ return classes.contains(tuitionClass);
+ }
+
+ /**
+ * Adds a person to the address book.
+ * The person must not already exist in the address book.
+ */
+ public void addStudent(Student p) {
+ students.add(p);
+ }
+
+ /**
+ * Adds a tuition class to the address book.
+ * The tuition class must not already exist in the address book.
+ */
+ public void addTuitionClass(TuitionClass t) {
+ classes.add(t);
+ }
+
+ /**
+ * Replaces the given person {@code target} in the list with {@code editedPerson}.
+ * {@code target} must exist in the address book.
+ * The person identity of {@code editedPerson} must not be the same as another existing person in the address book.
+ */
+ public void setPerson(Student target, Student editedStudent) {
+ requireNonNull(editedStudent);
+
+ students.setPerson(target, editedStudent);
+ }
+
+ /**
+ * Removes {@code key} from this {@code TimesTable}.
+ * {@code key} must exist in the address book.
+ */
+ public void removePerson(Student key) {
+ students.remove(key);
+ classes.removeStudent(key.getName());
+ }
+
+ public void deleteTuitionClass(TuitionClass toDelete) {
+ classes.delete(toDelete);
+ }
+
+ //// util methods
+
+ @Override
+ public String toString() {
+ return students.asUnmodifiableObservableList().size() + " persons";
+ // TODO: refine later
+ }
+
+ @Override
+ public ObservableList getStudentList() {
+ return students.asUnmodifiableObservableList();
+ }
+
+ @Override
+ public ObservableList getTuitionClassList() {
+ return classes.asUnmodifiableObservableList();
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof TimesTable // instanceof handles nulls
+ && students.equals(((TimesTable) other).students));
+ }
+
+ @Override
+ public int hashCode() {
+ return students.hashCode();
+ }
+
+ public void setClass(TuitionClass target, TuitionClass editedClass) {
+ requireNonNull(editedClass);
+ classes.setClass(target, editedClass);
+ }
+
+ /**
+ * Replaces the given old name in the list with a new name.
+ *
+ * @param newName New name to replace the given old name.
+ * @param oldName Old name to be replaced by new name.
+ */
+ public void updateClassStudentLists(Name newName, Name oldName) {
+ for (TuitionClass tuitionClass : classes) {
+ tuitionClass.replaceStudentName(newName, oldName);
+ }
+ }
+}
diff --git a/src/main/java/seedu/address/model/UserPrefs.java b/src/main/java/seedu/times/model/UserPrefs.java
similarity index 70%
rename from src/main/java/seedu/address/model/UserPrefs.java
rename to src/main/java/seedu/times/model/UserPrefs.java
index 25a5fd6eab9..b29fa02782f 100644
--- a/src/main/java/seedu/address/model/UserPrefs.java
+++ b/src/main/java/seedu/times/model/UserPrefs.java
@@ -1,4 +1,4 @@
-package seedu.address.model;
+package seedu.times.model;
import static java.util.Objects.requireNonNull;
@@ -6,7 +6,7 @@
import java.nio.file.Paths;
import java.util.Objects;
-import seedu.address.commons.core.GuiSettings;
+import seedu.times.commons.core.GuiSettings;
/**
* Represents User's preferences.
@@ -14,7 +14,7 @@
public class UserPrefs implements ReadOnlyUserPrefs {
private GuiSettings guiSettings = new GuiSettings();
- private Path addressBookFilePath = Paths.get("data" , "addressbook.json");
+ private Path timesTableFilePath = Paths.get("data" , "timestable.json");
/**
* Creates a {@code UserPrefs} with default values.
@@ -35,7 +35,7 @@ public UserPrefs(ReadOnlyUserPrefs userPrefs) {
public void resetData(ReadOnlyUserPrefs newUserPrefs) {
requireNonNull(newUserPrefs);
setGuiSettings(newUserPrefs.getGuiSettings());
- setAddressBookFilePath(newUserPrefs.getAddressBookFilePath());
+ setTimesTableFilePath(newUserPrefs.getTimesTableFilePath());
}
public GuiSettings getGuiSettings() {
@@ -47,13 +47,13 @@ public void setGuiSettings(GuiSettings guiSettings) {
this.guiSettings = guiSettings;
}
- public Path getAddressBookFilePath() {
- return addressBookFilePath;
+ public Path getTimesTableFilePath() {
+ return timesTableFilePath;
}
- public void setAddressBookFilePath(Path addressBookFilePath) {
- requireNonNull(addressBookFilePath);
- this.addressBookFilePath = addressBookFilePath;
+ public void setTimesTableFilePath(Path timesTableFilePath) {
+ requireNonNull(timesTableFilePath);
+ this.timesTableFilePath = timesTableFilePath;
}
@Override
@@ -68,19 +68,19 @@ public boolean equals(Object other) {
UserPrefs o = (UserPrefs) other;
return guiSettings.equals(o.guiSettings)
- && addressBookFilePath.equals(o.addressBookFilePath);
+ && timesTableFilePath.equals(o.timesTableFilePath);
}
@Override
public int hashCode() {
- return Objects.hash(guiSettings, addressBookFilePath);
+ return Objects.hash(guiSettings, timesTableFilePath);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("Gui Settings : " + guiSettings);
- sb.append("\nLocal data file location : " + addressBookFilePath);
+ sb.append("\nLocal data file location : " + timesTableFilePath);
return sb.toString();
}
diff --git a/src/main/java/seedu/address/model/person/Address.java b/src/main/java/seedu/times/model/person/Address.java
similarity index 71%
rename from src/main/java/seedu/address/model/person/Address.java
rename to src/main/java/seedu/times/model/person/Address.java
index 60472ca22a0..ab70cbffdb4 100644
--- a/src/main/java/seedu/address/model/person/Address.java
+++ b/src/main/java/seedu/times/model/person/Address.java
@@ -1,21 +1,23 @@
-package seedu.address.model.person;
+package seedu.times.model.person;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.model.util.Commons.MAX_CHAR_COUNT;
/**
- * Represents a Person's address in the address book.
+ * Represents a Person's address in the Timestable.
* Guarantees: immutable; is valid as declared in {@link #isValidAddress(String)}
*/
public class Address {
- public static final String MESSAGE_CONSTRAINTS = "Addresses can take any values, and it should not be blank";
+ public static final String MESSAGE_CONSTRAINTS = "Address is blank or has exceeded "
+ + MAX_CHAR_COUNT + " characters!";
/*
* The first character of the address must not be a whitespace,
* otherwise " " (a blank string) becomes a valid input.
*/
- public static final String VALIDATION_REGEX = "[^\\s].*";
+ public static final String VALIDATION_REGEX = "[^\\s].{0,84}";
public final String value;
@@ -31,7 +33,7 @@ public Address(String address) {
}
/**
- * Returns true if a given string is a valid email.
+ * Returns true if a given string is a valid address.
*/
public static boolean isValidAddress(String test) {
return test.matches(VALIDATION_REGEX);
diff --git a/src/main/java/seedu/address/model/person/Email.java b/src/main/java/seedu/times/model/person/Email.java
similarity index 82%
rename from src/main/java/seedu/address/model/person/Email.java
rename to src/main/java/seedu/times/model/person/Email.java
index f866e7133de..1765a0c78f3 100644
--- a/src/main/java/seedu/address/model/person/Email.java
+++ b/src/main/java/seedu/times/model/person/Email.java
@@ -1,10 +1,12 @@
-package seedu.address.model.person;
+package seedu.times.model.person;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.isWithinLength;
+import static seedu.times.model.util.Commons.MAX_CHAR_COUNT;
/**
- * Represents a Person's email in the address book.
+ * Represents a Person's email in the Timestable.
* Guarantees: immutable; is valid as declared in {@link #isValidEmail(String)}
*/
public class Email {
@@ -12,10 +14,11 @@ public class Email {
private static final String SPECIAL_CHARACTERS = "+_.-";
public static final String MESSAGE_CONSTRAINTS = "Emails should be of the format local-part@domain "
+ "and adhere to the following constraints:\n"
- + "1. The local-part should only contain alphanumeric characters and these special characters, excluding "
+ + "1. The total length of the email must not exceed 85 characters\n"
+ + "2. The local-part should only contain alphanumeric characters and these special characters, excluding "
+ "the parentheses, (" + SPECIAL_CHARACTERS + "). The local-part may not start or end with any special "
+ "characters.\n"
- + "2. This is followed by a '@' and then a domain name. The domain name is made up of domain labels "
+ + "3. This is followed by a '@' and then a domain name. The domain name is made up of domain labels "
+ "separated by periods.\n"
+ "The domain name must:\n"
+ " - end with a domain label at least 2 characters long\n"
@@ -48,7 +51,7 @@ public Email(String email) {
* Returns if a given string is a valid email.
*/
public static boolean isValidEmail(String test) {
- return test.matches(VALIDATION_REGEX);
+ return test.matches(VALIDATION_REGEX) && isWithinLength(test, MAX_CHAR_COUNT);
}
@Override
diff --git a/src/main/java/seedu/address/model/person/Name.java b/src/main/java/seedu/times/model/person/Name.java
similarity index 55%
rename from src/main/java/seedu/address/model/person/Name.java
rename to src/main/java/seedu/times/model/person/Name.java
index 79244d71cf7..f114dbfcbd2 100644
--- a/src/main/java/seedu/address/model/person/Name.java
+++ b/src/main/java/seedu/times/model/person/Name.java
@@ -1,19 +1,22 @@
-package seedu.address.model.person;
+package seedu.times.model.person;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.isWithinLength;
/**
- * Represents a Person's name in the address book.
+ * Represents a Person's name in the Timestable.
* Guarantees: immutable; is valid as declared in {@link #isValidName(String)}
*/
-public class Name {
+public class Name implements Comparable {
+ public static final int MAX_CHAR_COUNT = 120;
public static final String MESSAGE_CONSTRAINTS =
- "Names should only contain alphanumeric characters and spaces, and it should not be blank";
+ "Names contains characters that is not alphanumeric/space, or the name is not between 1 and 120 "
+ + "characters long.";
/*
- * The first character of the address must not be a whitespace,
+ * The first character of the name must not be a whitespace,
* otherwise " " (a blank string) becomes a valid input.
*/
public static final String VALIDATION_REGEX = "[\\p{Alnum}][\\p{Alnum} ]*";
@@ -31,11 +34,15 @@ public Name(String name) {
fullName = name;
}
+ public String getFullName() {
+ return fullName;
+ }
+
/**
* Returns true if a given string is a valid name.
*/
public static boolean isValidName(String test) {
- return test.matches(VALIDATION_REGEX);
+ return test.matches(VALIDATION_REGEX) && isWithinLength(test, MAX_CHAR_COUNT);
}
@@ -48,7 +55,7 @@ public String toString() {
public boolean equals(Object other) {
return other == this // short circuit if same object
|| (other instanceof Name // instanceof handles nulls
- && fullName.equals(((Name) other).fullName)); // state check
+ && fullName.compareToIgnoreCase(((Name) other).fullName) == 0); // compares names, ignores case
}
@Override
@@ -56,4 +63,9 @@ public int hashCode() {
return fullName.hashCode();
}
+ @Override
+ public int compareTo(Name otherName) {
+ return fullName.compareTo(otherName.fullName);
+ }
+
}
diff --git a/src/main/java/seedu/times/model/person/Nok.java b/src/main/java/seedu/times/model/person/Nok.java
new file mode 100644
index 00000000000..e930489b2bc
--- /dev/null
+++ b/src/main/java/seedu/times/model/person/Nok.java
@@ -0,0 +1,14 @@
+package seedu.times.model.person;
+
+/**
+ * Represents a students Next of Kin (ie parent etc.).
+ */
+public class Nok extends Person {
+
+ /**
+ * Every field must be present and not null.
+ */
+ public Nok(Name name, Phone phone, Email email, Address address) {
+ super(name, phone, email, address);
+ }
+}
diff --git a/src/main/java/seedu/address/model/person/Person.java b/src/main/java/seedu/times/model/person/Person.java
similarity index 70%
rename from src/main/java/seedu/address/model/person/Person.java
rename to src/main/java/seedu/times/model/person/Person.java
index 8ff1d83fe89..ce11a6fb110 100644
--- a/src/main/java/seedu/address/model/person/Person.java
+++ b/src/main/java/seedu/times/model/person/Person.java
@@ -1,39 +1,31 @@
-package seedu.address.model.person;
+package seedu.times.model.person;
-import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
-import java.util.Collections;
-import java.util.HashSet;
import java.util.Objects;
-import java.util.Set;
-
-import seedu.address.model.tag.Tag;
/**
- * Represents a Person in the address book.
+ * Represents a Person in the Timestable.
* Guarantees: details are present and not null, field values are validated, immutable.
*/
public class Person {
- // Identity fields
+ // Identity (mandatory) fields
private final Name name;
private final Phone phone;
private final Email email;
-
// Data fields
private final Address address;
- private final Set tags = new HashSet<>();
/**
* Every field must be present and not null.
*/
- public Person(Name name, Phone phone, Email email, Address address, Set tags) {
- requireAllNonNull(name, phone, email, address, tags);
+ public Person(Name name, Phone phone, Email email, Address address) {
+ requireAllNonNull(name, phone, email, address);
this.name = name;
this.phone = phone;
this.email = email;
this.address = address;
- this.tags.addAll(tags);
}
public Name getName() {
@@ -52,14 +44,6 @@ public Address getAddress() {
return address;
}
- /**
- * Returns an immutable tag set, which throws {@code UnsupportedOperationException}
- * if modification is attempted.
- */
- public Set getTags() {
- return Collections.unmodifiableSet(tags);
- }
-
/**
* Returns true if both persons have the same name.
* This defines a weaker notion of equality between two persons.
@@ -91,14 +75,13 @@ public boolean equals(Object other) {
return otherPerson.getName().equals(getName())
&& otherPerson.getPhone().equals(getPhone())
&& otherPerson.getEmail().equals(getEmail())
- && otherPerson.getAddress().equals(getAddress())
- && otherPerson.getTags().equals(getTags());
+ && otherPerson.getAddress().equals(getAddress());
}
@Override
public int hashCode() {
// use this method for custom fields hashing instead of implementing your own
- return Objects.hash(name, phone, email, address, tags);
+ return Objects.hash(name, phone, email, address);
}
@Override
@@ -112,11 +95,6 @@ public String toString() {
.append("; Address: ")
.append(getAddress());
- Set tags = getTags();
- if (!tags.isEmpty()) {
- builder.append("; Tags: ");
- tags.forEach(builder::append);
- }
return builder.toString();
}
diff --git a/src/main/java/seedu/address/model/person/Phone.java b/src/main/java/seedu/times/model/person/Phone.java
similarity index 68%
rename from src/main/java/seedu/address/model/person/Phone.java
rename to src/main/java/seedu/times/model/person/Phone.java
index 872c76b382f..2e30ddd1d02 100644
--- a/src/main/java/seedu/address/model/person/Phone.java
+++ b/src/main/java/seedu/times/model/person/Phone.java
@@ -1,18 +1,22 @@
-package seedu.address.model.person;
+package seedu.times.model.person;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
/**
- * Represents a Person's phone number in the address book.
+ * Represents a Person's phone number in the Timestable.
* Guarantees: immutable; is valid as declared in {@link #isValidPhone(String)}
*/
public class Phone {
+ public static final int MAX_DIGIT_COUNT = 25;
+ public static final int MIN_DIGIT_COUNT = 3;
public static final String MESSAGE_CONSTRAINTS =
- "Phone numbers should only contain numbers, and it should be at least 3 digits long";
- public static final String VALIDATION_REGEX = "\\d{3,}";
+ "Phone number contains non-number characters or its length is not between "
+ + MIN_DIGIT_COUNT + " and "
+ + MAX_DIGIT_COUNT + " digits!";
+ public static final String VALIDATION_REGEX = "\\d{3,25}";
public final String value;
/**
diff --git a/src/main/java/seedu/times/model/person/Student.java b/src/main/java/seedu/times/model/person/Student.java
new file mode 100644
index 00000000000..1afd9e8c264
--- /dev/null
+++ b/src/main/java/seedu/times/model/person/Student.java
@@ -0,0 +1,123 @@
+package seedu.times.model.person;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+import seedu.times.model.tag.Tag;
+import seedu.times.model.tuitionclass.ClassTiming;
+import seedu.times.model.tuitionclass.Location;
+import seedu.times.model.tuitionclass.Rate;
+
+/**
+ * Represents a Student in the Timestable.
+ * Guarantees: details are present and not null, field values are validated, immutable.
+ */
+public class Student extends Person {
+
+ /* Each Student has 0..1 Nok */
+ private Nok nok;
+
+ private final Set tags = new HashSet<>();
+
+ /**
+ * Student constructor
+ */
+ public Student(
+ Name name, Phone phone, Email email, Address address, Nok nok, Set tags) {
+ super(name, phone, email, address);
+
+ this.nok = nok;
+ this.tags.addAll(tags);
+ }
+
+ public void setNok(Nok nok) {
+ this.nok = nok;
+ }
+
+ public Nok getNok() {
+ return nok;
+ }
+
+ public ClassTiming getClassTiming() {
+ // TODO: Placeholder
+ return null;
+ }
+
+ public Location getLocation() {
+ // TODO: Placeholder
+ return null;
+ }
+
+ /**
+ * Returns tuition {@code Rate} of this student
+ */
+ public Rate getRate() {
+ // Placeholder
+ return null;
+ }
+
+ /**
+ * Returns an immutable tag set, which throws {@code UnsupportedOperationException}
+ * if modification is attempted.
+ */
+ public Set getTags() {
+ return Collections.unmodifiableSet(tags);
+ }
+
+ /**
+ * Returns true if any {@code Tag} belonging to this student matches {@code keyword} in name ignoring case.
+ */
+ public boolean isAnyTagsMatching(String keyword) {
+ requireNonNull(keyword);
+ return tags.stream()
+ .anyMatch(tag -> tag.isNameMatchingIgnoreCase(keyword));
+ }
+
+ /**
+ * Returns true if both persons have the same identity and data fields.
+ * This defines a stronger notion of equality between two persons.
+ * We check if their tags are equal as well.
+ */
+ @Override
+ public boolean equals(Object other) {
+ if (other == this) {
+ return true;
+ }
+
+ if (!(other instanceof Student)) {
+ return false;
+ }
+
+ Student o = (Student) other;
+ return super.equals(other)
+ && o.getTags().equals(getTags());
+ }
+
+ @Override
+ public int hashCode() {
+ // Hashes the hashcode to produce a new hash
+ return Objects.hash(super.hashCode(), tags);
+ }
+
+ @Override
+ public String toString() {
+ final StringBuilder builder = new StringBuilder(super.toString());
+
+ Set tags = getTags();
+ if (!tags.isEmpty()) {
+ builder.append("; Tags: ");
+ tags.forEach(builder::append);
+ }
+
+ builder.append("\nNext-of-Kin: ");
+ builder.append(nok.toString());
+
+
+ return builder.toString();
+ }
+
+}
diff --git a/src/main/java/seedu/times/model/person/UniqueStudentList.java b/src/main/java/seedu/times/model/person/UniqueStudentList.java
new file mode 100644
index 00000000000..44e80f97f23
--- /dev/null
+++ b/src/main/java/seedu/times/model/person/UniqueStudentList.java
@@ -0,0 +1,173 @@
+package seedu.times.model.person;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
+
+import java.util.Iterator;
+import java.util.List;
+import java.util.logging.Logger;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+import seedu.times.commons.core.LogsCenter;
+import seedu.times.model.person.exceptions.DuplicatePersonException;
+import seedu.times.model.person.exceptions.PersonNotFoundException;
+
+/**
+ * A list of persons that enforces uniqueness between its elements and does not allow nulls.
+ * A person is considered unique by comparing using {@code Person#isSamePerson(Person)}. As such, adding and
+ * updating of
+ * persons uses Person#isSamePerson(Person) for equality so as to ensure that the person being added or updated is
+ * unique in terms of identity in the UniquePersonList. However, the removal of a person uses Person#equals(Object) so
+ * as to ensure that the person with exactly the same fields will be removed.
+ *
+ * Supports a minimal set of list operations.
+ *
+ * @see Person#isSamePerson(Person)
+ */
+public class UniqueStudentList implements Iterable {
+
+ private final ObservableList internalList = FXCollections.observableArrayList();
+ private final ObservableList internalUnmodifiableList =
+ FXCollections.unmodifiableObservableList(internalList);
+ private final Logger logger = LogsCenter.getLogger(UniqueStudentList.class);
+
+ /**
+ * Returns true if the list contains an equivalent person as the given argument.
+ */
+ public boolean contains(Student toCheck) {
+ requireNonNull(toCheck);
+ return internalList.stream().anyMatch(toCheck::isSamePerson);
+ }
+
+ /**
+ * Adds a person to the list.
+ * The person must not already exist in the list.
+ */
+ public void add(Student toAdd) {
+ requireNonNull(toAdd);
+ if (contains(toAdd)) {
+ throw new DuplicatePersonException();
+ }
+ int listSize = internalList.size();
+
+ /*
+ * TODO:
+ * As of the new implementation there is a possibility a Student has multiple classes, so this is commented out
+ * for now
+ * for (int i = 0; i < listSize; i++) {
+ *
+ * if (internalList.get(i).getClassTiming().isEarlier(toAdd.getClassTiming())) {
+ * continue;
+ * } else {
+ * internalList.add(i, toAdd);
+ * break;
+ * }
+ * }
+ */
+
+ if (listSize == 0 || internalList.size() == listSize) {
+ internalList.add(toAdd);
+ }
+
+ }
+
+ public Student getStudent(Name name) {
+ requireAllNonNull(name);
+ for (Student student : internalList) {
+ if (student.getName() == name) {
+ return student;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Replaces the person {@code target} in the list with {@code editedPerson}.
+ * {@code target} must exist in the list.
+ * The person identity of {@code editedPerson} must not be the same as another existing person in the list.
+ */
+ public void setPerson(Student target, Student editedStudent) {
+ requireAllNonNull(target, editedStudent);
+
+ int index = internalList.indexOf(target);
+ if (index == -1) {
+ throw new PersonNotFoundException();
+ }
+
+ if (!target.isSamePerson(editedStudent) && contains(editedStudent)) {
+ throw new DuplicatePersonException();
+ }
+
+ internalList.set(index, editedStudent);
+ }
+
+ /**
+ * Removes the equivalent person from the list.
+ * The person must exist in the list.
+ */
+ public void remove(Student toRemove) {
+ requireNonNull(toRemove);
+ if (!internalList.remove(toRemove)) {
+ throw new PersonNotFoundException();
+ }
+ }
+
+ public void setPersons(UniqueStudentList replacement) {
+ requireNonNull(replacement);
+ internalList.setAll(replacement.internalList);
+ logger.info("List of Students set from replace UniquePersonList.");
+ }
+
+ /**
+ * Replaces the contents of this list with {@code persons}.
+ * {@code persons} must not contain duplicate persons.
+ */
+ public void setPersons(List students) {
+ requireAllNonNull(students);
+ if (!personsAreUnique(students)) {
+ throw new DuplicatePersonException();
+ }
+
+ internalList.setAll(students);
+ logger.info("List of Students set from List.");
+ }
+
+ /**
+ * Returns the backing list as an unmodifiable {@code ObservableList}.
+ */
+ public ObservableList asUnmodifiableObservableList() {
+ return internalUnmodifiableList;
+ }
+
+ @Override
+ public Iterator iterator() {
+ return internalList.iterator();
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof UniqueStudentList // instanceof handles nulls
+ && internalList.equals(((UniqueStudentList) other).internalList));
+ }
+
+ @Override
+ public int hashCode() {
+ return internalList.hashCode();
+ }
+
+ /**
+ * Returns true if {@code persons} contains only unique persons.
+ */
+ private boolean personsAreUnique(List students) {
+ for (int i = 0; i < students.size() - 1; i++) {
+ for (int j = i + 1; j < students.size(); j++) {
+ if (students.get(i).isSamePerson(students.get(j))) {
+ return false;
+ }
+ }
+ }
+ return true;
+ }
+}
diff --git a/src/main/java/seedu/address/model/person/exceptions/DuplicatePersonException.java b/src/main/java/seedu/times/model/person/exceptions/DuplicatePersonException.java
similarity index 87%
rename from src/main/java/seedu/address/model/person/exceptions/DuplicatePersonException.java
rename to src/main/java/seedu/times/model/person/exceptions/DuplicatePersonException.java
index d7290f59442..04205a7a01e 100644
--- a/src/main/java/seedu/address/model/person/exceptions/DuplicatePersonException.java
+++ b/src/main/java/seedu/times/model/person/exceptions/DuplicatePersonException.java
@@ -1,4 +1,4 @@
-package seedu.address.model.person.exceptions;
+package seedu.times.model.person.exceptions;
/**
* Signals that the operation will result in duplicate Persons (Persons are considered duplicates if they have the same
diff --git a/src/main/java/seedu/address/model/person/exceptions/PersonNotFoundException.java b/src/main/java/seedu/times/model/person/exceptions/PersonNotFoundException.java
similarity index 75%
rename from src/main/java/seedu/address/model/person/exceptions/PersonNotFoundException.java
rename to src/main/java/seedu/times/model/person/exceptions/PersonNotFoundException.java
index fa764426ca7..fc32e5502f9 100644
--- a/src/main/java/seedu/address/model/person/exceptions/PersonNotFoundException.java
+++ b/src/main/java/seedu/times/model/person/exceptions/PersonNotFoundException.java
@@ -1,4 +1,4 @@
-package seedu.address.model.person.exceptions;
+package seedu.times.model.person.exceptions;
/**
* Signals that the operation is unable to find the specified person.
diff --git a/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java b/src/main/java/seedu/times/model/person/predicates/NameContainsKeywordsPredicate.java
similarity index 71%
rename from src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java
rename to src/main/java/seedu/times/model/person/predicates/NameContainsKeywordsPredicate.java
index c9b5868427c..2fe5a224fca 100644
--- a/src/main/java/seedu/address/model/person/NameContainsKeywordsPredicate.java
+++ b/src/main/java/seedu/times/model/person/predicates/NameContainsKeywordsPredicate.java
@@ -1,14 +1,14 @@
-package seedu.address.model.person;
+package seedu.times.model.person.predicates;
import java.util.List;
import java.util.function.Predicate;
-import seedu.address.commons.util.StringUtil;
+import seedu.times.model.person.Student;
/**
* Tests that a {@code Person}'s {@code Name} matches any of the keywords given.
*/
-public class NameContainsKeywordsPredicate implements Predicate {
+public class NameContainsKeywordsPredicate implements Predicate {
private final List keywords;
public NameContainsKeywordsPredicate(List keywords) {
@@ -16,9 +16,10 @@ public NameContainsKeywordsPredicate(List keywords) {
}
@Override
- public boolean test(Person person) {
+ public boolean test(Student student) {
+ String nameLowerCase = student.getName().fullName.toLowerCase();
return keywords.stream()
- .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(person.getName().fullName, keyword));
+ .anyMatch(keyword -> nameLowerCase.contains(keyword.toLowerCase()));
}
@Override
diff --git a/src/main/java/seedu/times/model/person/predicates/TagsContainsKeywordsPredicate.java b/src/main/java/seedu/times/model/person/predicates/TagsContainsKeywordsPredicate.java
new file mode 100644
index 00000000000..49b8acd47d2
--- /dev/null
+++ b/src/main/java/seedu/times/model/person/predicates/TagsContainsKeywordsPredicate.java
@@ -0,0 +1,30 @@
+package seedu.times.model.person.predicates;
+
+import java.util.List;
+import java.util.function.Predicate;
+
+import seedu.times.model.person.Student;
+
+/**
+ * Tests if a {@code Person}'s list of {@code Tag} matches any of the keywords given.
+ */
+public class TagsContainsKeywordsPredicate implements Predicate {
+ private final List keywords;
+
+ public TagsContainsKeywordsPredicate(List keywords) {
+ this.keywords = keywords;
+ }
+
+ @Override
+ public boolean test(Student student) {
+ return keywords.stream()
+ .anyMatch(keyword -> student.isAnyTagsMatching(keyword));
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this
+ || (other instanceof TagsContainsKeywordsPredicate
+ && keywords.equals(((TagsContainsKeywordsPredicate) other).keywords));
+ }
+}
diff --git a/src/main/java/seedu/address/model/tag/Tag.java b/src/main/java/seedu/times/model/tag/Tag.java
similarity index 61%
rename from src/main/java/seedu/address/model/tag/Tag.java
rename to src/main/java/seedu/times/model/tag/Tag.java
index b0ea7e7dad7..5118e643982 100644
--- a/src/main/java/seedu/address/model/tag/Tag.java
+++ b/src/main/java/seedu/times/model/tag/Tag.java
@@ -1,7 +1,7 @@
-package seedu.address.model.tag;
+package seedu.times.model.tag;
import static java.util.Objects.requireNonNull;
-import static seedu.address.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.checkArgument;
/**
* Represents a Tag in the address book.
@@ -10,7 +10,13 @@
public class Tag {
public static final String MESSAGE_CONSTRAINTS = "Tags names should be alphanumeric";
- public static final String VALIDATION_REGEX = "\\p{Alnum}+";
+ public static final String VALIDATION_REGEX = "[^\\s].*";
+ public static final int MAX_TAG_LENGTH = 15;
+ public static final int MAX_TAG_NUMBER = 5;
+ public static final String MESSAGE_CONSTRAINTS_TOO_LONG =
+ "Tags names should be at most " + MAX_TAG_LENGTH + " characters";
+ public static final String MESSAGE_CONSTRAINTS_TOO_MANY =
+ "A student should have at most " + MAX_TAG_NUMBER + " tags";
public final String tagName;
@@ -32,6 +38,13 @@ public static boolean isValidTagName(String test) {
return test.matches(VALIDATION_REGEX);
}
+ /**
+ * Returns true if {@code tagName} of this {@code Tag} matches exactly with {@code keyword} ignoring case.
+ */
+ public boolean isNameMatchingIgnoreCase(String keyword) {
+ return tagName.toLowerCase().contains(keyword.toLowerCase());
+ }
+
@Override
public boolean equals(Object other) {
return other == this // short circuit if same object
diff --git a/src/main/java/seedu/times/model/tuitionclass/ClassName.java b/src/main/java/seedu/times/model/tuitionclass/ClassName.java
new file mode 100644
index 00000000000..6bf32170877
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/ClassName.java
@@ -0,0 +1,54 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.commons.util.AppUtil.isWithinLength;
+import static seedu.times.model.util.Commons.MAX_CHAR_COUNT;
+
+/**
+ * Represents the name given to a {@code TuitionClass} by a user
+ * Guarantees: immutable; is valid as declared in {@link #isValidClassName(String)}
+ */
+public class ClassName {
+ public static final String MESSAGE_CONSTRAINTS =
+ "Class name contains characters that is not alphanumeric/space, or the name is not between 1 and "
+ + MAX_CHAR_COUNT + " characters long!";
+
+ /*
+ * The first character of the name must not be a whitespace,
+ * otherwise " " (a blank string) becomes a valid input.
+ */
+ public static final String VALIDATION_REGEX = "[\\p{Alnum}][\\p{Alnum} ]*";
+
+ public final String className;
+
+ /**
+ * Constructs a {@code ClassName}.
+ *
+ * @param className A valid class name.
+ */
+ public ClassName(String className) {
+ requireNonNull(className);
+ checkArgument(isValidClassName(className), MESSAGE_CONSTRAINTS);
+ this.className = className;
+ }
+
+ /**
+ * Returns true if a given string is a valid class name.
+ */
+ public static boolean isValidClassName(String test) {
+ return test.matches(VALIDATION_REGEX) && isWithinLength(test, MAX_CHAR_COUNT);
+ }
+
+ @Override
+ public String toString() {
+ return className;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof ClassName // instanceof handles nulls
+ && className.equals(((ClassName) other).className)); // state check
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/ClassTiming.java b/src/main/java/seedu/times/model/tuitionclass/ClassTiming.java
new file mode 100644
index 00000000000..431ac4be7cb
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/ClassTiming.java
@@ -0,0 +1,294 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+
+import java.time.LocalTime;
+import java.time.format.DateTimeFormatter;
+
+import seedu.times.logic.parser.exceptions.ParseException;
+
+/**
+ * Represents a {@code TuitionClass}'s class timing in the Timestable.
+ * Guarantees: immutable; is valid as declared in {@link #isValidClassTiming(String)}
+ */
+public class ClassTiming implements Comparable {
+
+ public static final String MESSAGE_CONSTRAINTS =
+ "Class Timing must be in the form DAY HH:MM-HH:MM"
+ + "\nStart time must be earlier than end time, and "
+ + "start and end time has to start at the hour or half hour mark, but it can end at 23:59";
+
+ /*
+ * The string has to be in the form DAY HH:MM-HH:MM eg MON 23:59-01:00
+ */
+ public static final String VALIDATION_REGEX =
+ "^(?i)(MON |TUE |WED |THU |FRI |SAT |SUN )([01][0-9]|2[0-3]):[0-5][0-9]-([01][0-9]|2[0-3]):[0-5][0-9]";
+
+ public final String value;
+
+ private final LocalTime startTime;
+
+ private final LocalTime endTime;
+
+ private final String day;
+
+ /**
+ * Constructs a {@code ClassTiming}.
+ *
+ * @param classTiming A valid class timing.
+ */
+ public ClassTiming(String classTiming) {
+ requireNonNull(classTiming);
+ checkArgument(isValidClassTiming(classTiming), MESSAGE_CONSTRAINTS);
+ value = formatClassTiming(classTiming);
+ startTime = getStartTimeFromValue();
+ endTime = getEndTimeFromValue();
+ day = parseDay();
+ }
+
+ /**
+ * Gets the endTime from value.
+ *
+ * @return The end time.
+ */
+ private LocalTime getStartTimeFromValue() {
+ String[] timePart = splitTiming(this.value);
+ String startTime = timePart[0];
+ return LocalTime.parse(startTime, DateTimeFormatter.ofPattern("HH:mm"));
+ }
+
+ /**
+ * Gets the startTime from value.
+ *
+ * @return The start time.
+ */
+ private LocalTime getEndTimeFromValue() {
+ String[] timePart = splitTiming(this.value);
+ String endTime = timePart[1];
+ return LocalTime.parse(endTime, DateTimeFormatter.ofPattern("HH:mm"));
+ }
+
+ /**
+ * Formats the classTiming day into caps.
+ *
+ * @param classTiming classTiming where day is going to be changed to caps.
+ * @return classTiming with the day in caps.
+ */
+ private String formatClassTiming(String classTiming) {
+ String day = classTiming.split(" ")[0].toUpperCase();
+ String timing = classTiming.split(" ")[1];
+ return day + " " + timing;
+ }
+
+ /**
+ * Converts Day from the ClassTiming object into the int representation of the day.
+ *
+ * @return int representation of the Day of the ClassTiming object
+ */
+ public int getDayToInt() {
+ // TODO: change day to enum
+ switch (day.toUpperCase()) {
+ case "MON":
+ return 1;
+ case "TUE":
+ return 2;
+ case "WED":
+ return 3;
+ case "THU":
+ return 4;
+ case "FRI":
+ return 5;
+ case "SAT":
+ return 6;
+ case "SUN":
+ return 7;
+ default:
+ return 0;
+ }
+ }
+
+ /**
+ * Compares two ClassTiming objects.
+ *
+ * @param time ClassTiming being compared to.
+ * @return true if this ClassTiming is on an earlier day or has end time earlier than time's
+ * start time, otherwise false.
+ */
+ public boolean isEarlier(ClassTiming time) {
+ return this.compareTo(time) < 0;
+ }
+
+ /**
+ * Sees if the ClassTiming's start time is after the LocalTime given.
+ *
+ * @param time LocalTime being compared to.
+ * @return true if ClassTiming has a start time later than given time otherwise false.
+ */
+ public boolean isAfter(LocalTime time) {
+ return this.getStartTime().isAfter(time);
+ }
+
+ /**
+ * Parses the class timing string to retrieve the day from the value.
+ *
+ * @return The Day of the ClassTiming value.
+ */
+ private String parseDay() {
+ String[] classTimingPart = this.value.split(" ");
+ return classTimingPart[0];
+ }
+
+ /**
+ * Splits the class timing string to retrieve the start and end time in String form.
+ *
+ * @param ct ClassTiming string to be split.
+ * @return A String array consisting of the start time at index 0 and end time at index 1.
+ */
+ private static String[] splitTiming(String ct) {
+ String[] ctSplit = ct.split(" ");
+ String startEndTime = ctSplit[1];
+ return startEndTime.split("-");
+ }
+
+ /**
+ * Parses the input class timing string to retrieve the Start Time.
+ *
+ * @param ct ClassTiming string to be parsed.
+ * @return The start time of the input string.
+ * @throws ParseException if ct does not start at the hour or half hour mark.
+ */
+ private static LocalTime parseStartTime(String ct) throws ParseException {
+ String[] timePart = splitTiming(ct);
+ String startTime = timePart[0];
+ String startTimeMinutes = startTime.split(":")[1];
+
+ if (!startTimeMinutes.equals("00") && !startTimeMinutes.equals("30")) {
+ throw new ParseException("Invalid start time");
+ }
+
+ return LocalTime.parse(startTime, DateTimeFormatter.ofPattern("HH:mm"));
+ }
+
+ /**
+ * Parses the input class timing string to retrieve the End Time.
+ *
+ * @param ct ClassTiming string to be parsed.
+ * @return The end time of the input string.
+ * @throws ParseException if ct does not start at the hour or half hour mark.
+ */
+ private static LocalTime parseEndTime(String ct) throws ParseException {
+ String[] timePart = splitTiming(ct);
+ String endTime = timePart[1];
+ String endTimeMinutes = endTime.split(":")[1];
+
+ if (!endTimeMinutes.equals("00") && !endTimeMinutes.equals("30") && !endTime.equals("23:59")) {
+ throw new ParseException("Invalid end time");
+ }
+
+ return LocalTime.parse(endTime, DateTimeFormatter.ofPattern("HH:mm"));
+ }
+
+ /**
+ * Gets the start time of the class timing.
+ *
+ * @return Start Time of ClassTiming.
+ */
+ public LocalTime getStartTime() {
+ return this.startTime;
+ }
+
+ /**
+ * Gets the end time of the class timing.
+ *
+ * @return End Time of ClassTiming.
+ */
+ public LocalTime getEndTime() {
+ return this.endTime;
+ }
+
+ /**
+ * Gets the day of the class timing.
+ *
+ * @return Day of ClassTiming.
+ */
+ private String getDay() {
+ return this.day;
+ }
+
+ /**
+ * Returns boolean true if other is on the same day as this, false otherwise.
+ *
+ * @param other ClassTiming to compare to this.
+ * @return Boolean on whether this and other is on the same day.
+ */
+ public Boolean isSameDay(ClassTiming other) {
+ if (this.getDayToInt() == other.getDayToInt()) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Gets the timing string without the day of the ClassTiming.
+ *
+ * @return Timing of the ClassTiming without the Day.
+ */
+ public String getClassTiming() {
+ return this.value.split(" ")[1];
+ }
+
+ /**
+ * Returns true if a given string is a valid class timing.
+ */
+ public static boolean isValidClassTiming(String test) {
+ try {
+ if (test.matches(VALIDATION_REGEX)) {
+ LocalTime startTime = parseStartTime(test);
+ LocalTime endTime = parseEndTime(test);
+ return startTime.isBefore(endTime);
+ } else {
+ return false;
+ }
+ } catch (ParseException e) {
+ return false;
+ }
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof ClassTiming // instanceof handles nulls
+ && value.equals(((ClassTiming) other).value)); // state check
+ }
+
+ @Override
+ public int hashCode() {
+ return value.hashCode();
+ }
+
+ @Override
+ public int compareTo(ClassTiming o) {
+ int thisDayInt = getDayToInt();
+
+ String otherDay = o.getDay();
+ int otherDayInt = o.getDayToInt();
+ LocalTime otherStartTime = o.getStartTime();
+
+ if (thisDayInt < otherDayInt) {
+ return -1;
+ } else if (otherDayInt < thisDayInt) {
+ return 1;
+ } else if (this.getStartTime().equals(otherStartTime)) {
+ return 0;
+ } else {
+ return otherStartTime.isAfter(this.getEndTime()) || this.getStartTime().isBefore(otherStartTime) ? -1 : 1;
+ }
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/Location.java b/src/main/java/seedu/times/model/tuitionclass/Location.java
new file mode 100644
index 00000000000..771ec38f641
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/Location.java
@@ -0,0 +1,58 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.model.util.Commons.MAX_CHAR_COUNT;
+
+/**
+ * Represents a {@code TuitionClass}'s class location in the Timestable.
+ * Guarantees: immutable; is valid as declared in {@link #isValidLocation(String)}
+ */
+public class Location {
+
+ public static final String MESSAGE_CONSTRAINTS = "Class location should be between 1 and "
+ + MAX_CHAR_COUNT + " characters long!";
+
+ /*
+ * The first character of the address must not be a whitespace,
+ * otherwise " " (a blank string) becomes a valid input.
+ */
+ public static final String VALIDATION_REGEX = "[^\\s].{0,84}";
+
+ public final String value;
+
+ /**
+ * Constructs an {@code Location}.
+ *
+ * @param location A valid class address.
+ */
+ public Location(String location) {
+ requireNonNull(location);
+ checkArgument(isValidLocation(location), MESSAGE_CONSTRAINTS);
+ value = location;
+ }
+
+ /**
+ * Returns true if a given string is a valid class location.
+ */
+ public static boolean isValidLocation(String test) {
+ return test.matches(VALIDATION_REGEX);
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof Location // instanceof handles nulls
+ && value.equals(((Location) other).value)); // state check
+ }
+
+ @Override
+ public int hashCode() {
+ return value.hashCode();
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/Rate.java b/src/main/java/seedu/times/model/tuitionclass/Rate.java
new file mode 100644
index 00000000000..646a5c370b1
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/Rate.java
@@ -0,0 +1,60 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.AppUtil.checkArgument;
+import static seedu.times.model.util.Commons.MAX_CHAR_COUNT;
+
+/**
+ * Represents a {@code TuitionClass}'s rate in the Timestable.
+ */
+public class Rate {
+
+ public static final String MESSAGE_CONSTRAINTS =
+ "Rate should satisfy the following constraints:\n"
+ + "1. Not exceed a million\n"
+ + "2. Not be negative\n"
+ + "3. Not be empty\n"
+ + "4. At most be up to 2 decimal places\n"
+ + "5. You also cannot enter a decimal point without following it up with at least one digit.\n";
+ public static final String VALIDATION_REGEX = "\\d{1,6}(\\.\\d{1,2})?";
+
+ public final String value;
+
+ /**
+ * Constructs a {@code Rate}
+ *
+ * @param rate A valid tuition per hour rate.
+ */
+ public Rate(String rate) {
+ requireNonNull(rate);
+ checkArgument(isValidRate(rate), MESSAGE_CONSTRAINTS);
+ value = rate;
+ }
+
+ /**
+ * Returns true if a given string is a valid tuition rate.
+ *
+ * @param test String representing rate to be tested.
+ * @return A boolean value.
+ */
+ public static boolean isValidRate(String test) {
+ return test.matches(VALIDATION_REGEX) && test.length() < MAX_CHAR_COUNT;
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return other == this // short circuit if same object
+ || (other instanceof Rate // instanceof handles nulls
+ && value.equals(((Rate) other).value)); // state check
+ }
+
+ @Override
+ public int hashCode() {
+ return value.hashCode();
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/StudentNameList.java b/src/main/java/seedu/times/model/tuitionclass/StudentNameList.java
new file mode 100644
index 00000000000..2bd507ea456
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/StudentNameList.java
@@ -0,0 +1,182 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Iterator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import seedu.times.model.person.Name;
+import seedu.times.model.person.Person;
+import seedu.times.model.person.Student;
+import seedu.times.model.tuitionclass.exceptions.DuplicateStudentInClassException;
+
+/**
+ * Represents a unique list of names corresponding to the students
+ * that a {@code TuitionClass} has.
+ */
+public class StudentNameList implements Iterable {
+
+ private final List internalList = new ArrayList<>();
+
+ /**
+ * Constructs an StudentNameList from an array of Strings.
+ *
+ * @param nameList The String array to convert into an StudentNameList.
+ */
+ public StudentNameList(String[] nameList) {
+ for (String name : nameList) {
+ internalList.add(new Name(name));
+ }
+ }
+
+ /**
+ * Constructor that builds a StudentNameList from zero or more names.
+ *
+ * @param names Names to be stored in the StudentNameList.
+ */
+ public StudentNameList(Name... names) {
+ for (Name name : names) {
+ this.add(name);
+ }
+ }
+
+ /**
+ * Checks to see if the name in argument is already in the NameList.
+ *
+ * @param toCheck Name to check.
+ * @return boolean, true if name is already in list, false otherwise.
+ */
+ public boolean contains(Name toCheck) {
+ requireNonNull(toCheck);
+ return internalList.stream().anyMatch(toCheck::equals);
+ }
+
+ /**
+ * Removes name from the list.
+ *
+ * @param name to be removed.
+ */
+ public void remove(Name name) {
+ internalList.remove(name);
+ }
+
+ /**
+ * Removes all names provided from the list.
+ * @param names The list of names to be removed.
+ */
+ public void removeAll(List names) {
+ internalList.removeAll(names);
+ }
+
+ /**
+ * Adds a name to the list.
+ *
+ * @param toAdd name to be added.
+ * @throws DuplicateStudentInClassException if name is already in the list.
+ */
+ public void add(Name toAdd) throws DuplicateStudentInClassException {
+ requireNonNull(toAdd);
+ if (contains(toAdd)) {
+ throw new DuplicateStudentInClassException(toAdd);
+ }
+ internalList.add(toAdd);
+ }
+
+ /**
+ * Adds all the names in the argument into the list.
+ *
+ * @param names to be added in StudentNameList form.
+ */
+ public void addAll(StudentNameList names) {
+ for (Name name : names) {
+ if (!this.contains(name)) {
+ this.add(name);
+ }
+ }
+ }
+
+ /**
+ * Adds all the names in argument into the list.
+ *
+ * @param names list of names to be added.
+ * @throws DuplicateStudentInClassException if there are duplicate names in list.
+ */
+ public void addAll(List names) throws DuplicateStudentInClassException {
+ for (int i = 0; i < names.size(); i++) {
+ this.add(names.get(i));
+ }
+ }
+
+ public int size() {
+ return internalList.size();
+ }
+
+ @Override
+ public Iterator iterator() {
+ return internalList.iterator();
+ }
+
+ /**
+ * Sorts the internal Name list in the same order as the list of students given.
+ *
+ * @param listToSortBy The student list to sort the name list by.
+ */
+ public void sortListByList(List listToSortBy) {
+ Collections.sort(internalList,
+ Comparator.comparing(name -> listToSortBy.stream().map(Person::getName)
+ .collect(Collectors.toList()).indexOf(name)));
+ }
+
+ /**
+ * Gets the Name at the given index.
+ *
+ * @param zeroBasedIndex The index to retrieve the Name from.
+ * @return The Name at the given index.
+ */
+ public Name get(int zeroBasedIndex) {
+ assert (zeroBasedIndex < internalList.size());
+ return internalList.get(zeroBasedIndex);
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (o == this) {
+ return true;
+ }
+
+ if (!(o instanceof StudentNameList)) {
+ return false;
+ }
+
+ return ((StudentNameList) o).internalList.equals(internalList);
+ }
+
+ /**
+ * Replaces the old student name in the internalList with the new name.
+ *
+ * @param newName Name to replace the old name.
+ * @param oldName Name to be replaced by the new name.
+ */
+ public void replaceStudentName(Name newName, Name oldName) {
+ int oldNameIndex = internalList.indexOf(oldName);
+ if (oldNameIndex != -1) {
+ internalList.set(oldNameIndex, newName);
+ }
+ }
+
+ /**
+ * Utility method for testing
+ */
+ public String[] getNames() {
+ int len = internalList.size();
+ String[] res = new String[len];
+ for (int i = 0; i < len; i++) {
+ res[i] = internalList.get(i).getFullName();
+ }
+ return res;
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/TuitionClass.java b/src/main/java/seedu/times/model/tuitionclass/TuitionClass.java
new file mode 100644
index 00000000000..1439f12ba79
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/TuitionClass.java
@@ -0,0 +1,242 @@
+package seedu.times.model.tuitionclass;
+
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
+
+import java.time.LocalTime;
+import java.util.Arrays;
+
+import seedu.times.model.person.Name;
+
+/**
+ * Represents a {@code TuitionClass} in the Timestable.
+ * Guarantees: details are present and not null, field values are validated, immutable.
+ */
+public class TuitionClass {
+
+ private final ClassTiming classTiming;
+ private final ClassName className;
+ private final Location location;
+ private final Rate rate;
+
+ /**
+ * ArrayList of {@code Name}
+ * Rationale for choosing Name as identifier:
+ * If the {@code Student} objects are stored, any changes to a student would cause a cascade of updates in classes
+ * the student is in.
+ */
+ private final StudentNameList studentNameList;
+
+ /**
+ * Represents a tuition class for Students to join. A {@code TuitionClass} can have multiple {@code Student}s.
+ * A class is uniquely identified by its timing; a single timing can only have _one_ class.
+ *
:information_source: **Note:** This is just a high level explanation of how the Timetable UI is built, with the low level details being abstracted away.
-Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
+[comment]: <> ()
+
+[comment]: <> ()
+
+[comment]: <> ()
+
+[comment]: <> ()
+
+[comment]: <> ()
+
+
+
+### Observer Pattern
+
+The Observer Pattern is facilitated by the `CommandObserver` who represents the `Observer`. It observes the abstract `Command` class.
+
+#### Implementation
+
+The class diagram below shows how we implemented the structure of the Observer Pattern.
+
+
+
+The `MainWindow` from `UI` component implements both the `Ui` and `CommandObserver` interface as it plays the role of the `Ui` as well as a `CommandObserver`. The `MainWindow` observes the `Command` class, who calls `CommandObserver#updateView()`, `CommandObserver#updateClass()` and `CommandObserver#hideTuitionClassList()` depending on what Command `XYZCommand` is.
+
+For eg, the `ViewComand` calls `CommandObserver#updateView()` to set the displayed tab of the `CommandObserver` to the tab specified. Additionally, the `AddToClassCommand` calls both `CommandObserver#updateClass()` and `CommandObserver#updateView()` to update the class details and updates the view to the `Classes` tab when we execute the `AddToClassCommand`.
+
+#### Design Considerations
+
+1. (Bad) After each command call, set a variable in the `CommandResult` to be the value of the Tab to change to, or a boolean value to see if we need to update the class. The `MainWindow` would then check the variables in `CommandResult` in `MainWindow#executeCommand()`, and updates the tab or class accordingly.
+ - This is a very bad and inefficient method as the `MainWindow` would have to constantly check the `CommandResult` after every `Command`.
+ - With the addition of new variables in `CommandResult`, it has the potential to introduce more bugs and make the code more unreadable. Additionally, other classes may also be able to access these variables accidentally, as they have to be `public` in order for `MainWindow` to access them, leading to unwanted consequences.
+2. (Good) Follow the Observer Pattern taught in CS2103T, where we register the `MainWindow` as a `CommandObserver` to observe the abstract `Command` class, and will only get updated when necessary.
+ - This is a more efficient method as the `MainWindow` does not have to always check the `CommandResult` after each execution.
+ - No new variables are needed to be introduced into the `CommandResult`, keeping our code neater and less bug prone.
+
+
+
+### `add` and `edit` commands to include next-of-kin `nok`
+
+
+#### Implementation
+The solution that we came up with was very simple. we just had to split the string by `/nok` and put both of the split
+portions into the parser. Modifying the existing `parser` was not needed at all. we learnt that oftentimes for a small feature, we don't have
+to go for the most extensible or "smart" solution, but the simplest to understand.
+
+#### Design Considerations
+Initially, it appeared challenging to us because the current `Parser` is only able to parse contents _between_ tags, but not encompass other tags within recursively.
+For example, `add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` requires us to parse the tags before and after `nok/` _separately_, which is a challenging problem to think about at first.
+
+1. (Bad) We thought of a recursive implementation of the `Parser`, calling `parse` methods again on the two halves whenever we find an `/nok` tag, but
+it proved to be too lofty and unneccesarily complicated. Moreover, using recursion in applications is not recommended due to the high potential
+of unseen bugs.
+
+2. (Bad) We thought of modifying the parser such that it always checks for the `/nok` tag (or any of the tags specified in the parameter) _first_, before parsing the other tags
+in the normal way. However, this was again too large scale for a single command with the same parameter.
+
+
+
+
+### Find commands
+
+The find commands are a common group of commands that allows users to quickly find `Student` or `TuitionClass`. They are:
+* `findname`
+* `findtag`
+* `findclass`
+* `findclassname`
+
+#### Implementation of the command
-
+The implementation of all search-related commands such as `findtag`, `findname`, `findclass` and `findclassname` uses a
+common approach of setting a `Predicate` inside the corresponding `FilteredList` class. As mentioned above in [`Model`](#model-component)
+section, the filtered list either contains an `ObservableList
+#### Implementation of find predicates
-#### Design considerations:
+Furthermore, to fully understand the find command, we also have to understand how `Predicate` works. The `Predicate`s used
+that filters out students or classes are typical java `Predicate`. For each searchable attribute, a new class must be
+created that implements `Predicate` with the right generic type (i.e. predicate class for filtering `Student` must
+implement `Predicate+A busy tutor who has a large number of students can find it extremely difficult to + +- manage and organize student information +- schedule according to student class timing + +This is where Timestable comes in. It improves two main areas: + +- querying + - student information + - parent information + - class timing +- data manipulation + - add + - edit + - delete + +By improving the data manipulation process, the tutor can organize student information more easily.
+By improving the querying process, the tutor can make scheduling less painstaking and time-consuming. + + ### User stories Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -| Priority | As a … | I want to … | So that I can… | -| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- | -| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App | -| `* * *` | user | add a new person | | -| `* * *` | user | delete a person | remove entries that I no longer need | -| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list | -| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident | -| `*` | user with many persons in the address book | sort persons by name | locate a person easily | - -*{More to be added}* +| Priority | As a … | I want to … | So that I can… | +| -------- | -------------- | ----------------------------------------------------------- | --------------------------------------------------- | +| `* ` | Careless User | Be notified if there was a clash in timing | I can have peace of mind | +| `* ` | User | View schedule for a specific day | Can prepare for lesson and won't be absent | +| `* *` | User | Save class rates | Keep track of how much to charge each class | +| `* *` | User | Edit my student details | Keep track of changes of my students | +| `* *` | Organised user | Sort my students and classes | Arrange them the way I want to organise them | +| `* * *` | Forgetful user | Save their contacts | I can remember them | +| `* * *` | Organised User | View my class timings in a time table | Know how my weekly schedule looks like | +| `* * *` | User | Record parent contact of my students | Contact the student's parent in case of emergencies | +| `* * *` | User | Delete my student's contacts and information | I can declutter my contacts. | +| `* * *` | User | Record locations of classes | Knows where to go | +| `* * *` | User | Find a student or class with a specific name | Find details of a specific class or student quickly | + + ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) +(For all use cases below, the **System** is the `TimesTable` and the **Actor** is the `user`, unless specified otherwise) -**Use case: Delete a person** +**Use case: Delete a student** **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 deletes the person +1. User requests to list students. +2. TimesTable shows a list of students. +3. User requests to delete a specific student in the list. +4. TimesTable deletes the student. Use case ends. **Extensions** -* 2a. The list is empty. +- 1a. The list is empty. Use case ends. -* 3a. The given index is invalid. +- 3a. The given index is invalid. - * 3a1. AddressBook shows an error message. + - 3a1. TimesTable shows an error message. - Use case resumes at step 2. + Use case resumes at step 3. -*{More to be added}* +- 3b. The given delete command has a typo. + + - 3b1. TimesTable shows an error message. + + Use case resumes at step 3. + +**Use case: Add a student** + +**MSS** + +1. User input details of new person to be added to TimesTable. +2. TimesTable adds new person with relevant details. + + Use case ends. + +**Extension** + +- 1a. User keys in add command with invalid format(missing compulsory fields). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in add command with valid format but invalid String format for certain fields. + + - 1b1. TimesTable shows an error message saying which field contains the invalid format. + + Use case resumes at step 1. + +**Use case: Edit student details** + +**MSS** + +1. User edits details of existing student. +2. TimesTable updates the student with the added details. + + Use case ends. + +**Extension** + +- 1a. User keys in field with invalid format. + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +**Use case: Find student by name** + +**MSS** + +1. User input name of student that user wants to find. +2. TimesTable shows the student that has the same name. + + Use case ends. + +**Extension** + +- 1a. No student name matches the name keyword inputted. + + - 1a1. TimesTable shows no student listed. + + Use case ends. + +**Use case: Find student by tag** + +**MSS** + +1. User input tag of student that user wants to find. +2. TimesTable shows the student that has the same tag. + + Use case ends. + +**Extension** + +- 1a. No student tag matches the tag keyword inputted. + + - 1a1. TimesTable shows no student listed. + + Use case ends. + +**Use case: Add a tuition class** + +**MSS** + +1. User input details of new tuition class to be added to TimesTable. +2. TimesTable adds new tuition class with relevant details. + + Use case ends. + +**Extension** + +- 1a. User keys in addclass command with invalid format(missing compulsory fields). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in addclass command with valid format but invalid String format for certain field. + + - 1b1. TimesTable shows an error message saying which field contains the invalid format. + + Use case resumes at step 1. + +- 1c. User keys in addclass command with valid format, valid String format for all fields, but class timing overlaps + with other classes already in TimesTable. + + - 1c1. TimesTable shows an error message saying that this operation would cause a clash in class timing. + + Use case resumes at step 1. + +**Use case: Delete a tuition class** + +**MSS** + +1. User requests to list classes. +2. TimesTable shows a list of classes. +3. User requests to delete a specific class in the list. +4. TimesTable deletes the class. + + Use case ends. + +**Extensions** + +- 1a. The list is empty. + + Use case ends. + +- 3a. The given index is invalid. + + - 3a1. TimesTable shows an error message. + + Use case resumes at step 3. + +- 3b. The given deleteclass command has a typo. + + - 3b1. TimesTable shows an error message. + + Use case resumes at step 3. + +**Use case: Add students to a tuition class** + +**MSS** + +1. User input index of class(in `classes` tab) to be added to and index of students(in `students` tab) to be added. +2. TimesTable adds students selected into class selected. + + Use case ends. + +**Extension** + +- 1a. User keys in addtoclass command with invalid index(student or class or both). + + - 1a1. TimesTable shows an error message citing which index is invalid. + + Use case resumes at step 1. + +- 1b. User attempts to add student to a class where the student is already in. + + - 1b1. TimesTable shows an error message saying that student is already in the class. + + Use case resumes at step 1. + +**Use case: Remove students from a tuition class** + +**MSS** + +1. User input index of class(in `classes` tab) to be added to and index of students(in `classes` tab) to be removed. +2. TimesTable removes students from the class selected. + + Use case ends. + +**Extension** + +- 1a. User keys in removefromclass command with invalid index(student or class or both). + + - 1a1. TimesTable shows an error message citing which index is invalid. + + Use case resumes at step 1. + +**Use case: Edit tuition class details** + +**MSS** + +1. User edits details of existing tuition class. +2. TimesTable updates the tuition class with the added details. + + Use case ends. + +**Extension** + +- 1a. User keys in field with invalid format(wrong field name). + + - 1a1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1b. User keys in invalid index. + + - 1b1. TimesTable shows an error message. + + Use case resumes at step 1. + +- 1c. User keys in class timing that overlaps with other class's class timing. + + - 1c1. TimesTable shows an error message saying that this operation would cause a clash in class timing. + + Use case resumes at step 1. + +**Use case: Find tuition class by class timing** + +**MSS** + +1. User input class timing of tuition class that user wants to find. +2. TimesTable shows the tuition classes that has similar class timing. + + Use case ends. + +**Extension** + +- 1a. No tuition class timing matches the class timing keyword inputted. + + - 1a1. TimesTable shows no tuition classes listed. + + Use case ends. + +**Use case: Find tuition class by name** + +**MSS** + +1. User input name of tuition class that user wants to find. +2. TimesTable shows the tuition class that has similar name. + + Use case ends. + +**Extension** + +- 1a. No tuition class name matches the name keyword inputted. + + - 1a1. TimesTable shows no tuition class listed. + + Use case ends. + + ### Non-Functional Requirements 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. -2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. +2. Should be able to hold up to 1000 students without a noticeable sluggishness in performance for typical usage. 3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. - -*{More to be added}* +4. The data should be stored locally in a human editable text file +5. Should not use a database management system to store data +6. Should follow OOP paradigm primarily +7. Should work without requiring an installer +8. Should not depend on a remote server +9. Project should simulate a brownfield project by evolving the code base with each iteration incrementally (breadth-first) +10. Should be for a single user +11. Third-party frameworks, libraries and services should be free, open-source, do not require any installation by the user, and do not violate other requirements. +12. GUI should work well for + - Standard screen resolutions of 1920x1080 and higher + - Screen scales 100% and 125% +13. GUI should be usable for + - Resolutions 1280x720 and higher + - Screen scales 150% +14. Should package everything into a single JAR file +15. Product should not exceed 100 MB and documents should not exceed 15 MB/file +16. Developer Guide and User Guide should be PDF-friendly ### Glossary -* **Mainstream OS**: Windows, Linux, Unix, OS-X -* **Private contact detail**: A contact detail that is not meant to be shared with others +- **Mainstream OS**: Windows, Linux, Unix, OS-X +- **Private contact detail**: A contact detail that is not meant to be shared with others + +--- --------------------------------------------------------------------------------------------------------------------- + ## **Appendix: Instructions for manual testing** @@ -347,31 +1009,363 @@ testers are expected to do more *exploratory* testing. 1. Resize the window to an optimum size. Move the window to a different location. Close the window. 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. - -1. _{ more test cases … }_ - -### Deleting a person - -1. Deleting a person while all persons are being shown - - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. - - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. - - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. - -1. _{ more test cases … }_ - -### Saving data - -1. Dealing with missing/corrupted data files - - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ - -1. _{ more test cases … }_ + Expected: The most recent window size and location is retained. + +### Clearing data: `clear` + +1. Test case: Clear all `Student`s and `TuitionClass`es in TimesTable. + 1. Prerequisite: TimesTable contains `Student`s and `TuitionClass`es. Steps to do this are below: + 1. (You may skip this if you already have `Student`s) Add a student: `add n/Amber p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. (You may skip this if you already have `TuitionClass`es) Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Clear all data: `clear` + 3. Expected: `TimesTable has been cleared!` and all `Student`s and `TuitionClass`es are removed from TimesTable. + +2. Test case: Clear empty TimesTable. + 1. Prerequisite: TimesTable does not contain `Student`s and `TuitionClass`es. Steps to do remove them are below: + 1. (You may skip this if you do not have `Student`s) Delete a student: `delete INDEX` for all `Student`s in TimesTable. + 2. (You may skip this if you do not have `TuitionClass`es) Delete a class: `deleteclass INDEX` for all `TuitionClass`es in TimesTable. + 2. Clear all data: `clear` + 3. Expected: `TimesTable has been cleared!` and all `Student`s and `TuitionClass`es are removed from TimesTable. + + +### Adding a Student: `add` +1. Test case 1: Add a `Student` successfully + 1. Add a `Student` to TimesTable: `add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 + nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Expected message: `New Student added: John Doe; Phone: 98765432; Email: johnd@example.com; Address: 311, Clementi Ave 2, #02-25; Tags: [Chemistry][Sec 3] + Next-of-Kin: Jack Doe; Phone: 10987654; Email: jackd@example.com; Address: 311, Clementi Ave 2, #02-25` +2. Test case 2: Cannot add duplicate `Student` + 1. Prerequisite: TimesTable contains the sample `Student`s. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Add a `Student` with a clash in `NAME` with an existing `Student`: `add n/Alex Yeoh p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 + nok/ n/Elise Yeoh p/10987654 e/eliseyeoh@gmail.com a/311, Clementi Ave 2, #02-25` + 3. Expected: `This person already exists in the address book` message shown. + + +### Adding a class: `addclass` + +1. Test case: Adding a `TuitionClass` successfully - no clash in `CLASS_TIMING` with existing `TuitionClass`es. + 1. Prerequisite: TimesTable does not have any `TuitionClass`es. If you have any `TuitionClass`, steps to remove them are below: + 1. (You may skip this if you do not have `TuitionClass`es) Delete a class: `deleteclass INDEX` for all `TuitionClass`es in TimesTable. + 2. Add a `TuitionClass`: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 3. Expected: `New class added: Class Timing: MON 11:30-13:30 Class Name: Sec 4 A Maths Location: Nex Tuition Center Rate: 70` and switched to `Classes` Tab. The `Classes` Tab now shows the `TuitionClass` you added. The `Timetable` Tab also shows your `TuitionClass` on `MON 11:30-13:30`. + +2. Test case: Adding a `TuitionClass` unsuccessfully - clash in `CLASS_TIMING` with existing `TuitionClass`. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Add a `TuitionClass` with a clash in `CLASS_TIMING` with an existing `TuitionClass`: `addclass cn/CS2103T ct/MON 10:30-12:30 r/70 l/Nex Tuition Center` + 3. Expected: `The operation aborted because it will introduce a clash in class timing.` and the `TuitionClass` does not get added to the `Classes` Tab. + +### Deleting a student: `delete` + +1. Test case: Delete a student successfully + 1. Prerequisites: Student to delete must be present. Steps to do this are below: + 1. Add student: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Note the students in the student list. + 2. Delete the student: `delete INDEX`. `INDEX` is the index of the student shown in the student list. If there were no other student present before, this would be 1. Otherwise, it would be the number shown at the top left corner of the student card. + 3. Expected: `Deleted Person: Student; Phone: 98765432; Email: johnd@example.com; Address: 311, Clementi Ave 2, #02-25; Tags: [Chemistry][Sec 3] Next-of-Kin: Jack Doe; Phone: 10987654; Email: jackd@example.com; Address: 311, Clementi Ave 2, #02-25` message shown. + Class no longer belongs in the class list noted in (ia). +1. Test case: Cannot delete a student that doesn't exist + 1. Prerequisites: Student at the student index to be deleted must not exist. + 1. Easiest way to ensure that this happens: run `clear` + 2. Note that the student list is empty. + 2. Delete the student at index 1: `deleteclass 1`. + 3. Expected: `The student index provided is invalid` message shown. + +### Deleting a tuition class: `deleteclass` + +1. Test case: Deleting a class successfully + + 1. Prerequisites: Class to delete must be present. Steps to do this are below: + 1. Add class: addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center + 2. Note the classes in the class list. + + 2. Delete the class: `deleteclass INDEX`. `INDEX` is the index of the class shown in the class list. If there + were no other classes present before, this would be 1. Otherwise, it would be the number shown at the top left corner of the class card. + (eg. `deleteclass 1`). + + 3. Expected: `Class deleted: Class Timing: FRI 11:30-13:30 Class Name: Sec 4 A Maths Location: Nex Tuition + Center Rate: 70` message shown. Class no longer belongs in the class list noted in (ib). + +2. Test case: Cannot delete a class that does not exist + + 1. Prerequisites: Class at the class index to be deleted must not exist. Steps to do this are below: + 1. Easiest way to ensure that this happens: run clear + 2. Note that the class list is empty. + + 2. Delete the class at index 1: `deleteclass 1`.
+ 3. Expected: `The class index provided is invalid` message shown. + +### Adding a Student to a Class: `addtoclass` + +1. Test case 1: Add a `Student` to a `TuitionClass` successfully + 1. Prerequisites: You don't have any `Student`s or `TuitionClass`es. If you have at least _one_ `Student` or `TuitionClass`, you can skip adding a `Student` / `TuitionClass` respectively. + 2. Add a `Student` to TimesTable: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 3. Add a `TuitionClass` to TimesTable: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 4. Add the `Student` to the `TuitionClass`: `addtoclass 1 1` + Expected: `Successfully added students to class` message shown +2. Test case 2: Cannot add to a class that does not exist + 1. Prerequisites: You don't have any classes. If you have any, you can remove them using the `deleteclass INDEX` command or run `clear`. + 2. If you already have a student, you can skip this step. + Add a student to TimesTable: `add n/Student p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 3. Add the student to non-existing class: `addtoclass 1 1` + Expected: `The class index provided is invalid` message shown +3. Test case 2: Cannot add to a student that does not exist to a class + 1. Prerequisites: You don't have any students. If you have any, you can remove them using the `delete INDEX` command or run `clear`. + 2. If you already have a class, you can skip this step. + Add a class to TimesTable: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 3. Add non-existing student to the class: `addtoclass 1 1` + Expected: `The student index provided is invalid` message shown + +### Removing Student(s) from a class : `removefromclass` + +1. Test case: Removing a student from a class that doesn't currently exist + 1. Prerequisites: Class at the class index must not exist. Steps to do this are below: + 1. Run command `listclass` and note the index of the last class. + 2. Remove students from non-existing class at index (max index + 1): `removefromclass 5 1 2 3 `.
+ Where last class is at index 4 from (ib). + 3. Expected: `The class index provided is invalid` message shown. + +2. Test case: Removing a student from a class that has no student + 1. Prerequisites: There must be a class with 0 students in it. Steps to do this are below: + 1. Clear TimesTable usiing: `clear`. + 2. Add a new class: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center`. + 2. Remove student(s) from empty class: `removefromclass 1 1 2 3`. + 3. Expected: `The student index provided is invalid` message shown. + + +### Editing a student: `edit` + +1. Test case 1: Editing an existing student's own detail + 1. Prerequisites + 1. Add student: `add n/John p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` + 2. Note the student and his or her index in the displayed list in the `Student` tab. + 2. Edit the student (assuming the student's index is 1): `edit 1 n/updated student p/99993293 e/edited@gmail.com a/edited address t/` + 3. Expected: All fields are changed according to `edit` command inputs and all tags are removed. +2. Test case 2: Edit an existing student's NOK detail + 1. Prerequisites: Same as above + 2. Edit the student's NOK (assuming the student's index is 1): `edit 1 nok/ n/edited NOK name e/editedNOK@gmail.com a/edited address p/92393932` + 3. Expected: All NOK fields are changed according to `edit` command inputs +3. Negative test cases + 1. Out of range + 1. (assuming the student list does not have 100 students) enter `edit 100 n/edited name` + 2. Expected: "The student index provided is invalid" is displayed + 2. No fields provided + 1. enter `edit 1` + 2. Expected: "At least one field to edit must be provided." is displayed + 3. invalid prefix provided + 1. enter `edit 1 prefix/` + 2. Expected: Invalid command format message is displayed + +### Editing a class: `editclass` + +1. Test case 1: Editing an existing class + 1. Prerequisites + 1. Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the class and its index in the displayed list in the `Class` tab + 2. Edit the class (assuming the class's index is 1): `editclass 1 cn/edited classname ct/MON 09:00-11:00 r/90 l/edited location` + 3. Expected: All fields are changed according to `editclass` command's inputs +2. Negative test cases: + 1. Out of range + 1. (assuming the class list does not have 100 classes) enter `editclass 100 cn/edited class name` + 2. Expected: "The class index provided is invalid" is displayed + 2. No fields provided + 1. enter `editclass 1` + 2. Expected: "At least one field to editclass must be provided." is displayed + 3. invalid prefix provided + 1. enter `editclass 1 prefix/` + 2. Expected: Invalid command format message is displayed + +### Sorting classes and students: `sort` + +1. Test case: Sort classes in ascending order. + 1. Prerequisites: Add more than 1 class in non-sorted order by timing. Steps to do this are below: + 1. Add later class first: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Add earlier class second: `addclass cn/Sec 5 A Maths ct/FRI 10:30-11:30 r/70 l/Nex Tuition Center` + 3. Note that 'Sec 4 A Maths' comes _before_ 'Sec 5 A Maths' + 2. Sort classes: `sort timing asc`. + 3. Expected: `Sorted classes based on timing in asc direction` message shown, 'Sec 5 A Maths' now comes _before_ 'Sec 4 A Maths' in the class list. +2. Test case: Sort students in descending order. + 1. Prerequisites: Add more than 1 student in non-sorted order by name. Steps to do this are below: + 1. Add earlier student first: `add n/Amber p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25 ` + 2. Add later student second: `add n/Zebra p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/Chemistry t/Sec 3 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25 ` + 3. Note that 'Amber' comes _before_ 'Zebra' + 2. Sort students: `sort name desc`. + 3. Expected: `Sorted students based on name in desc direction` message shown, 'Zebra' now comes _before_ 'Amber' in the Student list. + + +### Locating a student by name: `findname` +1. Test case: No students has a name that matches the search term used + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a name that currently do not exist: `findname Jennifer`. + 3. Expected: `0 persons listed!` message shown and no students shown in `Students` tab. + +2. Test case: A student is found with name that matches search term. + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a single name that currently exists: `findname alex`. + 3. Expected: `1 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh` and + `David Li`. +3. Test case: Multiple students have names that matches search term. + 1. Prerequisites: TimesTable contain multiple students. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using part of a name that currently exists: `findname li`. + 3. Expected: `3 persons listed!` message shown and 3 students shown in `Students` tab, namely + `Charlotte Oliveiro`, `David Li` and `Angelica Holcomb`. + +### Locating a class by class timing: `findclass` +1. Test case: No `TuitionClass` matches the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of `WED`: `findclass WED` + 3. Expected: `0 classes listed!` and tab switched to `Classes` tab. + +2. Test case: `TuitionClass`es match the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of 'MON': `findclass mon` + 3. Expected: `2 classes listed!` and tab switched to `Classes` tab. The `Classes` Tab contains 2 `TuitionClass`es with `CLASS_TIMING` of `MON`. + +3. Test case: `TuitionClass`es match the multiple search terms used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_TIMING` of `MON` and `11:30-13:30`: `findclass mon 11:30-13:30` + 3. Expected: `1 classes listed!` and tab switched to `Classes` tab. The `Classes` Tab contains 1 `TuitionClass` with `CLASS_TIMING` of `MON` and `11:30-13:30`. + + + +### Locating a class by name: `findclassname` + +1. Test case: No `TuitionClass` matches the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of `CS2103T`: `findclassname CS2103T` + 3. Expected: `0 classes listed!` and tab switched to `Classes` tab. + +2. Test case: `TuitionClass`es match the search term used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of 'math': `findclassname math` + 3. Expected: `7 classes listed!` and tab switched to `Classes` tab. The `TuitionClass`es shown in the `Classes` Tab contains 7 `TuitionClass`es with `CLASS_NAME` of `math` (case insensitive). + +3. Test case: `TuitionClass`es match the multiple search terms used. + 1. Prerequisite: TimesTable contains the sample `TuitionClass`es. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Find `TuitionClass`es with `CLASS_NAME` of `math` and `jc`: `findclassname math, jc` + 3. Expected: `8 classes listed!` and tab switched to `Classes` tab. The `TuitionClass`es shown in the `Classes` Tab contains 8 `TuitionClass`es with `CLASS_NAME` of `math` or `jc` or both (case insensitive). + + +### Finding Student(s) by tag : `findtag` + +1. Test case: No students have tags that matches the search term used + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using tag that currently do not exist: `findtag social studies`. + 3. Expected: `0 persons listed!` message shown and no students shown in `Students` tab. + +2. Test case: Students have tags that matches search term(single) + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using a single tag that currently exists: `findtag a math`. + 3. Expected: `2 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh` and + `David Li`. +3. Test case: Students have tags that matches search terms(multiple) + 1. Prerequisites: TimesTable contain multiple students with differing tags. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start off with the sample data in TimesTable. + 2. Find students using multiple tag that currently exists: `findtag a math, physic, sec 4`. + 3. Expected: `4 persons listed!` message shown and 2 students shown in `Students` tab, namely `Alex Yeoh`, + `Charlotte Oliveiro`, `David Li` and `Illana Page`. + +### Changing tabs: `view` + +1. Test case: View `Classes` tab, but command has a typo error + 1. View `Classes` tab with typo: `view clases`. + 2. Expected: `Invalid command format!This tab doesn't exists. You can only switch to students, timetable or + classes.` message show. + +2. Test case: View `Classes` tab, but user is already on `Classes` tab + 1. View `Classes` tab: `view classes`. + 2. Expected: `Successfully switched to CLASSES tab` and remains on `Classes` tab. + +3. Test case: View `Timetable` tab, user is on `Classes` tab + 1. View `Timetable` tab: `view timetable`. + 2. Expected: `Successfully switched to TIMETABLE tab` and switched to `TimeTable` tab. + +### Selecting a class: `class` +1. Test case 1: viewing an existing class + 1. Prerequisites + 1. Add a class: `addclass cn/Sec 4 A Maths ct/MON 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the class and its index in the displayed list in the `Class` tab + 3. Adding students to the class (assuming the class's index is 1 and there are at least 2 students in Timestable): `addtoclass 1 1 2 ` + 2. view the class (assuming the class's index is 1): `class 1` + 3. Expected: the students list in `Classes` tab is showing students belonging to that class +2. Negative test cases: + 1. Out of range + 1. (assuming the class list does not have 100 classes) enter `class 100` + 2. Expected: "The class index provided is invalid" is displayed + +### Listing all students: `list` + +1. Test case: All `Student`s are listed and focus is moved to the `Students` tab. All previous filtering is reset. + 1. Prerequisite: `Student` filter must be present. Steps to do this are below: + 1. Delete `timestable.json` in the data file to start of with the sample data in TimesTable. + 2. Filter `Student`s: `findname alex`. One `Student` with the name `Alex Yeoh` should be listed. + 3. Go to `Classes` tab: `view classes` + 4. List all `Student`s: `list` + 5. Expected: `Listed all students` message shown and tab is changed to the `Students` tab. The list of `Student`s should be the same as before filtering (Step 2). + + +### Listing all classes: `listclass` + +1. Test case: All `TuitionClass`es are listed and focus is moved to `Classes` tab. All previous filtering is reset. + 1. Prerequisites: `TuitionClass` to filter must be present. Steps to do this are below: + 1. Add `TuitionClass`: `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` + 2. Note the `TuitionClass`es in the class list. + 2. Filter classes: `findclassname hello`. No `TuitionClass`es should be listed. + 3. Go to `Students` tab: `view students` + 4. List `TuitionClass`es: `listclass` + 5. Expected: `Listed all classes` message shown and tab is moved to `Classes` tab. Class list noted in (ib) is shown. + + + +## Appendix: Effort + +The effort required to evolve `AB3` to `TimesTable` could be estimated to be approximately the effort required to create `AB3`. Our team have contributed roughly 15k lines of functional code, automated unit and integration testing, and documentation. + +### Addition of Tabs +* `AB3` did not have any different tabs. There was only one page showing the `Person`'s contacts. +* Addition of tabs was the start of the evolution from `AB3` into `TimesTable`. +* By adding tabs, we could implement different UIs into each tab to give the user a better experience. +* The effort to add tabs was not very high, as we only had to add an additional JavaFx control. +* Building the contents of the Tabs was the difficult portion as we had to design the entire layout of the tabs by ourselves. + +### Addition of Timetable Tab +* Adding the Timetable Tab was difficult, as it was our first time building an interface like this. +* However, we were inspired by [Pet Store Helper](#acknowledgements), and adapted some of their basic ui components for our application. +* Despite, adapting some of their basic ui components, the effort to build the Timetable Tab was still high, as we implemented the [building process](#timetable-tab-feature) from scratch. +* We had to account for many JavaFx issues, alignments and row and column spans to build the slots, which was relatively hard as it was something new to us. + +### Addition of Classes Tab +* Adding the Classes Tab was difficult as we had to design an entire user interface from the ground up to both contain details of the `TuitionClass`es in TimesTable and details of the `Student`s in each class. +* We faced exceptional difficulty when making sure that the details of the `TuitionClass`, such as size of the class, and the list of `Student`s in each class, was being updated when `Student`(s) were being added or removed from any particular class, or when any `Student`'s or `TuitionClass`'s details were being edited. +* The very design of the Classes Tab itself also necessitates a lot of coupling, because the view in the `StudentClassPanel` depended on the view in the `ClassListPanel` as it changes based on what was clicked. + +### Addition of new fields +* `AB3` initially had the `Name`, `Phone Number`, `Email`, `Address`, and `Tag` categories. +* For `TimesTable`, we added additional fields like `ClassTiming`, `ClassName`, `Rate`, `Location` and `Nok`. + +### Addition of Tuition Class +* While AB3 only tracks persons, TimesTable also keeps track of Tuition Classes. +* The addition of the `TuitionClass` required a great deal of effort as it brought a lot of problems at the start, such as `TuitionClass`es overlapping with one another when being added into the `UniqueClassList` that contained all `TuitionClass`es in TimesTable, creating a clash in class timing that was undesirable for our intended user's purpose. Another example is the problem of integrating `TuitionClass` and `Student` which is further discussed below. + + +### Addition of Commands +* TimesTable added many new commands: `addclass`, `deleteclass`, `addtoclass`, `removefromclass`, `editclass`, `findclass`, `findclassname`, `listclass`, `selectclass`, `findtag`, `sort` and `view` +* In addition, the `add` and `edit` commands were modified with the addition of TimesTable's new Next-of-Kin field. The `find` command was also modified to allow for multi-word and partial matches. +* Many of these commands required a lot of restructuring and addition of code. For instance, the class commands have to interact with both Tuition Classes and Students. + +### Integration of Classes and Students +* Integration of classes and students was difficult because it required `TuitionClass`es to store references to the `Student`s. The simple solution would be to just store a list of `Student` in each `TuitionClass` and store a list of `TuitionClass` in each `Student`. However, we quickly found out that it was not the ideal design.This is because it would increase the overall level of dependencies in the project drastically mainly due to the fact that `TuitionClass` and `Student` are so tightly coupled together. It also decreased the overall testability due to high dependency. +* Integration of classes and students was also cause storing and reading properly difficult due to their high degree of coupling and was very prone to error, resulting in a very large amounts of checks needed when reading from the data JSON file. +* The design that we eventually implemented was to use a list of `Name`s instead which effectively reduced overall dependency and the number of bugs that we had. It also reduced the number of lines in our codebase by hundreds which is great since we were able to achieve the same desired result with less code. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..77244c21177 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -23,7 +23,7 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.
:exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. 1. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. + 1. Run the `seedu.times.Main` and try a few commands. 1. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- diff --git a/docs/Testing.md b/docs/Testing.md index 8a99e82438a..2f80e71f618 100644 --- a/docs/Testing.md +++ b/docs/Testing.md @@ -29,8 +29,8 @@ There are two ways to run tests. This project has three types of tests: 1. *Unit tests* targeting the lowest level methods/classes.
- e.g. `seedu.address.commons.StringUtilTest` + e.g. `seedu.times.commons.StringUtilTest` 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
- e.g. `seedu.address.storage.StorageManagerTest` + e.g. `seedu.times.storage.StorageManagerTest` 1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
- e.g. `seedu.address.logic.LogicManagerTest` + e.g. `seedu.times.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3716f3ca8a4..540aae89ecc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,190 +3,770 @@ layout: page title: User Guide --- -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. + +## Introduction + +**TimesTable** is a **tuition management** desktop app for tutors who prefer to use a Command Line Interface (CLI) over a +Graphical User Interface (GUI). **TimesTable** allows you to manage and keep track of your tuition students and classes. +The app stores basic information about your students and classes, such as `Name`, `Email`, `Address`, `Class Timing`, and more. +You can add the students to classes to organise them. + +**TimesTable** also automatically generates a TimeTable for you based on your created classes so you can visualise +your schedule at a glance. + +**TimesTable** uses the CLI to enter commands, which means you control the application by typing in commands into the +command box. Other GUI applications are controlled by clicking on buttons and boxes. +If you can type fast, TimesTable can get your class management tasks done faster than traditional GUI applications. +Using the CLI allows you to control the application quickly while still having the visual benefits of a GUI. + +This guide will take you through the commands of **TimesTable** step by step. For more information about how to use the +guide, head to the [Reading this User Guide](#reading-this-user-guide) section. To get started with using **TimesTable**, +jump to the [Quick Start](#quick-start) section. For a full list of commands and detailed instructions on each one, head to the +[Features](#features) section. + + + +## Table of Contents * Table of Contents {:toc} -------------------------------------------------------------------------------------------------------------------- -## Quick start +## Quick Start +### Set Up + +1. Ensure you have Java `11` or above installed in your Computer, if you do not, you can download it from [here](https://www.oracle.com/java/technologies/downloads/#java11-windows). + +2. Download the latest `timestable.jar` from [here](https://github.com/AY2122S1-CS2103T-F11-1/tp/releases). +  +3. Copy the file to the folder you want to use as the _home folder_ for your TimesTable. + -1. Ensure you have Java `11` or above installed in your Computer. -1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). +4. For `Windows`, double-click the file to start the app. + For `Mac`, you need to open `TimesTable` using terminal. You can right-click on the folder and click on New Terminal at Folder to bring up your terminal, and key in `java -jar timestable.jar`. Press Enter to launch the application. +  + -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. -1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+5. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample student data.
 + + + +### Tutorial + +1. Before we begin, note that we are at the Students Tab, where we show all the students that you are teaching. Other tabs will be explained later. +2. To get started, lets add a student using the [`add`](#adding-a-student-add) command. +First type `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 nok/ n/Jack Doe p/10987654 e/jackd@example.com a/311, Clementi Ave 2, #02-25` +into the command box to add 'John Doe' using the parameter `n/`, with his specified phone number using the `p/` parameter, and email using the `e/` parameter and so on (for more details refer to the [`add`](#adding-a-student-add) command). If you're wondering, the text after +`nok/` specifies all the information for his _next-of-kin_, and uses the similar parameters. + +Press enter afterwards to execute the command which adds a student to our TimesTable. + + +3. Next, we can try creating a class! Similar to before, we run the [`addclass`](#adding-a-class-addclass) command. +Type `addclass cn/Sec 4 A Maths ct/FRI 11:30-13:30 r/70 l/Nex Tuition Center` into the command box. +We are adding a class 'Sec 4 A Maths' using the `cn/` parameter, at 11:30am to 1:30pm using the `ct/` parameter, together with the rate and the location. + +Again, press enter to add the class to our TimesTable. + + +4. Oh! Notice that you have been transported to another tab. This is known as the Classes Tab, +which shows you all the information about the Classes you are teaching. + +When we scroll down, you can see that 'Sec 4 A Maths' is added at the bottom. + +5. See that blank space on the right? It is where all the students who are under that class go to. +I will now show you how to add students to a class! Here, we are using the [`addtoclass`](#adding-studentstudents-to-a-class-addtoclass) +command, which takes in the index of the class, followed by the indexes of the students. +Type `addtoclass 13 10` to add the student that you just added (in index 10) to the class that you just added (in index 13). +As shown, you can see the students that are added to the class. How cool is that? + + +6. Continuing on, let me introduce you to the Timetable tab! Here, we are using the [`view`](#viewing-of-different-tabs-view) command. +Type `view timetable` and press enter. + +Here, you can see all the classes that you are teaching in a nice, visual, weekly timetable format! On the first row which is Monday, you can see the 'Sec 4 A Math' class that you just added, with the correct timing. + + +7. Now that you have experienced the core functionality, you are all ready to explore the other commands. +To delete, we have commands like [`delete`](#deleting-a-student--delete) and [`deleteclass`](#delete-a-class-deleteclass) for students and classes respectively, and even commands to [`find`](#locating-students-by-name-findname) and [`sort`](#sorting-students-and-classes-sort) classes and students when you have become more familiar with the app, just refer to the [Features](#features) below for details of each command. +Lastly, if you would like to fill in Timestable with your own students, simply use the [`clear`](#clearing-all-entries--clear) command to delete all the sample students and classes. + + + +## Reading this User Guide +### General Symbols and Syntax + +Syntax | Definition +--------|------------------ +`UPPER_CASE` | Words in `UPPER_CASE` are the inputs to be supplied by the user.
e.g. in `add n/NAME`, `NAME` is an input which can be used as `add n/John Doe`. +`a/` | Signifies a field. The user inputs the field after the signifier. Also known as a parameter. (see [Glossary](#glossary)) +`[a/UPPER_CASE]` | Items in square brackets refer to optional fields.
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or just `n/John Doe`. +`...` | Indicates that the preceding field can be used multiple times.
e.g. `[t/TAG]…` can be used multiple times, such as`t/friend` or `t/friend t/family`. -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +### Glossary - * **`list`** : Lists all contacts. +Term | Definition +--------|------------------ +NOK | Next-of-kin. Refers to the student's guardian, parent or perhaps close friend to be contacted regarding admin matters like payment. +PARAMETERS | The inputs before the `/` are known as _parameters_.
e.g `n/NAME` (`n/` is the parameter for name).
e.g `a/ADDRESS` (`a/` is the parameter for name). +INDEX | The number next to the Student/Class that shows its postion on the list. - * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +
- * **`delete`**`3` : Deletes the 3rd contact shown in the current list. + - * **`clear`** : Deletes all contacts. +## Features - * **`exit`** : Exits the app. +
:bulb: **Tip:** Parameters can be in any order.
+ e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +
-1. Refer to the [Features](#features) below for details of each command.
---------------------------------------------------------------------------------------------------------------------
+### Student commands
-## Features
+#### Adding a student: `add`
++ e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +
-
+Adds a student to the TimesTable.
-**:information_source: Notes about the command format:**
+Format: +`add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… nok/ n/NOK_NAME p/NOK_PHONE_NUMBER e/NOK_EMAIL a/NOK_ADDRESS` -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +* This is a command that requires next-of-kin (NOK) information. +* This command is split into two segments (excluding command keyword). The first segment are the inputs before + `nok/` and the second segment are the inputs after `nok/`. + * Inputs in the first segment are about student information whereas inputs in the second segment are about NOK's information. +* The order of input within its own segment is swappable, but the segments themselves are not. +* The command does not allow adding duplicate students - as defined as the student having the same name, ignoring case. +* `NAME` can have a maximum of 120 characters. +* `PHONE_NUMBER` has to be between 3-25 numbers. +* `TAG` can have a maximum of 15 characters per tag. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. + -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +Examples: -* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.
- e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. +1. `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/ALevels nok/ n/Mary Doe p/93334848 e/mary23@gmail.com a/311, Clementi Ave 2, #02-25` +Adds a student with `NAME` `John Doe`, `PHONE` `98765432`, `EMAIL` `johnd@example.com`, `ADDRESS` `John street, block 123, #01-01`, `TAG` `ALevels`, with next-of-kin with `NAME` `Mary Doe`, `PHONE` `93334848`, `EMAIL` `mary23@gmail.com`, `ADDRESS` `311, Clementi Ave 2, #02-25` -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +2. `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/slow learner nok/ n/Karen e/karenSUper@gmail.com p/99994444 a/311, Clementi Ave 2, #02-25` + Adds a student with `NAME` `Betsy Crowe `, `PHONE` `1234567 `, `EMAIL` `betsycrowe@example.com`, `ADDRESS` `Newgate Prison `, `TAG` `friend`, with next-of-kin with `NAME` `Karen`, `PHONE` `99994444 `, `EMAIL` `karenSUper@gmail.com `, `ADDRESS` `311, Clementi Ave 2, #02-25` -
+ 
++Format: +`add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… nok/ n/NOK_NAME p/NOK_PHONE_NUMBER e/NOK_EMAIL a/NOK_ADDRESS` -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +* This is a command that requires next-of-kin (NOK) information. +* This command is split into two segments (excluding command keyword). The first segment are the inputs before + `nok/` and the second segment are the inputs after `nok/`. + * Inputs in the first segment are about student information whereas inputs in the second segment are about NOK's information. +* The order of input within its own segment is swappable, but the segments themselves are not. +* The command does not allow adding duplicate students - as defined as the student having the same name, ignoring case. +* `NAME` can have a maximum of 120 characters. +* `PHONE_NUMBER` has to be between 3-25 numbers. +* `TAG` can have a maximum of 15 characters per tag. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +
:bulb: **Tip:**
+A student can have 0 to 5 tags.
+
-* Items with `…` after them can be used multiple times including zero times.- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. + -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +Examples: -* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.
- e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. +1. `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/ALevels nok/ n/Mary Doe p/93334848 e/mary23@gmail.com a/311, Clementi Ave 2, #02-25` +Adds a student with `NAME` `John Doe`, `PHONE` `98765432`, `EMAIL` `johnd@example.com`, `ADDRESS` `John street, block 123, #01-01`, `TAG` `ALevels`, with next-of-kin with `NAME` `Mary Doe`, `PHONE` `93334848`, `EMAIL` `mary23@gmail.com`, `ADDRESS` `311, Clementi Ave 2, #02-25` -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +2. `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/slow learner nok/ n/Karen e/karenSUper@gmail.com p/99994444 a/311, Clementi Ave 2, #02-25` + Adds a student with `NAME` `Betsy Crowe `, `PHONE` `1234567 `, `EMAIL` `betsycrowe@example.com`, `ADDRESS` `Newgate Prison `, `TAG` `friend`, with next-of-kin with `NAME` `Karen`, `PHONE` `99994444 `, `EMAIL` `karenSUper@gmail.com `, `ADDRESS` `311, Clementi Ave 2, #02-25` -
+Example 1: Add John Doe +
-### Viewing help : `help` + -Shows a message explaning how to access the help page. +#### Editing a student : `edit` +- +Edits an existing student in the TimesTable. -Format: `help` +Format: +`edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [nok/ [n/NOK_NAME] [p/NOK_PHONE] [e/NOK_EMAIL] [a/NOK_ADDRESS]]` +` + +* Edits the student at the specified `INDEX`. The index refers to the index number shown in the displayed student + list. The index **must be a positive integer** 1, 2, 3, … +* At least one of the optional fields must be provided. +* An optional `nok/` (next-of-kin) field can be provided to edit the student's next-of-kin (NOK). All fields that come after `nok/` + will be for the student's next-of-kin. (same rule from `add` command applies) + * If `nok/` is provided, at least one of the optional fields belonging to NOK must be provided. + * Inputs in the first segment are about student information whereas inputs in the second segment are about NOK's information. +* The order of input within its own segment is swappable, but the segments themselves are not. +* When editing tags, the existing tags of the student will be removed i.e adding of tags is not cumulative. + * You can remove all the student's tags by typing `t/` without + specifying any tags after it. +* `NAME` can have a maximum of 120 characters. +* `PHONE_NUMBER` has to be between 3-25 numbers. +* `TAG` can have a maximum of 15 characters per tag, with a maximum of 5 tags. + +Examples (editing student information only): +1. `edit 1 p/91234567 e/johndoe@example.com` Edits the `PHONE` and `EMAIL` of the 1st student to be `91234567` and `johndoe@example.com` respectively. +2. `edit 2 n/Betsy Crower t/` Edits the `NAME` of the 2nd student to be `Betsy Crower` and clears all existing `TAG`s. +3. `edit 1 n/kevin p/12345678` Edits the `NAME` and `PHONE` of student 1 to become `kevin` and `12345678`. +4. `edit 4 n/John Walker a/4 Petir Road #16-04 Singapore 657891` Edits the `NAME` and `ADDRESS` of the 4th person to be + `John Walker` and `4 Petir Road #16-04 Singapore 657891` respectively. + + +
+Example 1: Edit Student 1 +
+ +Examples (also editing nok information): +1. `edit 2 nok/ p/98429239` Edits 2nd student's NOK's `PHONE` to be `98429239`. +2. `edit 3 a/Com2 nok/ p/98429239` Edits 3rd student's `ADDRESS` to be `Com2` while also editing + NOK's `PHONE` to be `98429239`. + + ++Example 1: Edit Student 2 with next-of-kin information +
+ + + +#### Locating students by name: `findname` ++ +Finds students whose `NAME` contain any of the given keywords. +Note that if you want to display the entire list of students again, run `list`. + +Format: +`findname NAME [, [NAME]...]` + +* The search is case-insensitive. e.g. `hans` will match `Hans`. +* The search terms are split by commas. e.g. `findname alex lim, bernice yu` +* Only the student's `NAME` is searched. +* Partial matches will still be matched e.g. `Han` will match `Hans`. +* Persons matching at least one search term will be returned (i.e. `OR` search). + e.g. `findname alex lim, bernice yu` will return `Alex Lim`, `Bernice Yu`. +* The entire search term is used for matching e.g. `findname Alex L` will match `Alex Lim` + but not `Alex Yu` + + +Examples: +1. `findname John` returns `john` and `John Doe` in both `Students` and `Classes` tab. +2. `findname alex, david` returns `Alex Yeoh`, `David Li` in both `Students` and `Classes` tab.
-### Adding a person: `add` + +
+Example 1: Find Students with name John +
-Adds a person to the address book. +
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
+**:information_source: Note:**
-
+ +Finds students whose `TAG`s contain any of the given keywords. +Note that if you want to display the entire list of students again, run `list`. + +Format: +`findtag KEYWORD [, [KEYWORD]...]` + +* Search terms can partially match the tag, or the entire tag, e.g. `math` for all `A Math` and `C Math` tags, or `A Math` for the `A Math` tag. +* Search terms are separated by commas. e.g. `findtag math, physics` will find students + with tags containing `math` or `physics`. +* Students matching at least one search term will be returned (i.e. `OR` search). + e.g. `findtag math, physics` will return students with the `Math` `TAG` but no `Physics` `TAG`, + students with only the`Physics` `TAG` but no `Math` `TAG`, and students with both `TAG`s. +* The search is case-insensitive. e.g `math` will match `Math`. + Examples: -* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` -* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` +1. `findtag math` returns `Alex Yeoh` with the `A Math` `TAG` and `John Doe` with the `C Math` `TAG` in both `Students` and `Classes` tab. +2. `findtag math, physics` returns `Alex Yeoh` with the `A Math` and `Biology` `TAG`s in both `Students` and `Classes` tab. +
+ + +
+ +Shows a list of all students in the Students tab. Format: `list` -### Editing a person : `edit` + + + + + +#### Deleting a student : `delete` +
+ +Deletes the specified student from the TimesTable. + +Format: +`delete INDEX` +* Deletes the student at the specified `INDEX`. +* The index refers to the index number shown in the displayed student list in the `Students` tab. + +Examples: +1. `list` followed by `delete 2` deletes the 2nd student in the TimesTable. +2. `findname Betsy` followed by `delete 1` deletes the 1st student in the results of the `find` command. + + +
+ +Add a class to the TimesTable. + +Format: +`addclass cn/CLASS_NAME ct/CLASS_TIMING r/HOURLY_RATE l/LOCATION` + +* This command adds a new class to keep track of all classes that the user is teaching. +* `CLASS_TIMING` must be in the form `ct/DAY HH:MM-HH:MM` +* `DAY` is case insensitive. +* `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* `RATE` must be less than $1,000,000/hr + +Examples: +1. `addclass cn/CS2103T ct/MON 09:30-11:30 r/70 l/Nex Tuition Center` +Adds a new class with name `CS2103T`, with class timing `MON 09:30-11:30`, with hourly rate of $`70`, at `Nex +Tuition Center`. + +2. `addclass cn/Sec 4 E Maths ct/TUE 12:30-14:30 r/65 l/Block 123, Clementi Ave 6, #14-41` +Adds a new class with name `Sec 4 E Maths`, with class timing `Tue 12:30-14:30`, with hourly rate of $`65`, at `Block 123, Clementi Ave 6, #14-41`. + + +
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` +Edits an existing class in the class list in the `classes` tab. -* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … +Format: +`editclass 1 [cn/CLASS_NAME] [ct/CLASS_TIMING] [r/RATE] [l/LOCATION]` + +* Edits the class at the specified `INDEX`. The index refers to the index number shown in the displayed class + list in the `classes` tab. + * The index **must be a positive integer** 1, 2, 3, … + * The index must belong to a class. * At least one of the optional fields must be provided. -* Existing values will be updated to the input values. -* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. -* You can remove all the person’s tags by typing `t/` without - specifying any tags after it. +* `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* Edit commands that will create a clash of `CLASS_TIMING` with other classes is not accepted. +* `RATE` must be less than $1,000,000/hr + + + +Examples: +1. `editclass 1 ct/wed 15:00-17:00` Edits the first class in the class list's `CLASS_TIMIMG` to be on Wednesday from +3pm to 5pm. + + +
+ +Add a single or multiple students to an existing class. + +Format: +`addtoclass CLASS_INDEX STUDENT_INDEX...` + +* This command adds any number of existing students into an existing class. +* `CLASS_INDEX` is the index number of the class in the displayed class list in the `Classes` tab, which will be + receiving the new students. +* `STUDENT_INDEX...` are the index number/s of the students shown in the displayed student list in the `Students` tab, these students are + to be added into the class. +* Exactly one class index must be provided and at least one student index must be provided. +* Students that already exist in the class can't be added to the same class. +* If you enter duplicate student indices in one command, Timestable will only add the student once. +* Size of the class will change to reflect the number of students in the class. + + + +Example: +1. `addtoclass 13 1 2 3` +Adds the 1st, 2nd and 3rd student in the displayed student list in the `Students` tab into the 13th class in the +displayed class list in the `Classes` tab, `size` of the class will increase by 3. + + +
+ +Removes a single or multiple students from an existing class. + +Format: +`removefromclass CLASS_INDEX STUDENT_INDEX...` + +* Removes a non-zero number of existing students from an existing class. +* `CLASS_INDEX` is the index number of the class in the displayed class list in the `Classes` tab to have its students removed from. +* `STUDENT_INDEX...` are the index number(s) of the students, shown in the displayed student list of the class to be removed from + in the `Classes` tab. + + +Example: +1. `removefromclass 13 1 2 3` +Removes the 1st, 2nd and 3rd student in the displayed student list of the 13th class in the `classes` tab, causing the +`size` of 1st class to decrease by 3. + + +
+ +Finds a class whose `CLASS_TIMING` matches the given keyword. +Note that if you want to display the list of classes again, run `listclass`. + +Format: `findclass CLASS_TIMING` + + +* The valid keywords for `CLASS_TIMING` are limited to the following types: + 1. 3 letter abbreviation for day of the week e.g. `Mon`, `Tue`, etc. + 2. Time expressed in HH:MM-HH:MM format e.g. `11:30-12:30`, `15:00-16:00`, etc. + * `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* Either a single keyword or two keywords of different types should be provided otherwise no classes would be returned. +* Multiple keywords of the same type (eg Mon Tue) would not return any classes, because the command finds classes which contain both timings (Mon and Tue), and + it is currently not possible to have a class with two different timings (ie a class that occurs on both Monday and Tuesday or both `10:00-12:00` and `17:00-19:00`) + * Important clarification: In TimesTable, class refers to a single slot per week in the timetable. +* If two keywords are entered, then the class returned would be the one that match all the keywords + (see example below). + + +Examples: +1. Single keyword + 1.1. `findclass mon` returns all classes on Monday. + 1.2. `findclass 10:00-12:00` returns all classes scheduled for `10:00 to 12:00` no matter which day of the week it belongs + to. +
+ +Finds a class whose class name matches the given keywords. +Note that if you want to display the list of classes again, run `listclass`. + +Format: +`findclassname CLASS_NAME [, [CLASS_NAME]...]` + +* The search is case-insensitive `PHYSICS` will match 'physics'. +* The search terms are split by commas. e.g. `findclassname sec 4 physics, jc math` +* Only the class' `CLASS_NAME` is searched. +* Partial matches will still be matched e.g. `Phy` will match `Physics`. +* Classes matching at least one search term will be returned (i.e. `OR` search). + e.g. `findclassname sec 4 phy, jc math` will return `sec 4 physics`, `jc mathematics`. +* The entire search term is used for matching e.g. `findclassname sec 4 phy` will match `sec 4 physics` + but not `sec 4 maths` + +Examples: +1. `findclassname math` returns all the classes with math in the class name. +2. `findclassname Sec, 4, maths` returns all the classes with `sec` or `4` or `maths` in the class name. Hence, + class with name `sec 4 physics` and class with name `JC maths` would both be returned. + + +
+ +Shows a list of all classes in the Classes tab. + +Format: `listclass` + + + + + +#### Selecting of classes: `class` +
+ +Selects a class in the Classes tab and displays its students without the need to use the mouse to double click the respective class. + +Format: +`class CLASS_INDEX` + +* Selected class will not be highlighted in the same way as when you click on a class using the mouse. +* `CLASS_INDEX` must be an index of a class that exists in the displayed class list. Examples: -* `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. -* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. +* `class 1` selects the class with `CLASS_INDEX` of `1` and displays its students in the Classes tab. + + -### Locating persons by name: `find` + -Finds persons whose names contain any of the given keywords. +#### Delete a class: `deleteclass` +
-Format: `find KEYWORD [MORE_KEYWORDS]` +Deletes the specified class from the TimesTable. -* The search is case-insensitive. e.g `hans` will match `Hans` -* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` -* Only the name is searched. -* Only full words will be matched e.g. `Han` will not match `Hans` -* Persons matching at least one keyword will be returned (i.e. `OR` search). - e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` +Format: +`deleteclass INDEX` + +* Deletes the class at the specified `INDEX`. +* The index refers to the index number shown in the displayed class list in the `Classes` tab. Examples: -* `find John` returns `john` and `John Doe` -* `find alex david` returns `Alex Yeoh`, `David Li`
-  +* `listclass` followed by `deleteclass 2` deletes the 2nd class in the TimesTable. + + + + + +### General commands + +#### Sorting students and classes: `sort` +
+ +Sorts the students based on their `NAME` in alphabetical order, +or classes based on their `CLASS_TIMING`, in either ascending or descending order. + +Format: +`sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT` + +* `PARAMETER_TO_SORT_BY` can either be `name` or `timing` which sorts the students and classes respectively. +* `DIRECTION_OF_SORT` can either be `asc` or `desc` to represent ascending and descending respectively. +* Sorting by `name` sorts the students in the Students tab and Classes tab but sorting by `timing` only sorts the classes in Classes tab but not the students in Students tab. + +Examples: +1. `sort name asc` sorts students alphabetically by their `NAME` in ascending order. +2. `sort name desc` sorts students alphabetically by their `NAME` in descending order. +3. `sort timing asc` sorts classes based on their `CLASS_TIMING` starting from the earliest in the week to the latest. +4. `sort timing desc` sorts classes based on their `CLASS_TIMING` starting from the latest in the week to the earliest. + + +
-Format: `delete INDEX` +Views an existing tab in the TimesTable without the need to use the mouse to click. -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +Format: +`view TAB_TO_VIEW` + +* `TAB_TO_VIEW` has to be an existing tab in Timestable (`students`, `classes`, `timetable`). Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +1. `view timetable` switches the displayed tab to be the `timetable` tab. + + -### Clearing all entries : `clear` +#### Clearing all entries : `clear` +
-Clears all entries from the address book. +Clears all entries from the TimesTable. Format: `clear` -### Exiting the program : `exit` + + +#### Viewing help : `help` +
+ +Shows a message explaining how to access the help page. + +Format: `help` + + + +#### Exiting the program : `exit` +
Exits the program. Format: `exit` -### Saving the data +#### Saving the data +
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +TimesTable data is saved in the hard disk automatically in the `data` folder present in the same directory as `timestable.jar` after any command that changes the data. There is no need to save manually. -### Editing the data file +#### Editing the data file +
-AddressBook data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +TimesTable data are saved as a JSON file `[JAR file location]/data/timestable.json`. Advanced users are welcome to update data directly by editing that data file.
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Timestable home folder. + +**Q**: Are you going to add XXX feature? What features are you planning to add?
+**A**: I'm glad you asked! We're currently planning to add the following features: + + + +### Upcoming Features: + +#### Payment Management with Invoice + +Different classes you teach will have different hourly rates, and they will of course have varying lengths and frequencies. +Having to keep track of how much someone has to pay and whether they have paid is a major source of stress. + +We recognise this demand, and thus are working on this feature for you to easily track required payments to students. + +A work in progress sneak peak of the feature is shown below. + + + +After a class, just input the time taught for that class and mark the attendance of those present. + +For each student present, TimesTable will take the hourly rate multiplied by the +session length for each person present to calculate the amount that each student has to pay. + +The session length field is useful when the class length goes beyond the intended length or when the class cuts short. + +This information will then be consolidated in an invoice to be generated. + +When you want to generate a new invoice, simply use the 'createinvoice' command. Invoices will be generated for all +students of the selected class. These invoices will use the session attendances recorded since the last invoice, generating +a table with the relevant information such as session date, session length, hourly rate, student name, and so on. You will +also be able to set the due date for the invoice. + +An example of the invoice generated is shown below. + + + +With this invoice generation feature, you will easily be able to charge the correct amount to your clients +and you would also not have to worry about providing evidence. TimesTable will take care of it for you. + +In addition to invoice generation, we are also working on an invoice management feature that will allow you to track +the status of each invoice. You will be able to mark the invoices as paid, and archive them. TimesTable will also +alert you once the due date for any invoice has passed. You can simply let TimesTable keep track of all payments for you. + + +If there are any other proposed features, please submit an issue via our GitHub over [here](https://github.com/AY2122S1-CS2103T-F11-1/tp/issues) and we'll look into it! -------------------------------------------------------------------------------------------------------------------- + ## Command summary -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +### Student Commands Summary + +Action | Format, Examples| +--------|------------------| +**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… nok/ n/NOK_NAME p/NOK_PHONE_NUMBER e/NOK_EMAIL a/NOK_ADDRESS`
e.g., `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/ALevels nok/ n/Mary Doe p/93334848 e/mary23@gmail.com a/311, Clementi Ave 2, #02-25 `| +**Delete** | `delete INDEX`
e.g., `delete 3`| +**Edit** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [nok/ [n/NOK_NAME] [p/NOK_PHONE] [e/NOK_EMAIL] [a/NOK_ADDRESS]]`
e.g.,`edit 2 n/James Lee e/jameslee@example.com`| +**Find name** | `findname NAME [, [NAME]...]`
e.g., `find Stuart`| +**Find tag** | `findtag KEYWORD [, [KEYWORD]...]`
e.g., `findtag math, physics`| +**List** | `list`| +**Sort** | `sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT`
e.g., `sort name asc`| + + + +### Class Commands Summary + +Action | Format, Examples| +--------|------------------| +**Add class** | `addclass cn/CLASS_NAME ct/CLASS_TIMING r/HOURLY_RATE l/LOCATION`
e.g., `addclass cn/Sec 4 A Maths ct/mon 11:30-13:30 r/70 l/Nex Tuition Center`| +**Add to class** | `addtoclass CLASS_INDEX STUDENT_INDEX…`
e.g., `addtoclass 1 1 2 3`| +**Delete class** | `deleteclass INDEX`
e.g., `deleteclass 2`| +**Edit class** | `editclass 1 [cn/CLASS_NAME] [ct/CLASS_TIMING] [r/RATE] [l/LOCATION]`
e.g., `editclass 1 ct/wed 15:00-17:00`| +**Find class name** | `findclassname CLASS_NAME [, [CLASS_NAME]...]`
e.g., `findclassname math`| +**Find class timing** | `findclass CLASS_TIMING`
e.g., `findclass mon 11:00-12:00`| +**List class** | `listclass`| +**Remove from class** | `removefromclass CLASS_INDEX STUDENT_INDEX...`
e.g., `removefromclass 1 1 2 3`| +**Select class** | `class CLASS_INDEX`
e.g., `class 2`| +**Sort** | `sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT`
e.g., `sort timing asc`| + + + +### General Commands Summary + +Action | Format, Examples| +--------|------------------| +**Clear** | `clear`| +**Exit** | `exit`| +**Help** | `help`| +**View** | `view TAB_TO_VIEW`
e.g., `view timetable`| + diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..e8033f05b1d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "TimesTable" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2122S1-CS2103T-F11-1/tp" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss index 0d3f6e80ced..75676f22a40 100644 --- a/docs/_sass/minima/_base.scss +++ b/docs/_sass/minima/_base.scss @@ -288,7 +288,7 @@ table { text-align: center; } .site-header:before { - content: "AB-3"; + content: "TimesTable"; font-size: 32px; } } diff --git a/docs/diagrams/AddClassModelSequenceDiagram.puml b/docs/diagrams/AddClassModelSequenceDiagram.puml new file mode 100644 index 00000000000..dbcba75a96a --- /dev/null +++ b/docs/diagrams/AddClassModelSequenceDiagram.puml @@ -0,0 +1,29 @@ +@startuml +!include style.puml + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +participant ":TimesTable" as TimesTable MODEL_COLOR_T3 +participant ":UniqueClassList" as UniqueClassList MODEL_COLOR_T3 +participant "internalList:ObservableArrayList" as ObservableArrayList MODEL_COLOR_T3 +end box + +[-> Model : addTuitionClass(t) +activate Model + +Model -> TimesTable : addTuitionClass(t) +activate TimesTable + +TimesTable -> UniqueClassList : add(t) +activate UniqueClassList + +UniqueClassList -> UniqueClassList : isValidTiming(t) +activate UniqueClassList +UniqueClassList --> UniqueClassList +deactivate UniqueClassList + +UniqueClassList -> ObservableArrayList : add(t) +activate ObservableArrayList + + +@enduml diff --git a/docs/diagrams/AddClassRef1.puml b/docs/diagrams/AddClassRef1.puml new file mode 100644 index 00000000000..f4d47533b93 --- /dev/null +++ b/docs/diagrams/AddClassRef1.puml @@ -0,0 +1,31 @@ +@startuml +!include style.puml + +group sd generate StudentNameList and TuitionClass + +box Logic LOGIC_COLOR_T1 +participant ":AddClassCommandParser" as AddClassCommandParser LOGIC_COLOR +participant "s:StudentNameList" as StudentNameList LOGIC_COLOR +participant "t:TuitionClass" as TuitionClass LOGIC_COLOR +end box + +activate AddClassCommandParser +create StudentNameList +AddClassCommandParser -> StudentNameList : StudentNameList() +activate StudentNameList + +StudentNameList --> AddClassCommandParser : s +deactivate StudentNameList + +create TuitionClass +AddClassCommandParser -> TuitionClass : TuitionClass(className, classTiming, location, rate, s) +activate TuitionClass + +TuitionClass --> AddClassCommandParser : t +deactivate TuitionClass + + + + +end +@enduml diff --git a/docs/diagrams/AddClassSequenceDiagram.puml b/docs/diagrams/AddClassSequenceDiagram.puml new file mode 100644 index 00000000000..62f2578b557 --- /dev/null +++ b/docs/diagrams/AddClassSequenceDiagram.puml @@ -0,0 +1,71 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR +participant ":AddClassCommandParser" as AddClassCommandParser LOGIC_COLOR +participant "a:AddClassCommand" as AddClassCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("addclass cn/... ct/... r/.. l/...") +activate LogicManager + +LogicManager -> TimesTableParser : parseCommand("addclass cn/... ct/... r/.. l/...") +activate TimesTableParser + +create AddClassCommandParser +TimesTableParser -> AddClassCommandParser +activate AddClassCommandParser + +AddClassCommandParser --> TimesTableParser +deactivate AddClassCommandParser + +TimesTableParser -> AddClassCommandParser : parse("cn/... ct/... r/.. l/...") +activate AddClassCommandParser + +ref over AddClassCommandParser : generate StudentNameList and TuitionClass + +create AddClassCommand +AddClassCommandParser -> AddClassCommand : AddClassCommand(t) +activate AddClassCommand + +AddClassCommand --> AddClassCommandParser : a +deactivate AddClassCommand + +AddClassCommandParser --> TimesTableParser : a +deactivate AddClassCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +AddClassCommandParser -[hidden]-> TimesTableParser +destroy AddClassCommandParser + +TimesTableParser --> LogicManager : a +deactivate TimesTableParser + +LogicManager -> AddClassCommand : execute() +activate AddClassCommand + +AddClassCommand -> Model : addTuitionClass(t) +activate Model +deactivate Model + + + +create CommandResult +AddClassCommand -> CommandResult +activate CommandResult + +CommandResult --> AddClassCommand +deactivate CommandResult + +AddClassCommand --> LogicManager : result +deactivate AddClassCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddToClassCreationSequenceDiagram.puml b/docs/diagrams/AddToClassCreationSequenceDiagram.puml new file mode 100644 index 00000000000..89c2d021b4e --- /dev/null +++ b/docs/diagrams/AddToClassCreationSequenceDiagram.puml @@ -0,0 +1,55 @@ +@startuml +!include Style.puml + +box Logic LOGIC_COLOR_T1 + +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR +participant ":AddToClassCommandParser" as AddToClassCommandParser LOGIC_COLOR +participant "c:AddToClassCommand" as AddToClassCommand LOGIC_COLOR +participant "result:CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +-> LogicManager: execute("addtoclass 1 1") +activate LogicManager +LogicManager -> TimesTableParser: parseCommand("addtoclass 1 1") +activate TimesTableParser +create AddToClassCommandParser +TimesTableParser -> AddToClassCommandParser +activate AddToClassCommandParser +TimesTableParser <-- AddToClassCommandParser +deactivate AddToClassCommandParser +TimesTableParser -> AddToClassCommandParser: parse("1 1") +activate AddToClassCommandParser +create AddToClassCommand +AddToClassCommandParser -> AddToClassCommand: AddToClassCommand(indexArray) +activate AddToClassCommand +AddToClassCommandParser <-- AddToClassCommand: c +deactivate AddToClassCommand +TimesTableParser <-- AddToClassCommandParser: c +deactivate AddToClassCommandParser +LogicManager <-- TimesTableParser: c +deactivate TimesTableParser + +LogicManager -> AddToClassCommand: execute() +activate AddToClassCommand +ref over AddToClassCommand, Model : Match Student and Class Indices to their objects. Create updated Name list. +AddToClassCommand -> Model: setClass(classToAddTo, editedClass) +activate Model +AddToClassCommand <-- Model +deactivate Model +create CommandResult +AddToClassCommand -> CommandResult +activate CommandResult +AddToClassCommand <-- CommandResult +deactivate CommandResult +LogicManager <-- AddToClassCommand: result +deactivate AddToClassCommand +<-- LogicManager: result +deactivate LogicManager + +@enduml diff --git a/docs/diagrams/AddToClassExecutionSequenceDiagram.puml b/docs/diagrams/AddToClassExecutionSequenceDiagram.puml new file mode 100644 index 00000000000..b38adbaa8e4 --- /dev/null +++ b/docs/diagrams/AddToClassExecutionSequenceDiagram.puml @@ -0,0 +1,89 @@ +@startuml +!include Style.puml + +box Logic LOGIC_COLOR_T1 +participant ":AddToClassCommand" as AddToClassCommand LOGIC_COLOR +participant "result:CommandResult" as CommandResult LOGIC_COLOR +end box +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +participant "classList:ObservableList" as tuitionClassList MODEL_COLOR
+participant "c1:TuitionClass" as TuitionClass MODEL_COLOR
+participant "studentList:ObservableList" as studentList MODEL_COLOR
+participant "c2:TuitionClass" as newTuitionClass MODEL_COLOR
+participant "sn:StudentNameList" as newStudentNameList MODEL_COLOR
+end box
+
+[-> AddToClassCommand: execute()
+activate AddToClassCommand
+
+AddToClassCommand -> Model: getFilteredStudentList()
+activate Model
+Model -> studentList: Get student list
+activate studentList
+Model <-- studentList: studentList
+deactivate
+AddToClassCommand <-- Model: studentList
+deactivate Model
+
+AddToClassCommand -> Model: getFilteredTuitionClassList()
+activate Model
+Model -> tuitionClassList: Get class list
+activate tuitionClassList
+Model <-- tuitionClassList: classList
+deactivate
+AddToClassCommand <-- Model: classList
+deactivate Model
+
+AddToClassCommand -> AddToClassCommand ++: checkIndicesAreValid(studentList, classList)
+AddToClassCommand --> AddToClassCommand --
+
+AddToClassCommand -> AddToClassCommand ++: createNameList(studentIndices, studentList)
+AddToClassCommand --> AddToClassCommand --: namesToAdd
+
+AddToClassCommand -> tuitionClassList: get(classIndex)
+activate tuitionClassList
+tuitionClassList -> TuitionClass: Get tuition class
+activate TuitionClass
+tuitionClassList <-- TuitionClass: c1
+deactivate
+AddToClassCommand <-- tuitionClassList: c1
+deactivate tuitionClassList
+
+AddToClassCommand -> TuitionClass: getStudentList()
+activate TuitionClass
+AddToClassCommand <-- TuitionClass: nameList
+deactivate
+
+create newStudentNameList
+AddToClassCommand -> newStudentNameList : StudentNameList()
+activate newStudentNameList
+newStudentNameList --> AddToClassCommand
+deactivate newStudentNameList
+AddToClassCommand -> newStudentNameList : addAll(nameList)
+activate newStudentNameList
+newStudentNameList --> AddToClassCommand : updatedNameList
+deactivate newStudentNameList
+AddToClassCommand -> newStudentNameList : addAll(namesToAdd)
+activate newStudentNameList
+newStudentNameList --> AddToClassCommand : updatedNameList
+deactivate newStudentNameList
+
+create newTuitionClass
+AddToClassCommand -> newTuitionClass ++ :Create new tuition class with updatedNameList
+AddToClassCommand <-- newTuitionClass -- : c2
+
+
+AddToClassCommand -> Model: setClass(c1, c2)
+activate Model
+AddToClassCommand <-- Model
+deactivate Model
+create CommandResult
+AddToClassCommand -> CommandResult
+activate CommandResult
+AddToClassCommand <-- CommandResult
+deactivate CommandResult
+[<-- AddToClassCommand: result
+deactivate AddToClassCommand
+
+@enduml
diff --git a/docs/diagrams/AddToClassRef1.puml b/docs/diagrams/AddToClassRef1.puml
new file mode 100644
index 00000000000..2c1960b1724
--- /dev/null
+++ b/docs/diagrams/AddToClassRef1.puml
@@ -0,0 +1,45 @@
+@startuml
+!include style.puml
+
+group sd generate updated StudentNameList
+
+box Logic LOGIC_COLOR_T1
+participant ":AddToClass" as AddToClass LOGIC_COLOR
+participant ":StudentNameList" as updatedNameList LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "lastShownTuitionClassList:FilteredList" as FilteredClass MODEL_COLOR
+participant "classToAddTo:TuitionClass" as classToAddTo MODEL_COLOR
+end box
+
+activate AddToClass
+
+AddToClass -> AddToClass : createNameList(...)
+activate AddToClass
+return namesToAdd
+
+AddToClass -> FilteredClass : get(...)
+activate FilteredClass
+return classToAddTo
+
+AddToClass -> classToAddTo : getStudentList()
+activate classToAddTo
+return currentStudentNameList
+
+
+create updatedNameList
+AddToClass -> updatedNameList : StudentNameList()
+activate updatedNameList
+return
+
+AddToClass -> updatedNameList : addAll(currentStudentNameList)
+activate updatedNameList
+return
+
+AddToClass -> updatedNameList : addAll(namesToAdd)
+activate updatedNameList
+return
+
+end
+@enduml
diff --git a/docs/diagrams/AddToClassRef2.puml b/docs/diagrams/AddToClassRef2.puml
new file mode 100644
index 00000000000..9338d27c23a
--- /dev/null
+++ b/docs/diagrams/AddToClassRef2.puml
@@ -0,0 +1,28 @@
+@startuml
+!include style.puml
+
+group sd generate updated TuitionClass
+
+box Logic LOGIC_COLOR_T1
+participant ":AddToClass" as AddToClass LOGIC_COLOR
+participant ":EditClassDescriptor" as descriptor LOGIC_COLOR
+participant ":EditClassCommand" as EditClassCommand <> LOGIC_COLOR
+end box
+
+create descriptor
+AddToClass -> descriptor : EditClassDescriptor()
+activate descriptor
+
+return
+
+
+AddToClass -> descriptor : setStudentList(updatedStudentNameList)
+activate descriptor
+return
+
+AddToClass -> EditClassCommand : createEditedClass(classToAddTo, editClassDescriptor)
+activate EditClassCommand
+return editedClass
+
+end
+@enduml
diff --git a/docs/diagrams/AddToClassSequenceDiagram.puml b/docs/diagrams/AddToClassSequenceDiagram.puml
new file mode 100644
index 00000000000..e7774e6ab78
--- /dev/null
+++ b/docs/diagrams/AddToClassSequenceDiagram.puml
@@ -0,0 +1,42 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddToClass" as AddToClass LOGIC_COLOR
+'participant ":EditClassDescriptor" as descripter LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":ModelManager" as ModelManager MODEL_COLOR
+'participant "lastShownTuitionClassList:FilteredList" as FilteredClass MODEL_COLOR
+end box
+
+[-> LogicManager : execute("addtoclass 1 1")
+activate LogicManager
+
+LogicManager -> AddToClass : execute()
+activate AddToClass
+
+AddToClass -> ModelManager : getFilteredStudentList()
+AddToClass <-- ModelManager
+AddToClass -> ModelManager : getFilteredClassList()
+AddToClass <-- ModelManager
+AddToClass -> AddToClass : checkIndicesAreInRange()
+activate AddToClass
+AddToClass --> AddToClass
+deactivate
+
+ref over AddToClass, ModelManager : generate updated StudentNameList
+
+ref over AddToClass, ModelManager : generate updated TuitionClass
+
+AddToClass -> ModelManager : setClass(classToAdd, editedClass)
+AddToClass <-- ModelManager
+
+return
+
+[<--LogicManager
+deactivate LogicManager
+
+@enduml
diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml
index ef81d18c337..eb4062823bc 100644
--- a/docs/diagrams/ArchitectureSequenceDiagram.puml
+++ b/docs/diagrams/ArchitectureSequenceDiagram.puml
@@ -13,13 +13,13 @@ activate ui UI_COLOR
ui -[UI_COLOR]> logic : execute("delete 1")
activate logic LOGIC_COLOR
-logic -[LOGIC_COLOR]> model : deletePerson(p)
+logic -[LOGIC_COLOR]> model : deleteStudent(s)
activate model MODEL_COLOR
model -[MODEL_COLOR]-> logic
deactivate model
-logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook)
+logic -[LOGIC_COLOR]> storage : saveTimesTable(timesTable)
activate storage STORAGE_COLOR
storage -[STORAGE_COLOR]> storage : Save to file
diff --git a/docs/diagrams/BuildTimetableDayActivityDiagram.puml b/docs/diagrams/BuildTimetableDayActivityDiagram.puml
new file mode 100644
index 00000000000..2a8a6562aea
--- /dev/null
+++ b/docs/diagrams/BuildTimetableDayActivityDiagram.puml
@@ -0,0 +1,19 @@
+@startuml
+title: Activity: Build TimetableDay
+start
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Mon";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Tue";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Wed";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Thu";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Fri";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Sat";
+:Increase row index by 1;
+:Build TimetableDay at\nthe left (column index 0)\nlabelled "Sun";
+
+stop
+@enduml
diff --git a/docs/diagrams/BuildTimetableHeaderActivityDiagram.puml b/docs/diagrams/BuildTimetableHeaderActivityDiagram.puml
new file mode 100644
index 00000000000..70483239510
--- /dev/null
+++ b/docs/diagrams/BuildTimetableHeaderActivityDiagram.puml
@@ -0,0 +1,22 @@
+@startuml
+title: Activity: Build TimetableHeader
+start
+:Build TimetableHeaderLabel at\ntop left (row index = 0 and\ncolumn index = 0) labelled "Time Slots";
+
+:Find earliest start hour and latest end hour ****;
+
+while () is ([earliest start hour\n< latest end hour])
+ if () then ([earliest start hour == 23:30])
+ :Add new TimetableHeaderTiming\nfrom earliest start hour to \nearliest start hour + 29 mins;
+ :Break out of while loop,\ngo to else portion of the loop;
+ else ([else])
+ :Add new TimetableHeaderTiming\nfrom earliest start hour to \nearliest start hour + 30 mins;
+ :Increase earliest start hour by 30mins;
+ endif
+endwhile ([else])
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+
+stop
+@enduml
diff --git a/docs/diagrams/BuildTimetableOverallDiagram.puml b/docs/diagrams/BuildTimetableOverallDiagram.puml
new file mode 100644
index 00000000000..e5cafa8dd16
--- /dev/null
+++ b/docs/diagrams/BuildTimetableOverallDiagram.puml
@@ -0,0 +1,18 @@
+@startuml
+start
+
+:Clear Displayed Timetable;
+
+:Build TimetableHeader ****;
+
+:Build TimetableDay ****;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([Number of TuitionClasses > 0])
+ :Build TimetableTuitionClassSlots ****;
+else ([else])
+endif
+stop
+@enduml
diff --git a/docs/diagrams/BuildTimetableTuitionClassSlotsActivityDiagram.puml b/docs/diagrams/BuildTimetableTuitionClassSlotsActivityDiagram.puml
new file mode 100644
index 00000000000..fab50ac803f
--- /dev/null
+++ b/docs/diagrams/BuildTimetableTuitionClassSlotsActivityDiagram.puml
@@ -0,0 +1,34 @@
+@startuml
+title: Activity: Build TimetableTuitionClassSlots
+start
+:Sort tuitionClasses based on their class timings\nstarting from the earliest;
+:Find earliest start hour and latest end hour ****;
+:Store the earliest start hour in a variable called\n'previousTime' which will act as a pointer to the end\nof the latest TuitionClassSlot we built up to;
+:int i = 0;;
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+while () is ([i < TuitionClasses.size()])
+:Get tuitionClass at index i;
+ if () then ([tuitionClass at index i's\nstart time != previousTime])
+ :Add empty slot from\npreviousTime to the\nstart time of the tuitionClass;
+
+
+ else ([else])
+ endif
+
+ :Add TimetableTuitionClassSlot from start\ntime to end time of tuitionClass at index i;
+ if () then ([tuitionClass at index i + 1\nis not on the same day as tuitionClass\nat index i])
+ :previousTime = Earliest start hour;
+
+ else ([else])
+ :previousTime = end time of tuitionClass at index i;
+ endif
+:i++;;
+
+endwhile ([else])
+
+
+
+
+stop
+@enduml
diff --git a/docs/diagrams/ClassPanelDiagram.puml b/docs/diagrams/ClassPanelDiagram.puml
new file mode 100644
index 00000000000..bbcf9c725b8
--- /dev/null
+++ b/docs/diagrams/ClassPanelDiagram.puml
@@ -0,0 +1,37 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor UI_COLOR_T4
+skinparam classBackgroundColor UI_COLOR
+
+package ClassesUi <>{
+Class ClassPanel
+Class StudentClassPanel
+Class StudentClassTabCard
+Class TuitionClassPanel
+Class TuitionClassCard
+}
+
+package Model <> {
+Class Student
+Class TuitionClass
+}
+
+Class "{abstract}\nUiPart" as UiPart
+
+Class MainWindow
+MainWindow *--> "1" ClassPanel
+ClassPanel -down-> "1" StudentClassPanel
+ClassPanel -down-> "1" TuitionClassPanel
+StudentClassPanel -down-> "*" StudentClassTabCard
+TuitionClassPanel -down-> "*" TuitionClassCard
+StudentClassTabCard ..> Student
+TuitionClassCard ..> TuitionClass
+
+ClassPanel --|> UiPart
+StudentClassPanel --|> UiPart
+TuitionClassPanel --|> UiPart
+StudentClassTabCard --|> UiPart
+TuitionClassCard --|> UiPart
+
+@enduml
diff --git a/docs/diagrams/ClassesUiSequenceDiagram.puml b/docs/diagrams/ClassesUiSequenceDiagram.puml
new file mode 100644
index 00000000000..db0faf4fc74
--- /dev/null
+++ b/docs/diagrams/ClassesUiSequenceDiagram.puml
@@ -0,0 +1,105 @@
+@startuml
+!include style.puml
+
+skinparam ParticipantPadding -2
+box MainWindow UI_COLOR_T1
+participant ":MainWindow" as MainWindow UI_COLOR
+end box
+
+box ClassesUi UI_COLOR_T1
+participant ":ClassPanel" as ClassPanel UI_COLOR_T3
+participant ":Student\nClassPanel" as StudentClassPanel UI_COLOR_T3
+participant ":Tuition\nClassPanel" as TuitionClassPanel UI_COLOR_T3
+participant ":StudentList\nClassTabViewCell" as StudentListClassTabViewCell UI_COLOR_T3
+participant ":Student\nClassTabCard" as StudentClassTabCard UI_COLOR_T3
+participant ":Tuition\nClassListViewCell" as TuitionClassListViewCell UI_COLOR_T3
+participant ":Tuition\nClassCard" as TuitionClassCard UI_COLOR_T3
+participant ":Filtered\nStudentList" as FilteredStudentList UI_COLOR_T3
+end box
+
+[-> MainWindow : fillInnerParts()
+activate MainWindow
+
+create FilteredStudentList
+
+create ClassPanel
+MainWindow -> ClassPanel : new ClassPanel\n(List,\nList)
+activate ClassPanel
+
+create StudentClassPanel
+ClassPanel -> StudentClassPanel : new StudentClassPanel\n(studentList)
+activate StudentClassPanel
+
+loop for every student
+create StudentListClassTabViewCell
+StudentClassPanel -> StudentListClassTabViewCell
+activate StudentListClassTabViewCell
+
+create StudentClassTabCard
+StudentListClassTabViewCell -> StudentClassTabCard
+activate StudentClassTabCard
+StudentClassTabCard --> StudentListClassTabViewCell
+deactivate StudentClassTabCard
+StudentListClassTabViewCell --> StudentClassPanel
+
+deactivate StudentListClassTabViewCell
+
+end
+
+StudentClassPanel --> ClassPanel
+deactivate StudentClassPanel
+
+create TuitionClassPanel
+ClassPanel -> TuitionClassPanel : new TuitionClassPanel\n(studentList, tuitionClassList)
+activate TuitionClassPanel
+
+TuitionClassPanel --> ClassPanel
+
+deactivate TuitionClassPanel
+
+
+ClassPanel -> TuitionClassPanel : setStudentClassList(...)
+activate TuitionClassPanel
+
+
+loop for every class
+
+create TuitionClassListViewCell
+TuitionClassPanel -> TuitionClassListViewCell
+activate TuitionClassListViewCell
+
+
+create TuitionClassCard
+TuitionClassListViewCell -> TuitionClassCard
+activate TuitionClassCard
+
+opt when clicked
+TuitionClassCard -> TuitionClassCard : onMouseClick()
+activate TuitionClassCard
+TuitionClassCard -> TuitionClassCard : selectTuitionClass()
+activate TuitionClassCard
+TuitionClassCard -> FilteredStudentList : filtered(student -> ...)
+activate FilteredStudentList
+FilteredStudentList -> TuitionClassCard
+deactivate FilteredStudentList
+
+
+deactivate TuitionClassCard
+deactivate TuitionClassCard
+end
+
+
+TuitionClassCard --> TuitionClassListViewCell
+deactivate TuitionClassCard
+TuitionClassListViewCell --> TuitionClassPanel
+deactivate TuitionClassListViewCell
+end
+TuitionClassPanel --> ClassPanel
+deactivate TuitionClassPanel
+ClassPanel --> MainWindow
+deactivate ClassPanel
+
+[<--MainWindow
+deactivate MainWindow
+
+@enduml
diff --git a/docs/diagrams/CommandObserverPattern.puml b/docs/diagrams/CommandObserverPattern.puml
new file mode 100644
index 00000000000..972bd2a0da2
--- /dev/null
+++ b/docs/diagrams/CommandObserverPattern.puml
@@ -0,0 +1,26 @@
+ @startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor UI_COLOR_T4
+skinparam classBackgroundColor UI_COLOR
+
+package UI <>{
+Interface Ui <>
+Interface CommandObserver <>
+Class UiManager
+Class MainWindow
+
+}
+
+package Logic <> {
+Class "{abstract}\nCommand" as Command LOGIC_COLOR
+Class XYZCommand LOGIC_COLOR
+}
+
+UiManager .right..|> Ui
+UiManager -down-> "1" MainWindow
+MainWindow .right..|> CommandObserver
+XYZCommand -up-|> Command LOGIC_COLOR_T4
+
+Command --> CommandObserver LOGIC_COLOR_T4 : < Observes
+@enduml
diff --git a/docs/diagrams/DeleteClassRef1.puml b/docs/diagrams/DeleteClassRef1.puml
new file mode 100644
index 00000000000..d2a68d5e98b
--- /dev/null
+++ b/docs/diagrams/DeleteClassRef1.puml
@@ -0,0 +1,46 @@
+@startuml
+!include style.puml
+
+group sd get TuitionClass to delete and delete from model
+
+box Logic LOGIC_COLOR_T1
+participant "d:DeleteClassCommand" as DeleteClassCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+participant ":TimesTable" as TimesTable MODEL_COLOR
+participant ":UniqueClassList" as UniqueClassList MODEL_COLOR
+participant "internalList:ObservableList" as internalList MODEL_COLOR
+end box
+
+activate DeleteClassCommand
+
+DeleteClassCommand -> Model : getFilteredTuitionClassList()
+activate Model
+
+
+
+Model --> DeleteClassCommand : classList
+deactivate Model
+
+DeleteClassCommand -> DeleteClassCommand : classList.get(index)
+activate DeleteClassCommand
+DeleteClassCommand --> DeleteClassCommand : tuitionclass
+deactivate DeleteClassCommand
+
+DeleteClassCommand -> Model : deleteTuitionClass(tuitionclass)
+activate Model
+Model -> TimesTable : deleteTuitionClass(tuitionclass)
+activate TimesTable
+TimesTable -> UniqueClassList : delete(tuitionclass)
+activate UniqueClassList
+UniqueClassList -> internalList : remove(tuitionclass)
+activate internalList
+deactivate internalList
+deactivate UniqueClassList
+deactivate TimesTable
+deactivate Model
+
+end
+@enduml
diff --git a/docs/diagrams/DeleteClassSequenceDiagram.puml b/docs/diagrams/DeleteClassSequenceDiagram.puml
new file mode 100644
index 00000000000..7b068c32e47
--- /dev/null
+++ b/docs/diagrams/DeleteClassSequenceDiagram.puml
@@ -0,0 +1,67 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR
+participant ":DeleteClassCommandParser" as DeleteClassCommandParser LOGIC_COLOR
+participant "d:DeleteClassCommand" as DeleteClassCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("deleteclass 1")
+activate LogicManager
+
+LogicManager -> TimesTableParser : parseCommand("deleteclass 1")
+activate TimesTableParser
+
+create DeleteClassCommandParser
+TimesTableParser -> DeleteClassCommandParser
+activate DeleteClassCommandParser
+
+DeleteClassCommandParser --> TimesTableParser
+deactivate DeleteClassCommandParser
+
+TimesTableParser -> DeleteClassCommandParser : parse("1")
+activate DeleteClassCommandParser
+
+create DeleteClassCommand
+DeleteClassCommandParser -> DeleteClassCommand
+activate DeleteClassCommand
+
+DeleteClassCommand --> DeleteClassCommandParser : d
+deactivate DeleteClassCommand
+
+DeleteClassCommandParser --> TimesTableParser : d
+deactivate DeleteClassCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+DeleteClassCommandParser -[hidden]-> TimesTableParser
+destroy DeleteClassCommandParser
+
+TimesTableParser --> LogicManager : d
+deactivate TimesTableParser
+
+LogicManager -> DeleteClassCommand : execute()
+activate DeleteClassCommand
+
+ref over DeleteClassCommand, Model : get TuitionClass to delete and delete from model
+
+
+
+create CommandResult
+DeleteClassCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> DeleteClassCommand
+deactivate CommandResult
+
+DeleteClassCommand --> LogicManager : result
+deactivate DeleteClassCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/DeleteSequenceDiagram.puml b/docs/diagrams/DeleteSequenceDiagram.puml
index 1dc2311b245..5149acd09c9 100644
--- a/docs/diagrams/DeleteSequenceDiagram.puml
+++ b/docs/diagrams/DeleteSequenceDiagram.puml
@@ -3,7 +3,7 @@
box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
-participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR
participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR
participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
@@ -16,17 +16,17 @@ end box
[-> LogicManager : execute("delete 1")
activate LogicManager
-LogicManager -> AddressBookParser : parseCommand("delete 1")
-activate AddressBookParser
+LogicManager -> TimesTableParser : parseCommand("delete 1")
+activate TimesTableParser
create DeleteCommandParser
-AddressBookParser -> DeleteCommandParser
+TimesTableParser -> DeleteCommandParser
activate DeleteCommandParser
-DeleteCommandParser --> AddressBookParser
+DeleteCommandParser --> TimesTableParser
deactivate DeleteCommandParser
-AddressBookParser -> DeleteCommandParser : parse("1")
+TimesTableParser -> DeleteCommandParser : parse("1")
activate DeleteCommandParser
create DeleteCommand
@@ -36,19 +36,19 @@ activate DeleteCommand
DeleteCommand --> DeleteCommandParser : d
deactivate DeleteCommand
-DeleteCommandParser --> AddressBookParser : d
+DeleteCommandParser --> TimesTableParser : d
deactivate DeleteCommandParser
'Hidden arrow to position the destroy marker below the end of the activation bar.
-DeleteCommandParser -[hidden]-> AddressBookParser
+DeleteCommandParser -[hidden]-> TimesTableParser
destroy DeleteCommandParser
-AddressBookParser --> LogicManager : d
-deactivate AddressBookParser
+TimesTableParser --> LogicManager : d
+deactivate TimesTableParser
LogicManager -> DeleteCommand : execute()
activate DeleteCommand
-DeleteCommand -> Model : deletePerson(1)
+DeleteCommand -> Model : deleteStudent(1)
activate Model
Model --> DeleteCommand
diff --git a/docs/diagrams/FindEarliestAndLatestHourActivityDiagram.puml b/docs/diagrams/FindEarliestAndLatestHourActivityDiagram.puml
new file mode 100644
index 00000000000..98cea015ed8
--- /dev/null
+++ b/docs/diagrams/FindEarliestAndLatestHourActivityDiagram.puml
@@ -0,0 +1,17 @@
+@startuml
+title: Activity: Find earliest start hour and latest end hour
+start
+if () then ([Number of TuitionClasses > 0])
+ :Iterate through the list of tuition\nclasses and find the earliest class\nstart timing and round down to\nthe nearest hour;
+ :Set earliest start hour to the earliest class\nstart timing found in the previous step or\nthe default earliest start timing(09:00),\nwhichever is earlier;
+ :Iterate through the list of tuition\nclasses and find the latest class\nend timing and round up to the\nnearest hour;
+ :Set latest end hour to the latest class\nend timing found in the previous step\nor the default latest end timing(18:00),\nwhichever is later;
+
+
+else ([else])
+ :Set earliest start hour\nto default earliest start timing\n(09:00);
+ :Set latest end hour\nto default latest end timing\n(18:00);
+
+endif
+stop
+@enduml
diff --git a/docs/diagrams/FindSequenceDiagram.puml b/docs/diagrams/FindSequenceDiagram.puml
new file mode 100644
index 00000000000..cd84efd403b
--- /dev/null
+++ b/docs/diagrams/FindSequenceDiagram.puml
@@ -0,0 +1,33 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":FindTagCommand" as FindTagCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":ModelManager" as ModelManager MODEL_COLOR
+participant "filteredStudent:FilteredList" as FilteredStudents MODEL_COLOR
+end box
+
+[-> LogicManager : execute("findtag maths")
+activate LogicManager
+
+LogicManager -> FindTagCommand : execute()
+activate FindTagCommand
+
+FindTagCommand -> ModelManager : updateFilteredStudentList(predicate)
+activate ModelManager
+
+ModelManager -> FilteredStudents : setPredicate(predicate)
+activate FilteredStudents
+
+return
+return
+return
+
+[<--LogicManager
+deactivate LogicManager
+
+@enduml
diff --git a/docs/diagrams/LogicClassDiagram.puml b/docs/diagrams/LogicClassDiagram.puml
index 6d14b17b361..2550deee8c2 100644
--- a/docs/diagrams/LogicClassDiagram.puml
+++ b/docs/diagrams/LogicClassDiagram.puml
@@ -6,7 +6,7 @@ skinparam classBackgroundColor LOGIC_COLOR
package Logic {
-Class AddressBookParser
+Class TimesTableParser
Class XYZCommand
Class CommandResult
Class "{abstract}\nCommand" as Command
@@ -23,23 +23,32 @@ Class HiddenModel #FFFFFF
package Storage{
}
+package UI {
+Class HiddenUI #FFFFFF
+}
+
Class HiddenOutside #FFFFFF
HiddenOutside ..> Logic
LogicManager .right.|> Logic
-LogicManager -right->"1" AddressBookParser
-AddressBookParser ..> XYZCommand : creates >
+LogicManager -right->"1" TimesTableParser
+TimesTableParser ..> XYZCommand : creates >
XYZCommand -up-|> Command
LogicManager .left.> Command : executes >
-LogicManager --> Model
+
+LogicManager -right-> Model
LogicManager --> Storage
Storage --[hidden] Model
Command .[hidden]up.> Storage
-Command .right.> Model
+Command .up.> Model
+Command -right-> UI : Observes <
+XYZCommand .down.> UI
note right of XYZCommand: XYZCommand = AddCommand, \nFindCommand, etc
+UI --> Logic
+LogicManager --> UI
Logic ..> CommandResult
LogicManager .down.> CommandResult
Command .up.> CommandResult : produces >
diff --git a/docs/diagrams/MainWindowDiagram.puml b/docs/diagrams/MainWindowDiagram.puml
new file mode 100644
index 00000000000..5685fd4dcb7
--- /dev/null
+++ b/docs/diagrams/MainWindowDiagram.puml
@@ -0,0 +1,74 @@
+ @startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor UI_COLOR_T4
+skinparam classBackgroundColor UI_COLOR
+
+
+'IGNORE THIS FILE FIRST
+package MainWindow <>{
+Class "{abstract}\nUiPart" as UiPart
+Class MainWindow
+Class HelpWindow
+Class ResultDisplay
+Class PersonListPanel
+Class PersonCard
+Class StatusBarFooter
+Class CommandBox
+
+package Timetable <> {
+Class HiddenTimetable #FFFFFF
+}
+
+}
+
+
+Class UiManager
+Interface Ui <>
+Interface CommandObserver <>
+
+package Model <> {
+Class HiddenModel #FFFFFF
+}
+
+package Logic <> {
+Class HiddenLogic #FFFFFF
+}
+
+Class HiddenOutside #FFFFFF
+
+UiManager .right.|> Ui
+UiManager -left-> "1" MainWindow
+
+MainWindow .up.|> CommandObserver
+MainWindow *-up---> "\n\n\n1" Timetable
+MainWindow *-left-> "1" CommandBox
+MainWindow *-down-> "1" ResultDisplay
+MainWindow *-down-> "1" PersonListPanel
+MainWindow *-down-> "1" StatusBarFooter
+MainWindow --> "0..1" HelpWindow
+MainWindow -down-|> UiPart
+
+PersonListPanel -down-> "*" PersonCard
+
+ResultDisplay --|> UiPart
+CommandBox --|> UiPart
+PersonListPanel --|> UiPart
+PersonCard --|> UiPart
+StatusBarFooter --|> UiPart
+HelpWindow --|> UiPart
+Timetable -right-|> UiPart
+
+PersonCard ..> Model
+UiManager -up-> Logic
+MainWindow -right-> Logic
+
+Logic -up-> "*" CommandObserver
+
+PersonListPanel -[hidden]left- HelpWindow
+HelpWindow -[hidden]left- CommandBox
+CommandBox -[hidden]left- ResultDisplay
+ResultDisplay -[hidden]left- StatusBarFooter
+
+MainWindow -[hidden]-|> UiPart
+@enduml
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
index 1122257bd9a..ebf8a299be2 100644
--- a/docs/diagrams/ModelClassDiagram.puml
+++ b/docs/diagrams/ModelClassDiagram.puml
@@ -5,50 +5,48 @@ skinparam arrowColor MODEL_COLOR
skinparam classBackgroundColor MODEL_COLOR
Package Model <>{
-Interface ReadOnlyAddressBook <>
+Interface ReadOnlyTimestable <>
Interface ReadOnlyUserPrefs <>
Interface Model <>
-Class AddressBook
-Class ReadOnlyAddressBook
+Class Timestable
+Class ReadOnlyTimestable
Class Model
Class ModelManager
Class UserPrefs
Class ReadOnlyUserPrefs
+Class UniqueStudentList
+Class UniqueClassList
+
+package TuitionClass <> {
+}
+package Student <> {
+}
+
-Class UniquePersonList
-Class Person
-Class Address
-Class Email
-Class Name
-Class Phone
-Class Tag
}
+
+
Class HiddenOutside #FFFFFF
HiddenOutside ..> Model
-AddressBook .up.|> ReadOnlyAddressBook
+Timestable .up.|> ReadOnlyTimestable
ModelManager .up.|> Model
Model .right.> ReadOnlyUserPrefs
-Model .left.> ReadOnlyAddressBook
-ModelManager -left-> "1" AddressBook
+Model .left.> ReadOnlyTimestable
+ModelManager -left-> "1" Timestable
ModelManager -right-> "1" UserPrefs
UserPrefs .up.|> ReadOnlyUserPrefs
-AddressBook *--> "1" UniquePersonList
-UniquePersonList --> "~* all" Person
-Person *--> Name
-Person *--> Phone
-Person *--> Email
-Person *--> Address
-Person *--> "*" Tag
+Timestable *--> "1" UniqueStudentList
+UniqueStudentList --> "~* all" Student
-Name -[hidden]right-> Phone
-Phone -[hidden]right-> Address
-Address -[hidden]right-> Email
+Timestable *--> "1" UniqueClassList
+UniqueClassList -right-> "~* all" TuitionClass
-ModelManager -->"~* filtered" Person
+ModelManager -->"~* filtered" Student
+ModelManager -->"~* filtered" TuitionClass
@enduml
diff --git a/docs/diagrams/ParserClasses.puml b/docs/diagrams/ParserClasses.puml
index 6ba585cba01..417c687fb31 100644
--- a/docs/diagrams/ParserClasses.puml
+++ b/docs/diagrams/ParserClasses.puml
@@ -9,7 +9,7 @@ Class XYZCommand
package "Parser classes"{
Interface Parser <>
-Class AddressBookParser
+Class TimesTableParser
Class XYZCommandParser
Class CliSyntax
Class ParserUtil
@@ -19,12 +19,12 @@ Class Prefix
}
Class HiddenOutside #FFFFFF
-HiddenOutside ..> AddressBookParser
+HiddenOutside ..> TimesTableParser
-AddressBookParser .down.> XYZCommandParser: creates >
+TimesTableParser .down.> XYZCommandParser: creates >
XYZCommandParser ..> XYZCommand : creates >
-AddressBookParser ..> Command : returns >
+TimesTableParser ..> Command : returns >
XYZCommandParser .up.|> Parser
XYZCommandParser ..> ArgumentMultimap
XYZCommandParser ..> ArgumentTokenizer
diff --git a/docs/diagrams/RemoveFromClassCommandSequenceDiagram.puml b/docs/diagrams/RemoveFromClassCommandSequenceDiagram.puml
new file mode 100644
index 00000000000..0ac0b9fbba3
--- /dev/null
+++ b/docs/diagrams/RemoveFromClassCommandSequenceDiagram.puml
@@ -0,0 +1,68 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+!include Style.puml
+
+
+
+box Logic LOGIC_COLOR_T1
+participant "c:RemoveFromClassCommand" as RemoveFromClassCommand LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+participant "classList:ObservableList" as tuitionClassList MODEL_COLOR
+participant "classToRemoveFrom:TuitionClass" as TuitionClass MODEL_COLOR
+participant "studentList:ObservableList" as studentList MODEL_COLOR
+participant "editedClass:TuitionClass" as newTuitionClass MODEL_COLOR
+end box
+
+activate RemoveFromClassCommand
+
+group sd Match Student and Class Indices to their objects. Create updated Name list.
+RemoveFromClassCommand -> Model: getFilteredTuitionClassList()
+activate Model
+Model -> tuitionClassList: Get class list
+activate tuitionClassList
+Model <-- tuitionClassList: classList
+deactivate
+RemoveFromClassCommand <-- Model: classList
+deactivate Model
+
+RemoveFromClassCommand -> tuitionClassList: get(classIndex)
+activate tuitionClassList
+tuitionClassList -> TuitionClass: Get tuition class
+activate TuitionClass
+tuitionClassList <-- TuitionClass: classToRemoveFrom
+deactivate
+RemoveFromClassCommand <-- tuitionClassList: classToRemoveFrom
+deactivate tuitionClassList
+
+RemoveFromClassCommand -> TuitionClass: getStudentList()
+activate TuitionClass
+RemoveFromClassCommand <-- TuitionClass: nameList
+deactivate
+
+RemoveFromClassCommand -> Model: getFilteredStudentList()
+activate Model
+Model -> studentList: Get student list
+activate studentList
+Model <-- studentList: studentList
+deactivate
+RemoveFromClassCommand <-- Model: studentList
+deactivate Model
+
+RemoveFromClassCommand -> RemoveFromClassCommand ++: checkIndicesAreValid(studentIndices, studentList)
+RemoveFromClassCommand --> RemoveFromClassCommand --
+
+RemoveFromClassCommand -> RemoveFromClassCommand ++: createNewNameList(studentIndices, studentList)
+RemoveFromClassCommand --> RemoveFromClassCommand --: newNameList
+
+create newTuitionClass
+RemoveFromClassCommand -> newTuitionClass ++ :Create new tuition class with newNameList
+
+
+RemoveFromClassCommand <-- newTuitionClass -- : editedClass
+
+end
+@enduml
diff --git a/docs/diagrams/RemoveFromClassOverviewDiagram.puml b/docs/diagrams/RemoveFromClassOverviewDiagram.puml
new file mode 100644
index 00000000000..dc32966a891
--- /dev/null
+++ b/docs/diagrams/RemoveFromClassOverviewDiagram.puml
@@ -0,0 +1,59 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+!include Style.puml
+
+box Logic LOGIC_COLOR_T1
+
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR
+participant ":RemoveFromClassCommandParser" as RemoveFromClassCommandParser LOGIC_COLOR
+participant "c:RemoveFromClassCommand" as RemoveFromClassCommand LOGIC_COLOR
+participant "result:CommandResult" as CommandResult LOGIC_COLOR
+end box
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+-> LogicManager: execute("removefromclass 1 1")
+activate LogicManager
+LogicManager -> TimesTableParser: parseCommand("removefromclass 1 1")
+activate TimesTableParser
+create RemoveFromClassCommandParser
+TimesTableParser -> RemoveFromClassCommandParser
+activate RemoveFromClassCommandParser
+TimesTableParser <-- RemoveFromClassCommandParser
+deactivate RemoveFromClassCommandParser
+TimesTableParser -> RemoveFromClassCommandParser: parse("1 1")
+activate RemoveFromClassCommandParser
+create RemoveFromClassCommand
+RemoveFromClassCommandParser -> RemoveFromClassCommand: RemoveFromClassCommand(indexArray)
+activate RemoveFromClassCommand
+RemoveFromClassCommandParser <-- RemoveFromClassCommand: c
+deactivate RemoveFromClassCommand
+TimesTableParser <-- RemoveFromClassCommandParser: c
+deactivate RemoveFromClassCommandParser
+RemoveFromClassCommandParser -[hidden]-> TimesTableParser
+destroy RemoveFromClassCommandParser
+LogicManager <-- TimesTableParser: c
+deactivate TimesTableParser
+
+LogicManager -> RemoveFromClassCommand: execute()
+activate RemoveFromClassCommand
+ref over RemoveFromClassCommand, Model : Match Student and Class Indices to their objects. Create updated Name list.
+RemoveFromClassCommand -> Model: setClass(classToRemoveFrom, editedClass)
+activate Model
+RemoveFromClassCommand <-- Model
+deactivate Model
+create CommandResult
+RemoveFromClassCommand -> CommandResult
+activate CommandResult
+RemoveFromClassCommand <-- CommandResult
+deactivate CommandResult
+LogicManager <-- RemoveFromClassCommand: result
+deactivate RemoveFromClassCommand
+<-- LogicManager: result
+deactivate LogicManager
+
+
+@enduml
diff --git a/docs/diagrams/SortSequenceDiagram.puml b/docs/diagrams/SortSequenceDiagram.puml
new file mode 100644
index 00000000000..f401d47f8df
--- /dev/null
+++ b/docs/diagrams/SortSequenceDiagram.puml
@@ -0,0 +1,85 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR
+participant ":SortCommandParser" as SortCommandParser LOGIC_COLOR
+participant "s:SortCommand" as SortCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+box UI UI_COLOR_T1
+participant "mainWindow:CommandObserver" as CommandObserver UI_COLOR
+end box
+
+[-> LogicManager : execute("sort name asc")
+activate LogicManager
+
+LogicManager -> TimesTableParser : parseCommand("sort name asc")
+activate TimesTableParser
+
+create SortCommandParser
+TimesTableParser -> SortCommandParser
+activate SortCommandParser
+
+SortCommandParser --> TimesTableParser
+deactivate SortCommandParser
+
+TimesTableParser -> SortCommandParser : parse("name asc")
+activate SortCommandParser
+
+create SortCommand
+SortCommandParser -> SortCommand
+activate SortCommand
+
+SortCommand --> SortCommandParser : s
+deactivate SortCommand
+
+SortCommandParser --> TimesTableParser : s
+deactivate SortCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+SortCommandParser -[hidden]-> TimesTableParser
+destroy SortCommandParser
+
+TimesTableParser --> LogicManager : s
+deactivate TimesTableParser
+
+LogicManager -> SortCommand : execute()
+activate SortCommand
+
+SortCommand -> Model : sortStudents()
+activate Model
+
+Model --> SortCommand
+deactivate Model
+
+SortCommand -> CommandObserver : updateView(STUDENTS)
+activate CommandObserver
+
+CommandObserver --> SortCommand
+deactivate CommandObserver
+
+create CommandResult
+SortCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> SortCommand
+deactivate CommandResult
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+'CommandResult -[hidden]-> TimesTableParser
+'destroy CommandResult
+
+SortCommand --> LogicManager : result
+deactivate SortCommand
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+'SortCommandParser -[hidden]-> TimesTableParser
+'destroy SortCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/StorageClassDiagramWTuitionClass.puml b/docs/diagrams/StorageClassDiagramWTuitionClass.puml
new file mode 100644
index 00000000000..6e10bab1080
--- /dev/null
+++ b/docs/diagrams/StorageClassDiagramWTuitionClass.puml
@@ -0,0 +1,46 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor STORAGE_COLOR
+skinparam classBackgroundColor STORAGE_COLOR
+
+package Storage{
+
+package "UserPrefs Storage" #F4F6F6{
+Interface UserPrefsStorage <>
+Class JsonUserPrefsStorage
+}
+
+Interface Storage <>
+Class StorageManager
+
+package "TimesTable Storage" #F4F6F6{
+Interface TimesTableStorage <>
+Class JsonTimesTableStorage
+Class JsonSerializableTimesTable
+Class JsonAdaptedStudent
+Class JsonAdaptedTag
+Class JsonAdaptedTuitionClass
+Class JsonAdaptedNok
+}
+
+}
+
+Class HiddenOutside #FFFFFF
+HiddenOutside ..> Storage
+
+StorageManager .up.|> Storage
+StorageManager -up-> "1" UserPrefsStorage
+StorageManager -up-> "1" TimesTableStorage
+
+Storage -left-|> UserPrefsStorage
+Storage -right-|> TimesTableStorage
+
+JsonUserPrefsStorage .up.|> UserPrefsStorage
+JsonTimesTableStorage .up.|> TimesTableStorage
+JsonTimesTableStorage ..> JsonSerializableTimesTable
+JsonSerializableTimesTable --> "*" JsonAdaptedStudent
+JsonSerializableTimesTable --> "*" JsonAdaptedTuitionClass
+JsonAdaptedStudent --> "*" JsonAdaptedTag
+JsonAdaptedStudent --> "1" JsonAdaptedNok
+@enduml
diff --git a/docs/diagrams/StudentModelClassDiagram.puml b/docs/diagrams/StudentModelClassDiagram.puml
new file mode 100644
index 00000000000..36f3e51ab54
--- /dev/null
+++ b/docs/diagrams/StudentModelClassDiagram.puml
@@ -0,0 +1,40 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package Student <>{
+
+Class Person
+Class Student
+Class Address
+Class Email
+Class Name
+Class Phone
+Class Tag
+Class NOK
+
+}
+
+Class HiddenOutside #FFFFFF
+HiddenOutside ...> " * all"Student
+HiddenOutside ...> " * filtered"Student
+
+Person <|-up- Student
+Person <|-right- NOK
+
+Person *--> "1" Name
+Person *--> "1" Phone
+Person *--> "1" Email
+Person *--> "1" Address
+Student *-right-> "*" Tag
+Student *--> "1" NOK
+
+
+Name -[hidden]right-> Phone
+Phone -[hidden]right-> Address
+Address -[hidden]right-> Email
+
+
+@enduml
diff --git a/docs/diagrams/StudentsDiagram.puml b/docs/diagrams/StudentsDiagram.puml
new file mode 100644
index 00000000000..a804b08318f
--- /dev/null
+++ b/docs/diagrams/StudentsDiagram.puml
@@ -0,0 +1,27 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor UI_COLOR_T4
+skinparam classBackgroundColor UI_COLOR
+
+package StudentsUi <>{
+Class StudentListPanel
+Class StudentCard
+}
+
+package Model <> {
+Class HiddenModel #FFFFFF
+}
+
+Class "{abstract}\nUiPart" as UiPart
+
+Class MainWindow
+MainWindow *--> "1" StudentListPanel
+StudentListPanel --> "*" StudentCard
+StudentListPanel --|> UiPart
+StudentCard .right.> Model
+StudentCard --|> UiPart
+
+
+
+@enduml
diff --git a/docs/diagrams/TimetableDiagram.puml b/docs/diagrams/TimetableDiagram.puml
new file mode 100644
index 00000000000..6f7971a27a6
--- /dev/null
+++ b/docs/diagrams/TimetableDiagram.puml
@@ -0,0 +1,45 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor UI_COLOR_T4
+skinparam classBackgroundColor UI_COLOR
+
+package TimetableUi <>{
+Class TimetablePanel
+Class TimetableDay
+Class TimetableEmptySlot
+Class TimetableHeader
+Class TimetableRegion
+Class TimetableTuitionClassSlot
+Class TimetableHeaderTiming
+Class TimetableHeaderLabel
+}
+
+package Model <> {
+Class HiddenModel #FFFFFF
+}
+
+Class "{abstract}\nUiPart" as UiPart
+
+Class MainWindow
+MainWindow *--> "1" TimetablePanel
+TimetablePanel *--> "7" TimetableDay
+TimetablePanel *--> "*" TimetableEmptySlot
+TimetablePanel *--> "18...48" TimetableHeaderTiming
+TimetablePanel *--> "1" TimetableHeaderLabel
+TimetablePanel *--> "*" TimetableTuitionClassSlot
+
+TimetableHeaderLabel -down-|> TimetableHeader
+TimetableHeaderTiming -down-|> TimetableHeader
+
+TimetableDay --|> TimetableRegion
+TimetableEmptySlot --|> TimetableRegion
+TimetableHeader --|> TimetableRegion
+TimetableTuitionClassSlot --|> TimetableRegion
+
+TimetableRegion --|> UiPart
+TimetablePanel --|> UiPart
+
+TimetablePanel .right.> Model
+
+@enduml
diff --git a/docs/diagrams/TimetableUiDaySequenceDiagram.puml b/docs/diagrams/TimetableUiDaySequenceDiagram.puml
new file mode 100644
index 00000000000..37ea54accc3
--- /dev/null
+++ b/docs/diagrams/TimetableUiDaySequenceDiagram.puml
@@ -0,0 +1,33 @@
+@startuml
+!include style.puml
+
+
+box TimetableUi UI_COLOR_T1
+participant ":TimetablePanel" as TimetablePanel UI_COLOR_T3
+participant ":TimetableDay" as TimetableDay UI_COLOR_T3
+end box
+
+
+create TimetablePanel
+[-[hidden]-> TimetablePanel
+activate TimetablePanel
+
+group sd buildDays
+TimetablePanel -> TimetablePanel : buildDays()
+activate TimetablePanel
+
+loop 7 times (Mon to Sun)
+create TimetableDay
+TimetablePanel -> TimetableDay
+activate TimetableDay
+TimetableDay --> TimetablePanel
+deactivate TimetableDay
+end
+
+
+TimetablePanel --> TimetablePanel
+deactivate TimetablePanel
+end
+
+
+@enduml
diff --git a/docs/diagrams/TimetableUiHeaderSequenceDiagram.puml b/docs/diagrams/TimetableUiHeaderSequenceDiagram.puml
new file mode 100644
index 00000000000..ddb4d0f795e
--- /dev/null
+++ b/docs/diagrams/TimetableUiHeaderSequenceDiagram.puml
@@ -0,0 +1,40 @@
+@startuml
+!include style.puml
+
+
+box TimetableUi UI_COLOR_T1
+participant ":TimetablePanel" as TimetablePanel UI_COLOR_T3
+participant ":TimetableHeaderLabel" as TimetableHeaderLabel UI_COLOR_T3
+participant ":TimetableHeaderTiming" as TimetableHeaderTiming UI_COLOR_T3
+end box
+
+
+create TimetablePanel
+[-[hidden]-> TimetablePanel
+activate TimetablePanel
+
+group sd buildHeader
+TimetablePanel -> TimetablePanel : buildHeader(List)
+activate TimetablePanel
+
+create TimetableHeaderLabel
+TimetablePanel -> TimetableHeaderLabel
+activate TimetableHeaderLabel
+TimetableHeaderLabel --> TimetablePanel
+deactivate TimetableHeaderLabel
+
+loop For every 30 mins from start to end time of List
+create TimetableHeaderTiming
+TimetablePanel -> TimetableHeaderTiming
+activate TimetableHeaderTiming
+TimetableHeaderTiming --> TimetablePanel
+deactivate TimetableHeaderTiming
+end
+
+
+TimetablePanel --> TimetablePanel
+deactivate TimetablePanel
+end
+
+
+@enduml
diff --git a/docs/diagrams/TimetableUiSequenceDiagram.puml b/docs/diagrams/TimetableUiSequenceDiagram.puml
new file mode 100644
index 00000000000..7a19f55f68e
--- /dev/null
+++ b/docs/diagrams/TimetableUiSequenceDiagram.puml
@@ -0,0 +1,38 @@
+@startuml
+!include style.puml
+
+
+box MainWindow UI_COLOR_T1
+participant ":MainWindow" as MainWindow UI_COLOR
+end box
+
+box TimetableUi UI_COLOR_T1
+participant ":TimetablePanel" as TimetablePanel UI_COLOR_T3
+end box
+
+[-> MainWindow : fillInnerParts()
+activate MainWindow
+
+create TimetablePanel
+MainWindow -> TimetablePanel : new TimetablePanel(List)
+activate TimetablePanel
+
+TimetablePanel -> TimetablePanel : build()
+activate TimetablePanel
+
+ref over TimetablePanel, TimetablePanel: buildHeader
+
+ref over TimetablePanel, TimetablePanel: buildDays
+
+opt UI_COLOR_T1 has classes
+ref over TimetablePanel, TimetablePanel: buildClasses
+
+end
+
+TimetablePanel --> TimetablePanel
+deactivate TimetablePanel
+
+TimetablePanel --> MainWindow
+[<-- MainWindow
+deactivate MainWindow
+@enduml
diff --git a/docs/diagrams/TimetableUiSlotSequenceDiagram.puml b/docs/diagrams/TimetableUiSlotSequenceDiagram.puml
new file mode 100644
index 00000000000..d6c0625ba19
--- /dev/null
+++ b/docs/diagrams/TimetableUiSlotSequenceDiagram.puml
@@ -0,0 +1,43 @@
+@startuml
+!include style.puml
+
+
+box TimetableUi UI_COLOR_T1
+participant ":TimetablePanel" as TimetablePanel UI_COLOR_T3
+participant ":TimetableTuitionClassSlot" as TimetableTuitionClassSlot UI_COLOR_T3
+participant ":TimetableEmptySlot" as TimetableEmptySlot UI_COLOR_T3
+end box
+
+
+create TimetablePanel
+[-[hidden]-> TimetablePanel
+activate TimetablePanel
+
+group sd buildClasses
+TimetablePanel -> TimetablePanel : buildClasses(List)
+activate TimetablePanel
+
+loop Until end of List
+
+opt Free time in between this and previous class
+create TimetableEmptySlot
+TimetablePanel -> TimetableEmptySlot
+activate TimetableEmptySlot
+TimetableEmptySlot --> TimetablePanel
+deactivate TimetableEmptySlot
+end
+
+create TimetableTuitionClassSlot
+TimetablePanel -> TimetableTuitionClassSlot
+activate TimetableTuitionClassSlot
+TimetableTuitionClassSlot --> TimetablePanel
+deactivate TimetableTuitionClassSlot
+end
+
+
+TimetablePanel --> TimetablePanel
+deactivate TimetablePanel
+end
+
+
+@enduml
diff --git a/docs/diagrams/TuitionClassModelClassDiagram.puml b/docs/diagrams/TuitionClassModelClassDiagram.puml
new file mode 100644
index 00000000000..856c4e8c9a4
--- /dev/null
+++ b/docs/diagrams/TuitionClassModelClassDiagram.puml
@@ -0,0 +1,27 @@
+@startuml
+!include style.puml
+skinparam arrowThickness 1.1
+skinparam arrowColor MODEL_COLOR
+skinparam classBackgroundColor MODEL_COLOR
+
+Package TuitionClass <>{
+
+Class TuitionClass
+Class ClassName
+Class ClassTiming
+Class Rate
+Class Location
+Class StudentNameList
+
+}
+
+Class HiddenOutside #FFFFFF
+HiddenOutside ...> " * all"TuitionClass
+HiddenOutside ...> " * filtered"TuitionClass
+
+TuitionClass *--> "1" ClassName
+TuitionClass *--> "1" ClassTiming
+TuitionClass *--> "1" Rate
+TuitionClass *--> "1" Location
+TuitionClass *--> "1" StudentNameList
+@enduml
diff --git a/docs/diagrams/UiClassDiagram.puml b/docs/diagrams/UiClassDiagram.puml
index ecae4876432..1cd89a61bbc 100644
--- a/docs/diagrams/UiClassDiagram.puml
+++ b/docs/diagrams/UiClassDiagram.puml
@@ -1,4 +1,4 @@
-@startuml
+ @startuml
!include style.puml
skinparam arrowThickness 1.1
skinparam arrowColor UI_COLOR_T4
@@ -6,17 +6,28 @@ skinparam classBackgroundColor UI_COLOR
package UI <>{
Interface Ui <>
+Interface CommandObserver <>
Class "{abstract}\nUiPart" as UiPart
Class UiManager
Class MainWindow
Class HelpWindow
Class ResultDisplay
-Class PersonListPanel
-Class PersonCard
+'Class StudentListPanel
+'Class StudentCard
Class StatusBarFooter
Class CommandBox
+Enum TabName <>
+
+package TimetableUi <> {
+}
+
+package ClassesUi <> {
}
+package StudentsUi <> {
+}
+
+}
package Model <> {
Class HiddenModel #FFFFFF
}
@@ -28,33 +39,48 @@ Class HiddenLogic #FFFFFF
Class HiddenOutside #FFFFFF
HiddenOutside ..> Ui
-UiManager .left.|> Ui
+UiManager .right.|> Ui
UiManager -down-> "1" MainWindow
+MainWindow .right.|> CommandObserver
MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
-MainWindow *-down-> "1" PersonListPanel
-MainWindow *-down-> "1" StatusBarFooter
-MainWindow --> "0..1" HelpWindow
-
-PersonListPanel -down-> "*" PersonCard
+MainWindow -down-> "0..1" HelpWindow
-MainWindow -left-|> UiPart
+'MainWindow *-down-> "1" StudentListPanel
+MainWindow *-down-> "1" TimetableUi
+MainWindow *-down-> "1" ClassesUi
+MainWindow *-down-> "1" StudentsUi
+MainWindow *-down-> "1" StatusBarFooter
+'StudentListPanel -down-> "*" StudentCard
+MainWindow -down-|> UiPart
ResultDisplay --|> UiPart
CommandBox --|> UiPart
-PersonListPanel --|> UiPart
-PersonCard --|> UiPart
+'StudentListPanel --|> UiPart
+'StudentCard --|> UiPart
+ClassesUi --|> UiPart
+TimetableUi --|> UiPart
+StudentsUi --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart
-PersonCard ..> Model
-UiManager -right-> Logic
-MainWindow -left-> Logic
+'StudentCard .right.> Model
+UiManager -up-> Logic
+MainWindow -up-> Logic
-PersonListPanel -[hidden]left- HelpWindow
+Logic ---down-> CommandObserver : < Observes
+Logic .down.> TabName
+
+TimetableUi .up.> Model
+ClassesUi .up.> Model
+StudentsUi .up.> Model
+
+'StudentListPanel -[hidden]left- HelpWindow
HelpWindow -[hidden]left- CommandBox
CommandBox -[hidden]left- ResultDisplay
ResultDisplay -[hidden]left- StatusBarFooter
MainWindow -[hidden]-|> UiPart
+
+MainWindow .right.> TabName
@enduml
diff --git a/docs/diagrams/ViewSequenceDiagram.puml b/docs/diagrams/ViewSequenceDiagram.puml
new file mode 100644
index 00000000000..e5f6a75a007
--- /dev/null
+++ b/docs/diagrams/ViewSequenceDiagram.puml
@@ -0,0 +1,75 @@
+@startuml
+!include style.puml
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR
+participant ":ViewCommandParser" as ViewCommandParser LOGIC_COLOR
+participant "v:ViewCommand" as ViewCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box UI UI_COLOR_T1
+participant "mainWindow:CommandObserver" as CommandObserver UI_COLOR
+end box
+
+[-> LogicManager : execute("view timetable")
+activate LogicManager
+
+LogicManager -> TimesTableParser : parseCommand("view timetable")
+activate TimesTableParser
+
+create ViewCommandParser
+TimesTableParser -> ViewCommandParser
+activate ViewCommandParser
+
+ViewCommandParser --> TimesTableParser
+deactivate ViewCommandParser
+
+TimesTableParser -> ViewCommandParser : parse("timetable")
+activate ViewCommandParser
+
+create ViewCommand
+ViewCommandParser -> ViewCommand
+activate ViewCommand
+
+ViewCommand --> ViewCommandParser : v
+deactivate ViewCommand
+
+ViewCommandParser --> TimesTableParser : v
+deactivate ViewCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+ViewCommandParser -[hidden]-> TimesTableParser
+destroy ViewCommandParser
+
+TimesTableParser --> LogicManager : v
+deactivate TimesTableParser
+
+LogicManager -> ViewCommand : execute()
+activate ViewCommand
+
+ViewCommand -> CommandObserver : updateView(TIMETABLE)
+activate CommandObserver
+
+CommandObserver --> ViewCommand
+deactivate CommandObserver
+
+create CommandResult
+ViewCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> ViewCommand
+deactivate CommandResult
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+'CommandResult -[hidden]-> TimesTableParser
+'destroy CommandResult
+
+ViewCommand --> LogicManager : result
+deactivate ViewCommand
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+'ViewCommand -[hidden]-> TimesTableParser
+'destroy ViewCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/plantuml/FindXYZ.puml b/docs/diagrams/plantuml/FindXYZ.puml
new file mode 100644
index 00000000000..26aac77b3a3
--- /dev/null
+++ b/docs/diagrams/plantuml/FindXYZ.puml
@@ -0,0 +1,11 @@
+@startuml
+":Logic" -> ":FindTagCommand" : execute()
+activate ":FindTagCommand"
+":FindTagCommand" -> ":Model" : updateFilteredPersonList(predicate)
+activate ":Model"
+":Model" -> "filteredStudents:FilteredList" : setPredicate(predicate)
+activate "filteredStudents:FilteredList"
+return
+return
+return
+@enduml
diff --git a/docs/images/AddClassModelSequenceDiagram.png b/docs/images/AddClassModelSequenceDiagram.png
new file mode 100644
index 00000000000..7f084df7182
Binary files /dev/null and b/docs/images/AddClassModelSequenceDiagram.png differ
diff --git a/docs/images/AddClassRef1.png b/docs/images/AddClassRef1.png
new file mode 100644
index 00000000000..27b7a330a0a
Binary files /dev/null and b/docs/images/AddClassRef1.png differ
diff --git a/docs/images/AddClassSequenceDiagram.png b/docs/images/AddClassSequenceDiagram.png
new file mode 100644
index 00000000000..279ff975b01
Binary files /dev/null and b/docs/images/AddClassSequenceDiagram.png differ
diff --git a/docs/images/AddToClassCreationSequenceDiagram.png b/docs/images/AddToClassCreationSequenceDiagram.png
new file mode 100644
index 00000000000..c9564cbd225
Binary files /dev/null and b/docs/images/AddToClassCreationSequenceDiagram.png differ
diff --git a/docs/images/AddToClassExecutionSequenceDiagram.png b/docs/images/AddToClassExecutionSequenceDiagram.png
new file mode 100644
index 00000000000..d5913c5093e
Binary files /dev/null and b/docs/images/AddToClassExecutionSequenceDiagram.png differ
diff --git a/docs/images/AddToClassRef1.png b/docs/images/AddToClassRef1.png
new file mode 100644
index 00000000000..d5e6f4ca4bc
Binary files /dev/null and b/docs/images/AddToClassRef1.png differ
diff --git a/docs/images/AddToClassRef2.png b/docs/images/AddToClassRef2.png
new file mode 100644
index 00000000000..f179d8ebc32
Binary files /dev/null and b/docs/images/AddToClassRef2.png differ
diff --git a/docs/images/AddToClassSequenceDiagram.png b/docs/images/AddToClassSequenceDiagram.png
new file mode 100644
index 00000000000..6035103bdd6
Binary files /dev/null and b/docs/images/AddToClassSequenceDiagram.png differ
diff --git a/docs/images/ArchitectureSequenceDiagram.png b/docs/images/ArchitectureSequenceDiagram.png
index 2f1346869d0..07ceafba692 100644
Binary files a/docs/images/ArchitectureSequenceDiagram.png and b/docs/images/ArchitectureSequenceDiagram.png differ
diff --git a/docs/images/BuildTimetableDayActivityDiagram-Activity__Build_TimetableDay.png b/docs/images/BuildTimetableDayActivityDiagram-Activity__Build_TimetableDay.png
new file mode 100644
index 00000000000..4fe7e7cefc3
Binary files /dev/null and b/docs/images/BuildTimetableDayActivityDiagram-Activity__Build_TimetableDay.png differ
diff --git a/docs/images/BuildTimetableHeaderActivityDiagram-Activity__Build_TimetableHeader.png b/docs/images/BuildTimetableHeaderActivityDiagram-Activity__Build_TimetableHeader.png
new file mode 100644
index 00000000000..75a8942b866
Binary files /dev/null and b/docs/images/BuildTimetableHeaderActivityDiagram-Activity__Build_TimetableHeader.png differ
diff --git a/docs/images/BuildTimetableOverallDiagram.png b/docs/images/BuildTimetableOverallDiagram.png
new file mode 100644
index 00000000000..187fc4a0fbc
Binary files /dev/null and b/docs/images/BuildTimetableOverallDiagram.png differ
diff --git a/docs/images/BuildTimetableTuitionClassSlotsActivityDiagram-Activity__Build_TimetableTuitionClassSlots.png b/docs/images/BuildTimetableTuitionClassSlotsActivityDiagram-Activity__Build_TimetableTuitionClassSlots.png
new file mode 100644
index 00000000000..4efcfd187a7
Binary files /dev/null and b/docs/images/BuildTimetableTuitionClassSlotsActivityDiagram-Activity__Build_TimetableTuitionClassSlots.png differ
diff --git a/docs/images/ClassList.png b/docs/images/ClassList.png
new file mode 100644
index 00000000000..23f89b5e988
Binary files /dev/null and b/docs/images/ClassList.png differ
diff --git a/docs/images/ClassPanelDiagram.png b/docs/images/ClassPanelDiagram.png
new file mode 100644
index 00000000000..ec39669efe3
Binary files /dev/null and b/docs/images/ClassPanelDiagram.png differ
diff --git a/docs/images/ClassPanelImage.png b/docs/images/ClassPanelImage.png
new file mode 100644
index 00000000000..f1e14fad26c
Binary files /dev/null and b/docs/images/ClassPanelImage.png differ
diff --git a/docs/images/ClassesUiSequenceDiagram.png b/docs/images/ClassesUiSequenceDiagram.png
new file mode 100644
index 00000000000..5372ebe3f71
Binary files /dev/null and b/docs/images/ClassesUiSequenceDiagram.png differ
diff --git a/docs/images/CommandObserverPattern.png b/docs/images/CommandObserverPattern.png
new file mode 100644
index 00000000000..ee66aee06e1
Binary files /dev/null and b/docs/images/CommandObserverPattern.png differ
diff --git a/docs/images/DeleteClassRef1.png b/docs/images/DeleteClassRef1.png
new file mode 100644
index 00000000000..bc4462fbe44
Binary files /dev/null and b/docs/images/DeleteClassRef1.png differ
diff --git a/docs/images/DeleteClassSequenceDiagram.png b/docs/images/DeleteClassSequenceDiagram.png
new file mode 100644
index 00000000000..ca410e6a8a9
Binary files /dev/null and b/docs/images/DeleteClassSequenceDiagram.png differ
diff --git a/docs/images/DeleteSequenceDiagram.png b/docs/images/DeleteSequenceDiagram.png
index fa327b39618..9bf764c27cf 100644
Binary files a/docs/images/DeleteSequenceDiagram.png and b/docs/images/DeleteSequenceDiagram.png differ
diff --git a/docs/images/DownloadJar.png b/docs/images/DownloadJar.png
new file mode 100644
index 00000000000..54313f44c86
Binary files /dev/null and b/docs/images/DownloadJar.png differ
diff --git a/docs/images/FindEarliestAndLatestHourActivityDiagram-Activity__Find_earliest_start_hour_and_latest_end_hour.png b/docs/images/FindEarliestAndLatestHourActivityDiagram-Activity__Find_earliest_start_hour_and_latest_end_hour.png
new file mode 100644
index 00000000000..79f574b78cc
Binary files /dev/null and b/docs/images/FindEarliestAndLatestHourActivityDiagram-Activity__Find_earliest_start_hour_and_latest_end_hour.png differ
diff --git a/docs/images/FindSequenceDiagram.png b/docs/images/FindSequenceDiagram.png
new file mode 100644
index 00000000000..91dbdb0ae04
Binary files /dev/null and b/docs/images/FindSequenceDiagram.png differ
diff --git a/docs/images/InvoiceExample.png b/docs/images/InvoiceExample.png
new file mode 100644
index 00000000000..a5f2e7d0b5e
Binary files /dev/null and b/docs/images/InvoiceExample.png differ
diff --git a/docs/images/LogicClassDiagram.png b/docs/images/LogicClassDiagram.png
index c3028aa1cda..d7fef19808a 100644
Binary files a/docs/images/LogicClassDiagram.png and b/docs/images/LogicClassDiagram.png differ
diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
index 39d7aec4b33..ae068c4a010 100644
Binary files a/docs/images/ModelClassDiagram.png and b/docs/images/ModelClassDiagram.png differ
diff --git a/docs/images/ParserClasses.png b/docs/images/ParserClasses.png
index 58ad22ce16a..22c1a6c7a3c 100644
Binary files a/docs/images/ParserClasses.png and b/docs/images/ParserClasses.png differ
diff --git a/docs/images/RemoveFromClassCommandSequenceDiagram.png b/docs/images/RemoveFromClassCommandSequenceDiagram.png
new file mode 100644
index 00000000000..06a746c7d65
Binary files /dev/null and b/docs/images/RemoveFromClassCommandSequenceDiagram.png differ
diff --git a/docs/images/RemoveFromClassOverviewDiagram.png b/docs/images/RemoveFromClassOverviewDiagram.png
new file mode 100644
index 00000000000..3fb4672bc39
Binary files /dev/null and b/docs/images/RemoveFromClassOverviewDiagram.png differ
diff --git a/docs/images/SortSequenceDiagram.png b/docs/images/SortSequenceDiagram.png
new file mode 100644
index 00000000000..331634cf850
Binary files /dev/null and b/docs/images/SortSequenceDiagram.png differ
diff --git a/docs/images/StorageClassDiagramWTuitionClass.png b/docs/images/StorageClassDiagramWTuitionClass.png
new file mode 100644
index 00000000000..d027f312ca8
Binary files /dev/null and b/docs/images/StorageClassDiagramWTuitionClass.png differ
diff --git a/docs/images/StudentModelClassDiagram.png b/docs/images/StudentModelClassDiagram.png
new file mode 100644
index 00000000000..68c925218fd
Binary files /dev/null and b/docs/images/StudentModelClassDiagram.png differ
diff --git a/docs/images/StudentsDiagram.png b/docs/images/StudentsDiagram.png
new file mode 100644
index 00000000000..73e6ab83df3
Binary files /dev/null and b/docs/images/StudentsDiagram.png differ
diff --git a/docs/images/TimestableLogo.png b/docs/images/TimestableLogo.png
new file mode 100644
index 00000000000..ae8acc32efe
Binary files /dev/null and b/docs/images/TimestableLogo.png differ
diff --git a/docs/images/TimestableMacStartUp.png b/docs/images/TimestableMacStartUp.png
new file mode 100644
index 00000000000..172dc4e6c6f
Binary files /dev/null and b/docs/images/TimestableMacStartUp.png differ
diff --git a/docs/images/Timetable.png b/docs/images/Timetable.png
new file mode 100644
index 00000000000..9491b9da384
Binary files /dev/null and b/docs/images/Timetable.png differ
diff --git a/docs/images/TimetableAnnotation.png b/docs/images/TimetableAnnotation.png
new file mode 100644
index 00000000000..5e00dcd8fdc
Binary files /dev/null and b/docs/images/TimetableAnnotation.png differ
diff --git a/docs/images/TimetableDiagram.png b/docs/images/TimetableDiagram.png
new file mode 100644
index 00000000000..b771a014aa8
Binary files /dev/null and b/docs/images/TimetableDiagram.png differ
diff --git a/docs/images/TimetableUiDaySequenceDiagram.png b/docs/images/TimetableUiDaySequenceDiagram.png
new file mode 100644
index 00000000000..4baacfba0dc
Binary files /dev/null and b/docs/images/TimetableUiDaySequenceDiagram.png differ
diff --git a/docs/images/TimetableUiHeaderSequenceDiagram.png b/docs/images/TimetableUiHeaderSequenceDiagram.png
new file mode 100644
index 00000000000..5dffc12a6f5
Binary files /dev/null and b/docs/images/TimetableUiHeaderSequenceDiagram.png differ
diff --git a/docs/images/TimetableUiSequenceDiagram.png b/docs/images/TimetableUiSequenceDiagram.png
new file mode 100644
index 00000000000..8dc4453fe29
Binary files /dev/null and b/docs/images/TimetableUiSequenceDiagram.png differ
diff --git a/docs/images/TimetableUiSlotSequenceDiagram.png b/docs/images/TimetableUiSlotSequenceDiagram.png
new file mode 100644
index 00000000000..ae66ffd9cef
Binary files /dev/null and b/docs/images/TimetableUiSlotSequenceDiagram.png differ
diff --git a/docs/images/TuitionClassModelClassDiagram.png b/docs/images/TuitionClassModelClassDiagram.png
new file mode 100644
index 00000000000..e1a886b13bd
Binary files /dev/null and b/docs/images/TuitionClassModelClassDiagram.png differ
diff --git a/docs/images/TutorialImage.png b/docs/images/TutorialImage.png
new file mode 100644
index 00000000000..2ec03308696
Binary files /dev/null and b/docs/images/TutorialImage.png differ
diff --git a/docs/images/TutorialImageFive.png b/docs/images/TutorialImageFive.png
new file mode 100644
index 00000000000..8df6807217c
Binary files /dev/null and b/docs/images/TutorialImageFive.png differ
diff --git a/docs/images/TutorialImageFour.png b/docs/images/TutorialImageFour.png
new file mode 100644
index 00000000000..5108ab3fb9e
Binary files /dev/null and b/docs/images/TutorialImageFour.png differ
diff --git a/docs/images/TutorialImageOne.png b/docs/images/TutorialImageOne.png
new file mode 100644
index 00000000000..247eff54bd8
Binary files /dev/null and b/docs/images/TutorialImageOne.png differ
diff --git a/docs/images/TutorialImageThree.png b/docs/images/TutorialImageThree.png
new file mode 100644
index 00000000000..21e9af157ea
Binary files /dev/null and b/docs/images/TutorialImageThree.png differ
diff --git a/docs/images/TutorialImageTwo.png b/docs/images/TutorialImageTwo.png
new file mode 100644
index 00000000000..b97ce7a5cec
Binary files /dev/null and b/docs/images/TutorialImageTwo.png differ
diff --git a/docs/images/UGCommandExamples/AddClassCommand.png b/docs/images/UGCommandExamples/AddClassCommand.png
new file mode 100644
index 00000000000..49c4debf75a
Binary files /dev/null and b/docs/images/UGCommandExamples/AddClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/AddCommand.png b/docs/images/UGCommandExamples/AddCommand.png
new file mode 100644
index 00000000000..97dcab7098d
Binary files /dev/null and b/docs/images/UGCommandExamples/AddCommand.png differ
diff --git a/docs/images/UGCommandExamples/AddToClassCommand.png b/docs/images/UGCommandExamples/AddToClassCommand.png
new file mode 100644
index 00000000000..d816ed69ad4
Binary files /dev/null and b/docs/images/UGCommandExamples/AddToClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/ClassCommand.png b/docs/images/UGCommandExamples/ClassCommand.png
new file mode 100644
index 00000000000..ace217d7f1e
Binary files /dev/null and b/docs/images/UGCommandExamples/ClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/ClearCommand.png b/docs/images/UGCommandExamples/ClearCommand.png
new file mode 100644
index 00000000000..88d98e38576
Binary files /dev/null and b/docs/images/UGCommandExamples/ClearCommand.png differ
diff --git a/docs/images/UGCommandExamples/DeleteClassCommand.png b/docs/images/UGCommandExamples/DeleteClassCommand.png
new file mode 100644
index 00000000000..baaae97a3ae
Binary files /dev/null and b/docs/images/UGCommandExamples/DeleteClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/DeleteCommand.png b/docs/images/UGCommandExamples/DeleteCommand.png
new file mode 100644
index 00000000000..602e23e4b1f
Binary files /dev/null and b/docs/images/UGCommandExamples/DeleteCommand.png differ
diff --git a/docs/images/UGCommandExamples/EditClassCommand.png b/docs/images/UGCommandExamples/EditClassCommand.png
new file mode 100644
index 00000000000..9ce693fdf83
Binary files /dev/null and b/docs/images/UGCommandExamples/EditClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/EditCommand1.png b/docs/images/UGCommandExamples/EditCommand1.png
new file mode 100644
index 00000000000..0f491c42880
Binary files /dev/null and b/docs/images/UGCommandExamples/EditCommand1.png differ
diff --git a/docs/images/UGCommandExamples/EditCommand2.png b/docs/images/UGCommandExamples/EditCommand2.png
new file mode 100644
index 00000000000..da70e3849a8
Binary files /dev/null and b/docs/images/UGCommandExamples/EditCommand2.png differ
diff --git a/docs/images/UGCommandExamples/FindClassCommand1.png b/docs/images/UGCommandExamples/FindClassCommand1.png
new file mode 100644
index 00000000000..930fc603976
Binary files /dev/null and b/docs/images/UGCommandExamples/FindClassCommand1.png differ
diff --git a/docs/images/UGCommandExamples/FindClassCommand2.png b/docs/images/UGCommandExamples/FindClassCommand2.png
new file mode 100644
index 00000000000..635ee5e7227
Binary files /dev/null and b/docs/images/UGCommandExamples/FindClassCommand2.png differ
diff --git a/docs/images/UGCommandExamples/FindClassCommand3.png b/docs/images/UGCommandExamples/FindClassCommand3.png
new file mode 100644
index 00000000000..9a7d435139d
Binary files /dev/null and b/docs/images/UGCommandExamples/FindClassCommand3.png differ
diff --git a/docs/images/UGCommandExamples/FindClassNameCommand.png b/docs/images/UGCommandExamples/FindClassNameCommand.png
new file mode 100644
index 00000000000..efcda435857
Binary files /dev/null and b/docs/images/UGCommandExamples/FindClassNameCommand.png differ
diff --git a/docs/images/UGCommandExamples/FindNameCommand.png b/docs/images/UGCommandExamples/FindNameCommand.png
new file mode 100644
index 00000000000..9d0a49fd794
Binary files /dev/null and b/docs/images/UGCommandExamples/FindNameCommand.png differ
diff --git a/docs/images/UGCommandExamples/FindTagCommand.png b/docs/images/UGCommandExamples/FindTagCommand.png
new file mode 100644
index 00000000000..281a871713f
Binary files /dev/null and b/docs/images/UGCommandExamples/FindTagCommand.png differ
diff --git a/docs/images/UGCommandExamples/HelpCommand.png b/docs/images/UGCommandExamples/HelpCommand.png
new file mode 100644
index 00000000000..5f4067dbd8e
Binary files /dev/null and b/docs/images/UGCommandExamples/HelpCommand.png differ
diff --git a/docs/images/UGCommandExamples/ListClassCommand.png b/docs/images/UGCommandExamples/ListClassCommand.png
new file mode 100644
index 00000000000..cca3c4802cc
Binary files /dev/null and b/docs/images/UGCommandExamples/ListClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/ListCommand.png b/docs/images/UGCommandExamples/ListCommand.png
new file mode 100644
index 00000000000..6a709bc3032
Binary files /dev/null and b/docs/images/UGCommandExamples/ListCommand.png differ
diff --git a/docs/images/UGCommandExamples/RemoveFromClassCommand.png b/docs/images/UGCommandExamples/RemoveFromClassCommand.png
new file mode 100644
index 00000000000..2c91ce2d32e
Binary files /dev/null and b/docs/images/UGCommandExamples/RemoveFromClassCommand.png differ
diff --git a/docs/images/UGCommandExamples/SortCommand.png b/docs/images/UGCommandExamples/SortCommand.png
new file mode 100644
index 00000000000..eee4eb78bce
Binary files /dev/null and b/docs/images/UGCommandExamples/SortCommand.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample1.png b/docs/images/UGCommandExamples/TutorialExample1.png
new file mode 100644
index 00000000000..daf4330030b
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample1.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample2.png b/docs/images/UGCommandExamples/TutorialExample2.png
new file mode 100644
index 00000000000..fa280b45f39
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample2.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample3.png b/docs/images/UGCommandExamples/TutorialExample3.png
new file mode 100644
index 00000000000..1de22f13dad
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample3.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample4.png b/docs/images/UGCommandExamples/TutorialExample4.png
new file mode 100644
index 00000000000..23f59dad85e
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample4.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample5.png b/docs/images/UGCommandExamples/TutorialExample5.png
new file mode 100644
index 00000000000..346c57f0e78
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample5.png differ
diff --git a/docs/images/UGCommandExamples/TutorialExample6.png b/docs/images/UGCommandExamples/TutorialExample6.png
new file mode 100644
index 00000000000..fb6997fd7aa
Binary files /dev/null and b/docs/images/UGCommandExamples/TutorialExample6.png differ
diff --git a/docs/images/UGCommandExamples/ViewCommand.png b/docs/images/UGCommandExamples/ViewCommand.png
new file mode 100644
index 00000000000..d10496d0e93
Binary files /dev/null and b/docs/images/UGCommandExamples/ViewCommand.png differ
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
index 91488fd1a0f..c2641b7cc39 100644
Binary files a/docs/images/Ui.png and b/docs/images/Ui.png differ
diff --git a/docs/images/UiClassDiagram.png b/docs/images/UiClassDiagram.png
index 4bb8b2ce591..4d927be7dd4 100644
Binary files a/docs/images/UiClassDiagram.png and b/docs/images/UiClassDiagram.png differ
diff --git a/docs/images/UpcomingFeature.png b/docs/images/UpcomingFeature.png
new file mode 100644
index 00000000000..b7fd14c5b6d
Binary files /dev/null and b/docs/images/UpcomingFeature.png differ
diff --git a/docs/images/ViewSequenceDiagram.png b/docs/images/ViewSequenceDiagram.png
new file mode 100644
index 00000000000..2bf3180951f
Binary files /dev/null and b/docs/images/ViewSequenceDiagram.png differ
diff --git a/docs/images/bernardwan.png b/docs/images/bernardwan.png
new file mode 100644
index 00000000000..9e4f54480fb
Binary files /dev/null and b/docs/images/bernardwan.png differ
diff --git a/docs/images/findAlexDavidResult.png b/docs/images/findAlexDavidResult.png
index 235da1c273e..c70525a61dc 100644
Binary files a/docs/images/findAlexDavidResult.png and b/docs/images/findAlexDavidResult.png differ
diff --git a/docs/images/helpMessage.png b/docs/images/helpMessage.png
index b1f70470137..c0f7e28c13a 100644
Binary files a/docs/images/helpMessage.png and b/docs/images/helpMessage.png differ
diff --git a/docs/images/ongzl.png b/docs/images/ongzl.png
new file mode 100644
index 00000000000..c0318165ae7
Binary files /dev/null and b/docs/images/ongzl.png differ
diff --git a/docs/images/s7u4rt99.png b/docs/images/s7u4rt99.png
new file mode 100644
index 00000000000..fb48872aadf
Binary files /dev/null and b/docs/images/s7u4rt99.png differ
diff --git a/docs/images/softmagnet.png b/docs/images/softmagnet.png
new file mode 100644
index 00000000000..82707687c0a
Binary files /dev/null and b/docs/images/softmagnet.png differ
diff --git a/docs/images/yourally2.png b/docs/images/yourally2.png
new file mode 100644
index 00000000000..86ff1bd7491
Binary files /dev/null and b/docs/images/yourally2.png differ
diff --git a/docs/index.md b/docs/index.md
index 7601dbaad0d..f935282114f 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,19 +1,48 @@
---
layout: page
-title: AddressBook Level-3
+title: TimesTable
---
+[](https://codecov.io/gh/AY2122S1-CS2103T-F11-1/tp)
+[](https://github.com/AY2122S1-CS2103T-F11-1/tp/actions)
-[](https://github.com/se-edu/addressbook-level3/actions)
-[](https://codecov.io/gh/se-edu/addressbook-level3)
+
+
+**TimesTable is a desktop app for managing your tuition students and classes, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).**
+While it has a GUI, it can be controlled by typing in commands using the CLI.
+If you can type fast, TimesTable can get your class management tasks done faster than traditional GUI apps.
+
+* If you are interested in using TimesTable, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+* If you are interested about developing TimesTable, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+
+# Features
+
+### Student Management
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+TimesTable supports all basic contact management commands such as adding of students and their contact info, editing of contact info,
+deleting students, finding students, sorting, etc. Furthermore, TimesTable also stores the Next-of-Kin(NOK) information of the student,
+which is important and often used. This is displayed to the right of the student information.
+
+### Class Management
+
+
+
+TimesTable allows users to easily create and manage their classes. The Class tab shows all the information
+about your various classes at a glance, with the student information in the sidebar on the right. Users can
+easily add and remove students from the various classes using the commands. The class list can also be filtered
+to search for a specific class.
+
+### View Timetable
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+
+TimesTable automatically generates a timetable for you based on the classes that you have added.
+Simply head over to the Timetable tab by clicking on it or using the view command.
**Acknowledgements**
* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+* The [`Timetable`](#view-timetable) feature was inspired by a similar feature in the past project of [Pet Store Helper](https://github.com/AY1920S2-CS2103-W15-4/main) ([DG](https://ay1920s2-cs2103-w15-4.github.io/main/DeveloperGuide.html#calendar-feature)).
+ The implementation of the components of the Timetable feature (`TimetableTuitionClassSlot`, `TimetableDay`, `TimetableRegion` and `TimetableEmptySlot`) has been adapted from them with maximum changes to fit our app.
+ The implementation of how we built and designed ([TimetablePanel.java](https://github.com/AY2122S1-CS2103T-F11-1/tp/blob/master/src/main/java/seedu/times/ui/timetabletab/TimetablePanel.java)) the entire Timetable Tab (layout, classes etc) is entirely new.
diff --git a/docs/team/bernardwan.md b/docs/team/bernardwan.md
new file mode 100644
index 00000000000..e806f83758e
--- /dev/null
+++ b/docs/team/bernardwan.md
@@ -0,0 +1,81 @@
+---
+layout: page
+title: Bernard Wan De Yuan's Project Portfolio Page
+---
+### Project: TimesTable
+
+TimesTable is a desktop address book plus planner application for tuition teachers to keep track of their students
+and classes. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java,
+and has about 25 kLoC.
+
+Given below are my contributions to the project.
+
+
+* **New Feature**: Added the `removefromclass` command to remove one or more students from an existing class.
+ * Justification: A core feature to remove students that left.
+ * Highlights: The implementation of this command was especially challenging as the only information that the command has
+ are the student indices and the class index. These indices are based on the view displayed by the GUI, which is
+ affected by `sort` and `find` commands. Furthermore, only student names are stored in the `TuitionClass` object to reduce
+ update cascading. As such, the correct filters and sorting must be applied to the overall student list to obtain the student
+ names in the right order as displayed by the GUI.
+ * Pull requests: [\#117](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/117), [\#147](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/147),
+ [\#260](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/260), [\#266](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/266)
+ , [\#301](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/301)
+
+
+* **New Feature**: Added the `deleteclass` command to delete existing tuition classes.
+ * Justification: A core feature for the user to get rid of older classes that they have finished teaching.
+ * Highlights: Deleting the entire class is much simpler than removing students from a class. The most challenging aspect
+ would be to ensure that the index of the class to be deleted corresponds to the actual class list order displayed on the GUI
+ after any `sort` or `find` commands.
+ * Pull requests: [\#104](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/104), [\#273](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/273)
+
+
+* **New Feature**: Updated the behaviour of the `findname` and `findtag` command to support more natural use cases.
+ * What it does: Changed the functionality of the two `find` commands for students to support partial matches
+ and to allow for multi-word searches.
+ * Justification: The different types of `find` commands needs different logic as what the user will want to do varies.
+ For name searches, users would often want to search for first name together with last name. As such, the command should treat
+ the multi-word keyword as a single sequence. For the `findtag` command, users might search for just `math` and expect to find
+ all tags that contain math. As such, partial matching is required.
+ * Highlights: Previously, whitespace was used as a delimiter to obtain separate keywords. However, to use multi-word keywords,
+ another delimiter, a comma, was used. Also, the logic had to be adjusted to allow for partial matches, ignoring case.
+ * Pull requests: [\#145](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/145), [\#159](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/104),
+ [\#163](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/163)
+
+
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=totalCommits&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=bernardwan&tabRepo=AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false)
+
+
+* **Enhancements to existing features**:
+ * Added some initial code for the class feature in the model - UniqueClassList and JsonAdaptedTuitionClass. ([\#104](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/104))
+ * Wrote additional tests for existing features to increase test coverage ([\#260](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/260), [\#266](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/266), [\#273](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/273))
+ * Updated the sample data to fill out the timetable, have more students with realistic data. ([\#145](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/145), [\#164](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/164))
+ * Add tests for NOK feature ([\#66](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/66))
+ * Added location field ([\#58](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/58))
+
+
+* **Documentation**:
+ * User Guide:
+ * Added section for location field. ([\#37](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/37))
+ * Updated behavior for find features. ([\#145](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/145))
+ * Update UG and examples for findname and findtag. ([\#163](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/163))
+ * Added section for proposed feature of invoice generation. ([\#323](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/323))
+ * Developer Guide:
+ * Updated NFRs section to include relevant information. ([\#12](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/12))
+ * Added implementation details of the `removefromclass` feature. Added UML diagrams for the command. ([\#82](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/82), [\#301](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/301))
+
+* **Contributions to team-based tasks**
+ * Set up project website:
+ * Set up github pages, changed settings, changed names and links from AddressBook to TimesTable
+ * Landing Page ([\#133](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/133) , [\#306](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/306)):
+ * Updated landing page to reflect TimesTable contents, added a section for each major feature, added pictures.
+ * Project Demo for 1.3:
+ * Recorded gifs and screenshots for different features.
+ * Helped maintained issue tracker:
+ * Created new issues, added milestones and assignees, closed relevant issues.
+
+* **Community**:
+ * PRs reviewed (with non-trivial review comments): [\#303](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/303)
+ * Reported bugs for other teams during PE-D. [PE-D](https://github.com/bernardwan/ped/issues)
+
diff --git a/docs/team/ongzl.md b/docs/team/ongzl.md
new file mode 100644
index 00000000000..3e8c4e19d40
--- /dev/null
+++ b/docs/team/ongzl.md
@@ -0,0 +1,95 @@
+---
+layout: page
+title: Ong Zheng Lin's Project Portfolio Page
+---
+
+### Project: TimesTable
+
+TimesTable is a desktop class management application for tuition teachers to keep track of their students
+and classes. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java,
+and has about 25 kLoC.
+
+Given below are my contributions to the project.
+
+* **New feature**: Added a schedule command that filters and sort students by their class timing (V1.2)
+ * What it does: Allows the user to filter students by day of which they are attending their class, so that user
+ can see who he is teaching and when.
+ * Justification: Provides early functionality to sort students by their class timing during the early phases of
+ the application. Provides some early work towards functions like `sort` and back-end processing of
+ `TuitionClass` and `ClassTiming`.
+ * Highlights: Provide a foundation for later iteration which improved the functionality of `TuitionClass` and `ClassTiming`.
+ * Pull request: [\#62](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/62), [\#71](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/71)
+
+* **New feature**: Added the basic GUI for the `TuitionClass list` in the `classes` tab
+ * What it does: Allows the user to view the classes currently in TimesTable.
+ * Justification: Allows the user to know the details of classes currently in TimesTable, so that they can have a
+ better idea of their workload and schedule.
+ * Highlights: Provide a foundation for later improvement and iterations in the `classes` tab.
+ * Commits: [1](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/e632b2de0b0f44bc67e84de601d8632e28696bf1)
+
+* **New feature** Added the backend support for `UniqueClassList` and `TuitionClass`
+ * What it does: Create support for adding and removing `TuitionClass` in `UniqueClassList` by ensuring no
+ overlap and proper updates from and to storage.
+ * Justification: Ensures that there is smooth reading of the JSON file into the model and overlapping class
+ timing between tuition classes are not allowed during editing and adding of class.
+ * Highlights: Provide support for `AddClassCommand`, `EditClassCommand` and safe reading of JSON file into model.
+ * Commits: [1](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/7ddac4e24d6abc6da6b669c0daf50a85601c3f5a),
+ [2](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/d344612297e2d21c988653b51a7eaa7d409cdacb),
+ [3](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/39d388fd3f0bf55dd3dcab9995d41ccf0419f0c6)
+
+* **Code contributed**: [Reposense](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=f11&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=Ongzl&tabRepo=AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false)
+
+* **Enhancements to existing features**:
+ * Link the `JSON` file and `UniqueClassList` in model, allowing the model to save (Commits
+ [1](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/7ddac4e24d6abc6da6b669c0daf50a85601c3f5a),
+ [2](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/d344612297e2d21c988653b51a7eaa7d409cdacb),
+ [3](https://github.com/AY2122S1-CS2103T-F11-1/tp/commit/39d388fd3f0bf55dd3dcab9995d41ccf0419f0c6))
+ * Wrote additional tests for existing features to increase coverage (Pull request
+ [\#234](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/234),
+ [\#259](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/259),
+ [\#281](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/281))
+ * Bug fixes for features `Class size` in `classes` tab and `Student list` in `classes` tab (Pull request
+ [\#106](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/106),
+ [\#137](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/137),
+ [\#246](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/246),
+ [\#249](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/249),
+ [\#251](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/251),
+ [\#252](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/252))
+ * Fix old test cases which were outdated due to change in commands (Pull request [\#115](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/115), [\#155](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/155))
+
+* **Documentation**
+ * User Guide:
+ * Added basic documentation for features `addclass`, `deleteclass`, `addtoclass`, `editclass`, `findclass`,
+ `listclass` [\#130](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/130)
+ * Added documentation on filtering `students` [\#281](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/281)
+ * Developer Guide
+ * Added use cases (Pull request
+ [\#17](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/17),
+ [\#265](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/265))
+ * Updated `Storage` component and UML diagram [\#290](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/290)
+ * Added sequence diagrams and implementation detail for `AddClassCommand` and edited other UML diagrams (Pull request
+ [\#294](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/294),
+ [\#295](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/295),
+ [\#333](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/333))
+ * Added challenges faced in `AddClassCommand` [\#344](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/344)
+ * Added documentation and sequence diagrams for `DeleteClassCommand` [\#320](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/320)
+ [\#333](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/333),
+ [\#339](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/339))
+ * Added documentation and sequence diagrams for `DeleteClassCommand` (Pull request
+ [\#320](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/320),
+ [\#333](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/333))
+ * Added method for manual testing of `deleteclass`, `removefromclass`, `findtag` and `view` [\#332](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/332)
+* **Community**
+ * PRs reviewed (with non-trivial review comments): (Pull request
+ [\#26](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/26)
+ [\#40](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/40),
+ [\#47](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/47#partial-pull-merging),
+ [\#53](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/53),
+ [\#92](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/92),
+ [\#152](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/152),
+ [\#237](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/237),
+ [\#253](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/253),
+ [\#254](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/254),
+ [\#260](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/260))
+ * Reported bugs for other teams during PE-D: [ped issues github](https://github.com/Ongzl/ped/issues)
+
diff --git a/docs/team/s7u4rt99.md b/docs/team/s7u4rt99.md
new file mode 100644
index 00000000000..982ccd60a3f
--- /dev/null
+++ b/docs/team/s7u4rt99.md
@@ -0,0 +1,57 @@
+---
+layout: page
+title: Stuart Long's Project Portfolio Page
+---
+
+### Project: TimesTable
+
+TimesTable is a Class Management desktop application for tuition teachers to keep track of their students
+and classes. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java,
+and has about 25 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the skeleton of the tabs (Pull request: [\#73](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/73))
+ * What it does: Added the base skeleton of the 3 tabs - `Students`, `Classes` and `Timetable`
+ * Highlights: I had to implement this before my teammates could start working on their respective tabs. This enhancement was the start of our evolution from the original AB3 into what we have today. It improved the entire UI and allowed us to have multiple tabs which users could view.
+
+* **New Feature**: Added the Timetable UI (Pull requests: [\#81](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/81), [\#97](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/97), [\#114](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/114), [\#136](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/136), [\#138](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/138))
+ * What it does: Displays the tuition classes of the user in a timetable format in the `Timetable` Tab, improving the user experience.
+ * Justification: The Timetable allows user to see his entire weekly schedule in a glance.
+ * Highlights: This enhancement revamped the entire UI of the app. It required an in-depth analysis of all possible design patterns to upgrade the UI. The implementation was challenging as it required addition of many new components to build the entire timetable component.
+ * Credits: AY19/20 S2 CS2103-W15-4 [Github](https://github.com/AY1920S2-CS2103-W15-4/main/tree/master/src/main/java/clzzz/helper/ui/calendar)
+
+* **New Feature**: Added the `sort` feature (Pull requests: [\#126](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/126), [\#129](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/129), [\#132](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/132), [\#240](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/240), [\#250](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/250))
+ * What it does: Sorts the students and classes based on the specified parameter in the specified order.
+ * Justification: User is able to arrange the list of students and/or classes in the order the user would like. It is also one of the basic features an address book application should have.
+ * Highlights: Implementing this `sort` command was relatively easier than the Timetable UI. However, the challenging part was choosing what parameter to allow the user to sort the students or classes by. The parameters I allowed to be sorted by were the student's name and the class' timing, as I believe that these are the two parameters which the user would sort them by the most.
+
+* **New Feature**: Added the `view` feature using Observer Pattern (Pull request: [\#92](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/92), [\#126](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/126))
+ * What it does: Opens the tab specified by the user.
+ * Justification: This feature was crucial as it tailored our app towards users who do not like using the mouse or voice commands. The user can now switch tabs without the need of a mouse. This feature also played an important role in other commands. The commands related to TuitionClass, such as `addToClass`, `editClass` etc used this feature to switch to the `Classes` tab when they were called. Similarly, commands related to Student, such as `add`, `edit` etc used this feature to switch to the `Students` Tab.
+ * Highlights: Implementing this `view` command required an in-depth analysis of the possible design patterns. I decided to use the Observer pattern here. In this case, the `MainWindow` implemented the `CommandObserver` and observed the `Command`s. `CommandObserver#updateView()` switches the tab of the Observers to the tab indicated by the user.
+
+* **Code contributed**: [Reposense](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=s7u4rt99&tabRepo=AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false)
+
+* **Project management**:
+ * Managed releases `v1.3.trial`, `v1.3(final)` and `v1.4` on GitHub.
+
+* **Enhancements to existing features**:
+ * Added the field names to all StudentCard (Pull requests [\#68](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/68))
+ * Wrote tests to increase code coverage (Pull requests [\#81](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/81), [\#92](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/92), [\#126](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/126), [\#136](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/136), [\#240](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/240), [\#255](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/255), [\#256](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/256))
+
+* **Documentation**:
+ * User Guide:
+ * Added documentation for the `CLASS_TIMING` field, and the `sort`, `view` and `class` commands: [\#29](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/29), [\#146](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/146)
+ * Added command summary for `addclass`, `addtoclass`, `deleteclass`, `editclass`, `findname`, `findclass`, `findclassname`, `findtag`, `list`, `listclass`, `selectclass`, `sort`, `view`: [\#146](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/146)
+ * Reordered User Guide to follow the order which the user uses the app to improve the reader's experience: [\#150](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/150)
+ * Did cosmetic tweaks to existing documentation of features `delete`, `deleteclass`, `listclass`, `editclass`, `findname`, `findtag` and `findclassname`: [\#146](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/146)
+ * Developer Guide:
+ * Added target user profile: [\#25](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/25)
+ * Added UML diagrams and implementation details of the `Timetable` feature, `View` feature, `Sort` feature and `Observer` feature: [\#94](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/94), [\#297](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/297), [\#310](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/310), [\#325](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/325)
+ * Improved class diagram of Ui and Logic Component: [\#297](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/297), [\#310](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/310)
+
+* **Community**:
+ * PRs reviewed (with non-trivial review comments): [\#31](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/31), [\#36](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/36), [\#37](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/37), [\#56](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/56), [\#58](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/58), [\#62](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/62), [\#71](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/71), [\#147](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/147), [\#254](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/254), [\#258](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/258), [\#281](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/281)
+ * Reported bugs and suggestions for other teams during PE-D: [PE-D issues github](https://github.com/s7u4rt99/ped/issues)
+ * Recorded 17 bugs, top 10% of cohort
diff --git a/docs/team/softmagnet.md b/docs/team/softmagnet.md
new file mode 100644
index 00000000000..ddb59f95733
--- /dev/null
+++ b/docs/team/softmagnet.md
@@ -0,0 +1,77 @@
+---
+layout: page
+title: Lin Zhiwei's Project Portfolio Page
+---
+### Project: TimesTable
+
+TimesTable is a desktop address book plus planner application for tuition teachers to keep track of their students
+and classes. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java,
+and has about 25 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Integrated the `TuitionClass` into the model
+ * What it does: serves as the backbone for our application as our application needs a tuition class entity in its
+ model.
+ * Justification: Same as above, it serves as backbone for our project.
+ * Highlights: I wrote the initial setup for tuition class and added new classes to model a tuition class's
+attributes such as StudentNameList. I made the design decision for how we keep track of students in classes so as to
+minimize dependency.
+ * PRs: [\#56](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/56),
+ [\#60](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/60),
+ [\#104](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/104),
+ [\#127](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/127),
+ [\#139](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/139),
+ [\#151](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/151),
+ [\#152](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/152)...
+
+* **New Feature**: Added numerous basic commands related to tuition class such as `addclass`, `editclass`
+and `addtoclass`
+ * What it does: adds the basic functionality of being able to interact with tuition classes such as adding a class,
+editing a class and adding students to classes.
+ * Justification: The functionalities mentioned above are the basic features that our application should have given our
+goal and target user.
+ * Highlights: Add commands and edit commands are relatively easier than addtoclass command which require designing
+a new command format. I ended deciding to use indices of currently displayed list as it is the most convenient and
+intuitive to use.
+ * PRs: [\#70](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/70),
+ [\#104](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/104),
+ [\#127](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/127),
+ [\#160](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/160),
+ [\#237](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/237),
+ [\#253](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/253),
+ [\#263](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/263)...
+
+* **New Feature/Enhancements to existing features**: greatly enhanced the search capabiltiy of our application by
+adding `findtag`, `findclass` and `findclassname` commands
+ * What it does: allows user to find students by the tags they have and also find classes by class timing and class
+name.
+ * Justification: Users should be able to have such search functionalities as mentioned above to find quickly students
+or classes they are interested in.
+ * Highlights: Adding find commands for each different attributes have various nuances that one has to look out for and
+I have learnt to be more careful around these nuances.
+ * PRs: [\#70](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/70),
+ [\#112](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/112),
+ [\#158](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/158)...
+
+* **Code contributed**: [Reposense](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabAuthor=softmagnet&tabRepo=AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&tabType=authorship)
+
+* **Documentation**
+ * User Guide: Added some documentation for updated features
+ * PRs: [\#170](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/170),
+ [\#254](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/254)
+ * Developer Guide (DG): Added DG for find, addtoclass commands and updated DG for model component
+ * PRs: [\#88](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/88),
+ [\#293](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/293),
+ [\#308](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/308),
+ [\#312](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/312),
+ [\#326](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/326)...
+
+* **Community**
+ * PRs reviewed (with non-trivial review comments): [\#232](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/232),
+ [\#117](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/117),
+ [\#53](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/53),
+ [\#25](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/25),
+ [\#17](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/17)
+
+ * Reported bugs for other teams during PE-D: [ped issues github](https://github.com/softmagnet/ped)
diff --git a/docs/team/yourally2.md b/docs/team/yourally2.md
new file mode 100644
index 00000000000..229bf319fcb
--- /dev/null
+++ b/docs/team/yourally2.md
@@ -0,0 +1,66 @@
+---
+layout: page
+title: Kevin Chua's Project Portfolio Page
+---
+
+### Project: TimesTable
+
+TimesTable is a Class Management desktop application for tuition teachers to keep track of their students
+and classes. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java,
+and has about 25 kLoC.
+
+Given below are my contributions to the project.
+
+* **New feature**: Added the GUI and related behaviour for the class tab (Pull Request: [\#103](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/103))
+ * What it does: Allows the user to visually see which students belong to each respective class by double clicking on the class
+ or using a command `class INDEX` which is described in another section.
+ * Justification: Visuals allows the user to quickly tell which students belong to a class at a glance.
+ Forms the backbone of the class feature as all interactions with the class is done in this tab.
+ * Highlights: I gained a deep understanding of how the GUI functioned together with greater understanding of different design patterns.
+
+* **New feature**: Add `class` feature to view a specific class without double clicking (Pull Request: [\#103](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/103))
+ * What it does: It shows the students belonging to the specified class. Does the same thing as double clicking on a class.
+ * Justification: It allows us to perform the same functionality without using a mouse, which is important.
+ * Highlights: It was challenging to modify the GUI using a command as it meant a lot of coupling, so after discussing with Stuart we decided to follow the Observer pattern,
+ which proved to be very useful.
+
+* **New feature**: Overloaded `edit` and set up base for overloading `add` command to allow user to add the next-of-kin (nok) of the Student. (Pull Requests: [\#26](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/26) [\#47](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/47))
+ * What it does: Allows the user to add/edit a Student's nok with name, address, and location when adding/editing a Student.
+ * Highlights: This enhancement went through several iterations as we initially implemented the
+ `nok` command to specifically to add/edit an nok, but settled on overloading the `add` and `edit` command because it would
+ be faster and less confusing to add an `nok` and the Student at once.
+
+* **New feature**: Store next-of-kin (nok) information in a nested json (Pull Request: [\#65](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/65))
+ * Highlights: I decided to nest the json in a key `nok` instead of having fields like `nok_name`, `nok_phone` etc so it is clearer what the fields are for. Nesting json objects proved to be more complex compared to strings.
+
+* **New feature**: Improved colours for the GUI overall (Pull Request: [\#217](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/217))
+ * Highlights: Finding the right combination of colors that the entire team agreed on proved to be more difficult than expected and the colors went through several iterations before the team could decide on a color. In the process, finding the css for specific components to change was surprisingly harder than expected as the documentation for the css in javafx is often unclear.
+
+* **Code contributed**: [Reposense](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=yourally2&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=yourally2&tabRepo=AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false)
+
+* **Enhancements to existing features**:
+ * Make Student and next-of-kin (NOK) inherit from Person to implement DRY principles (Pull Request [\#30](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/30))
+ * Limit length and number of tags to prevent GUI from covering other information and added tests (Pull Request [\#319](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/319))
+ * Wrote tests for `FindClassCommandParser`, `FindClassCommand`, `SelectClassCommand` and `SelectClassCommandParser` (Pull Request [\#258](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/258) [\#302](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/302))
+ * Bug fixes for GUI, `class` command, Student list in `classes` tab and `addtoclass` command (Pull Request
+ [\#248](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/248),
+ [\#243](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/243),
+ [\#304](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/304))
+
+* **Documentation**
+ * User Guide:
+ * Ensured entire UG flowed well (Pull Request [\#224](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/224), [\#303](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/303))
+ * Added section for proposed feature of attendance marking in Payment Management feature. ([Commit](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/319/commits/effd6fbe0d67a6ed821fa16581e7ed3fd3e9cd32))
+ * Developer Guide
+ * Added UML class diagram, Sequence Diagram for Ui component and the ClassesUi component (Pull Request [\#291](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/291) [\#309](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/309))
+ * Added noteworthy implementation details for `nok/` field (Pull Request [\#292](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/292), [\#291](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/291))
+ * Added manual testing for `addtoclass`, `listclass`, `delete`, `sort` commands (Pull Request [\#327](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/327) [\#86](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/86))
+ * Added user stories (Pull Request [\#22](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/22))
+
+* **Community**
+ * PRs reviewed (with non-trivial review comments): (Pull Request
+ [\#256](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/256),
+ [\#81](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/81),
+ [\#50](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/50),
+ [\#311](https://github.com/AY2122S1-CS2103T-F11-1/tp/pull/311)
+ * Reported bugs for other teams during PE-D: [ped issues github](https://github.com/yourally2/ped/issues)
diff --git a/docs/tutorials/AddRemark.md b/docs/tutorials/AddRemark.md
index 8919d8eaa17..64aaf9a00a7 100644
--- a/docs/tutorials/AddRemark.md
+++ b/docs/tutorials/AddRemark.md
@@ -23,9 +23,9 @@ For now, let’s keep `RemarkCommand` as simple as possible and print some outpu
**`RemarkCommand.java`:**
``` java
-package seedu.address.logic.commands;
+package seedu.times.logic.commands;
-import seedu.address.model.Model;
+import seedu.times.model.Model;
/**
* Changes the remark of an existing person in the address book.
@@ -91,7 +91,7 @@ Let’s change `RemarkCommand` to parse input from the user.
We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if our code is functioning as intended.
``` java
-import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
//...
public class RemarkCommand extends Command {
//...
@@ -142,7 +142,7 @@ Your code should look something like [this](https://github.com/se-edu/addressboo
Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user.
-Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` interface.
+Create a `RemarkCommandParser` class in the `seedu.times.logic.parser` package. The class must extend the `Parser` interface.
@@ -229,7 +229,7 @@ Now that we have all the information that we need, let’s lay the groundwork fo
### Add a new `Remark` class
-Create a new `Remark` in `seedu.address.model.person`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
+Create a new `Remark` in `seedu.times.model.person`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
A copy-paste and search-replace later, you should have something like [this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-af2f075d24dfcd333876f0fbce321f25). Note how `Remark` has no constrains and thus does not require input
validation.
@@ -242,7 +242,7 @@ Let’s change `RemarkCommand` and `RemarkCommandParser` to use the new `Remark`
Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each person.
-Simply add the following to [`seedu.address.ui.PersonCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
+Simply add the following to [`seedu.times.ui.studenttab.StudentCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
**`PersonCard.java`:**
@@ -295,7 +295,7 @@ While the changes to code may be minimal, the test data will have to be updated
-According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
+According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.times.logic.Logic`.
@@ -48,7 +48,7 @@ According to the sequence diagram you saw earlier (and repeated above for refere
:bulb: **Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
-A quick look at the `seedu.address.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
+A quick look at the `seedu.times.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
```java
public interface Logic {
@@ -190,7 +190,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
public CommandResult execute(Model model) throws CommandException {
...
Person personToEdit = lastShownList.get(index.getZeroBased());
- Person editedPerson = createEditedPerson(personToEdit, editPersonDescriptor);
+ Person editedPerson = createEditedPerson(personToEdit, editStudentDescriptor);
if (!personToEdit.isSamePerson(editedPerson) && model.hasPerson(editedPerson)) {
throw new CommandException(MESSAGE_DUPLICATE_PERSON);
}
diff --git a/src/main/java/seedu/address/commons/core/Messages.java b/src/main/java/seedu/address/commons/core/Messages.java
deleted file mode 100644
index 1deb3a1e469..00000000000
--- a/src/main/java/seedu/address/commons/core/Messages.java
+++ /dev/null
@@ -1,13 +0,0 @@
-package seedu.address.commons.core;
-
-/**
- * Container for user visible messages.
- */
-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_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
-
-}
diff --git a/src/main/java/seedu/address/logic/commands/AddCommand.java b/src/main/java/seedu/address/logic/commands/AddCommand.java
deleted file mode 100644
index 71656d7c5c8..00000000000
--- a/src/main/java/seedu/address/logic/commands/AddCommand.java
+++ /dev/null
@@ -1,67 +0,0 @@
-package seedu.address.logic.commands;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
-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_TAG;
-
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.model.Model;
-import seedu.address.model.person.Person;
-
-/**
- * Adds a person to the address book.
- */
-public class AddCommand extends Command {
-
- public static final String COMMAND_WORD = "add";
-
- public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
- + "Parameters: "
- + PREFIX_NAME + "NAME "
- + PREFIX_PHONE + "PHONE "
- + PREFIX_EMAIL + "EMAIL "
- + PREFIX_ADDRESS + "ADDRESS "
- + "[" + PREFIX_TAG + "TAG]...\n"
- + "Example: " + COMMAND_WORD + " "
- + PREFIX_NAME + "John Doe "
- + PREFIX_PHONE + "98765432 "
- + PREFIX_EMAIL + "johnd@example.com "
- + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
- + PREFIX_TAG + "friends "
- + PREFIX_TAG + "owesMoney";
-
- public static final String MESSAGE_SUCCESS = "New person added: %1$s";
- public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";
-
- private final Person toAdd;
-
- /**
- * Creates an AddCommand to add the specified {@code Person}
- */
- public AddCommand(Person person) {
- requireNonNull(person);
- toAdd = person;
- }
-
- @Override
- public CommandResult execute(Model model) throws CommandException {
- requireNonNull(model);
-
- if (model.hasPerson(toAdd)) {
- throw new CommandException(MESSAGE_DUPLICATE_PERSON);
- }
-
- model.addPerson(toAdd);
- return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
- }
-
- @Override
- public boolean equals(Object other) {
- return other == this // short circuit if same object
- || (other instanceof AddCommand // instanceof handles nulls
- && toAdd.equals(((AddCommand) other).toAdd));
- }
-}
diff --git a/src/main/java/seedu/address/logic/commands/Command.java b/src/main/java/seedu/address/logic/commands/Command.java
deleted file mode 100644
index 64f18992160..00000000000
--- a/src/main/java/seedu/address/logic/commands/Command.java
+++ /dev/null
@@ -1,20 +0,0 @@
-package seedu.address.logic.commands;
-
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.model.Model;
-
-/**
- * Represents a command with hidden internal logic and the ability to be executed.
- */
-public abstract class Command {
-
- /**
- * Executes the command and returns the result message.
- *
- * @param model {@code Model} which the command should operate on.
- * @return feedback message of the operation result for display
- * @throws CommandException If an error occurs during command execution.
- */
- public abstract CommandResult execute(Model model) throws CommandException;
-
-}
diff --git a/src/main/java/seedu/address/logic/commands/EditCommand.java b/src/main/java/seedu/address/logic/commands/EditCommand.java
deleted file mode 100644
index 7e36114902f..00000000000
--- a/src/main/java/seedu/address/logic/commands/EditCommand.java
+++ /dev/null
@@ -1,226 +0,0 @@
-package seedu.address.logic.commands;
-
-import static java.util.Objects.requireNonNull;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
-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_TAG;
-import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS;
-
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Optional;
-import java.util.Set;
-
-import seedu.address.commons.core.Messages;
-import seedu.address.commons.core.index.Index;
-import seedu.address.commons.util.CollectionUtil;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.model.Model;
-import seedu.address.model.person.Address;
-import seedu.address.model.person.Email;
-import seedu.address.model.person.Name;
-import seedu.address.model.person.Person;
-import seedu.address.model.person.Phone;
-import seedu.address.model.tag.Tag;
-
-/**
- * Edits the details of an existing person in the address book.
- */
-public class EditCommand extends Command {
-
- public static final String COMMAND_WORD = "edit";
-
- public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the person identified "
- + "by the index number used in the displayed person list. "
- + "Existing values will be overwritten by the input values.\n"
- + "Parameters: INDEX (must be a positive integer) "
- + "[" + PREFIX_NAME + "NAME] "
- + "[" + PREFIX_PHONE + "PHONE] "
- + "[" + PREFIX_EMAIL + "EMAIL] "
- + "[" + PREFIX_ADDRESS + "ADDRESS] "
- + "[" + PREFIX_TAG + "TAG]...\n"
- + "Example: " + COMMAND_WORD + " 1 "
- + PREFIX_PHONE + "91234567 "
- + PREFIX_EMAIL + "johndoe@example.com";
-
- public static final String MESSAGE_EDIT_PERSON_SUCCESS = "Edited Person: %1$s";
- public static final String MESSAGE_NOT_EDITED = "At least one field to edit must be provided.";
- public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book.";
-
- private final Index index;
- private final EditPersonDescriptor editPersonDescriptor;
-
- /**
- * @param index of the person in the filtered person list to edit
- * @param editPersonDescriptor details to edit the person with
- */
- public EditCommand(Index index, EditPersonDescriptor editPersonDescriptor) {
- requireNonNull(index);
- requireNonNull(editPersonDescriptor);
-
- this.index = index;
- this.editPersonDescriptor = new EditPersonDescriptor(editPersonDescriptor);
- }
-
- @Override
- public CommandResult execute(Model model) throws CommandException {
- requireNonNull(model);
- List-
:bulb: **Tip:**
-A person can have any number of tags (including 0)
+* For commands that alters the list of students (eg. `findname`, `findtag`, `sort name asc`), the displayed
+ changes for students will be shown in both the `Students` tab as well as the `Classes` tab.
+ This means that when students are filtered by their `name` and `tag`, they will be filtered by their `name` and `tag` in the `Classes` tab as well.
+ Likewise, when students are sorted by their names, they will be sorted in the `Classes` tab as well.
+
+* The `list` and `listclass` commands can be used to show the original lists of students and classes respectively.
+
+* Class size will **not** be affected by filtering students (using FindName or FindTag).
+
+
+#### Locating students by tag: `findtag`
++ +Finds students whose `TAG`s contain any of the given keywords. +Note that if you want to display the entire list of students again, run `list`. + +Format: +`findtag KEYWORD [, [KEYWORD]...]` + +* Search terms can partially match the tag, or the entire tag, e.g. `math` for all `A Math` and `C Math` tags, or `A Math` for the `A Math` tag. +* Search terms are separated by commas. e.g. `findtag math, physics` will find students + with tags containing `math` or `physics`. +* Students matching at least one search term will be returned (i.e. `OR` search). + e.g. `findtag math, physics` will return students with the `Math` `TAG` but no `Physics` `TAG`, + students with only the`Physics` `TAG` but no `Math` `TAG`, and students with both `TAG`s. +* The search is case-insensitive. e.g `math` will match `Math`. + Examples: -* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` -* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` +1. `findtag math` returns `Alex Yeoh` with the `A Math` `TAG` and `John Doe` with the `C Math` `TAG` in both `Students` and `Classes` tab. +2. `findtag math, physics` returns `Alex Yeoh` with the `A Math` and `Biology` `TAG`s in both `Students` and `Classes` tab. +
+ + +
+Example 1: Find Students with tag math +
+ + +
+
+**:information_source: Note:**
+ +* For commands that alters the list of students (eg. `findname`, `findtag`, `sort name asc`), the displayed + changes for students will be shown in both the `Students` tab as well as the `Classes` tab. + This means that when students are filtered by their `name` and `tag`, they will be filtered by their `name` and `tag` in the `Classes` tab as well. + Likewise, when students are sorted by their names, they will be sorted in the `Classes` tab as well. -### Listing all persons : `list` +* The `list` and `listclass` commands can be used to show the original lists of students and classes respectively. -Shows a list of all persons in the address book. +* Class size will **not** be affected by filtering students (using FindName or FindTag). +
+
+
+#### Listing all students : `list`
++ +* For commands that alters the list of students (eg. `findname`, `findtag`, `sort name asc`), the displayed + changes for students will be shown in both the `Students` tab as well as the `Classes` tab. + This means that when students are filtered by their `name` and `tag`, they will be filtered by their `name` and `tag` in the `Classes` tab as well. + Likewise, when students are sorted by their names, they will be sorted in the `Classes` tab as well. -### Listing all persons : `list` +* The `list` and `listclass` commands can be used to show the original lists of students and classes respectively. -Shows a list of all persons in the address book. +* Class size will **not** be affected by filtering students (using FindName or FindTag). +
+ +Shows a list of all students in the Students tab. Format: `list` -### Editing a person : `edit` + + + + + +#### Deleting a student : `delete` +
+ +Deletes the specified student from the TimesTable. + +Format: +`delete INDEX` +* Deletes the student at the specified `INDEX`. +* The index refers to the index number shown in the displayed student list in the `Students` tab. + +Examples: +1. `list` followed by `delete 2` deletes the 2nd student in the TimesTable. +2. `findname Betsy` followed by `delete 1` deletes the 1st student in the results of the `find` command. + + +
+Example 1: Deletes the 2nd student +
+ + + +### Class commands + +#### Adding a class: `addclass` ++ +Add a class to the TimesTable. + +Format: +`addclass cn/CLASS_NAME ct/CLASS_TIMING r/HOURLY_RATE l/LOCATION` + +* This command adds a new class to keep track of all classes that the user is teaching. +* `CLASS_TIMING` must be in the form `ct/DAY HH:MM-HH:MM` +* `DAY` is case insensitive. +* `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* `RATE` must be less than $1,000,000/hr + +Examples: +1. `addclass cn/CS2103T ct/MON 09:30-11:30 r/70 l/Nex Tuition Center` +Adds a new class with name `CS2103T`, with class timing `MON 09:30-11:30`, with hourly rate of $`70`, at `Nex +Tuition Center`. + +2. `addclass cn/Sec 4 E Maths ct/TUE 12:30-14:30 r/65 l/Block 123, Clementi Ave 6, #14-41` +Adds a new class with name `Sec 4 E Maths`, with class timing `Tue 12:30-14:30`, with hourly rate of $`65`, at `Block 123, Clementi Ave 6, #14-41`. + + +
+Example 1: Adding CS2103T class +
+ + -Edits an existing person in the address book. +#### Editing a class: `editclass` +-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` +Edits an existing class in the class list in the `classes` tab. -* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … +Format: +`editclass 1 [cn/CLASS_NAME] [ct/CLASS_TIMING] [r/RATE] [l/LOCATION]` + +* Edits the class at the specified `INDEX`. The index refers to the index number shown in the displayed class + list in the `classes` tab. + * The index **must be a positive integer** 1, 2, 3, … + * The index must belong to a class. * At least one of the optional fields must be provided. -* Existing values will be updated to the input values. -* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. -* You can remove all the person’s tags by typing `t/` without - specifying any tags after it. +* `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* Edit commands that will create a clash of `CLASS_TIMING` with other classes is not accepted. +* `RATE` must be less than $1,000,000/hr + + + +Examples: +1. `editclass 1 ct/wed 15:00-17:00` Edits the first class in the class list's `CLASS_TIMIMG` to be on Wednesday from +3pm to 5pm. + + +
+Example 1: Editing class indexed 1 +
+ + + +#### Adding student/students to a class: `addtoclass` ++ +Add a single or multiple students to an existing class. + +Format: +`addtoclass CLASS_INDEX STUDENT_INDEX...` + +* This command adds any number of existing students into an existing class. +* `CLASS_INDEX` is the index number of the class in the displayed class list in the `Classes` tab, which will be + receiving the new students. +* `STUDENT_INDEX...` are the index number/s of the students shown in the displayed student list in the `Students` tab, these students are + to be added into the class. +* Exactly one class index must be provided and at least one student index must be provided. +* Students that already exist in the class can't be added to the same class. +* If you enter duplicate student indices in one command, Timestable will only add the student once. +* Size of the class will change to reflect the number of students in the class. + + + +Example: +1. `addtoclass 13 1 2 3` +Adds the 1st, 2nd and 3rd student in the displayed student list in the `Students` tab into the 13th class in the +displayed class list in the `Classes` tab, `size` of the class will increase by 3. + + +
+Example 1: Adding students indexed 1, 2 and 3 to class indexed 13 +
+ + + +#### Removing students from a class: `removefromclass` ++ +Removes a single or multiple students from an existing class. + +Format: +`removefromclass CLASS_INDEX STUDENT_INDEX...` + +* Removes a non-zero number of existing students from an existing class. +* `CLASS_INDEX` is the index number of the class in the displayed class list in the `Classes` tab to have its students removed from. +* `STUDENT_INDEX...` are the index number(s) of the students, shown in the displayed student list of the class to be removed from + in the `Classes` tab. + + +Example: +1. `removefromclass 13 1 2 3` +Removes the 1st, 2nd and 3rd student in the displayed student list of the 13th class in the `classes` tab, causing the +`size` of 1st class to decrease by 3. + + +
+Example 1: Remove students indexed 1, 2 and 3 in class list from class indexed 13 +
+ + + +#### Locating class by class timing : `findclass` ++ +Finds a class whose `CLASS_TIMING` matches the given keyword. +Note that if you want to display the list of classes again, run `listclass`. + +Format: `findclass CLASS_TIMING` + + +* The valid keywords for `CLASS_TIMING` are limited to the following types: + 1. 3 letter abbreviation for day of the week e.g. `Mon`, `Tue`, etc. + 2. Time expressed in HH:MM-HH:MM format e.g. `11:30-12:30`, `15:00-16:00`, etc. + * `CLASS_TIMING` can only start and end at the hour mark or half hour mark, but can also end at 23:59 hours. +* Either a single keyword or two keywords of different types should be provided otherwise no classes would be returned. +* Multiple keywords of the same type (eg Mon Tue) would not return any classes, because the command finds classes which contain both timings (Mon and Tue), and + it is currently not possible to have a class with two different timings (ie a class that occurs on both Monday and Tuesday or both `10:00-12:00` and `17:00-19:00`) + * Important clarification: In TimesTable, class refers to a single slot per week in the timetable. +* If two keywords are entered, then the class returned would be the one that match all the keywords + (see example below). + + +Examples: +1. Single keyword + 1.1. `findclass mon` returns all classes on Monday. + 1.2. `findclass 10:00-12:00` returns all classes scheduled for `10:00 to 12:00` no matter which day of the week it belongs + to. +
Example 1.1: Find all classes on Monday
+2. Two keywords + 2.1 `findclass mon 11:30-13:30` returns the exact class on `Mon at 11:30-13:30`. + 2.2 `findclass tue 11:00-12:00` returns the exact class on `Tue at 11:00-12:00`.  +Example 2.1: Find classes on Monday at 11:30-13:30
+3. Negative examples (Two or more keywords of the same type) + 3.1 `findclass mon tue` returns nothing. + 3.2 `findclass 09:00-10:30 11:00-12:00` returns nothing. + + ++Example 3.1: Find classes with two keywords of the same type +
+ + + + +#### Locating class by class name: `findclassname` ++ +Finds a class whose class name matches the given keywords. +Note that if you want to display the list of classes again, run `listclass`. + +Format: +`findclassname CLASS_NAME [, [CLASS_NAME]...]` + +* The search is case-insensitive `PHYSICS` will match 'physics'. +* The search terms are split by commas. e.g. `findclassname sec 4 physics, jc math` +* Only the class' `CLASS_NAME` is searched. +* Partial matches will still be matched e.g. `Phy` will match `Physics`. +* Classes matching at least one search term will be returned (i.e. `OR` search). + e.g. `findclassname sec 4 phy, jc math` will return `sec 4 physics`, `jc mathematics`. +* The entire search term is used for matching e.g. `findclassname sec 4 phy` will match `sec 4 physics` + but not `sec 4 maths` + +Examples: +1. `findclassname math` returns all the classes with math in the class name. +2. `findclassname Sec, 4, maths` returns all the classes with `sec` or `4` or `maths` in the class name. Hence, + class with name `sec 4 physics` and class with name `JC maths` would both be returned. + + +
+Example 1: Find classes with math in the class name +
+ + + +#### Listing all the classes: `listclass` ++ +Shows a list of all classes in the Classes tab. + +Format: `listclass` + + + + + +#### Selecting of classes: `class` +
+ +Selects a class in the Classes tab and displays its students without the need to use the mouse to double click the respective class. + +Format: +`class CLASS_INDEX` + +* Selected class will not be highlighted in the same way as when you click on a class using the mouse. +* `CLASS_INDEX` must be an index of a class that exists in the displayed class list. Examples: -* `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. -* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. +* `class 1` selects the class with `CLASS_INDEX` of `1` and displays its students in the Classes tab. + + -### Locating persons by name: `find` + -Finds persons whose names contain any of the given keywords. +#### Delete a class: `deleteclass` +
-Format: `find KEYWORD [MORE_KEYWORDS]` +Deletes the specified class from the TimesTable. -* The search is case-insensitive. e.g `hans` will match `Hans` -* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` -* Only the name is searched. -* Only full words will be matched e.g. `Han` will not match `Hans` -* Persons matching at least one keyword will be returned (i.e. `OR` search). - e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` +Format: +`deleteclass INDEX` + +* Deletes the class at the specified `INDEX`. +* The index refers to the index number shown in the displayed class list in the `Classes` tab. Examples: -* `find John` returns `john` and `John Doe` -* `find alex david` returns `Alex Yeoh`, `David Li`
-  +* `listclass` followed by `deleteclass 2` deletes the 2nd class in the TimesTable. + + + + + +### General commands + +#### Sorting students and classes: `sort` +
+ +Sorts the students based on their `NAME` in alphabetical order, +or classes based on their `CLASS_TIMING`, in either ascending or descending order. + +Format: +`sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT` + +* `PARAMETER_TO_SORT_BY` can either be `name` or `timing` which sorts the students and classes respectively. +* `DIRECTION_OF_SORT` can either be `asc` or `desc` to represent ascending and descending respectively. +* Sorting by `name` sorts the students in the Students tab and Classes tab but sorting by `timing` only sorts the classes in Classes tab but not the students in Students tab. + +Examples: +1. `sort name asc` sorts students alphabetically by their `NAME` in ascending order. +2. `sort name desc` sorts students alphabetically by their `NAME` in descending order. +3. `sort timing asc` sorts classes based on their `CLASS_TIMING` starting from the earliest in the week to the latest. +4. `sort timing desc` sorts classes based on their `CLASS_TIMING` starting from the latest in the week to the earliest. + + +
+Example 1: Sorts students in alphabetical order +
-### Deleting a person : `delete` -Deletes the specified person from the address book. +
+
+**:information_source: Note:**
+ +* For commands that alters the list of students (eg. `findname`, `findtag`, `sort name asc`), the displayed + changes for students will be shown in both the `Students` tab as well as the `Classes` tab. + This means that when students are filtered by their `name` and `tag`, they will be filtered by their `name` and `tag` in the `Classes` tab as well. + Likewise, when students are sorted by their names, they will be sorted in the `Classes` tab as well. + +* The `list` and `listclass` commands can be used to show the original lists of students and classes respectively. + +* Class size will **not** be affected by filtering students (using FindName or FindTag). +
+
+
+
+#### Viewing of different tabs: `view`
++ +* For commands that alters the list of students (eg. `findname`, `findtag`, `sort name asc`), the displayed + changes for students will be shown in both the `Students` tab as well as the `Classes` tab. + This means that when students are filtered by their `name` and `tag`, they will be filtered by their `name` and `tag` in the `Classes` tab as well. + Likewise, when students are sorted by their names, they will be sorted in the `Classes` tab as well. + +* The `list` and `listclass` commands can be used to show the original lists of students and classes respectively. + +* Class size will **not** be affected by filtering students (using FindName or FindTag). +
-Format: `delete INDEX` +Views an existing tab in the TimesTable without the need to use the mouse to click. -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +Format: +`view TAB_TO_VIEW` + +* `TAB_TO_VIEW` has to be an existing tab in Timestable (`students`, `classes`, `timetable`). Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +1. `view timetable` switches the displayed tab to be the `timetable` tab. + + -### Clearing all entries : `clear` +#### Clearing all entries : `clear` +
-Clears all entries from the address book. +Clears all entries from the TimesTable. Format: `clear` -### Exiting the program : `exit` + + +#### Viewing help : `help` +
+ +Shows a message explaining how to access the help page. + +Format: `help` + + + +#### Exiting the program : `exit` +
Exits the program. Format: `exit` -### Saving the data +#### Saving the data +
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +TimesTable data is saved in the hard disk automatically in the `data` folder present in the same directory as `timestable.jar` after any command that changes the data. There is no need to save manually. -### Editing the data file +#### Editing the data file +
-AddressBook data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +TimesTable data are saved as a JSON file `[JAR file location]/data/timestable.json`. Advanced users are welcome to update data directly by editing that data file.
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
+If your changes to the data file makes its format invalid, Timestable will discard all data and start with an empty data file at the next run.
-### Archiving data files `[coming in v2.0]`
-
-_Details coming soon ..._
-
--------------------------------------------------------------------------------------------------------------------
## FAQ
**Q**: How do I transfer my data to another Computer?-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Timestable home folder. + +**Q**: Are you going to add XXX feature? What features are you planning to add?
+**A**: I'm glad you asked! We're currently planning to add the following features: + + + +### Upcoming Features: + +#### Payment Management with Invoice + +Different classes you teach will have different hourly rates, and they will of course have varying lengths and frequencies. +Having to keep track of how much someone has to pay and whether they have paid is a major source of stress. + +We recognise this demand, and thus are working on this feature for you to easily track required payments to students. + +A work in progress sneak peak of the feature is shown below. + + + +After a class, just input the time taught for that class and mark the attendance of those present. + +For each student present, TimesTable will take the hourly rate multiplied by the +session length for each person present to calculate the amount that each student has to pay. + +The session length field is useful when the class length goes beyond the intended length or when the class cuts short. + +This information will then be consolidated in an invoice to be generated. + +When you want to generate a new invoice, simply use the 'createinvoice' command. Invoices will be generated for all +students of the selected class. These invoices will use the session attendances recorded since the last invoice, generating +a table with the relevant information such as session date, session length, hourly rate, student name, and so on. You will +also be able to set the due date for the invoice. + +An example of the invoice generated is shown below. + + + +With this invoice generation feature, you will easily be able to charge the correct amount to your clients +and you would also not have to worry about providing evidence. TimesTable will take care of it for you. + +In addition to invoice generation, we are also working on an invoice management feature that will allow you to track +the status of each invoice. You will be able to mark the invoices as paid, and archive them. TimesTable will also +alert you once the due date for any invoice has passed. You can simply let TimesTable keep track of all payments for you. + + +If there are any other proposed features, please submit an issue via our GitHub over [here](https://github.com/AY2122S1-CS2103T-F11-1/tp/issues) and we'll look into it! -------------------------------------------------------------------------------------------------------------------- + ## Command summary -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +### Student Commands Summary + +Action | Format, Examples| +--------|------------------| +**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… nok/ n/NOK_NAME p/NOK_PHONE_NUMBER e/NOK_EMAIL a/NOK_ADDRESS`
e.g., `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/ALevels nok/ n/Mary Doe p/93334848 e/mary23@gmail.com a/311, Clementi Ave 2, #02-25 `| +**Delete** | `delete INDEX`
e.g., `delete 3`| +**Edit** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [nok/ [n/NOK_NAME] [p/NOK_PHONE] [e/NOK_EMAIL] [a/NOK_ADDRESS]]`
e.g.,`edit 2 n/James Lee e/jameslee@example.com`| +**Find name** | `findname NAME [, [NAME]...]`
e.g., `find Stuart`| +**Find tag** | `findtag KEYWORD [, [KEYWORD]...]`
e.g., `findtag math, physics`| +**List** | `list`| +**Sort** | `sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT`
e.g., `sort name asc`| + + + +### Class Commands Summary + +Action | Format, Examples| +--------|------------------| +**Add class** | `addclass cn/CLASS_NAME ct/CLASS_TIMING r/HOURLY_RATE l/LOCATION`
e.g., `addclass cn/Sec 4 A Maths ct/mon 11:30-13:30 r/70 l/Nex Tuition Center`| +**Add to class** | `addtoclass CLASS_INDEX STUDENT_INDEX…`
e.g., `addtoclass 1 1 2 3`| +**Delete class** | `deleteclass INDEX`
e.g., `deleteclass 2`| +**Edit class** | `editclass 1 [cn/CLASS_NAME] [ct/CLASS_TIMING] [r/RATE] [l/LOCATION]`
e.g., `editclass 1 ct/wed 15:00-17:00`| +**Find class name** | `findclassname CLASS_NAME [, [CLASS_NAME]...]`
e.g., `findclassname math`| +**Find class timing** | `findclass CLASS_TIMING`
e.g., `findclass mon 11:00-12:00`| +**List class** | `listclass`| +**Remove from class** | `removefromclass CLASS_INDEX STUDENT_INDEX...`
e.g., `removefromclass 1 1 2 3`| +**Select class** | `class CLASS_INDEX`
e.g., `class 2`| +**Sort** | `sort PARAMETER_TO_SORT_BY DIRECTION_OF_SORT`
e.g., `sort timing asc`| + + + +### General Commands Summary + +Action | Format, Examples| +--------|------------------| +**Clear** | `clear`| +**Exit** | `exit`| +**Help** | `help`| +**View** | `view TAB_TO_VIEW`
e.g., `view timetable`| + diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..e8033f05b1d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,4 +1,4 @@ -title: "AB-3" +title: "TimesTable" theme: minima header_pages: @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2122S1-CS2103T-F11-1/tp" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss index 0d3f6e80ced..75676f22a40 100644 --- a/docs/_sass/minima/_base.scss +++ b/docs/_sass/minima/_base.scss @@ -288,7 +288,7 @@ table { text-align: center; } .site-header:before { - content: "AB-3"; + content: "TimesTable"; font-size: 32px; } } diff --git a/docs/diagrams/AddClassModelSequenceDiagram.puml b/docs/diagrams/AddClassModelSequenceDiagram.puml new file mode 100644 index 00000000000..dbcba75a96a --- /dev/null +++ b/docs/diagrams/AddClassModelSequenceDiagram.puml @@ -0,0 +1,29 @@ +@startuml +!include style.puml + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +participant ":TimesTable" as TimesTable MODEL_COLOR_T3 +participant ":UniqueClassList" as UniqueClassList MODEL_COLOR_T3 +participant "internalList:ObservableArrayList" as ObservableArrayList MODEL_COLOR_T3 +end box + +[-> Model : addTuitionClass(t) +activate Model + +Model -> TimesTable : addTuitionClass(t) +activate TimesTable + +TimesTable -> UniqueClassList : add(t) +activate UniqueClassList + +UniqueClassList -> UniqueClassList : isValidTiming(t) +activate UniqueClassList +UniqueClassList --> UniqueClassList +deactivate UniqueClassList + +UniqueClassList -> ObservableArrayList : add(t) +activate ObservableArrayList + + +@enduml diff --git a/docs/diagrams/AddClassRef1.puml b/docs/diagrams/AddClassRef1.puml new file mode 100644 index 00000000000..f4d47533b93 --- /dev/null +++ b/docs/diagrams/AddClassRef1.puml @@ -0,0 +1,31 @@ +@startuml +!include style.puml + +group sd generate StudentNameList and TuitionClass + +box Logic LOGIC_COLOR_T1 +participant ":AddClassCommandParser" as AddClassCommandParser LOGIC_COLOR +participant "s:StudentNameList" as StudentNameList LOGIC_COLOR +participant "t:TuitionClass" as TuitionClass LOGIC_COLOR +end box + +activate AddClassCommandParser +create StudentNameList +AddClassCommandParser -> StudentNameList : StudentNameList() +activate StudentNameList + +StudentNameList --> AddClassCommandParser : s +deactivate StudentNameList + +create TuitionClass +AddClassCommandParser -> TuitionClass : TuitionClass(className, classTiming, location, rate, s) +activate TuitionClass + +TuitionClass --> AddClassCommandParser : t +deactivate TuitionClass + + + + +end +@enduml diff --git a/docs/diagrams/AddClassSequenceDiagram.puml b/docs/diagrams/AddClassSequenceDiagram.puml new file mode 100644 index 00000000000..62f2578b557 --- /dev/null +++ b/docs/diagrams/AddClassSequenceDiagram.puml @@ -0,0 +1,71 @@ +@startuml +!include style.puml + +box Logic LOGIC_COLOR_T1 +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR +participant ":AddClassCommandParser" as AddClassCommandParser LOGIC_COLOR +participant "a:AddClassCommand" as AddClassCommand LOGIC_COLOR +participant ":CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +[-> LogicManager : execute("addclass cn/... ct/... r/.. l/...") +activate LogicManager + +LogicManager -> TimesTableParser : parseCommand("addclass cn/... ct/... r/.. l/...") +activate TimesTableParser + +create AddClassCommandParser +TimesTableParser -> AddClassCommandParser +activate AddClassCommandParser + +AddClassCommandParser --> TimesTableParser +deactivate AddClassCommandParser + +TimesTableParser -> AddClassCommandParser : parse("cn/... ct/... r/.. l/...") +activate AddClassCommandParser + +ref over AddClassCommandParser : generate StudentNameList and TuitionClass + +create AddClassCommand +AddClassCommandParser -> AddClassCommand : AddClassCommand(t) +activate AddClassCommand + +AddClassCommand --> AddClassCommandParser : a +deactivate AddClassCommand + +AddClassCommandParser --> TimesTableParser : a +deactivate AddClassCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +AddClassCommandParser -[hidden]-> TimesTableParser +destroy AddClassCommandParser + +TimesTableParser --> LogicManager : a +deactivate TimesTableParser + +LogicManager -> AddClassCommand : execute() +activate AddClassCommand + +AddClassCommand -> Model : addTuitionClass(t) +activate Model +deactivate Model + + + +create CommandResult +AddClassCommand -> CommandResult +activate CommandResult + +CommandResult --> AddClassCommand +deactivate CommandResult + +AddClassCommand --> LogicManager : result +deactivate AddClassCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/diagrams/AddToClassCreationSequenceDiagram.puml b/docs/diagrams/AddToClassCreationSequenceDiagram.puml new file mode 100644 index 00000000000..89c2d021b4e --- /dev/null +++ b/docs/diagrams/AddToClassCreationSequenceDiagram.puml @@ -0,0 +1,55 @@ +@startuml +!include Style.puml + +box Logic LOGIC_COLOR_T1 + +participant ":LogicManager" as LogicManager LOGIC_COLOR +participant ":TimesTableParser" as TimesTableParser LOGIC_COLOR +participant ":AddToClassCommandParser" as AddToClassCommandParser LOGIC_COLOR +participant "c:AddToClassCommand" as AddToClassCommand LOGIC_COLOR +participant "result:CommandResult" as CommandResult LOGIC_COLOR +end box + +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +end box + +-> LogicManager: execute("addtoclass 1 1") +activate LogicManager +LogicManager -> TimesTableParser: parseCommand("addtoclass 1 1") +activate TimesTableParser +create AddToClassCommandParser +TimesTableParser -> AddToClassCommandParser +activate AddToClassCommandParser +TimesTableParser <-- AddToClassCommandParser +deactivate AddToClassCommandParser +TimesTableParser -> AddToClassCommandParser: parse("1 1") +activate AddToClassCommandParser +create AddToClassCommand +AddToClassCommandParser -> AddToClassCommand: AddToClassCommand(indexArray) +activate AddToClassCommand +AddToClassCommandParser <-- AddToClassCommand: c +deactivate AddToClassCommand +TimesTableParser <-- AddToClassCommandParser: c +deactivate AddToClassCommandParser +LogicManager <-- TimesTableParser: c +deactivate TimesTableParser + +LogicManager -> AddToClassCommand: execute() +activate AddToClassCommand +ref over AddToClassCommand, Model : Match Student and Class Indices to their objects. Create updated Name list. +AddToClassCommand -> Model: setClass(classToAddTo, editedClass) +activate Model +AddToClassCommand <-- Model +deactivate Model +create CommandResult +AddToClassCommand -> CommandResult +activate CommandResult +AddToClassCommand <-- CommandResult +deactivate CommandResult +LogicManager <-- AddToClassCommand: result +deactivate AddToClassCommand +<-- LogicManager: result +deactivate LogicManager + +@enduml diff --git a/docs/diagrams/AddToClassExecutionSequenceDiagram.puml b/docs/diagrams/AddToClassExecutionSequenceDiagram.puml new file mode 100644 index 00000000000..b38adbaa8e4 --- /dev/null +++ b/docs/diagrams/AddToClassExecutionSequenceDiagram.puml @@ -0,0 +1,89 @@ +@startuml +!include Style.puml + +box Logic LOGIC_COLOR_T1 +participant ":AddToClassCommand" as AddToClassCommand LOGIC_COLOR +participant "result:CommandResult" as CommandResult LOGIC_COLOR +end box +box Model MODEL_COLOR_T1 +participant ":Model" as Model MODEL_COLOR +participant "classList:ObservableList
-:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
+:exclamation: You must delete AddressBook’s storage file located at `/data/timestable.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
diff --git a/docs/tutorials/RemovingFields.md b/docs/tutorials/RemovingFields.md
index f29169bc924..5b718e73164 100644
--- a/docs/tutorials/RemovingFields.md
+++ b/docs/tutorials/RemovingFields.md
@@ -28,7 +28,7 @@ IntelliJ IDEA provides a refactoring tool that can identify *most* parts of a re
### Assisted refactoring
-The `address` field in `Person` is actually an instance of the `seedu.address.model.person.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
+The `address` field in `Person` is actually an instance of the `seedu.times.model.person.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
* :bulb: To make things simpler, you can unselect the options `Search in comments and strings` and `Search for text occurrences`
@@ -96,7 +96,7 @@ At this point, your application is working as intended and all your tests are pa
In `src/test/data/`, data meant for testing purposes are stored. While keeping the `address` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
-**`invalidPersonAddressBook.json`:**
+**`invalidPersonTimesTable.json`:**
```json
{
diff --git a/docs/tutorials/TracingCode.md b/docs/tutorials/TracingCode.md
index 4fb62a83ef6..91bac22457d 100644
--- a/docs/tutorials/TracingCode.md
+++ b/docs/tutorials/TracingCode.md
@@ -39,7 +39,7 @@ In our case, we would want to begin the tracing at the very point where the App
-According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
+According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.times.logic.Logic`.
@@ -48,7 +48,7 @@ According to the sequence diagram you saw earlier (and repeated above for refere
:bulb: **Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
+ * A {@code Student} can have multiple {@code TuitionClass}es as well. + * + * @param className The name of the class to be created. + * @param classTiming The timing of the class specified. This is the unique identifier (id) of the class. + * @param location The location of the class. + * @param rate How much it costs per hour to attend the class. + */ + public TuitionClass(ClassName className, ClassTiming classTiming, Location location, Rate rate, + StudentNameList studentNameList) { + requireAllNonNull(className, classTiming, location, rate); + this.className = className; + this.classTiming = classTiming; + this.location = location; + this.rate = rate; + this.studentNameList = studentNameList; + } + + /** + * Represents a tuition class for Students to join. A {@code TuitionClass} can have multiple {@code Student}s. + * A class is uniquely identified by its timing; a single timing can only have _one_ class. Without the + * StudentNameList. + *
+ * A {@code Student} can have multiple {@code TuitionClass}es as well.
+ *
+ * @param className The name of the class to be created.
+ * @param classTiming The timing of the class specified. This is the unique identifier (id) of the class.
+ * @param location The location of the class.
+ * @param rate How much it costs per hour to attend the class.
+ */
+ public TuitionClass(ClassName className, ClassTiming classTiming, Location location, Rate rate) {
+ requireAllNonNull(className, classTiming, location, rate);
+ this.className = className;
+ this.classTiming = classTiming;
+ this.location = location;
+ this.rate = rate;
+ this.studentNameList = new StudentNameList();
+ }
+
+ public ClassName getClassName() {
+ return className;
+ }
+
+ public String getClassNameString() {
+ return className.toString();
+ }
+
+ public ClassTiming getClassTiming() {
+ return classTiming;
+ }
+
+ public LocalTime getStartTiming() {
+ return classTiming.getStartTime();
+ }
+
+ public LocalTime getEndTiming() {
+ return classTiming.getEndTime();
+ }
+
+ public Location getLocation() {
+ return location;
+ }
+
+ public Rate getRate() {
+ return rate;
+ }
+
+ /**
+ * Returns whether the tuition class contains the Student.
+ *
+ * @return whether the tuition class contains the Student or not.
+ */
+ public boolean containsStudent(Name name) {
+ return studentNameList.contains(name);
+ }
+
+ public StudentNameList getStudentList() {
+ return studentNameList;
+ }
+
+ public void addStudent(Name name) {
+ studentNameList.add(name);
+ }
+
+ public void addAllStudents(Name... names) {
+ studentNameList.addAll(Arrays.asList(names));
+ }
+
+ /**
+ * Removes student name from the name list.
+ *
+ * @param name to be removed.
+ * @return this after name has been removed.
+ */
+ public TuitionClass removeStudent(Name name) {
+ if (studentNameList.contains(name)) {
+ studentNameList.remove(name);
+ }
+ return this;
+ }
+
+ public void addStudentList(StudentNameList studentNameList) {
+ this.studentNameList.addAll(studentNameList);
+ }
+
+ /**
+ * Checks if the TuitionClass is at this timing.
+ */
+ public boolean isAtTiming(ClassTiming otherClassTiming) {
+ return classTiming.equals(otherClassTiming);
+ }
+
+
+ @Override
+ public boolean equals(Object other) {
+ if (other == this) {
+ return true;
+ }
+
+ if (!(other instanceof TuitionClass)) {
+ return false;
+ }
+
+ TuitionClass o = (TuitionClass) other;
+ return o.className.equals(getClassName())
+ && o.classTiming.equals(getClassTiming())
+ && o.rate.equals(getRate())
+ && o.location.equals(getLocation())
+ && o.studentNameList.equals(getStudentList());
+ }
+
+ /**
+ * Returns true if the class timing of the class to be checked overlaps with this class.
+ */
+ public boolean isOverlapping(TuitionClass toCheck) {
+ if (this.equals(toCheck)) {
+ return true;
+ } else if (this.getClassTiming().isSameDay(toCheck.getClassTiming()) //on the same day
+ && ((toCheck.getStartTiming().compareTo(this.getEndTiming()) < 0
+ && toCheck.getStartTiming().compareTo(this.getStartTiming()) >= 0) // && toCheck start time overlap
+ // with this
+ || (toCheck.getEndTiming().compareTo(this.getEndTiming()) <= 0
+ && toCheck.getEndTiming().compareTo(this.getStartTiming()) > 0) //toCheck end time overlap with this
+ || (toCheck.getStartTiming().compareTo(this.getStartTiming()) <= 0 //toCheck starts earlier than this
+ && toCheck.getEndTiming().compareTo(this.getEndTiming()) >= 0))) { //toCheck ends later than this
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Checks if 2 TuitionClass are the same using ClassTiming.
+ *
+ * @param otherClass to be checked with this.
+ * @return boolean.
+ */
+ public boolean isSameClass(TuitionClass otherClass) {
+ if (otherClass == this) {
+ return true;
+ }
+
+ return otherClass != null
+ && otherClass.getClassTiming().equals(getClassTiming());
+ }
+
+ public boolean isAfter(LocalTime time) {
+ return this.classTiming.isAfter(time);
+ }
+
+ public LocalTime getStartTime() {
+ return this.classTiming.getStartTime();
+ }
+
+ public LocalTime getEndTime() {
+ return this.classTiming.getEndTime();
+ }
+
+ public int getDayToInt() {
+ return this.classTiming.getDayToInt();
+ }
+
+ public void replaceStudentName(Name newName, Name oldName) {
+ studentNameList.replaceStudentName(newName, oldName);
+ }
+
+ @Override
+ public String toString() {
+ final StringBuilder builder = new StringBuilder();
+
+ builder.append("Class Timing: ")
+ .append(getClassTiming())
+ .append(" ");
+
+ if (!getClassTiming().equals(getClassName())) {
+ builder.append(" Class Name: ")
+ .append(getClassName())
+ .append(" ");
+ }
+
+ builder.append("Location: ")
+ .append(getLocation())
+ .append(" ");
+
+ builder.append("Rate: ")
+ .append(getRate())
+ .append(" ");
+
+ return builder.toString();
+ }
+}
diff --git a/src/main/java/seedu/times/model/tuitionclass/UniqueClassList.java b/src/main/java/seedu/times/model/tuitionclass/UniqueClassList.java
new file mode 100644
index 00000000000..318647fcc8f
--- /dev/null
+++ b/src/main/java/seedu/times/model/tuitionclass/UniqueClassList.java
@@ -0,0 +1,176 @@
+package seedu.times.model.tuitionclass;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.times.commons.util.CollectionUtil.requireAllNonNull;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+import seedu.times.model.person.Name;
+import seedu.times.model.tuitionclass.exceptions.DuplicateClassException;
+import seedu.times.model.tuitionclass.exceptions.OverlappingClassException;
+import seedu.times.model.tuitionclass.exceptions.TuitionClassNotFoundException;
+
+/**
+ * A list of classes that makes sure there is no overlap between class timings.
+ */
+public class UniqueClassList implements Iterable