Package de.svws_nrw.db.schema

Klasse SchemaTabelleSpalte

java.lang.Object
de.svws_nrw.db.schema.SchemaTabelleSpalte
Alle implementierten Schnittstellen:
Comparable<SchemaTabelleSpalte>
public final class SchemaTabelleSpalte extends Object implements Comparable<SchemaTabelleSpalte>
Diese Klasse dient der Definition des Schemas von SVWS-Datenbank-Tabellenspalten.

  • Methodendetails

    • brauchtDeveloperDTO

      public boolean brauchtDeveloperDTO()
      Prüft, ob diese Spalte eine Änderung hat, welche eine Entwickler-Version des Tabellen-DTO notwendig macht.
      Gibt zurück:
      true, falls ein Entwickler-DTO benötigt wird und ansonsten false

    • setDatenlaenge

      public SchemaTabelleSpalte setDatenlaenge(int laenge)
      Setzt die Länge der Daten (z.B. bei String-Datentypen).
      Parameter:
      laenge - die Länge der Daten
      Gibt zurück:
      dieses Objekt

    • setDefault

      public SchemaTabelleSpalte setDefault(String def)
      Setzt den Default-Wert für diese Spalte.
      Parameter:
      def - der default-Wert
      Gibt zurück:
      dieses Objekt

    • setNotNull

      public SchemaTabelleSpalte setNotNull()
      Setzt eine NOT-NULL-Beschränkung auf diese Spalte.
      Gibt zurück:
      dieses Objekt

    • setRevision

      public SchemaTabelleSpalte setRevision(SchemaRevisionen revision)
      Setzt die Revision, ab wann die Spalte gültig ist. Dabei wird der übernommene Wert von der Tabelle überschrieben.
      Parameter:
      revision - die Revision
      Gibt zurück:
      dieses Objekt

    • setVeraltet

      public SchemaTabelleSpalte setVeraltet(SchemaRevisionen veraltet)
      Setzt die Revision, ab wann die Spalte veraltet ist. Dabei wird der übernommene Wert von der Tabelle überschrieben.
      Parameter:
      veraltet - die Revision
      Gibt zurück:
      dieses Objekt

    • setJavaName

      public SchemaTabelleSpalte setJavaName(String name)
      Setzt den Namen des Java-Attributes, sofern dieser vom Spaltennamen abweicht.
      Parameter:
      name - der Name des Java-Attributes
      Gibt zurück:
      dieses Objekt

    • setConverter

      public SchemaTabelleSpalte setConverter(Class<? extends DBAttributeConverter<?,?>> converter)
      Setzt den zu verwendenden Java-Attribut-Converter
      Parameter:
      converter - der Konverter
      Gibt zurück:
      dieses Objekt

    • setConverterRevision

      public SchemaTabelleSpalte setConverterRevision(SchemaRevisionen revision)
      Setzt die Revision, ab der der Konverter eingesetzt werden soll.
      Parameter:
      revision - die Revision
      Gibt zurück:
      dieses Objekt

    • setConverterVeraltet

      public SchemaTabelleSpalte setConverterVeraltet(SchemaRevisionen veraltet)
      Setzt die Revision, ab der der Konverter nicht mehr eingesetzt werden soll.
      Parameter:
      veraltet - die Revision
      Gibt zurück:
      dieses Objekt

    • setJavaComment

      public SchemaTabelleSpalte setJavaComment(String comment)
      Setzt den Kommentar, der für das Java-Doc der Spalte verwendet werden soll.
      Parameter:
      comment - der Kommentar
      Gibt zurück:
      dieses Objekt

    • tabelle

      public SchemaTabelle tabelle()
      Gibt die Tabelle zurück, der diese Spalte zugeordnet ist.
      Gibt zurück:
      die Tabelle

    • sortierung

      public int sortierung()
      Gibt die Position der Spalte bei der Tabelle zurück.
      Gibt zurück:
      die Position der Spalte für eine Sortierung

    • name

      public String name()
      Gibt den Namen der Spalte zurück.
      Gibt zurück:
      der Name der Spalte

    • datentyp

      public SchemaDatentypen datentyp()
      Gibt den Datentyp der Spalte zurück.
      Gibt zurück:
      der Datentyp der Spalte

    • datenlaenge

      public Integer datenlaenge()
      Gibt die Länge des Datentyps (z.B. bei String-Datentypen) der Spalte zurück.
      Gibt zurück:
      der Länge des Datentyps der Spalte

    • defaultWert

      public String defaultWert()
      Gibt den Default-Wert der Tabellenspalte zurück.
      Gibt zurück:
      der Default-Wert

    • notNull

      public boolean notNull()
      Gibt zurück, ob die Tabellenspalte eine NOT-NULL-Beschränkung hat oder nicht.
      Gibt zurück:
      true, falls eine NOT-NULL-Beschränkung existiert und ansonsten false

    • revision

      public SchemaRevisionen revision()
      Gibt die Revision zurück, ab wann die Spalte gültig ist.
      Gibt zurück:
      die Revision

    • veraltet

      public SchemaRevisionen veraltet()
      Gibt die Revision zurück, ab wann die Spalte veraltet ist. Ist sie nicht veraltet, so wird SchemaRevisionen.UNDEFINED zurückgegeben.
      Gibt zurück:
      die Revision, ab wann die Spalte veraltet ist, oder SchemaRevisionen.UNDEFINED

    • javaAttributName

      public String javaAttributName()
      Gibt den Namen des zugehörigen Java-Attributs zurück.
      Gibt zurück:
      der Name des Java-Attributs

    • javaConverter

      public DBAttributeConverter<?,?> javaConverter(long rev)
      Gibt die Java-Attribut-Converter-Klasse zurück, welche genutzt wird um dass Attribut in den zuhörigen Java-Datentyp umzuwandeln. Wird kein Converter genutzt, so wird null zurückgegeben.
      Parameter:
      rev - die Revision, für welche der Attribute-Converter bestimmt werden soll.
      Gibt zurück:
      der Converter oder null

    • javaConverterRevision

      public SchemaRevisionen javaConverterRevision()
      Gibt die Revision zurück, ab welcher der Attribut-Converter eingesetzt werden soll.
      Gibt zurück:
      die Revision

    • javaConverterVeraltet

      public SchemaRevisionen javaConverterVeraltet()
      Gibt an, ab welcher Revision der Attribut-Converter als veraltet markiert ist und bis zu welcher er nur eingesetzt werden soll.
      Gibt zurück:
      die Revision

    • javaComment

      public String javaComment()
      Gibt den Javadoc-Kommentar für das Attribut innerhalt der Java-DTO-Klasse an
      Gibt zurück:
      der Kommentar

    • getJavaAttributConverter

      public String getJavaAttributConverter(long rev)
      Liefert den Attribute Converter, sofern einer gesetzt wurde und in der angegebenen Revision gültig ist.
      Parameter:
      rev - die Revision, für welche der Attribute-Converter bestimmt werden soll.
      Gibt zurück:
      der Name des Attribut-Converters oder null

    • getDefaultWertConverted

      public Object getDefaultWertConverted()
      Liefert ein Object mit dem zugeordneten Default-Wert zurück. Der tatsächliche Typ hängt von dem Datentyp der Spalte ab.
      Gibt zurück:
      der Default-Wert der Spalte

    • getSQL

      public String getSQL(DBDriver dbms)
      Liefert den SQL-Code für diese Spalte und das angegeben DBMS
      Parameter:
      dbms - das DBMS
      Gibt zurück:
      der SQL-Code zur Verwendung beim Erzeugen der Tabellenspalte

    • getSQLCreate

      public String getSQLCreate(DBDriver dbms)
      Liefert den SQL-Code für das nachträgliche Hinzufügen dieser Spalte für das angegebene DBMS
      Parameter:
      dbms - das DBMS
      Gibt zurück:
      der SQL-Code zur nachträglichen Erzeugung der Tabellenspalte

    • getSQLDrop

      public String getSQLDrop(DBDriver dbms)
      Erzeugt den SQL-Drop-Befehl für diese Tabellenspalte für den SQL-Dialekt des angegebenen DBMS
      Parameter:
      dbms - das DBMS
      Gibt zurück:
      der SQL-Drop-Befehl

    • compareTo

      public int compareTo(SchemaTabelleSpalte other)
      Angegeben von:
      compareTo in Schnittstelle Comparable<SchemaTabelleSpalte>