inchorus Export Plugin Dokumentation

Das Export Plugin bietet Ihnen die Möglichkeit Daten aus dem XML Format anhand eines XSL Templates als PDF, HTML oder CSV zu exportieren.

Folgende Funktionalitäten stehen zur Verfügung:

Das Export Plugin basiert auf dem Apache FOP Projekt und verwendet das inchorus XML Plugin.

Plugin einbinden

Öffnen Sie die Datei pom.xml Ihres inchorus Gadget Projektes und ergänzen Sie folgende Zeilen im Abschnitt "dependencies":

<dependency>
	<groupId>de.guh.plugin</groupId>
	<artifactId>inchorus-export-plugin</artifactId>
	<version>2.0.5</version>
</dependency>

Initialisieren des Export Plugins

Das Export Plugin besteht im wesentlichen aus den zwei Klassen ExportEngine und ExportDocument. Um ein XML Dokument zu exportieren, muss ein ExportDocument erstellt werden, welches die notwendigen Parameter für das Zieldokument enthält:

ExportDocument doc = new ExportDocument("de", "style.xsl", DocumentType.DOCUMENTFORMAT_PDF);

Der erste Parameter gibt die Sprache an, style.xsl definierten den Dateinamen des XSL Templates und mit DocumentType.DOCUMENTFORMAT_PDF wird das Zielformat angegeben, in diesem Fall eine PDF Datei. Alternativ kann mit dem entsprechenden Konstruktor der Inhalt der style.xsl Datei als String übergeben werden, statt als Dateiname.

Zusätzlich muss eine ExportEngine instantiiert werden:

ExportEngine exportEngine = new ExportEngine("Quellpfad", "Zielpfad");

Die den Pfad zum Ordner mit den XSL Templates enthält und den Pfad, in den die Dokumente exportiert werden sollen.

XSL Templates

Das übergebene XSL Template muss geeignet sein, um Inhalt im entsprechenden Format zu erzeugen. Entsprechende Beispiel-Templates finden Sie im Ordner Beispiele.

Exportieren der XML Daten

Um XML Daten zu exportieren, müssen sie im Format des inchorus XML Plugins vorliegen. Dann können sie z.B. als PDF Datei exportiert werden:

exportEngine.generateDokumentFilePDF(xmlData, exportDocument, targetFile);

Der Parameter xmlData enthält die Daten im XML Format des Inchorus XML Plugins, exportDocument enthält die oben initialisierten Parameter für das Zieldokument und targetFile ist die Datei, in die das Dokument exportiert werden soll.

Analog kann mit dem Befehl generateDokumentFileHTML und dem entsprechenden XSL Template eine HTML Datei generiert werden.

Exportieren als Byte-Array oder String

Mit render(exportDocument, xmlData) wird das Dokument entsprechend der Einstellungen in exportDocument als Byte-Array erzeugt und kann weiter verwendet werden. Als dritte Möglichkeit kann mit generateDokumentCSV bzw. generateDokumentHTML das CSV oder HTML Dokument als String exportiert werden.

Treten Fehler beim Exportieren oder lesen der Dateien auf, werden entsprechende Exceptions geworfen.

Schließen der ExportEngine

Nach der Verwendung der ExportEngine kann sie mit einem Aufrauf von destroy() geschlossen werden.

Nähere Informationen zu den Klassen und Methoden finden sie in der API Dokumentation.

Beispiele finden Sie im Ordner Beispiele.

Bei Fragen und Anregungen nutzen Sie unser inchorus Forum.

Dieses Dokument erhalten sie hier auch als PDF.

G+H Systems GmbH

Professionell, effizient und zuverlässig.

Ludwigstraße 8

63067 Offenbach am Main

Deutschland

Telefon: +49 (0) 69 85 00 02 - 0

Fax: +49 (0) 69 85 00 02 - 51

Email: info@guh-systems.de

Web: www.guh-systems.de

Die G+H Systems leistet keinerlei Gewähr bezüglich des Inhaltes oder Gebrauchs dieser Dokumentation. Insbesondere werden keine ausdrücklichen oder stillschweigenden Gewährleistungen hinsichtlich der handelsüblichen Qualität oder Eignung für einen bestimmten Zweck übernommen. Die G+H Systems behält sich weiterhin das Recht vor, diese Dokumentation zu revidieren und ihren Inhalt jederzeit und ohne vorherige Ankündigung zu ändern.

Des Weiteren übernimmt die G+H Systems für Software keinerlei Haftung und schließt insbesondere jegliche ausdrücklichen oder impliziten Gewährleistungsansprüche bezüglich der Marktfähigkeit oder der Eignung für einen bestimmten Zweck aus. Außerdem behält sich die G+H Systems das Recht vor, G+H Software ganz oder teilweise jederzeit inhaltlich zu ändern, ohne dass für die G+H Systems die Verpflichtung entsteht, Personen oder Organisationen von diesen Überarbeitungen oder Änderungen in Kenntnis zu setzen.

Copyright © inchorus ist ein Produkt der G+H Systems GmbH

Ohne ausdrückliche, schriftliche Genehmigung des Herausgebers darf kein Teil dieser Veröffentlichung reproduziert, fotokopiert, übertragen oder in einem Speichersystem verarbeitet werden.