Klasse Vorsatz

java.lang.Object

gdv.xport.satz.Satz

gdv.xport.satz.Vorsatz

Alle implementierten Schnittstellen:

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).

Seit:

0.0.1 (09-Okt-2009)

Autor:

oliver

Feldübersicht

Felder

Modifikator und Typ	Feld	Beschreibung
static final SatzTyp	SATZART	Satzart fuer Vorsatz.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Vorsatz()	Hiermit wird ein Vorsatz mit 3 Teildatensaetzen erstellt.
Vorsatz(Vorsatz other)	Dies ist der Copy-Constructor, mit dem man einen bestehenden Vorsatz kopieren kann.
Vorsatz(SatzRegistry factory)	Ueber die mitgegebene Factory wird der Vorsatz genauso aufgebaut, wie die SatzRegistry als Vorlage liefert.
Vorsatz(String content)	Legt einen Vorsatz mit dem angegebenen Inhalt an.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
String	getAbsender()	Liefert den Absender (Byte 10 - 39).
String	getAdressat()
String	getErstellungsZeitraum()
Datum	getErstellungsZeitraumBis()
Datum	getErstellungsZeitraumVon()
Feld	getFeld(Bezeichner bezeichner)	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.
Collection<Feld>	getFelder()	Hier wird Satz.getFelder() ueberschrieben, um das Feld "Erstellungs-Datum, Zeitraum von, Zeitraum bis" in zwei Felder aufzuteilen.
Map<SatzTyp,Version>	getSatzartVersionen()	Liefert eine Liste aller gesetzter Versionen im Vorsatz.
String	getVersion(int art)
String	getVersion(int art, int sparte)
String	getVersion(Bezeichner bezeichner)	Ermittelt die Version des uebergebenen Bezeichners.
String	getVersion(Satz satz)	Abfrage der Satzart-Version eines Datensatzes, falls die Satzart im Vorsatz bekannt ist.
String	getVersion(SatzTyp satzTyp)	Liefert die Version zum gewuenschten SatzTyp.
String	getVersion(String bezeichner)	Veraltet. bitte getVersion(Bezeichner) verwenden (TODO: wird mit v8 oder v9 entsorgt)
String	getVuNummer()
void	setAbsender(String name)	Um Absender (Byte 10 - 39) in allen Teildatensaetzen setzen zu koennen.
void	setAdressat(String name)	Um Adressat (Byte 40 - 69) in allen Teildatensaetzen setzen zu koennen.
void	setErstellungsZeitraum(Datum startDatum, Datum endDatum)	Um Erstellungs-Datum Zeitraum vom- Zeitraum bis (Byte 70 - 85) in allen Teildatensaetzen setzen zu koennen.
void	setErstellungsZeitraum(String startDatum, String endDatum)	Um Erstellungs-Datum Zeitraum vom- Zeitraum bis (Byte 70 - 85) in allen Teildatensaetzen setzen zu koennen.
void	setErstellungsZeitraumBis(Datum bis)
void	setErstellungsZeitraumVon(Datum von)
void	setVersion(int art, int sparte, String version)	Setzen der Version.
void	setVersion(Bezeichner bezeichner, String version)	Setzen der Version.
void	setVersion(Satz satz)	Setzen der Satzart-Version eines Datensatzes.
void	setVersion(SatzTyp satzTyp)	Setzen der Satzart-Version eines SatzTyps.
void	setVuNummer(String s)	Um die VU-Nummer (Byte 5 - 9) in allen Teildatensaetzen setzen zu koennen.

Von Klasse geerbte Methoden Satz

add, add, add, addAll, addFiller, clone, cloneTeildatensaetze, equals, export, export, export, export, getBausparenArt, getConfig, getFeld, getFeld, getFeld, getFeld, getFeld, getFeldInhalt, getFeldInhalt, getGdvSatzartName, getGdvSatzartNummer, getKrankenFolgeNr, getNumberOfTeildatensaetze, getSatzart, getSatzartFeld, getSatzTyp, getSatzversion, getSparte, getTeildatensaetze, getTeildatensatz, getTeildatensatzBySatzNr, getVermittler, getVersion, getWagnisart, hasBausparenArt, hasFeld, hasFeld, hashCode, hasKrankenFolgeNr, hasSparte, hasWagnisart, importFrom, importFrom, importFrom, importFrom, importFrom, isComplete, isValid, matchesNextTeildatensatz, mergeWith, remove, remove, removeAllTeildatensaetze, removeTeildatensatz, removeTeildatensatzBySatzNr, removeUnusedTeildatensaetze, resetGdvSatzartName, setFeld, setFeld, setFeld, setFeld, setGdvSatzartName, setVermittler, toLongString, toShortString, toString, validate, validate

Modifikator und Typ	Methode	Beschreibung
void	add(Feld feld)	Fuegt das uebergebene Feld zur Liste der Datenfelder hinzu.
void	add(Feld feld, int teildatensatzNr)	Fuegt das uebergebene Feld zur Liste der Datenfelder hinzu.
final void	add(Teildatensatz tds)	Und hierueber kann ein Teildatensatz hinzugefuegt werden.
void	addAll(Feld feld)	Fuegt das uebergebene Feld in jeden Teildatensatz hinzu.
void	addFiller()	Fuellt fuer alle leeren Stellen ein entsprechendes Fuellfeld auf.
Object	clone()	Legt eine Kopie des Satzes an.
protected final List<Teildatensatz>	cloneTeildatensaetze()	Hier wird eine Kopie aller Teildatensaetze zurueckgegeben.
boolean	equals(Object obj)	Zwei Saetze sind gleich, wenn sie die gleichen Daten besitzen.
void	export(File file)	Exportiert den Satz.
void	export(OutputStream ostream)
void	export(Writer writer)	Exportiert den Satz.
void	export(Writer writer, String eod)	Export.
final String	getBausparenArt()	Liefert den Inhalt des 9.
final Config	getConfig()	Liefert die aktuelle Konfiguration zurueck.
final Feld	getFeld(Bezeichner bezeichner, int nr)	Liefert das gewuenschte Feld.
<T extends Feld> T	getFeld(Bezeichner bezeichner, Class<T> clazz)	Liefert das gewuenschte Feld im gewuenschten Typ.
Feld	getFeld(ByteAdresse adresse)	Holt sich das entsprechende Feld aus dem Teildatensatz.
Feld	getFeld(String name)	Veraltet. bitte getFeld(Bezeichner) verwenden (TODO: wird mit v8 oder v9 entsorgt)
final Feld	getFeld(String name, int nr)	Veraltet. bitte getFeld(Bezeichner, int) verwenden (TODO: wird mit v8 oder v9 entsorgt)
final String	getFeldInhalt(Bezeichner bezeichner)	Liefert den Inhalt des gewuenschten Feldes.
final String	getFeldInhalt(String name, int nr)	Liefert den Inhalt des gewuenschten Feldes.
String	getGdvSatzartName()
String	getGdvSatzartNummer()	Veraltet. bitte Satzartnummer ueber Satz.getSatzTyp() ermitteln
final String	getKrankenFolgeNr()	Liefert den Inhalt des Feldes, in dessen Bezeichnung "Folge-Nr" oder "Folgenummer" gefolgt von "zur laufenden" vorkommt (ByteAdresse 48), wenn es existiert.
final int	getNumberOfTeildatensaetze()	Liefert die Anzahl der Teildatensaetze.
int	getSatzart()	Liefert die Satzart zurueck.
NumFeld	getSatzartFeld()	Liefert die Satzart.
SatzTyp	getSatzTyp()	Liefert den Satz-Typ zurueck.
final AlphaNumFeld	getSatzversion()	Liefert die Satzversion
int	getSparte()	Liefert den Inhalt des Sparten-Felds.
final List<Teildatensatz>	getTeildatensaetze()	Liefert alle Teildatensaetze zurueck.
final Teildatensatz	getTeildatensatz(int n)	Liefert den n-ten Teildatensatz aus der Liste der Teildatensätze zurueck.
final Teildatensatz	getTeildatensatzBySatzNr(int n)	Liefert den Teildatensatz mit der wirklichen Satznummer n zurueck.
final String	getVermittler()	Liefert den Vermittler zurueck.
final String	getVersion()	Liefert die Version des Satzes.
final String	getWagnisart()	Liefert den Inhalt des Wagnisart-Felds.
boolean	hasBausparenArt()	Schaut nach dem 9.
boolean	hasFeld(Bezeichner bezeichner)	Fraegt ab, ob das entsprechende Feld vorhanden ist.
boolean	hasFeld(ByteAdresse adresse)	Fraegt ab, ob das entsprechende Feld vorhanden ist.
int	hashCode()
boolean	hasKrankenFolgeNr()	Schaut nach dem 10.
boolean	hasSparte()	Schaut nach einem Feld "SPARTE" und liefert true zurueck, falls es existiert.
boolean	hasWagnisart()	Schaut nach einem Feld "WAGNISART" und liefert true zurueck, falls es existiert.
final Satz	importFrom(PushbackLineNumberReader reader)	Der hier verwendete PushbackReader wird benoetigt, damit die gelesene Satzart und Sparte wieder zurueckgesetllt werden kann.
Satz	importFrom(File file)	Importiert einen Satz von der angegebenen Datei.
final Satz	importFrom(InputStream istream)	Import von einem InputStream.
final Satz	importFrom(Reader reader)	Import von einem Reader.
Satz	importFrom(String s)	Eigentlich wollte ich ja diese Methode "import" nennen, aber das kollidiert leider mit dem Schluesselwort "import" in Java.
boolean	isComplete()	Sind alle Teildatensaetze eines Satzes vorhanden und ausgefuellt, liefert diese Methode 'true' zurueck.
boolean	isValid()	Aus Performance-Gruenden stuetzt sich diese Methode nicht auf die validate()-Methode ab.
protected boolean	matchesNextTeildatensatz(PushbackLineNumberReader reader, char[] lastFeld1To7, Character satznummer)	Prueft, ob die kommende Zeile noch zu dem aktuellen Datensatz gehoert.
void	mergeWith(Satz other)	Vereinigt den anderen Satz mit dem aktuellen Satz, falls das moeglich ist.
void	remove(Bezeichner bezeichner)	Falls ein Feld zuviel gesetzt wurde, kann es mit 'remove" wieder entfernt werden.
void	remove(String name)	Falls ein Feld zuviel gesetzt wurde, kann es mit 'remove" wieder entfernt werden.
final void	removeAllTeildatensaetze()	Hiermit koennen Unterklassen alle Teildatensaetze wieder entfernen (wird z.B. vom Satz 0220.030 benoetigt).
final void	removeTeildatensatz(int n)	Entfernt den gewuenschten Teildatensatz.
final void	removeTeildatensatzBySatzNr(int n)	Entfernt den gewuenschten Teildatensatz mit der wirklichen Satznummer n.
protected void	removeUnusedTeildatensaetze(SortedSet<Integer> usedIndexes)
void	resetGdvSatzartName()
void	setFeld(Bezeichner name, Integer value)	Setzt den Inhalt des gewuenschten Feldes.
void	setFeld(Bezeichner name, String value)	Setzt das angegebene Feld in allen Teildatensaetzen, in denen es gefunden wird.
void	setFeld(ByteAdresse adresse, String value)	Setzt das angegebene Feld anhand der Adresse in allen Teildatensaetzen.
void	setFeld(String name, String value)	Setzt das angegebene Feld in allen Teildatensaetzen, in denen es gefunden wird.
protected void	setGdvSatzartName(String string)	Setzen des Namens einer Gdv-Satzart.
final void	setVermittler(String vermittler)	Setzt den Vermittler in das entsprechende Feld.
String	toLongString()	To long string.
String	toShortString()	To short string.
final String	toString()
List<net.sf.oval.ConstraintViolation>	validate()	Validiert die einzelnen Teildatensaetze mit der eingestellten Standard-Konfiguration.
List<net.sf.oval.ConstraintViolation>	validate(Config validationConfig)	Im Unterschied zur normalen validate-Methode kann man hier eine die Validierung ueber Config.LAX oder Config.STRICT verschaerfen oder abmildern.

Von Klasse geerbte Methoden Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Felddetails

SATZART

public static final SatzTyp SATZART

Satzart fuer Vorsatz.

Konstruktordetails

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.

Parameter:

factory - sollte die Vorlage fuer den Vorsatz liefern.

Seit:

5.0

Vorsatz

public Vorsatz(String content)

Legt einen Vorsatz mit dem angegebenen Inhalt an.

Parameter:

content - Inhalt des Vorsatzes

Vorsatz

public Vorsatz(Vorsatz other)

Dies ist der Copy-Constructor, mit dem man einen bestehenden Vorsatz kopieren kann.

Parameter:

other - der originale Vorsatz

Methodendetails

setVuNummer

public void setVuNummer(String s)

Um die VU-Nummer (Byte 5 - 9) in allen Teildatensaetzen setzen zu koennen.

Parameter:

s - VU-Nummer (max. 5-stellig)

getVuNummer

public String getVuNummer()

Gibt zurück:

VU-Nummer

setAbsender

public void setAbsender(String name)

Um Absender (Byte 10 - 39) in allen Teildatensaetzen setzen zu koennen.

Parameter:

name - Absender

getAbsender

public String getAbsender()

Liefert den Absender (Byte 10 - 39).

Gibt zurück:

Absender

setAdressat

public void setAdressat(String name)

Um Adressat (Byte 40 - 69) in allen Teildatensaetzen setzen zu koennen.

Parameter:

name - neuer Adressat

getAdressat

public String getAdressat()

Gibt zurück:

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.

Parameter:

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.

Parameter:

startDatum - im Format "TTMMJJJJ"

endDatum - im Format "TTMMJJJJ"

getErstellungsZeitraum

public String getErstellungsZeitraum()

Gibt zurück:

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.

Parameter:

satz - der Satz

Gibt zurück:

die Satzversion oder null wenn Satzart unbekannt

getVersion

public String getVersion(Bezeichner bezeichner)

Ermittelt die Version des uebergebenen Bezeichners.

Parameter:

bezeichner - z.B. VERSION_VORSATZ; hier koennen alle die Bezeichner-Konstanten gewaehlt werden, die mit "VERSION_" anfangen.

Gibt zurück:

Version des gewuenschten Bezeichners

Seit:

2.0

getVersion

@Deprecated
public String getVersion(String bezeichner)

Veraltet.

bitte getVersion(Bezeichner) verwenden (TODO: wird mit v8 oder v9 entsorgt)

Ermittelt die Version des uebergebenen Bezeichners.

Parameter:

bezeichner - z.B. VERSION_VORSATZ; hier koennen alle die Bezeichner-Konstanten gewaehlt werden, die mit "VERSION_" anfangen.

Gibt zurück:

Version des gewuenschten Bezeichners

getVersion

public String getVersion(int art)

Parameter:

art - Satzart

Gibt zurück:

z.B. 1.1

getVersion

public String getVersion(int art,
 int sparte)

Parameter:

art - Satzart

sparte - z.B. 70 (Rechtsschutz)

Gibt zurück:

z.B. 1.1

getVersion

public String getVersion(SatzTyp satzTyp)

Liefert die Version zum gewuenschten SatzTyp.

Parameter:

satzTyp - z.B. SatzTyp.of("0100");

Gibt zurück:

z.B. 2.3

Seit:

5.0

setVersion

public void setVersion(Satz satz)

Setzen der Satzart-Version eines Datensatzes.

Parameter:

satz - der Satz

setVersion

public void setVersion(SatzTyp satzTyp)

Setzen der Satzart-Version eines SatzTyps.

Parameter:

satzTyp - der Satztyp

setVersion

public void setVersion(Bezeichner bezeichner,
 String version)

Setzen der Version.

Parameter:

bezeichner - Bezeichner

version - z.B. "1.2"

Seit:

4.1.1

setVersion

public void setVersion(int art,
 int sparte,
 String version)

Setzen der Version.

Parameter:

art - Satzart

sparte - Sparte

version - z.B. "1.2"

Seit:

4.1.1

getSatzartVersionen

public Map<SatzTyp,Version> getSatzartVersionen()

Liefert eine Liste aller gesetzter Versionen im Vorsatz.

Gibt zurück:

Liste mit Versionen

Seit:

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.

Setzt außer Kraft:

getFeld in Klasse Satz

Parameter:

bezeichner - gesuchtes Field

Gibt zurück:

Feld

Löst aus:

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.

Setzt außer Kraft:

getFelder in Klasse Satz

Gibt zurück:

alle Felder in der richtigen Reihenfolge