Package de.svws_nrw.module.reporting.factories

Klasse HtmlFactory

java.lang.Object
de.svws_nrw.module.reporting.factories.HtmlFactory
public class HtmlFactory extends Object

Diese Klasse erstellt HTML-Inhalte auf Basis des in den Reporting-Parametern übergebenen HTML-Templates und der übergebenen Daten.

Dabei erstellt die Factory bei der Initialisierung zunächst die Contexts mit den Daten gemäß dem HTML-Template. Zum Erstellen der HTML-Inhalte generiert die Factory einen oder mehrere HTML-Builder, die aus dem Template das fertige HTML erzeugen.

Die HTML-Builder können extern weiter verarbeitet werden oder es kann intern eine Response im HTML-Format erzeugt werden.

  • Konstruktordetails

    • HtmlFactory

      protected HtmlFactory(ReportingRepository reportingRepository) throws ApiOperationException
      Erzeugt eine neue HTML-Factory, um eine HTML-Datei aus einem HTML-Template zu erzeugen.
      Parameter:
      reportingRepository - Repository für das Reporting, welches verschiedene Daten aus der Datenbank zwischenspeichert.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

  • Methodendetails

    • initContextSchueler

      public void initContextSchueler() throws ApiOperationException
      Initialisiert den Context für Schüler.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextKlassen

      public void initContextKlassen() throws ApiOperationException
      Initialisiert den Context für Klassen.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextKurse

      public void initContextKurse() throws ApiOperationException
      Initialisiert den Context für Kurse.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextLehrer

      public void initContextLehrer() throws ApiOperationException
      Initialisiert den Context für Lehrer.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextGostLaufbahnplanungAbiturjahrgangFachwahlstatistiken

      public void initContextGostLaufbahnplanungAbiturjahrgangFachwahlstatistiken() throws ApiOperationException
      Initialisiert die Fachwahlstatistiken für den Context der GOSt-Laufbahnplanung eines Abiturjahrgangs.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextGostKursplanung

      public void initContextGostKursplanung() throws ApiOperationException
      Initialisiert den Context für die GOSt-Kursplanung.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextGostKlausurplanung

      public void initContextGostKlausurplanung() throws ApiOperationException
      Initialisiert den Context für die GOSt-Klausurplanung.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • initContextStundenplanung

      public void initContextStundenplanung() throws ApiOperationException
      Initialisiert den Context zur Stundenplanung.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • createHtmlBuilders

      protected List<HtmlBuilder> createHtmlBuilders() throws ApiOperationException
      Erzeugt auf Basis des gegebenen HTML-Templates und der übergebenen Daten die HTML-Builder, aus denen die HTML-Inhalte erzeugt werden können.
      Gibt zurück:
      Eine Liste mit htmlBuilder.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.

    • createHtmlResponse

      protected jakarta.ws.rs.core.Response createHtmlResponse() throws ApiOperationException
      Erstellt eine Response in Form einer einzelnen HTML-Datei oder Z eine einzelne ZIP-Datei, die mehrere generierte HTML-Dateien enthält.
      Gibt zurück:
      Im Falle eines Success enthält die HTTP-Response das HTML-Dokument oder die ZIP-Datei.
      Löst aus:
      ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.