Package gdv.xport.util
Class GdvXmlFormatter
java.lang.Object
gdv.xport.util.AbstractFormatter
gdv.xport.util.GdvXmlFormatter
- All Implemented Interfaces:
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.
- Since:
- 5.0 (27.03.2021)
- Author:
- oliver (ob@aosd.de)
-
Constructor Summary
ConstructorsConstructorDescriptionDefault-Konstruktor.GdvXmlFormatter
(OutputStream ostream) Der Konstruktor fuer einenOutputStream
.GdvXmlFormatter
(OutputStream ostream, Config config) Der Konstruktor fuer einenOutputStream
zusammen 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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Hierueber werden noch die Felder-Definitionen und der Abspann rausgeschrieben, ehe die Writer-Resource geschlossen wird.void
setWriter
(OutputStream ostream) Setzt den Ausgabekanal auf den uebergebenen OutputStream.void
Setzt den Ausgabekanal auf den uebergebenen Writer.void
Ausgabe eines Datensatzes als XML.
-
Constructor Details
-
GdvXmlFormatter
public GdvXmlFormatter()Default-Konstruktor. -
GdvXmlFormatter
Der Konstruktor fuer die normale Arbeit.- Parameters:
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).- Parameters:
writer
- the writerstand
- Info, die nach dem XML-Header steht
-
GdvXmlFormatter
Der Konstruktor fuer einenOutputStream
.- Parameters:
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).- Parameters:
ostream
- z.B. System.out
-
GdvXmlFormatter
Der Konstruktor fuer einenOutputStream
zusammen mit einemConfig
-Objekt fuer weitere Einstellungen.- Parameters:
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>- Since:
- 5.3
-
-
Method Details
-
setWriter
Description copied from class:AbstractFormatter
Setzt den Ausgabekanal auf den uebergebenen Writer.- Overrides:
setWriter
in classAbstractFormatter
- Parameters:
writer
- Ausgabekanal
-
setWriter
Description copied from class:AbstractFormatter
Setzt den Ausgabekanal auf den uebergebenen OutputStream.- Overrides:
setWriter
in classAbstractFormatter
- Parameters:
ostream
- OutputStream als Ausgabekanal
-
close
Hierueber werden noch die Felder-Definitionen und der Abspann rausgeschrieben, ehe die Writer-Resource geschlossen wird.- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classAbstractFormatter
- Throws:
IOException
- falls was schief geht
-
write
Ausgabe eines Datensatzes als XML.- Overrides:
write
in classAbstractFormatter
- Parameters:
satz
- der auszugebende (Daten-)Satz- Throws:
IOException
- Signals that an I/O exception has occurred.- See Also:
-