public class GWAPrueftool
extends java.lang.Object
implements java.io.Serializable
Überschrift: GWAPrueftool
Beschreibung: Die Klasse GWAPrueftool dient zur Durchführung des Prüfprozesses einer Datenlieferung und der darin enthaltenen
Gewerbeanzeige auf formale Richtigkeit und zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES)
mit ggfls. enthaltenen Fehlern.
Nachfolgende vom Statistischen Bundesamt bereitgestellten Komponente sind im GWA-Prüftool enthalten:
Constructor and Description |
---|
GWAPrueftool()
Konstruktor.
|
Modifier and Type | Method and Description |
---|---|
void |
generateProtokoll(java.io.InputStream inputFileAsStream,
java.lang.String eingangsstempel,
java.io.OutputStream outputStream)
Dient zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES) als OutputStream zur übergebenen und zu prüfenden
XSTATISTIK-Meldung als InputStream.
|
void |
generateProtokoll(java.lang.String inputFileXML)
Dient zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES) zur übergebenen und zu prüfenden XSTATISTIK-Meldung.
|
void |
generateProtokoll(java.lang.String inputDir,
java.lang.String inputFileXML)
Dient zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES) zur übergebenen und zu prüfenden XSTATISTIK-Meldung.
|
void |
generateProtokoll(java.lang.String inputDir,
java.lang.String inputFileXML,
java.lang.String eingangsstempel)
Dient zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES) zur übergebenen und zu prüfenden XSTATISTIK-Meldung .
|
void |
generateProtokollWithProperties(java.lang.String inputFileXML,
java.lang.String propertiesFile)
Dient zur Erzeugung der gewerbeanzeigespezifischen Protokolldatei (DatML/RES) zur übergebenen und zu prüfenden XSTATISTIK-Meldung.
|
int |
getInspectionLevel()
Liefert den aktuell eingestellten InspectionLevel.
|
de.destatis.core.inspector.InspectionReport |
getInspectionReport(java.io.InputStream inputFileAsStream)
Dient der Überprüfung des im Parameter übergebenen DatML/RAW-Dokumentes als InputStream und liefert einen Prüfbericht (InspectionReport)
zurück.
|
java.lang.String |
getLogsDir()
Liefert das aktuell eingestellte Logs-Verzeichnis.
|
java.lang.String |
getOutputDir()
Liefert das aktuell eingestellte Ausgabeverzeichnis zur Ablage der erzeugten Protokolldateien.
|
java.lang.String |
getOutputResFile()
Liefert den aktuell eingestellten Dateinamen der Protokolldatei.
|
java.lang.String |
getSurveyDir()
Liefert das aktuell eingestellte Erhebungsbeschreibungsverzeichnis.
|
java.lang.String |
getVersion()
Liefert die Version des GWA-Prüftools.
|
java.lang.String |
getVersionInfo()
Liefert den Erstellungszeitpunkt des GWA-Prüftools.
|
java.lang.String |
getXsltDir()
Liefert das aktuell eingestellte Verzeichnis der Transformationsdatei (res2res-gewerbe.xsl) und der dazugehörigen
Konfigurationsdatei (res2res-gewerbe.config.xml).
|
boolean |
isRotateLogFile()
Zeigt an, ob Log-Datei rotiert werden sollen.
|
void |
setInspectionLevel(int inspectionLevel)
Setzt den InspectionLevel.
|
void |
setLogsDir(java.lang.String logsDir)
Setzt das Logs-Verzeichnis.
|
void |
setOutputDir(java.lang.String outputDir)
Setzt das Ausgabeverzeichnis zur Ablage der erzeugten Protokolldateien.
|
void |
setOutputResFile(java.lang.String outputResFile)
Setzt den Dateinamen der Protokolldatei.
|
void |
setRotateLogFile(boolean rotateLogFile)
Setzt die Rotierung der Log-Datei.
|
void |
setSurveyDir(java.lang.String surveyDir)
Setzt das Erhebungsbeschreibungsverzeichnis.
|
void |
setXsltDir(java.lang.String xsltDir)
Setzt das Verzeichnis der Transformationsdatei (res2res-gewerbe.xsl) und der dazugehörigen Konfigurationsdatei (res2res-gewerbe.config.xml).
|
public GWAPrueftool() throws java.io.IOException, GWAPrueftoolException
java.io.IOException
- falls die Transformationsdatei (res2res-gewerbe.xsl) oder die Konfigurationsdatei (res2res-gewerbe.config.xml) nicht ermittelt werden konnte.GWAPrueftoolException
- falls das Ausgabeverzeichnis, das Log-Verzeichnis, das Erhebungsbeschreibungsverzeichnis oder das Verzeichnis der
Transformationsdatei mit null
angegeben wurde oder keinem gültigem Pfad entspricht.public void generateProtokoll(java.lang.String inputFileXML) throws java.io.IOException, GWAPrueftoolException, javax.xml.transform.TransformerException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException
inputFileXML
- Die zu prüfende XSTATISTIK-Meldung.java.io.IOException
- falls eine IOException mit der zu prüfenden XSTATISTIK-Meldung oder der Protokolldatei auftritt.GWAPrueftoolException
- falls das Eingabeverzeichnis "in" nicht existiert, der Dateiname der XSTATISTIK-Meldung mit null
angegeben
wurde oder die angegebene zu prüfende XSTATISTIK-Meldung nicht existiert.javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
public void generateProtokollWithProperties(java.lang.String inputFileXML, java.lang.String propertiesFile) throws java.io.IOException, GWAPrueftoolException, javax.xml.transform.TransformerException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException
inputFileXML
- Die zu prüfende XSTATISTIK-Meldung.propertiesFile
- Die Properties-Datei mit der Konfiguration zu den Verzeichnissen.java.io.IOException
- falls eine IOException mit der zu prüfenden XSTATISTIK-Meldung oder der Protokolldatei auftritt bzw. die
Transformationsdatei (res2res-gewerbe.xsl) oder die Konfigurationsdatei (res2res-gewerbe.config.xml) nicht ermittelt werden konnte.GWAPrueftoolException
- falls das Eingabeverzeichnis "in" nicht existiert, der Dateiname der XSTATISTIK-Meldung mit null
angegeben
wurde, die angegebene zu prüfende XSTATISTIK-Meldung oder die angegebene Properties-Datei nicht existiert .javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
javax.xml.transform.TransformerConfigurationException
javax.xml.transform.TransformerException
public void generateProtokoll(java.lang.String inputDir, java.lang.String inputFileXML) throws java.io.IOException, GWAPrueftoolException, javax.xml.transform.TransformerException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException
inputDir
- Das Eingabeverzeichnis der XSTATISTIK-Meldungen. Falls null
angegeben, wird der Default-Wert "in" verwendet.inputFileXML
- Die zu prüfende XSTATISTIK-Meldung.java.io.IOException
- falls eine IOException mit der zu prüfenden XSTATISTIK-Meldung oder der Protokolldatei auftritt.GWAPrueftoolException
- falls das Eingabeverzeichnis nicht existiert, der Dateiname der XSTATISTIK-Meldung mit null
angegeben
wurde oder die angegebene zu prüfende XSTATISTIK-Meldung nicht existiert.javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
public void generateProtokoll(java.lang.String inputDir, java.lang.String inputFileXML, java.lang.String eingangsstempel) throws java.io.IOException, GWAPrueftoolException, javax.xml.transform.TransformerException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException
inputDir
- Das Eingabeverzeichnis der XSTATISTIK-Meldungen. Falls null
angegeben, wird der Default-Wert "in" verwendet.inputFileXML
- Die zu prüfende XSTATISTIK-Meldung.eingangsstempel
- Der Eingangsstempel zur Hinterlegung im Dateneingang der Protokolldatei. Falls null
angegeben,
wird der Dateiname der XSTATISTIK-Meldung als Eingangsstempel verwendet.java.io.IOException
- falls eine IOException mit der zu prüfenden XSTATISTIK-Meldung oder der Protokolldatei auftritt.GWAPrueftoolException
- falls das Eingabeverzeichnis nicht existiert, der Dateiname der XSTATISTIK-Meldung mit null
angegeben
wurde oder die angegebene zu prüfende XSTATISTIK-Meldung nicht existiert.javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
public void generateProtokoll(java.io.InputStream inputFileAsStream, java.lang.String eingangsstempel, java.io.OutputStream outputStream) throws java.io.IOException, javax.xml.transform.TransformerException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException, GWAPrueftoolException
inputFileAsStream
- Die zu prüfende XSTATISTIK-Meldung als InputStream.eingangsstempel
- Der Eingangsstempel zur Hinterlegung im Dateneingang der Protokolldatei. Falls null
angegeben,
wird "EINGANGSSTEMPEL_yyyyMMdd_HHmmssSSS" als Eingangsstempel verwendet.outputStream
- der zu erzeugenden gewerbeanzeigespezifischen Protokolldatei (DatML/RES) zur übergebenen XSTATISTIK-Meldung.java.io.IOException
- falls eine IOException während der Prüfung der XSTATISTIK-Meldung auftritt.javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
GWAPrueftoolException
public int getInspectionLevel()
public void setInspectionLevel(int inspectionLevel) throws GWAPrueftoolException
inspectionLevel
- Der für die Prüfung zu verwendende InspectionLevel.
gültige Werte sind:
GWAPrueftoolException
- falls eine Prüfstufe ungleich 3 (Prüfstufe Autorisierung) oder 4 (Prüfstufe Daten) angegeben wurde.public java.lang.String getOutputDir()
public void setOutputDir(java.lang.String outputDir) throws GWAPrueftoolException
outputDir
- Das Ausgabeverzeichnis zur Ablage der erzeugten Protokolldateien. Das Ausgabeverzeichnis muss existieren und
darf nicht null
sein.
Default-Wert: "out"
GWAPrueftoolException
- falls das Ausgabeverzeichnis mit null
angegeben wurde oder keinem gültigem Pfad entspricht.public java.lang.String getLogsDir()
public void setLogsDir(java.lang.String logsDir) throws GWAPrueftoolException
logsDir
- Das Logs-Verzeichnis. Das Logs-Verzeichnis muss existieren und darf nicht null
sein.
Default-Wert: "logs"
GWAPrueftoolException
- falls das Logs-Verzeichnis mit null
angegeben wurde oder keinem gültigem Pfad entspricht.public java.lang.String getSurveyDir()
public void setSurveyDir(java.lang.String surveyDir) throws GWAPrueftoolException
surveyDir
- Das Erhebungsbeschreibungsverzeichnis. Das Erhebungsbeschreibungsverzeichnis muss existieren und darf nicht null
sein.
Default-Wert: "sdf"
GWAPrueftoolException
- falls das Erhebungsbeschreibungsverzeichnis mit null
angegeben wurde oder keinem gültigem Pfad entspricht.public java.lang.String getXsltDir()
In der Konfigurationsdatei (res2res-gewerbe.config.xml) ist die Beschreibung der Anwendung anhand des Anwendungsnamens, der dazugehörigen Version
und des Herstellers vorzunehmen:
public void setXsltDir(java.lang.String xsltDir) throws GWAPrueftoolException, java.io.IOException
In der Konfigurationsdatei ist die Beschreibung der Anwendung anhand des Anwenungsnamens, der dazugehörigen Version
und des Herstellers vorzunehmen:
xsltDir
- Das Verzeichnis der Transformationsdatei und der dazugehörigen Konfigurationsdatei. Das Verzeichnis der Transformationsdatei und
der dazugehörigen Konfigurationsdatei muss existieren und darf nicht null
sein.
Default-Wert: "xslt"
GWAPrueftoolException
- falls das Verzeichnis der Transformationsdatei und der dazugehörigen Konfigurationsdatei mit null
angegeben wurde oder keinem gültigem Pfad entspricht.java.io.IOException
- falls die Transformationsdatei (res2res-gewerbe.xsl) oder die Konfigurationsdatei (res2res-gewerbe.config.xml) nicht ermittelt werden konnte.public java.lang.String getOutputResFile()
public void setOutputResFile(java.lang.String outputResFile) throws GWAPrueftoolException
outputResFile
- Der Dateinamen der Protokolldatei. Die Protokolldatei darf nicht null
sein.
Default-Wert: Dateiname der zu prüfenden XSTATISTIK-Meldung (ohne Extension '.xml') erweitert um den Anhang "-prot.xml".
GWAPrueftoolException
- falls die Protokolldatei mit null
oder eine ungültiger Dateiname angegeben wurde.public de.destatis.core.inspector.InspectionReport getInspectionReport(java.io.InputStream inputFileAsStream) throws GWAPrueftoolException, java.io.IOException
inputFileAsStream
- Die zu prüfende XSTATISTIK-Meldung als InputStream.null
, falls kein
InspectionReport erzeugt werden konnte.GWAPrueftoolException
java.io.IOException
public java.lang.String getVersion()
public java.lang.String getVersionInfo()
public boolean isRotateLogFile()
public void setRotateLogFile(boolean rotateLogFile)
rotateLogFile
- Die Rotierung 'true' (aktiviert) / 'false' (deaktiviert)' der Log-Datei.Copyright © 2015 Statistisches Bundesamt Wiesbaden