Package de.svws_nrw.db.schema

Klasse View

java.lang.Object
de.svws_nrw.db.schema.View
public class View extends Object
Diese Klasse beschreibt die Definition einer View in der SVWS-DB

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    final @NotNull String
    beschreibung
    Eine Beschreibung, welchen Zweck die View erfüllt.
    final @NotNull String
    dtoName
    Gibt den Namen der zugehörigen Java-DTO-Klasse an.
    final @NotNull String
    name
    Der Name der View
    final @NotNull String
    packageName
    Gibt den Namen des Java-Sub-Packages an, in dem der zugehörige Java-DTO generiert werden soll.
    final @NotNull List<@NotNull ViewSpalte>
    pkSpalten
    Eine Liste der Spalten, welcher als Primärschlüssel der View geeignet ist
    final @NotNull List<@NotNull ViewSpalte>
    spalten
    Eine Liste der Spalten der View

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    View(@NotNull String name, @NotNull String packageName, @NotNull String dtoName, @NotNull String beschreibung, Integer revision, Integer veraltet, @NotNull String sql)
    Erstellt eine neue Schema-Definition einer Datenbank-View

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    View
    add(@NotNull String name, @NotNull String beschreibung, @NotNull String datentyp, @NotNull String sql, Class<? extends DBAttributeConverter<?,?>> converter, boolean istPrimaryKey)
    Fügt eine Spalte zu der View hinzu.
    boolean
    brauchtDeveloperDTO()
    Prüft, ob diese View eine Entwickler-Version des DTO benötigt, indem überprüft wird, ob an der View Änderungen zwischen der Aktuellen Revision und der Entwickler Revision vorgenommen wurden.
    String
    getJavaKlasse(long rev)
    Liefert den Namen der Java-Klasse, wie er in der angegebenn Revision genutzt werden soll.
    String
    getJPQLParameterizedQuery(long rev)
    Erstellt den Code für eine parametrisierte JPQL-Query
    String
    getSQLCreate(DBDriver driver)
    Liefert den SQL-Code für das Erstellen der View
    String
    getSQLDrop()
    Liefert den SQL-Code für das Entfernen der View
    boolean
    hasSimplePrimaryKey()
    Gibt zurück, ob der Java-DTO einen einfachen Primary-Key hat oder nicht

    Von Klasse geerbte Methoden java.lang.Object

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

  • Felddetails

    • name

      @NotNull public final @NotNull String name
      Der Name der View

    • packageName

      @NotNull public final @NotNull String packageName
      Gibt den Namen des Java-Sub-Packages an, in dem der zugehörige Java-DTO generiert werden soll.

    • dtoName

      @NotNull public final @NotNull String dtoName
      Gibt den Namen der zugehörigen Java-DTO-Klasse an.

    • beschreibung

      @NotNull public final @NotNull String beschreibung
      Eine Beschreibung, welchen Zweck die View erfüllt.

    • spalten

      @NotNull public final @NotNull List<@NotNull ViewSpalte> spalten
      Eine Liste der Spalten der View

    • pkSpalten

      @NotNull public final @NotNull List<@NotNull ViewSpalte> pkSpalten
      Eine Liste der Spalten, welcher als Primärschlüssel der View geeignet ist

  • Konstruktordetails

    • View

      public View(@NotNull @NotNull String name, @NotNull @NotNull String packageName, @NotNull @NotNull String dtoName, @NotNull @NotNull String beschreibung, Integer revision, Integer veraltet, @NotNull @NotNull String sql)
      Erstellt eine neue Schema-Definition einer Datenbank-View
      Parameter:
      name - der Name der View
      packageName - der Name des Java-Sub-Packages, in dem der zugehörige Java-DTO generiert werden soll
      dtoName - der Name der zugehörigen Java-DTO-Klasse
      beschreibung - eine Beschreibung, welchen Zweck die View erfüllt
      revision - die Revision, in welcher die View eingeführt wurde
      veraltet - die Revision, in welcher die View als veraltet definiert wurde - null, wenn sie noch nicht veraltet ist
      sql - der SQL-Code für den FROM-Teil des SELECT der View

  • Methodendetails

    • brauchtDeveloperDTO

      public boolean brauchtDeveloperDTO()
      Prüft, ob diese View eine Entwickler-Version des DTO benötigt, indem überprüft wird, ob an der View Änderungen zwischen der Aktuellen Revision und der Entwickler Revision vorgenommen wurden.
      Gibt zurück:
      true, falls ein Entwickler-DTO benötigt wird und ansonsten false

    • add

      public View add(@NotNull @NotNull String name, @NotNull @NotNull String beschreibung, @NotNull @NotNull String datentyp, @NotNull @NotNull String sql, Class<? extends DBAttributeConverter<?,?>> converter, boolean istPrimaryKey)
      Fügt eine Spalte zu der View hinzu.
      Parameter:
      name - der Name der Spalte
      beschreibung - die Beschreibung der Spalte zur Dokumentation
      datentyp - der Java-Datentyp der Spalte
      sql - der SQL-Code für die Spaltendefinition
      converter - der Konverter zum automatischen Umwandeln des Datenbank-Wertes beim Einlesen in Java oder null
      istPrimaryKey - gibt an, ob die Spalte Bestandteil des Primärschlüssels der View ist
      Gibt zurück:
      diese View-Definition

    • getSQLCreate

      public String getSQLCreate(DBDriver driver)
      Liefert den SQL-Code für das Erstellen der View
      Parameter:
      driver - der Datenbank-Treiber, für den der SQL-Code erzeugt wird
      Gibt zurück:
      der SQL-Code für das Erstellen der View

    • getSQLDrop

      public String getSQLDrop()
      Liefert den SQL-Code für das Entfernen der View
      Gibt zurück:
      der SQL-Code für das Entfernen der View

    • getJavaKlasse

      public String getJavaKlasse(long rev)
      Liefert den Namen der Java-Klasse, wie er in der angegebenn Revision genutzt werden soll.
      Parameter:
      rev - die Revision
      Gibt zurück:
      der Name der Java-Klasse

    • getJPQLParameterizedQuery

      public String getJPQLParameterizedQuery(long rev)
      Erstellt den Code für eine parametrisierte JPQL-Query
      Parameter:
      rev - die DB-Revision, für welche die Query erstellt wird
      Gibt zurück:
      die JPQL

    • hasSimplePrimaryKey

      public boolean hasSimplePrimaryKey()
      Gibt zurück, ob der Java-DTO einen einfachen Primary-Key hat oder nicht
      Gibt zurück:
      true, falls der Java-DTO einen einfachen Primary-Key hat