desmoj.extensions.xml.util

Class XMLHelper

java.lang.Object

desmoj.extensions.xml.util.XMLHelper

public class XMLHelper
extends java.lang.Object

A utility class providing several static methods to handle DOM documents.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Nicolas Knaak and Gunnar Kiesel Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
XMLHelper()

Method Summary

Modifier and Type	Method and Description
static void	addElement(org.w3c.dom.Document document, org.w3c.dom.Element father, java.lang.String name, java.lang.String attOneName, java.lang.String attOneValue) adds an Element with one attribut to a DOM-tree.
static void	addElement(org.w3c.dom.Document document, org.w3c.dom.Element father, java.lang.String name, java.lang.String attOneName, java.lang.String attOneValue, java.lang.String attTwoName, java.lang.String attTwoValue) adds an Element with two attributs to a DOM-tree.
static void	applyXSL(java.io.File xmlFile, java.io.File xslFile, java.lang.String outputFilename) Transforms an xml-file (xmlFilename) using an xsl-file (xslFilename) and writes the output into file (outputFilename).
static org.w3c.dom.CDATASection	createCDATA(org.w3c.dom.Document d, java.lang.String text) Creates a CDATA section node in an XML document
static org.w3c.dom.Comment	createComment(org.w3c.dom.Document d, java.lang.String text) Creates an XML comment with the given text
static org.w3c.dom.Document	createDocument() Creates a new DOM document.
static org.w3c.dom.Element	createElement(org.w3c.dom.Document d, java.lang.String name) Creates a DOM element node with the given name.
static org.w3c.dom.Element	createElement(org.w3c.dom.Document d, java.lang.String name, java.lang.String value, boolean isCDATA) Creates a DOM element node with the given name and contents.
static org.w3c.dom.Element	createElementLn(org.w3c.dom.Document d, java.lang.String name, java.lang.String value, boolean isCDATA) Creates a DOM element node with the given name and contents.
static org.w3c.dom.Text	createText(org.w3c.dom.Document d, java.lang.String text) Creates a text node in an XML document
static org.w3c.dom.Text	createTextLn(org.w3c.dom.Document d) Creates a text node in an XML document representing a new line character
static org.w3c.dom.Text	createTextLn(org.w3c.dom.Document d, java.lang.String text) Creates a text node in an XML document ended by a new line character
static void	serializeDocument(org.w3c.dom.Document document, java.io.Writer out) Saves a DOM tree as XML file
static void	writeNode(org.w3c.dom.Node n, java.io.FileOutputStream o) Writes a DOM node (and all its ancestors) to the given output stream

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLHelper

public XMLHelper()

Method Detail

writeNode

public static void writeNode(org.w3c.dom.Node n,
                             java.io.FileOutputStream o)

Writes a DOM node (and all its ancestors) to the given output stream

Parameters:

n - the node to write

o - the output stream to write the node to

createElement

public static org.w3c.dom.Element createElement(org.w3c.dom.Document d,
                                                java.lang.String name)

Creates a DOM element node with the given name. This node must only be used in the specified document.

Parameters:

d - the "mother" document of the created node

name - the name of the node

Returns:

a node with the given name

createComment

public static org.w3c.dom.Comment createComment(org.w3c.dom.Document d,
                                                java.lang.String text)

Creates an XML comment with the given text

Parameters:

d - the "mother" document of the created comment

text - the comment text

Returns:

a comment containing the given text

createText

public static org.w3c.dom.Text createText(org.w3c.dom.Document d,
                                          java.lang.String text)

Creates a text node in an XML document

Parameters:

d - the "mother" document of the created text node

text - contents of the text node

Returns:

a new text node

createElement

public static org.w3c.dom.Element createElement(org.w3c.dom.Document d,
                                                java.lang.String name,
                                                java.lang.String value,
                                                boolean isCDATA)

Creates a DOM element node with the given name and contents. If indicated the contents is enclosed in CDATA marks.

Parameters:

d - the "mother" document of the created Element

name - the name of the element

value - the element's value

isCDATA - a flag indicating if this element contains (unformatted) CDATA.

Returns:

a new DOM Element

createElementLn

public static org.w3c.dom.Element createElementLn(org.w3c.dom.Document d,
                                                  java.lang.String name,
                                                  java.lang.String value,
                                                  boolean isCDATA)

Creates a DOM element node with the given name and contents. If indicated the contents is enclosed in CDATA marks. The tag ends with a new line character.

Parameters:

d - the "mother" document of the created Element

name - the name of the element

value - the element's value

isCDATA - a flag indicating if this element contains (unformatted) CDATA.

Returns:

a new DOM Element

createTextLn

public static org.w3c.dom.Text createTextLn(org.w3c.dom.Document d,
                                            java.lang.String text)

Creates a text node in an XML document ended by a new line character

Parameters:

d - the "mother" document of the created text node

text - contents of the text node

Returns:

a new text node

createTextLn

public static org.w3c.dom.Text createTextLn(org.w3c.dom.Document d)

Creates a text node in an XML document representing a new line character

Parameters:

d - the "mother" document of the created text node

Returns:

a text node containing a single newline character

createCDATA

public static org.w3c.dom.CDATASection createCDATA(org.w3c.dom.Document d,
                                                   java.lang.String text)

Creates a CDATA section node in an XML document

Parameters:

d - the "mother" document of the created text node

text - the text this CDATA section contains

Returns:

a new CDATA section node.

createDocument

public static org.w3c.dom.Document createDocument()

Creates a new DOM document.

Returns:

a new empty DOM document

serializeDocument

public static void serializeDocument(org.w3c.dom.Document document,
                                     java.io.Writer out)

Saves a DOM tree as XML file

Parameters:

document - Document: The DOM-Tree to be saved

out: - Writer: The (file)writer to be used

addElement

public static void addElement(org.w3c.dom.Document document,
                              org.w3c.dom.Element father,
                              java.lang.String name,
                              java.lang.String attOneName,
                              java.lang.String attOneValue)

adds an Element with one attribut to a DOM-tree.

Parameters:

document - Document: the DOM-tree to add to

father - Element: the new element will be inserted directly under this Element in the tree

name - String: the name of the new element

attOneName - String: the name of the attribut

attOneValue - String: the value of the attribut

addElement

public static void addElement(org.w3c.dom.Document document,
                              org.w3c.dom.Element father,
                              java.lang.String name,
                              java.lang.String attOneName,
                              java.lang.String attOneValue,
                              java.lang.String attTwoName,
                              java.lang.String attTwoValue)

adds an Element with two attributs to a DOM-tree.

Parameters:

document - Document: the DOM-tree to add to

father - Element: the new element will be inserted directly under this Element in the tree

name - String: the name of the new element

attOneName - String: the name of the 1st attribut

attOneValue - String: the value of the 1st attribut

attTwoName - String: the name of the 2nd attribut

attTwoValue - String: the value of the 2nd attribut

applyXSL

public static void applyXSL(java.io.File xmlFile,
                            java.io.File xslFile,
                            java.lang.String outputFilename)

Transforms an xml-file (xmlFilename) using an xsl-file (xslFilename) and writes the output into file (outputFilename).

Parameters:

xmlFile - File: the xml-source-file to be transformed

xslFile - File: the xsl-file with the transformation rules

outputFilename - String: the name of the file the result will be written to