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.

  • Konstruktorübersicht

    Konstruktoren
    Modifizierer
    Konstruktor
    Beschreibung
    protected
    HtmlFactory(ReportingRepository reportingRepository)
    Erzeugt eine neue html-Factory, um eine html-Datei aus einem html-Template zu erzeugen.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    protected List<HtmlBuilder>
    createHtmlBuilders()
    Erzeugt auf Basis des gegebenen html-Templates und der übergebenen Daten die html-Builder, aus denen die html-Inhalte erzeugt werden können.
    protected jakarta.ws.rs.core.Response
    createHtmlResponse()
    Erstellt eine Response in Form einer einzelnen html-Datei oder Z eine einzelne ZIP-Datei, die mehrere generierte html-Dateien enthält.

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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

    • 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.