Class Vorsatz

java.lang.Object
gdv.xport.satz.Satz
gdv.xport.satz.Vorsatz
All Implemented Interfaces:
Cloneable

public class Vorsatz extends Satz
Dies ist der erste Satz, der Vorsatz eben.

Da Vorsatz und Nachsatz von der Datenpaket-Klasse benoetigt werden, habe ich das "deprecated" wieder entfernt (24-Nov-2012, oboehm).

Since:
0.0.1 (09-Okt-2009)
Author:
oliver
  • Field Details

    • SATZART

      public static final SatzTyp SATZART
      Satzart fuer Vorsatz.
  • Constructor Details

    • Vorsatz

      public Vorsatz()
      Hiermit wird ein Vorsatz mit 3 Teildatensaetzen erstellt.
    • Vorsatz

      public Vorsatz(SatzRegistry factory)
      Ueber die mitgegebene Factory wird der Vorsatz genauso aufgebaut, wie die SatzRegistry als Vorlage liefert.
      Parameters:
      factory - sollte die Vorlage fuer den Vorsatz liefern.
      Since:
      5.0
    • Vorsatz

      public Vorsatz(String content)
      Legt einen Vorsatz mit dem angegebenen Inhalt an.
      Parameters:
      content - Inhalt des Vorsatzes
    • Vorsatz

      public Vorsatz(Vorsatz other)
      Dies ist der Copy-Constructor, mit dem man einen bestehenden Vorsatz kopieren kann.
      Parameters:
      other - der originale Vorsatz
  • Method Details

    • setVuNummer

      public void setVuNummer(String s)
      Um die VU-Nummer (Byte 5 - 9) in allen Teildatensaetzen setzen zu koennen.
      Parameters:
      s - VU-Nummer (max. 5-stellig)
    • getVuNummer

      public String getVuNummer()
      Returns:
      VU-Nummer
    • setAbsender

      public void setAbsender(String name)
      Um Absender (Byte 10 - 39) in allen Teildatensaetzen setzen zu koennen.
      Parameters:
      name - Absender
    • getAbsender

      public String getAbsender()
      Liefert den Absender (Byte 10 - 39).
      Returns:
      Absender
    • setAdressat

      public void setAdressat(String name)
      Um Adressat (Byte 40 - 69) in allen Teildatensaetzen setzen zu koennen.
      Parameters:
      name - neuer Adressat
    • getAdressat

      public String getAdressat()
      Returns:
      Adressat
    • setErstellungsZeitraum

      public void setErstellungsZeitraum(String startDatum, String endDatum)
      Um Erstellungs-Datum Zeitraum vom- Zeitraum bis (Byte 70 - 85) in allen Teildatensaetzen setzen zu koennen.
      Parameters:
      startDatum - im Format "TTMMJJJJ"
      endDatum - im Format "TTMMJJJJ"
    • setErstellungsZeitraum

      public void setErstellungsZeitraum(Datum startDatum, Datum endDatum)
      Um Erstellungs-Datum Zeitraum vom- Zeitraum bis (Byte 70 - 85) in allen Teildatensaetzen setzen zu koennen.
      Parameters:
      startDatum - im Format "TTMMJJJJ"
      endDatum - im Format "TTMMJJJJ"
    • getErstellungsZeitraum

      public String getErstellungsZeitraum()
      Returns:
      Erstellungszeitraum (VonDatum, BisDatum)
    • setErstellungsZeitraumVon

      public void setErstellungsZeitraumVon(Datum von)
    • getErstellungsZeitraumVon

      public Datum getErstellungsZeitraumVon()
    • setErstellungsZeitraumBis

      public void setErstellungsZeitraumBis(Datum bis)
    • getErstellungsZeitraumBis

      public Datum getErstellungsZeitraumBis()
    • getVersion

      public String getVersion(Satz satz)
      Abfrage der Satzart-Version eines Datensatzes, falls die Satzart im Vorsatz bekannt ist.
      Parameters:
      satz - der Satz
      Returns:
      die Satzversion oder null wenn Satzart unbekannt
    • getVersion

      public String getVersion(Bezeichner bezeichner)
      Ermittelt die Version des uebergebenen Bezeichners.
      Parameters:
      bezeichner - z.B. VERSION_VORSATZ; hier koennen alle die Bezeichner-Konstanten gewaehlt werden, die mit "VERSION_" anfangen.
      Returns:
      Version des gewuenschten Bezeichners
      Since:
      2.0
    • getVersion

      @Deprecated public String getVersion(String bezeichner)
      Deprecated.
      bitte getVersion(Bezeichner) verwenden (TODO: wird mit v8 oder v9 entsorgt)
      Ermittelt die Version des uebergebenen Bezeichners.
      Parameters:
      bezeichner - z.B. VERSION_VORSATZ; hier koennen alle die Bezeichner-Konstanten gewaehlt werden, die mit "VERSION_" anfangen.
      Returns:
      Version des gewuenschten Bezeichners
    • getVersion

      public String getVersion(int art)
      Parameters:
      art - Satzart
      Returns:
      z.B. 1.1
    • getVersion

      public String getVersion(int art, int sparte)
      Parameters:
      art - Satzart
      sparte - z.B. 70 (Rechtsschutz)
      Returns:
      z.B. 1.1
    • getVersion

      public String getVersion(SatzTyp satzTyp)
      Liefert die Version zum gewuenschten SatzTyp.
      Parameters:
      satzTyp - z.B. SatzTyp.of("0100");
      Returns:
      z.B. 2.3
      Since:
      5.0
    • setVersion

      public void setVersion(Satz satz)
      Setzen der Satzart-Version eines Datensatzes.
      Parameters:
      satz - der Satz
    • setVersion

      public void setVersion(SatzTyp satzTyp)
      Setzen der Satzart-Version eines SatzTyps.
      Parameters:
      satzTyp - der Satztyp
    • setVersion

      public void setVersion(Bezeichner bezeichner, String version)
      Setzen der Version.
      Parameters:
      bezeichner - Bezeichner
      version - z.B. "1.2"
      Since:
      4.1.1
    • setVersion

      public void setVersion(int art, int sparte, String version)
      Setzen der Version.
      Parameters:
      art - Satzart
      sparte - Sparte
      version - z.B. "1.2"
      Since:
      4.1.1
    • getSatzartVersionen

      public Map<SatzTyp,Version> getSatzartVersionen()
      Liefert eine Liste aller gesetzter Versionen im Vorsatz.
      Returns:
      Liste mit Versionen
      Since:
      5.2
    • getFeld

      public Feld getFeld(Bezeichner bezeichner) throws IllegalArgumentException
      Da im Feld "Erstellungs-Datum Zeitraum vom- Zeitraum bis" (Adresse 70-85) 2 Datumsfelder zusammengefasst sind, ist diese Methode ueberschrieben, um diese beiden Felder auch einzeln abfragen zu koennen.
      Overrides:
      getFeld in class Satz
      Parameters:
      bezeichner - gesuchtes Field
      Returns:
      Feld
      Throws:
      IllegalArgumentException - falls es das Feld nicht gibt
    • getFelder

      public Collection<Feld> getFelder()
      Hier wird Satz.getFelder() ueberschrieben, um das Feld "Erstellungs-Datum, Zeitraum von, Zeitraum bis" in zwei Felder aufzuteilen. Dies wird u.a. von den verschiedenen Formattern (wie z.B. CsvFormatter fuer die Aufbereitung der Ausgabe verwendet.
      Overrides:
      getFelder in class Satz
      Returns:
      alle Felder in der richtigen Reihenfolge