Update DG with implementation details for loan view GUI #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #77 +/- ##
=========================================
Coverage 59.43% 59.43%
Complexity 442 442
=========================================
Files 85 85
Lines 1817 1817
Branches 178 178
=========================================
Hits 1080 1080
Misses 692 692
Partials 45 45 ☔ View full report in Codecov by Sentry. |
Joseph31416
approved these changes
Mar 27, 2024
| @@ -302,10 +302,12 @@ _{more aspects and alternatives to be added} | |||
| ### Loan Analytics - Joseph | |||
|
|
|||
| #### Implementation | |||
|
|
|||
|
|
||
| #### Design Considerations | ||
|
|
||
| ##### Aspect: How the GUI is updated |
There was a problem hiding this comment.
Good consideration of implementation.
|
|
||
| ### Loan view GUI - Kyal Sin Min Thet | ||
|
|
||
| #### Implementation |
There was a problem hiding this comment.
Clear description of implementation.
xiaorui-ui
reviewed
Mar 27, 2024
| * Pros: Follows the observer design pattern, reducing coupling between the `Model` and `MainWindow` components. | ||
| * Cons: The GUI updates are restricted to the observable properties of the `Model` component. | ||
|
|
||
| * **Alternative 2:** The GUI updates are done by the `MainWindow` component. |
| @@ -402,6 +444,7 @@ Sequence diagram for the deletion of a loan: | |||
| **Target user profile**: | |||
|
|
|||
| The target user is businessman who satisfies the following criteria | |||
|
|
|||
| * **Alternative 2:** The GUI updates are done by the `MainWindow` component. | ||
| * Pros: More explicit control over the GUI updates. | ||
| * Cons: `Model` needs a reference to `MainWindow` to update the GUI directly. This increases coupling between the | ||
| components. |
There was a problem hiding this comment.
Careful analysis of pros and cons, good!
| * **Non-Functional Requirements**: A requirement that specifies criteria that can be used to judge the operation of | ||
| a system, rather than specific behaviours. | ||
| * **Non-Functional Requirements**: A requirement that specifies criteria that can be used to judge the operation of | ||
| a system, rather than specific behaviours. | ||
| * **Mainstream OS**: Windows, Linux, Unix, or MacOS | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- |
kjw142857
approved these changes
Mar 28, 2024
| ##### Aspect: Initialization of the Analytics object: | ||
|
|
There was a problem hiding this comment.
I like how you left blank lines to increase clarity and structure of the file!
| @@ -347,13 +351,14 @@ parsed and transformed into an appropriate format. | |||
| The parsing of the command is done by the `DeleteLoanCommandParser` class, which is responsible for parsing the user | |||
| input. | |||
|
|
|||
| The `DeleteLoanCommand` class is instantiated in the `DeleteLoanCommandParser` class, while the | |||
| The `DeleteLoanCommand` class is instantiated in the `DeleteLoanCommandParser` class, while the | |||
There was a problem hiding this comment.
Nice catch on the removed whitespace!
| * **Alternative 1 (current choice):** The `DeleteLoanCommand` class is responsible for executing the command only. | ||
| * Pros: Follows the Single Responsibility Principle. Simpler to debug. | ||
| * Cons: May result in more classes. | ||
| * **Alternative 2:** The `LogicManager` class is responsible for executing the command. | ||
| * Pros: More centralized command execution. | ||
| * Cons: May result in the `LogicManager` class becoming too large. This also goes against various SWE principles, | ||
| and makes the code harder to maintain. | ||
| and makes the code harder to maintain. |
There was a problem hiding this comment.
Again, good effort to standardise the formatting!
| contact. It generates new `LoanCard` objects according to the `loanList` in the `Model` class. | ||
| To accommodate the new GUI component, the `MainWindow.java` file is updated to include the new `LoanListPanel`. | ||
|
|
||
| To ensure that only either the loan list or the person list is displayed, an additional `BooleanProperty` is added to |
There was a problem hiding this comment.
Nice explanation of why the BooleanProperty is abstracted out!
| the `Model` | ||
| component to act as a flag to indicate which list is currently being displayed. This flag is updated by corresponding | ||
| commands. | ||
| For instance, commands such as `list` will toggle the flag to false, while `viewloan` will toggle the flag to true. |
There was a problem hiding this comment.
Clear and concise examples of what will cause the flag to toggle, well done!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.