de.kl.xsreports
Interface GeneratorConfiguration

All Known Implementing Classes:
CsvGenerator, RtfGenerator, TextGenerator

public interface GeneratorConfiguration

Dieses Interface wird von der Factory benutzt, um einen Report-Generator zu konfigurieren. Bei der Konfiguration wird dem Report-Generator das Template mitgeteilt, mit dem gearbeitet werden soll. Eine Klasse die dieses Interface implementiert wird in der Regel auch das Interface Generator implementieren. Dieses Interface ist optional. Ein Generator der dieses Interface nicht implementiert kann jedoch weder mit einem Template gefuettert werden, noch Init-Parameter aus der WEB.XML Datei lesen.

Version:
%version%
Author:
nikita

Method Summary
 void init(javax.servlet.ServletConfig Config)
          Diese Methode wird con der Factory aufgerufen um dem Generator die Moeglichkeit zu geben, Daten aus der Servlet Konfiguration zu lesen.
 void setProperties(java.util.Map Prop)
          Definiert die Eigenschaften des Reports.
 void setTemplate(java.io.InputStream TemplateSource)
          Definiert das Template mit dem der Generator arbeitet.
 

Method Detail

init

void init(javax.servlet.ServletConfig Config)
          throws ConfigurationException
Diese Methode wird con der Factory aufgerufen um dem Generator die Moeglichkeit zu geben, Daten aus der Servlet Konfiguration zu lesen. Diese Methode wird vor allen anderen Methoden aufgerufen.

Parameters:
Config - Interface mit der Servlet Konfiguration.
Throws:
ConfigurationException - Falls in den Konfigurations-Daten des Servlet was faul ist.

setTemplate

void setTemplate(java.io.InputStream TemplateSource)
                 throws java.io.IOException
Definiert das Template mit dem der Generator arbeitet.

Parameters:
TemplateSource - Die Quelle, von der das Template fuer den Report gelesen werden kann.
Throws:
java.io.IOException - Falls beim Lesen der Template-Daten Fehler auftreten.

setProperties

void setProperties(java.util.Map Prop)
                   throws ConfigurationException
Definiert die Eigenschaften des Reports.

Parameters:
Prop - Ein Object das das Map Interface implementiert Das Object speichert zusaetzlich Eigenschaften die aus Aussehen des Reports bestimmen.
Throws:
ConfigurationException