Klasse GdvXmlFormatter
java.lang.Object
gdv.xport.util.AbstractFormatter
gdv.xport.util.GdvXmlFormatter
- Alle implementierten Schnittstellen:
ImportListener,AutoCloseable,EventListener
Diese Klasse orientiert an sich an der GDV-XML-Beschreibung fuer das
Ausgabeformat. Es kann u.a. dazu benutzt werden, um aus einem Datensatz
mit Enum-Beschreibung die entspechende XML-Beschreibung zu bekommen.
Mit v6 soll die Beschreibung eigener Datensaetze mittels Enums durch XML-basierte Beschreibungen abgeloest werden. Fuer dieses Ziel ist diese Klasse ein Baustein dazu.
- Seit:
- 5.0 (27.03.2021)
- Autor:
- oliver (ob@aosd.de)
-
Konstruktorübersicht
KonstruktorenKonstruktorBeschreibungDefault-Konstruktor.GdvXmlFormatter(OutputStream ostream) Der Konstruktor fuer einenOutputStream.GdvXmlFormatter(OutputStream ostream, Config config) Der Konstruktor fuer einenOutputStreamzusammen mit einemConfig-Objekt fuer weitere Einstellungen.GdvXmlFormatter(OutputStream ostream, String stand) Der Konstruktor fuer einenOutputStream.GdvXmlFormatter(Writer writer) Der Konstruktor fuer die normale Arbeit.GdvXmlFormatter(Writer writer, String stand) Der Konstruktor fuer die normale Arbeit. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoidclose()Hierueber werden noch die Felder-Definitionen und der Abspann rausgeschrieben, ehe die Writer-Resource geschlossen wird.voidsetWriter(OutputStream ostream) Setzt den Ausgabekanal auf den uebergebenen OutputStream.voidSetzt den Ausgabekanal auf den uebergebenen Writer.voidAusgabe eines Datensatzes als XML.
-
Konstruktordetails
-
GdvXmlFormatter
public GdvXmlFormatter()Default-Konstruktor. -
GdvXmlFormatter
Der Konstruktor fuer die normale Arbeit.- Parameter:
writer- the writer
-
GdvXmlFormatter
Der Konstruktor fuer die normale Arbeit. Als Info erscheint dabei der Zeitpunkt der Generierung (analog zumXmlFormatter, wo es als Kommentar ans Ende geschrieben wird).- Parameter:
writer- the writerstand- Info, die nach dem XML-Header steht
-
GdvXmlFormatter
Der Konstruktor fuer einenOutputStream.- Parameter:
ostream- z.B. System.outstand- Datum, ab dem erzeugte XML-Beschreibung gilt (Format TT.MM.JJJJ) z.B. "01.07.2018".
Dieser Wert erscheint in Analogie zur GDV-XML-Beschreibung am Beginn der XML-Beschreibung in einem Tag: <info><stand>...</stand></info>
-
GdvXmlFormatter
Der Konstruktor fuer einenOutputStream. Als Info erscheint dabei der Zeitpunkt der Generierung (analog zumXmlFormatter, wo es als Kommentar ans Ende geschrieben wird).- Parameter:
ostream- z.B. System.out
-
GdvXmlFormatter
Der Konstruktor fuer einenOutputStreamzusammen mit einemConfig-Objekt fuer weitere Einstellungen.- Parameter:
ostream- z.B. System.outconfig- mit weiteren Einstellungen. So kann man ueber die Property "gdv.export.xml.stand" z.B. den Stand fuer die erzeugte XML-Beschreibung mitgeben. Dieser Wert erscheint in Analogie zur GDV-XML-Beschreibung am Beginn der XML-Beschreibung in einem Tag: <info><stand>...</stand></info>- Seit:
- 5.3
-
-
Methodendetails
-
setWriter
Beschreibung aus Klasse kopiert:AbstractFormatterSetzt den Ausgabekanal auf den uebergebenen Writer.- Setzt außer Kraft:
setWriterin KlasseAbstractFormatter- Parameter:
writer- Ausgabekanal
-
setWriter
Beschreibung aus Klasse kopiert:AbstractFormatterSetzt den Ausgabekanal auf den uebergebenen OutputStream.- Setzt außer Kraft:
setWriterin KlasseAbstractFormatter- Parameter:
ostream- OutputStream als Ausgabekanal
-
close
Hierueber werden noch die Felder-Definitionen und der Abspann rausgeschrieben, ehe die Writer-Resource geschlossen wird.- Angegeben von:
closein SchnittstelleAutoCloseable- Setzt außer Kraft:
closein KlasseAbstractFormatter- Löst aus:
IOException- falls was schief geht
-
write
Ausgabe eines Datensatzes als XML.- Setzt außer Kraft:
writein KlasseAbstractFormatter- Parameter:
satz- der auszugebende (Daten-)Satz- Löst aus:
IOException- Signals that an I/O exception has occurred.- Siehe auch:
-