org.pfsw.pax

Class XmlUtil

java.lang.Object

org.pfsw.pax.XmlUtil

public class XmlUtil
extends java.lang.Object

This class provides general helper classes that normally should be part of the Java API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NS_PREFIX The prefix name that is used for the default namespace (i.e.
static XmlUtil	XU An instance of this class which can be easily included as static import and then used like XU.parseXmlString(string).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlUtil() Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
void	addNamespacesFrom(NamespacePrefixMapper namespaces, org.w3c.dom.Element element) Adds all namespaces that are declared in the given element with their prefix to the provided namespace prefix mapper.
void	addNamespacesFromElementAndChildren(NamespacePrefixMapper namespaces, org.w3c.dom.Element element) Adds all namespaces that are declared in the given element and all child elements together with their prefixes to the provides namespace prefix mapper.
java.lang.String	asString(org.w3c.dom.Element element)
protected void	close(java.io.Closeable closeable)
static XmlUtil	current() Returns the only instance this class supports (design pattern "Singleton")
javax.xml.namespace.NamespaceContext	extractNamespacesFrom(org.w3c.dom.Document document) Extracts all namespace definitions from the given document and returns them in a NamespaceContext implementation.
javax.xml.namespace.NamespaceContext	extractNamespacesFrom(org.w3c.dom.Element rootElement) Extracts all namespace definitions from the given root element and returns them in a NamespaceContext implementation.
protected java.io.File	findFile(java.lang.String filename) Tries to find the file with the given name.
java.lang.String	getAttributeLN(org.w3c.dom.Element element, java.lang.String localName) Returns the value of the attribute with the given local name in the specified element.
java.util.List<org.w3c.dom.Element>	getChildElements(org.w3c.dom.Element element) Returns a list of all direct children of the given element.
org.w3c.dom.Element	getFirstChildElement(org.w3c.dom.Element element) Returns the first Element under the given element.
org.w3c.dom.Element	getFirstElementByTagName(org.w3c.dom.Document document, java.lang.String tagName) Returns the first element in the given document that matches the specified tagName.
org.w3c.dom.Element	getFirstElementByTagName(org.w3c.dom.Element element, java.lang.String tagName) Returns the first element under the given element that matches the specified tagName.
java.lang.String	getNamespaceURIOf(org.w3c.dom.Element element) Returns the namespace URI of the given element or null if none can be found.
java.util.List<org.w3c.dom.Node>	nodeListToListOfNodes(org.w3c.dom.NodeList nodeList) Converts a nodeList to a list of Node objects.
protected org.w3c.dom.Document	parse(org.xml.sax.InputSource inputSource)
protected org.w3c.dom.Document	parse(org.xml.sax.InputSource inputSource, javax.xml.validation.Schema schema)
org.w3c.dom.Document	parseXmlString(java.lang.String xml)
javax.xml.validation.Schema	readSchema(java.lang.String schemaFileName) Returns the Schema object for the specified XML schema file.
org.w3c.dom.Document	readXmlDocument(java.lang.String xmlFileName, javax.xml.validation.Schema schema) Returns the Document object for the specified XML file.
org.w3c.dom.Document	readXmlDocument(java.lang.String xmlFileName, java.lang.String schemaFileName) Returns the Document object for the specified XML file.
org.w3c.dom.Document	readXmlFile(java.lang.String filename) Returns the document object read from the specified XML file.

Methods inherited from class java.lang.Object

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

Field Detail

XU

public static final XmlUtil XU

An instance of this class which can be easily included as static import and then used like XU.parseXmlString(string).

DEFAULT_NS_PREFIX

public static final java.lang.String DEFAULT_NS_PREFIX

The prefix name that is used for the default namespace (i.e. "dns").

See Also:

Constant Field Values

Constructor Detail

XmlUtil

protected XmlUtil()

Initialize the new instance with default values.

Method Detail

current

public static XmlUtil current()

Returns the only instance this class supports (design pattern "Singleton")

readXmlFile

public org.w3c.dom.Document readXmlFile(java.lang.String filename)
                                 throws java.lang.Exception

Returns the document object read from the specified XML file. If the file cannot be found directly with the given name it will be looked-up on the classpath.

Throws:

java.lang.Exception

readXmlDocument

public org.w3c.dom.Document readXmlDocument(java.lang.String xmlFileName,
                                            java.lang.String schemaFileName)
                                     throws java.lang.Exception

Returns the Document object for the specified XML file. Validates the XML content against the schema in the specified schema file. Both filenames are treated in the following way:

1. If the filename is absolute, the file will be read directly.
2. If the filename is relative, the file will looked-up relative to the current working directory.
3. If the filename is relative, and has not been found in the current working directory, it will be looked-up in the classpath.
4. If a file with the given filename is still not found, a FileNotFoundException will be thrown.

Parameters:

xmlFileName - The name of the XML file to read (must not be null)

schemaFileName - The name of the XML schema (XSD) file (may be null)

Throws:

java.lang.Exception

readXmlDocument

public org.w3c.dom.Document readXmlDocument(java.lang.String xmlFileName,
                                            javax.xml.validation.Schema schema)
                                     throws java.lang.Exception

Returns the Document object for the specified XML file. Validates the XML content against the given schema (if not null). The xmlFileName is treated in the following way:

1. If the filename is absolute, the file will be read directly.
2. If the filename is relative, the file will looked-up relative to the current working directory.
3. If the filename is relative, and has not been found in the current working directory, it will be looked-up in the classpath.
4. If a file with the given filename is still not found, a FileNotFoundException will be thrown.

Parameters:

xmlFileName - The name of the XML file to read (must not be null)

schema - The schema to validate the XML data against (may be null)

Throws:

java.lang.Exception

readSchema

public javax.xml.validation.Schema readSchema(java.lang.String schemaFileName)
                                       throws java.io.FileNotFoundException,
                                              org.xml.sax.SAXException

Returns the Schema object for the specified XML schema file. The schemaFileName is treated in the following way:

1. If the filename is null of an empty or blank string, null will be returned.
2. If the filename is absolute, the file will be read directly.
3. If the filename is relative, the file will looked-up relative to the current working directory.
4. If the filename is relative, and has not been found in the current working directory, it will be looked-up in the classpath.
5. If a file with the given filename is still not found, a FileNotFoundException will be thrown.

Parameters:

schemaFileName - The name of the XML schema file to read (may be null)

Returns:

The schema object representing the schema definition in the specified file or null if the given filename was null or blank/empty.

Throws:

java.io.FileNotFoundException

org.xml.sax.SAXException

addNamespacesFrom

public void addNamespacesFrom(NamespacePrefixMapper namespaces,
                              org.w3c.dom.Element element)

Adds all namespaces that are declared in the given element with their prefix to the provided namespace prefix mapper.

Parameters:

namespaces - An implementation of a NamespaceContext that can collect prefix to namespace mappings (must not be null)

element - The element from which to extract namespace declarations.

addNamespacesFromElementAndChildren

public void addNamespacesFromElementAndChildren(NamespacePrefixMapper namespaces,
                                                org.w3c.dom.Element element)

Adds all namespaces that are declared in the given element and all child elements together with their prefixes to the provides namespace prefix mapper.

Parameters:

namespaces - An implementation of a NamespaceContext that can collect prefix to namespace mappings (must not be null)

element - The element from which to start recursivly extracting namespace declarations.

extractNamespacesFrom

public javax.xml.namespace.NamespaceContext extractNamespacesFrom(org.w3c.dom.Element rootElement)

Extracts all namespace definitions from the given root element and returns them in a NamespaceContext implementation.

extractNamespacesFrom

public javax.xml.namespace.NamespaceContext extractNamespacesFrom(org.w3c.dom.Document document)

Extracts all namespace definitions from the given document and returns them in a NamespaceContext implementation.

getNamespaceURIOf

public java.lang.String getNamespaceURIOf(org.w3c.dom.Element element)

Returns the namespace URI of the given element or null if none can be found. This method is doing a recursive look-up for the namespaceURI. That is, if the element has no namespaceURI set the parent element will be used and so on until no parent element exists.

Parameters:

element - The element of interest.

Returns:

The name of the element's namespace URI or null if nonen can be determined.

getFirstElementByTagName

public org.w3c.dom.Element getFirstElementByTagName(org.w3c.dom.Document document,
                                                    java.lang.String tagName)

Returns the first element in the given document that matches the specified tagName. If no such element can be found this method returns null. The element will be searched for in the whole hierarchy under the given document.

Parameters:

document - The document in which to find the element (must not be null)

tagName - The name of the element to find (must not be null)

Returns:

The found element or null

getFirstElementByTagName

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

Returns the first element under the given element that matches the specified tagName. If no such element can be found this method returns null. The element will be searched for in the whole hierarchy under the given element.

Parameters:

element - The element under which to find the element (must not be null)

tagName - The name of the element to find (must not be null)

Returns:

The found element or null

getChildElements

public java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element element)

Returns a list of all direct children of the given element. If no child element exists an empty list will be returned.

getFirstChildElement

public org.w3c.dom.Element getFirstChildElement(org.w3c.dom.Element element)

Returns the first Element under the given element. If no child element exists null will be returned.

getAttributeLN

public java.lang.String getAttributeLN(org.w3c.dom.Element element,
                                       java.lang.String localName)

Returns the value of the attribute with the given local name in the specified element. If no attribute with that name exists in the element null will be returned.

Parameters:

element - The element from which to retrieve the attribute

localName - The local name (i.e. without any prefix) of the attribute

asString

public java.lang.String asString(org.w3c.dom.Element element)
                          throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

parseXmlString

public org.w3c.dom.Document parseXmlString(java.lang.String xml)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

nodeListToListOfNodes

public java.util.List<org.w3c.dom.Node> nodeListToListOfNodes(org.w3c.dom.NodeList nodeList)

Converts a nodeList to a list of Node objects.

parse

protected org.w3c.dom.Document parse(org.xml.sax.InputSource inputSource)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

parse

protected org.w3c.dom.Document parse(org.xml.sax.InputSource inputSource,
                                     javax.xml.validation.Schema schema)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

findFile

protected java.io.File findFile(java.lang.String filename)
                         throws java.io.FileNotFoundException

Tries to find the file with the given name. The file look-up is done in the following steps:

1. If the filename is absolute, the file will be read directly.
2. If the filename is relative, the file will looked-up relative to the current working directory.
3. If the filename is relative, and has not been found in the current working directory, it will be looked-up via the class loader of XmlUtil.
4. If a file with the given filename is still not found, a FileNotFoundException will be thrown.

Parameters:

filename - The name of the file to find

Returns:

A file object that exists on the file system

Throws:

java.io.FileNotFoundException - If the file could not be found.

close

protected void close(java.io.Closeable closeable)