Package de.svws_nrw.module.reporting.html

Klasse HtmlBuilder

java.lang.Object
de.svws_nrw.module.reporting.html.HtmlBuilder
public class HtmlBuilder extends Object
Erzeugt aus einem Thymeleaf-HTML-Template (HTML-Vorlage) und den zugehörigen Daten in den Contexts den finalen HTML-Code inklusive der Daten. Die Rückgabe des HTML-Codes kann in Form eines Strings, eines ByteArrays oder einer Response erfolgen.

  • Konstruktordetails

    • HtmlBuilder

      public HtmlBuilder(String htmlVorlage, List<HtmlContext<?>> contexts, String dateiname)
      Erstellt einen neuen HTML-Builder und initialisiert die Variablen
      Parameter:
      htmlVorlage - Der Inhalt einer HTML-Vorlagendatei, die mit Daten gefüllt werden soll.
      contexts - Liste mit Daten-Contexts, die zu einem finalen Context zusammengefügt werden, um damit das HTML-Template zu füllen.
      dateiname - Dateiname der HTML-Datei ohne Dateiendung.

    • HtmlBuilder

      public HtmlBuilder(String htmlVorlage, List<HtmlContext<?>> contexts, List<Long> ids, String dateiname)
      Erstellt einen neuen HTML-Builder und initialisiert die Variablen, inklusive der IDs, für die der Builder erzeugt wird.
      Parameter:
      htmlVorlage - Der Inhalt einer HTML-Vorlagendatei, die mit Daten gefüllt werden soll.
      contexts - Liste mit Daten-Contexts, die zu einem finalen Context zusammengefügt werden, um damit das HTML-Template zu füllen.
      ids - Liste der IDs, für die der Builder erzeugt wird.
      dateiname - Dateiname der HTML-Datei ohne Dateiendung.

  • Methodendetails

    • getIds

      public Set<Long> getIds()
      Liefert die IDs, für die dieser Builder erzeugt wurde.
      Gibt zurück:
      Ein unveränderliches Set der IDs des Builders.

    • getBuilderMitIds

      public HtmlBuilder getBuilderMitIds(List<Long> ids)
      Die übergebenen IDs (die für die Erstellung genutzt wurden) werden dem Builder hinzugefügt und dieser wird anschließend zurückgegeben.
      Parameter:
      ids - Die IDs, die dem Builder als IDs der Erstellung hinzugefügt werden sollen.
      Gibt zurück:
      Dieser HTML-Builder mit den ergänzten IDs.

    • getDateiname

      public String getDateiname()
      Gibt den Dateinamen der HTML-Datei zurück.
      Gibt zurück:
      Dateiname der HTML-Datei.

    • getDateinameMitEndung

      public String getDateinameMitEndung()
      Gibt den Dateinamen der HTML-Datei mit Dateiendung zurück.
      Gibt zurück:
      Dateiname der HTML-Datei mit Endung.

    • getHtml

      public String getHtml()
      Gibt den finalen HTML-Inhalt als String zurück.
      Gibt zurück:
      String des finalen HTML-Inhaltes.

    • getHtmlByteArray

      public byte[] getHtmlByteArray()
      Gibt den finalen HTML-Inhalt in Form eines Byte-Arrays.
      Gibt zurück:
      das Byte-Array des finalen HTML-Inhaltes im UTF-8-Format.

    • getHtmlResponse

      public jakarta.ws.rs.core.Response getHtmlResponse()
      Erzeugt eine Response mit einer HTML-Datei als Content
      Gibt zurück:
      Response mit der HTML-Datei als Content