Package de.svws_nrw.module.reporting.html.contexts

Klasse HtmlContext<T>

java.lang.Object
de.svws_nrw.module.reporting.html.contexts.HtmlContext<T>
Typparameter:
T - der Datentyp der vom Context verwalteten Elemente in contextData
Bekannte direkte Unterklassen:
HtmlContextGostKlausurplanungKlausurplan, HtmlContextGostKursplanungBlockungsergebnis, HtmlContextGostLaufbahnplanungAbiturjahrgangFachwahlstatistiken, HtmlContextKlassen, HtmlContextKurse, HtmlContextLehrer, HtmlContextSchueler, HtmlContextSchule, HtmlContextStundenplanungFachStundenplan, HtmlContextStundenplanungKlassenStundenplan, HtmlContextStundenplanungLehrerStundenplan, HtmlContextStundenplanungRaumStundenplan, HtmlContextStundenplanungSchuelerStundenplan
public abstract class HtmlContext<T> extends Object
Abstrakte Basisklasse für die Thymeleaf-html-Daten-Contexts.

  • Konstruktordetails

    • HtmlContext

      protected HtmlContext(ReportingRepository reportingRepository, Boolean istHauptdatenContext)
      Konstruktor für die Klasse HtmlContext, die das Repository und das Flag zur Hauptdatenquelle initialisiert.
      Parameter:
      reportingRepository - Das Reporting-Repository, welches verwendet wird, um die Daten zu verwalten.
      istHauptdatenContext - Ein Boolean-Wert, der angibt, ob der aktuelle Kontext ein Hauptdatenkontext ist.

  • Methodendetails

    • getContext

      public org.thymeleaf.context.Context getContext()
      Rückgabe des Thymeleaf-Daten-Context
      Gibt zurück:
      Gibt einen Thymeleaf-Daten-Context zurück.

    • setContext

      public void setContext(org.thymeleaf.context.Context context)
      Setzen des Thymeleaf-Daten-Context
      Parameter:
      context - Thymeleaf-Daten-Context mit den Daten.

    • getContextData

      public List<T> getContextData()
      Gibt die Context-Daten zurück.
      Gibt zurück:
      die Liste der in diesem Context verwalteten Daten

    • getIds

      public List<Long> getIds()
      Die IDs der Daten (z. B. Schüler-/Lehrer-/Klassen-/Kurs-IDs), die dieser Context für nachgelagerte Schritte (z. B. E-Mail-Versand) bereitstellt. Der Standard ist eine leere Liste. Abgeleitete Kontexte überschreiben diese Methode, um die konkreten IDs zu ermitteln.
      Gibt zurück:
      Die Liste der IDs. Standard ist eine leere Liste.

    • setContextData

      public void setContextData(List<T> data)
      Setzt die Context-Daten. Null-Werte werden herausgefiltert. Bei Übergabe von null wird eine leere Liste gesetzt.
      Parameter:
      data - die zu setzende Datenliste

    • getSortierungAttribute

      public List<String> getSortierungAttribute()
      Gibt die Liste der Sortierungsattribute zurück, die definiert wurden, um den Kontext entsprechend zu sortieren.
      Gibt zurück:
      Eine Liste von Attributnamen, die für die Sortierung verwendet werden.

    • setSortierungAttribute

      public void setSortierungAttribute(List<String> sortierungAttribute)
      Legt die Sortierungsattribute für den Kontext fest. Null-Werte und leere Strings in der übergebenen Liste der Attribute werden herausgefiltert. Wenn die gefilterte Liste leer ist oder null übergeben wird, wird eine leere Liste gesetzt.
      Parameter:
      sortierungAttribute - Liste von Attributnamen, die für die Sortierung des Kontexts verwendet werden sollen. Null-Werte und leere Strings werden ignoriert.

    • sortiereContextMitRegistry

      protected void sortiereContextMitRegistry()
      Sortiert die im Context gespeicherten Daten (contextData) basierend auf den im Context definierten Sortierungsattributen. Die Methode filtert null-Werte aus contextData heraus. Für Strings wird die deutsche Sortierreihenfolge angewandt. Falls die Attribute nicht gefunden werden, werden sie für die Sortierung ignoriert.

    • sortiereListeMitRegistry

      protected List<T> sortiereListeMitRegistry(List<T> list)
      Sortiert eine Liste von Objekten basierend auf den im Kontext definierten Sortierungsattributen, die durch eine Sortierung-Registry bereitgestellt werden. Sofern eine Sortierung möglich ist, werden Null-Werte aus der übergebenen Liste in der sortierten Ergebnisliste entfernt, aber falls die Sortierungsattribute leer sind oder nicht gültig sind und so eine Sortierung nicht möglich ist, wird die ursprüngliche Liste ohne Änderungen zurückgegeben.
      Parameter:
      list - Die Liste von Objekten, die sortiert werden sollen. Null-Werte in der Liste werden herausgefiltert. Wenn die Liste null ist, wird ebenfalls null zurückgegeben.
      Gibt zurück:
      Die sortierte Liste, ggf. bereinigt um null-Werte. Falls die Eingabeliste oder die Sortierungsattribute null oder leer sind oder keine gültigen Attribute für die Sortierung gefunden werden konnten, wird die unveränderte Eingabeliste zurückgegeben.