org.conqat.lib.commons.xml

Class XMLUtils

java.lang.Object

org.conqat.lib.commons.xml.XMLUtils

public class XMLUtils
extends java.lang.Object

Collection of utility methods for XML.

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Element	appendChild(org.w3c.dom.Element element, java.lang.String tagName) Appends a child element with the given tag name to the given element and returns the new element.
static org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String tagName, java.lang.String textContent) Appends a child element with the given tag name and the given text content to the given element and returns the new element.
static org.w3c.dom.Document	createEmptyDocument() Creates an empty XML document.
static javax.xml.stream.XMLEventReader	createStAXParser(org.xml.sax.InputSource input) Creates a StAX parser.
static <ElementsEnum extends java.lang.Enum<ElementsEnum>,AttributesEnum extends java.lang.Enum<AttributesEnum>> XMLWriter<ElementsEnum,AttributesEnum>	createUtf8Writer(java.io.File outputFile, java.lang.Class<AttributesEnum> attributesClass) Creates a new XMLWriter that writes to the given output file.
static java.util.List<org.w3c.dom.Element>	elementNodes(org.w3c.dom.NodeList nodeList) Extracts all ElementNodes from a NodeList and returns the result as a list.
static java.lang.String	fixIllegalXmlChars(java.lang.String content) Fixes chars which are not allowed in XML content.
static org.w3c.dom.Element	getAncestor(org.w3c.dom.Element element, int distance) Returns the ancestor of the given element with the given distance.
static org.w3c.dom.Element	getElementByChildContent(java.util.List<org.w3c.dom.Element> elements, java.lang.String childName, java.lang.String childContent) Returns the first element whose child with the given name has the given text content.
static int	getElementPosition(org.w3c.dom.Element element) Determines the index (starting at 0) of the given element relative to other element nodes for the same parent.
static org.w3c.dom.Element	getLastNamedChild(org.w3c.dom.Element element, java.lang.String name) Returns the last child of the given element which is an element named as specified.
static org.w3c.dom.Element	getNamedChild(org.w3c.dom.Element element, java.lang.String name) Returns the first child of the given element which is an element named as specified.
static java.lang.String	getNamedChildContent(org.w3c.dom.Element parent, java.lang.String name) Get the text content of the given element's first child that is an element named as specified.
static java.util.List<org.w3c.dom.Element>	getNamedChildren(org.w3c.dom.Element element, java.lang.String elementNames) Returns all children of the given element which are element named as specified.
static java.util.List<org.w3c.dom.Element>	leafElementNodes(org.w3c.dom.Element root) Get all leaf elements of an XML tree rooted at an element
static org.w3c.dom.Document	parse(java.io.File file) Parse a file without validation.
static org.w3c.dom.Document	parse(java.io.File file, java.io.File schema) Same as parse(File, URL) but with schema file.
static org.w3c.dom.Document	parse(java.io.File file, java.net.URL schemaURL) Parse and validate file using schema.
static org.w3c.dom.Document	parse(org.xml.sax.InputSource input) Parse an input source without validation.
static org.w3c.dom.Document	parse(org.xml.sax.InputSource input, java.net.URL schemaURL) Parse and validate file using schema.
static void	parseSAX(java.io.File file, org.xml.sax.helpers.DefaultHandler handler) Parse an input source using SAX without validation.
static void	parseSAX(java.io.File file, java.net.URL schemaURL, org.xml.sax.helpers.DefaultHandler handler) Parse and validate file using SAX and schema.
static void	parseSAX(org.xml.sax.InputSource input, org.xml.sax.helpers.DefaultHandler handler) Parse an input source using SAX without validation.
static void	parseSAX(org.xml.sax.InputSource input, java.net.URL schemaURL, org.xml.sax.helpers.DefaultHandler handler) Parse and validate file using SAX and schema.
static void	parseSAX(java.lang.String content, org.xml.sax.helpers.DefaultHandler handler) Parse a string that contains XML without validation.
static java.lang.String	prettyPrint(org.w3c.dom.Document doc) Returns a string representation of the given XML document, which is "pretty printed", i.e.
static java.lang.String	print(org.w3c.dom.Document document) Transforms the document to an xml string (flat, with no line breaks).
static void	removeElement(org.w3c.dom.Element element) Removes the given element from its parent.
static org.xml.sax.InputSource	toInputSource(java.lang.String string) Converts the given String to a SAX InputSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

createUtf8Writer

public static <ElementsEnum extends java.lang.Enum<ElementsEnum>,AttributesEnum extends java.lang.Enum<AttributesEnum>> XMLWriter<ElementsEnum,AttributesEnum> createUtf8Writer(java.io.File outputFile,
                                                                                                                                                                                java.lang.Class<AttributesEnum> attributesClass)
                                                                                                                                                                         throws java.io.FileNotFoundException,
                                                                                                                                                                                java.io.UnsupportedEncodingException

Creates a new XMLWriter that writes to the given output file.

Throws:

java.io.FileNotFoundException

java.io.UnsupportedEncodingException

parse

public static org.w3c.dom.Document parse(java.io.File file)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException

Parse a file without validation.

Parameters:

file - the file to parse.

Returns:

the DOM document.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed.

java.io.IOException - if an IO exception occurs.

parse

public static org.w3c.dom.Document parse(org.xml.sax.InputSource input)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException

Parse an input source without validation.

Parameters:

input - the input source to parse

Returns:

the DOM document.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed.

java.io.IOException - if an IO exception occurs.

parseSAX

public static void parseSAX(java.io.File file,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parse an input source using SAX without validation.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed.

java.io.IOException - if an IO exception occurs.

parseSAX

public static void parseSAX(org.xml.sax.InputSource input,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parse an input source using SAX without validation.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed.

java.io.IOException - if an IO exception occurs.

parseSAX

public static void parseSAX(java.lang.String content,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parse a string that contains XML without validation.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed.

java.io.IOException - if an IO exception occurs.

parse

public static org.w3c.dom.Document parse(java.io.File file,
                                         java.net.URL schemaURL)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException

Parse and validate file using schema. This implements a custom error handler to avoid different behaviour between the JAXP implementations shipping with Java 1.5 and Java 1.6.

Parameters:

file - the file to parse.

schemaURL - URL point to schema, may not be null

Returns:

the DOM document.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed or not valid

java.io.IOException - if an IO exception occurs.

parse

public static org.w3c.dom.Document parse(org.xml.sax.InputSource input,
                                         java.net.URL schemaURL)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException

Parse and validate file using schema. This implements a custom error handler to avoid different behaviour between the JAXP implementations shipping with Java 1.5 and Java 1.6.

Parameters:

input - the input to parse.

schemaURL - URL point to schema, may not be null

Returns:

the DOM document.

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed or not valid

java.io.IOException - if an IO exception occurs.

parseSAX

public static void parseSAX(java.io.File file,
                            java.net.URL schemaURL,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parse and validate file using SAX and schema.

Parameters:

file - the file to parse.

schemaURL - URL point to schema, may not be null

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed or not valid

java.io.IOException - if an IO exception occurs.

parseSAX

public static void parseSAX(org.xml.sax.InputSource input,
                            java.net.URL schemaURL,
                            org.xml.sax.helpers.DefaultHandler handler)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parse and validate file using SAX and schema.

Parameters:

input - the input to parse.

schemaURL - URL point to schema, may not be null

Throws:

org.xml.sax.SAXException - if a parsing exception occurs, i.e. if the file is not well-formed or not valid

java.io.IOException - if an IO exception occurs.

createStAXParser

public static javax.xml.stream.XMLEventReader createStAXParser(org.xml.sax.InputSource input)
                                                        throws javax.xml.stream.XMLStreamException

Creates a StAX parser. The parser can be queried for new parsing events via hasNext()/next(). It continues parsing only on next() calls. This parser should be used if performance is relevant and only part of the XML document is needed.

Throws:

javax.xml.stream.XMLStreamException

parse

public static org.w3c.dom.Document parse(java.io.File file,
                                         java.io.File schema)
                                  throws org.xml.sax.SAXException,
                                         java.io.IOException

Same as parse(File, URL) but with schema file.

Throws:

java.lang.IllegalArgumentException - if the schema file could not be converted to an URL

org.xml.sax.SAXException

java.io.IOException

prettyPrint

public static java.lang.String prettyPrint(org.w3c.dom.Document doc)
                                    throws javax.xml.transform.TransformerException

Returns a string representation of the given XML document, which is "pretty printed", i.e. the tags are indented.

Throws:

javax.xml.transform.TransformerException

print

public static java.lang.String print(org.w3c.dom.Document document)
                              throws javax.xml.transform.TransformerException

Transforms the document to an xml string (flat, with no line breaks). Use prettyPrint(Document) for readable xml output.

Throws:

javax.xml.transform.TransformerException

getElementPosition

public static int getElementPosition(org.w3c.dom.Element element)

Determines the index (starting at 0) of the given element relative to other element nodes for the same parent.

getNamedChildren

public static java.util.List<org.w3c.dom.Element> getNamedChildren(org.w3c.dom.Element element,
                                                                   java.lang.String elementNames)

Returns all children of the given element which are element named as specified.

getNamedChild

public static org.w3c.dom.Element getNamedChild(org.w3c.dom.Element element,
                                                java.lang.String name)

Returns the first child of the given element which is an element named as specified. Returns null if none are found.

getLastNamedChild

public static org.w3c.dom.Element getLastNamedChild(org.w3c.dom.Element element,
                                                    java.lang.String name)

Returns the last child of the given element which is an element named as specified. Returns null if none are found.

getNamedChildContent

public static java.lang.String getNamedChildContent(org.w3c.dom.Element parent,
                                                    java.lang.String name)

Get the text content of the given element's first child that is an element named as specified. If none is found, the empty string is returned.

getElementByChildContent

public static org.w3c.dom.Element getElementByChildContent(java.util.List<org.w3c.dom.Element> elements,
                                                           java.lang.String childName,
                                                           java.lang.String childContent)

Returns the first element whose child with the given name has the given text content.

getAncestor

public static org.w3c.dom.Element getAncestor(org.w3c.dom.Element element,
                                              int distance)

Returns the ancestor of the given element with the given distance. Distance zero means the element itself, one the parent and so on.

elementNodes

public static java.util.List<org.w3c.dom.Element> elementNodes(org.w3c.dom.NodeList nodeList)

Extracts all ElementNodes from a NodeList and returns the result as a list.

Parameters:

nodeList - the NodeList to be searched for ElementNodes.

Returns:

an array containing all ElementNodes stored in the given node list or null if the input has been null.

removeElement

public static void removeElement(org.w3c.dom.Element element)

Removes the given element from its parent.

appendChild

public static org.w3c.dom.Element appendChild(org.w3c.dom.Element element,
                                              java.lang.String tagName)

Appends a child element with the given tag name to the given element and returns the new element.

appendChild

public static org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                              java.lang.String tagName,
                                              java.lang.String textContent)

Appends a child element with the given tag name and the given text content to the given element and returns the new element.

leafElementNodes

public static java.util.List<org.w3c.dom.Element> leafElementNodes(org.w3c.dom.Element root)

Get all leaf elements of an XML tree rooted at an element

Parameters:

root - The root element

Returns:

List of all leaf elements

createEmptyDocument

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

Creates an empty XML document.

toInputSource

public static org.xml.sax.InputSource toInputSource(java.lang.String string)

Converts the given String to a SAX InputSource.

fixIllegalXmlChars

public static java.lang.String fixIllegalXmlChars(java.lang.String content)

Fixes chars which are not allowed in XML content. The following replacements are allowed:

• All '&' which are not part of an XML escape char sequence are replaced by '&'.
• All low ASCII control chars are removed, besides TAB, LF, CR
• Escaped ASCII control chars are removed (e.g. � or �) with variable zero padding in hex and decimal format.