Class AbstractFormatter

java.lang.Object
gdv.xport.util.AbstractFormatter
All Implemented Interfaces:
ImportListener, AutoCloseable, EventListener
Direct Known Subclasses:
CsvFormatter, GdvXmlFormatter, HtmlFormatter, JsonFormatter, NullFormatter, XmlFormatter

public abstract class AbstractFormatter extends Object implements ImportListener, AutoCloseable
Dies ist das gemeinsame Oberklasse der verschiedenen Formatter. Es wird z.B. von der Main-Klasse fuer die Ausgabe verwendet.

Seit 5.0 wird das AutoCloseable-Interface implementiert.

Since:
0.5.0 (29.11.2010)
Author:
oliver (ob@aosd.de)
  • Constructor Details

    • AbstractFormatter

      public AbstractFormatter()
      Default-Konstruktor, der als Standard-Ausgabekanal stdout einstellt.
    • AbstractFormatter

      public AbstractFormatter(Writer writer)
      Instantiiert einen neuen Formatter.
      Parameters:
      writer - the writer
    • AbstractFormatter

      protected AbstractFormatter(Writer writer, Config config)
    • AbstractFormatter

      public AbstractFormatter(OutputStream ostream)
      Instantiiert einen neuen Formatter.
      Parameters:
      ostream - the ostream
  • Method Details

    • getConfig

      protected final Config getConfig()
    • getWriter

      public final Writer getWriter()
      Liefert den eingestellten Writer.
      Returns:
      the writer
    • setWriter

      public void setWriter(Writer writer)
      Setzt den Ausgabekanal auf den uebergebenen Writer.
      Parameters:
      writer - Ausgabekanal
    • setWriter

      public void setWriter(OutputStream ostream)
      Setzt den Ausgabekanal auf den uebergebenen OutputStream.
      Parameters:
      ostream - OutputStream als Ausgabekanal
    • notice

      public void notice(Satz satz)
      Sobald diese Methode aufgerufen, wird der uebergebene Satz formattiert ausgegeben.
      Specified by:
      notice in interface ImportListener
      Parameters:
      satz - der soeben importierte Satz
      See Also:
    • write

      public void write(Satz satz) throws IOException
      Wenn ein Formatter als ImportListener eingesetzt werden soll, muss er diese Methode ueberschreiben.
      Parameters:
      satz - Satz, der ausgegeben werden soll
      Throws:
      IOException - Signals that an I/O exception has occurred.
      See Also:
    • write

      public void write(Datenpaket datenpaket) throws IOException
      Ausgabe eines kompletten Datenpakets. Diese Methode war urspruenglich abstrakt, ist aber jetzt nicht mehr unbedingt noetig, wenn write(Satz) ueberschrieben wurde.
      Parameters:
      datenpaket - Datenpaket, das formattiert ausgegeben werden soll
      Throws:
      IOException - bei Problemen mit der Generierung
      See Also:
    • write

      public void write(String content) throws IOException
      Ausgabe des uebergebenen Strings.
      Parameters:
      content - the content
      Throws:
      IOException - Signals that an I/O exception has occurred.
    • close

      public void close() throws IOException
      Schliesst die Writer-Resource.
      Specified by:
      close in interface AutoCloseable
      Throws:
      IOException - falls was schief geht
      Since:
      5.0