How tmaszrit/peerevalsc works
• Data Source Layer: Represent the external CSV files (located under the “data” directory) as the raw data source for peer evaluation submissions.
• Data Ingestion/Parsing: Include the EvalParser component which reads and processes CSV files. This module is responsible for converting raw CSV data into domain objects.
• Domain/Model Layer: Capture the core domain objects such as Course, Eval, EvalMessage, Student, and Team. This layer represents the application’s business logic.
• Presentation/View Layer: Show the JavaFX-based GUI components. This includes components like PeerEvalGUI, EvalPane, StudentPane, MailDialog, and supporting widgets. The primary and secondary FXML files in the resources/activities folder also belong here.
• Application Bootstrap: Include the main entry points like HelloFX, which likely initialize the JavaFX application.
• Build & Configuration: Although not a component in runtime, the pom.xml denotes Maven managing dependencies (like JavaFX) and the module-info.java indicates the application’s modular design.
Relationships and Interactions
• From the Parsing module, show transformation into Domain Model objects. These objects (Course, Eval, etc.) are then used by the business logic.
• Communication between the Domain/Model Layer and the Presentation/View Layer. For instance, the GUI (PeerEvalGUI and its associated panes) fetches, displays, and likely manipulates these domain objects.
• The application bootstrap (HelloFX) ties the view and model layers together by instantiating the necessary components on application startup.
• Optionally, include testing (unit tests under src/test) that validate the correctness of these components.
Architectural Patterns and Key Technologies
• MVC pattern or its variation within the project. The separation between the model (data and business logic) and view (JavaFX UI) is clear.
• Use of Maven (pom.xml) for build management and dependency management, ensuring that all modules and libraries (like JavaFX) are integrated properly.
• Mention that the modular design (module-info.java) encourages clear module boundaries within the Java ecosystem.
• That the design supports CSV-based data ingestion which is typical for legacy data-driven systems where manual file data is processed.
Final Checklist
• All major components should be clearly labeled.
• If applicable, include a ‘Test’ block to represent unit tests as an ancillary component ensuring quality assurance.