[D2] 4.1 Principle 1

[gohguanlin]

TODO: Principle 1 of SOLID principle.

To be completed on

[gohguanlin]

Identified Single Responsibility Principle violated for my QuarterlyReport Class. Currently QuarterlyReport Controller is responsible for mainly:

1. Pulling project progress data via iProgress interface from M2.
2. Compiling data for project progress.
3. Perform data analysis on compiled data.
4. Generation of report.

Therefore there are 4 reasons to change if modifications is required in the class:

1. Ways to interface or format of data from M2
2. Ways or timeframe to compile progress data (Quarterly to Annual)
3. Metrics/algorithm change on how analysis is performed
4. Different format or output is required to be changed

As a result, the responsibilities should be split into 4 different classes namely:

DataProvider

• Interface via iProgress from M2 and pull required project progress data.

DataCompiler

• Takes data from DataProvider and compiles it in required timeframe and format.

DataAnalysis

• Takes data from DataCompiler and perform data analysis on data.

ReportGenerator

• Takes data from DataCompiler and DataAnalysis to put together a report and prepare it for export.

[gohguanlin]

Amended class diagram for QuarterlyReport. The new classes are split according to their responsibilities.

Reviewed and acknowledged by team members:

• [x] Yi Kiat
• [x] Jing Yi
• [x] Jia Xin
• [x] Ai Xin

[jiaxinlarhh]

Completed and closed on 16/3