Package de.elo.mover.main.helper

Class XmlHelper

java.lang.Object

de.elo.mover.main.helper.XmlHelper

public class XmlHelper
extends Object

Überschrift: XmlHelper.

Beschreibung: Hilfsklasse für das Lesen und Schreiben von XML-Dateien. Für die Methoden für die PDF-Konvertierung kann nur begrenzter Support geleistet werden.

Copyright: Copyright (c) ELO Digital Office GmbH 2018 - 2022

Constructor Summary

Constructors

Constructor	Description
XmlHelper()

Method Summary

Modifier and Type	Method	Description
static void	convertToPdf(File foFile, File pdfFile)	Konvertiert die angegebene FO-Datei nach PDF.
static void	convertToPdf(File xmlFile, File xslFile, File pdfFile)	Konvertiert die angegebene XML-Datei zu einer PDF-Datei mit Hilfe der angegebenen XSL-Datei.
static void	convertToPdf(InputStream foStream, OutputStream pdfStream)	Konvertiert die angegebene FO-Datei nach PDF.
static void	convertToPdf2(InputStream foStream, OutputStream pdfStream, boolean autodetect, File[] fontDirectories)	Konvertiert die angegebene FO-Datei nach PDF.
static void	convertToPdf3(InputStream foStream, OutputStream pdfStream, boolean autodetect, File[] fontDirectories, File fopCacheFile)	Konvertiert die angegebene FO-Datei nach PDF.
static void	convertXmlFileToTxt(File xmlFile, File txtFile)	Konvertiert die angegebene XML-Datei nach TXT.
static String	formatXmlText(String unformattedXmlText, int lineWidth, int indent)	Liefert den formattierten XML-Text aus dem angegebenen nicht formattierten XML-Text zurück.
static org.apache.fop.configuration.Configuration	getConfigFromNode(Node node)	Erzeugt eine Konfiguration für den angegebenen XML-Knoten.
static org.apache.fop.configuration.Configuration	getConfiguration(File configFile)	Liefert ein Konfigurationsobjekt aus der angegebenen Konfigurationsdatei zurück.
static String	getDocumentContent(File xmlFile, boolean withDeclaration, boolean standalone)	Liefert den Dokumentinhalt als ein String zurück.
static String	getDocumentContent(Document xmlDoc, boolean withDeclaration, boolean standalone)	Liefert den Dokumentinhalt als ein String zurück.
static Document	getDocumentFromString(String docContent)	Liefert ein XML-Dokument aus dem angegebenen String zurück.
static String	getEncoding(File xmlFile)	Liefert die Kodierung der angegebenen XML-Datei zurück.
static String	getItemValue(File xmlFile, String xPathExpression)	Liefert den Text des angegebenen aktuellen Knotens zurück.
static String	getNodeValue(File xmlFile, String xPathExpression)	Liefert den Wert für den angegebenen Knoten zurück.
static int	selectNodes(File xmlFile, String xPathExpression)	Evaluiert die angegebenen XML-Knoten und liefert die Anzahl der evaluierten Knoten zurück.
static void	transform(File xmlFile, File xslFile, File resultXmlFile)
static void	writeKeywordingInXml(de.elo.ix.client.Sord sord, File xmlFile)	Schreibt die angegebenen Metadaten in einer XML-Datei.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlHelper

public XmlHelper()

Method Details

writeKeywordingInXml

public static void writeKeywordingInXml(de.elo.ix.client.Sord sord,
 File xmlFile)
                                 throws Exception

Schreibt die angegebenen Metadaten in einer XML-Datei.

Parameters:

sord - Metadaten eines Eintrags

xmlFile - XML-Datei

Throws:

Exception

getDocumentContent

public static String getDocumentContent(Document xmlDoc,
 boolean withDeclaration,
 boolean standalone)
                                 throws TransformerException,
Exception

Liefert den Dokumentinhalt als ein String zurück.

Parameters:

xmlDoc - XML-Dokument

withDeclaration - Ausgabe mit einer XML-Deklaration

standalone - Standalone Dokument Deklaration

Returns:

Dokumentinhalt als String

Throws:

TransformerException

Exception

getDocumentContent

public static String getDocumentContent(File xmlFile,
 boolean withDeclaration,
 boolean standalone)
                                 throws TransformerException,
Exception

Liefert den Dokumentinhalt als ein String zurück.

Parameters:

xmlFile - XML-Datei

withDeclaration - Ausgabe mit einer XML-Deklaration

standalone - Standalone Dokument Deklaration

Returns:

Dokumentinhalt als String

Throws:

TransformerException

Exception

getDocumentFromString

public static Document getDocumentFromString(String docContent)
                                      throws ParserConfigurationException,
SAXException,
IOException,
Exception

Liefert ein XML-Dokument aus dem angegebenen String zurück.

Parameters:

docContent - Dokumentinhalt

Returns:

XML-Dokument

Throws:

ParserConfigurationException

SAXException

IOException

Exception

getNodeValue

public static String getNodeValue(File xmlFile,
 String xPathExpression)
                           throws Exception

Liefert den Wert für den angegebenen Knoten zurück.

Parameters:

xmlFile - XML-Datei

xPathExpression - XPath-Ausdruck

Returns:

Ergebnis

Throws:

Exception

selectNodes

public static int selectNodes(File xmlFile,
 String xPathExpression)
                       throws Exception

Evaluiert die angegebenen XML-Knoten und liefert die Anzahl der evaluierten Knoten zurück.

Parameters:

xmlFile - XML-Datei

xPathExpression - XPath-Ausdruck

Returns:

Anzahl der evaluierten XML-Knoten

Throws:

Exception

getItemValue

public static String getItemValue(File xmlFile,
 String xPathExpression)
                           throws Exception

Liefert den Text des angegebenen aktuellen Knotens zurück.

Parameters:

xmlFile - XML-Datei

xPathExpression - Pfad zum aktuellen Knoten

Returns:

Text des aktuellen Knotens

Throws:

Exception

convertToPdf

public static void convertToPdf(File xmlFile,
 File xslFile,
 File pdfFile)
                         throws Exception

Konvertiert die angegebene XML-Datei zu einer PDF-Datei mit Hilfe der angegebenen XSL-Datei. Die XSL-Datei enthält die Transformationsregeln.

Parameters:

xmlFile - XML-Datei

xslFile - XSL-Datei

pdfFile - PDF-Datei

Throws:

Exception

transform

public static void transform(File xmlFile,
 File xslFile,
 File resultXmlFile)
                      throws Exception

Throws:

Exception

convertToPdf

public static void convertToPdf(File foFile,
 File pdfFile)
                         throws Exception

Konvertiert die angegebene FO-Datei nach PDF.

Parameters:

foFile - FO-Datei

pdfFile - PDF-Datei

Throws:

Exception

convertToPdf

public static void convertToPdf(InputStream foStream,
 OutputStream pdfStream)
                         throws Exception

Konvertiert die angegebene FO-Datei nach PDF. Dabei werden die Betriebssystemschriften unterstützt.

Parameters:

foStream - InputStream für die FO-Datei

pdfStream - OutputStream für die PDF-Datei

Throws:

Exception

convertToPdf2

public static void convertToPdf2(InputStream foStream,
 OutputStream pdfStream,
 boolean autodetect,
 File[] fontDirectories)
                          throws Exception

Konvertiert die angegebene FO-Datei nach PDF. Dabei werden die Schriftarten aus den angegebenen Verzeichnissen unterstützt.

Parameters:

foStream - InputStream für die FO-Datei

pdfStream - OutputStream für die PDF-Datei

autodetect - Automatische Suche nach Schriftarten aktivieren

fontDirectories - Liste mit Verzeichnissen für die Schriftarten

Throws:

Exception

convertToPdf3

public static void convertToPdf3(InputStream foStream,
 OutputStream pdfStream,
 boolean autodetect,
 File[] fontDirectories,
 File fopCacheFile)
                          throws Exception

Konvertiert die angegebene FO-Datei nach PDF. Dabei werden die Schriftarten aus den angegebenen Verzeichnissen unterstützt.

Parameters:

foStream - InputStream für die FO-Datei

pdfStream - OutputStream für die PDF-Datei

autodetect - Automatische Suche nach Schriftarten aktivieren

fontDirectories - Liste mit Verzeichnissen für die Schriftarten oder null falls nicht benötigt

fopCacheFile - FOP Cache-Datei oder null falls nicht benötigt

Throws:

Exception

convertXmlFileToTxt

public static void convertXmlFileToTxt(File xmlFile,
 File txtFile)
                                throws Exception

Konvertiert die angegebene XML-Datei nach TXT.

Parameters:

xmlFile - XML-Datei

txtFile - TXT-Datei

Throws:

Exception

formatXmlText

public static String formatXmlText(String unformattedXmlText,
 int lineWidth,
 int indent)
                            throws Exception

Liefert den formattierten XML-Text aus dem angegebenen nicht formattierten XML-Text zurück.

Parameters:

unformattedXmlText - nicht formattierter XML-Text

lineWidth - Zeilenbreite

indent - Zeileneinzug

Returns:

formattierter XML-Text

Throws:

Exception

getEncoding

public static String getEncoding(File xmlFile)
                          throws Exception

Liefert die Kodierung der angegebenen XML-Datei zurück.

Parameters:

xmlFile - XML-Datei

Returns:

Kodierung der XML-Datei

Throws:

Exception

getConfiguration

public static org.apache.fop.configuration.Configuration getConfiguration(File configFile)
                                                                   throws Exception

Liefert ein Konfigurationsobjekt aus der angegebenen Konfigurationsdatei zurück.

Parameters:

configFile - Konfigurationsdatei

Returns:

Konfigurationsobjekt

Throws:

Exception

getConfigFromNode

public static org.apache.fop.configuration.Configuration getConfigFromNode(Node node)
                                                                    throws Exception

Erzeugt eine Konfiguration für den angegebenen XML-Knoten.

Parameters:

node - HTML-Knoten

Returns:

Konfiguration

Throws:

Exception