Skip to content

FeedbackReport Class Documentation

Jump to bottom
100levelz edited this page Nov 21, 2023 · 6 revisions

Overview

The FeedbackReport class is responsible for generating a PDF report based on the feedback data collected for students. The report includes a header and content, which are added to the document by the ReportHeader and ReportContent classes respectively. This documentation outlines the key functionalities and methods within the class. It utilizes the iText library for PDF generation.

Class-Level

Constructor

  • public FeedbackReport(ReportContent content): This constructor creates a new FeedbackReport instance, initializing the document, headers, and content components. The ReportContent object passed as a parameter should contain the necessary feedback data.

Method-Level

Methods

  • public void generateDocument(): Initiates the generation of a PDF document by creating an instance of the Document class and coordinating the addition of headers and content. The resulting document is saved with a filename derived from the original feedback file.

Field-Level

Fields

  • private Document document: This field represents the document that the feedback report will be written to. It's used to add elements such as paragraphs, tables, and images to the report.

  • private ReportHeader headers: This field represents the headers of the report. It's used to store information such as the student's ID, assignment Number, and school information on the report.

  • private ReportContent content: This field represents the content of the report. It's used to store the actual feedback that will be included in the report.

Clone this wiki locally