loci.common.xml

Class XMLTools

java.lang.Object

loci.common.xml.XMLTools

public final class XMLTools
extends java.lang.Object

A utility class for working with XML.

Source code:

Trac, Gitweb

Author:

Curtis Rueden ctrueden at wisc.edu, Chris Allan callan at blackcat.ca, Melissa Linkert melissa at glencoesoftware.com

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	avoidUndeclaredNamespaces(java.lang.String xml) Replaces NS:tag with NS_tag for undeclared namespaces
static javax.xml.parsers.DocumentBuilder	createBuilder() Creates a new DocumentBuilder via DocumentBuilderFactory or logs and throws a RuntimeException.
static org.w3c.dom.Document	createDocument() Calls DocumentBuilder.newDocument() on a new builder.
static java.lang.String	dumpXML(java.lang.String schemaLocation, org.w3c.dom.Document doc, org.w3c.dom.Element r) Dumps the given OME-XML DOM tree to a string.
static java.lang.String	dumpXML(java.lang.String schemaLocation, org.w3c.dom.Document doc, org.w3c.dom.Element r, boolean includeXMLDeclaration) Dumps the given OME-XML DOM tree to a string.
static java.lang.String	escapeXML(java.lang.String s) Escape special characters.
static javax.xml.transform.Templates	getStylesheet(java.lang.String resourcePath, java.lang.Class<?> sourceClass) Gets an XSLT template from the given resource location.
static java.lang.String	getXML(org.w3c.dom.Document doc) Converts the given DOM back to a string.
static java.lang.String	indentXML(java.lang.String xml) Indents XML to be more readable.
static java.lang.String	indentXML(java.lang.String xml, boolean preserveCData) Indents XML to be more readable, avoiding any whitespace injection into CDATA if the preserveCData flag is set.
static java.lang.String	indentXML(java.lang.String xml, int spacing) Indents XML by the given spacing to be more readable.
static java.lang.String	indentXML(java.lang.String xml, int spacing, boolean preserveCData) Indents XML by the given spacing to be more readable, avoiding any whitespace injection into CDATA if the preserveCData flag is set.
static org.w3c.dom.Document	parseDOM(java.io.File file) Parses a DOM from the given XML file on disk.
static org.w3c.dom.Document	parseDOM(java.io.InputStream is) Parses a DOM from the given XML input stream.
static org.w3c.dom.Document	parseDOM(java.lang.String xml) Parses a DOM from the given XML string.
static void	parseXML(byte[] xml, org.xml.sax.helpers.DefaultHandler handler) Parses the XML contained in the given byte array into using the specified XML handler.
static void	parseXML(java.io.InputStream xml, org.xml.sax.helpers.DefaultHandler handler) Parses the XML contained in the given InputStream using the specified XML handler.
static void	parseXML(RandomAccessInputStream stream, org.xml.sax.helpers.DefaultHandler handler) Parses the XML contained in the given input stream into using the specified XML handler.
static java.util.Hashtable<java.lang.String,java.lang.String>	parseXML(java.lang.String xml) Parses the given XML string into a list of key/value pairs.
static void	parseXML(java.lang.String xml, org.xml.sax.helpers.DefaultHandler handler) Parses the given XML string using the specified XML handler.
static java.lang.String	sanitizeXML(java.lang.String s) Remove invalid characters from an XML string.
static java.lang.String	transformXML(javax.xml.transform.Source xmlSource, javax.xml.transform.Templates xslt) Transforms the given XML data using the specified XSLT stylesheet.
static java.lang.String	transformXML(java.lang.String xml, javax.xml.transform.Templates xslt) Transforms the given XML string using the specified XSLT stylesheet.
static boolean	validateXML(java.lang.String xml) Attempts to validate the given XML string using Java's XML validation facility.
static boolean	validateXML(java.lang.String xml, java.lang.String label) Attempts to validate the given XML string using Java's XML validation facility.
static void	writeXML(java.io.OutputStream os, org.w3c.dom.Document doc) Writes the specified DOM to the given output stream.
static void	writeXML(java.io.OutputStream os, org.w3c.dom.Document doc, boolean includeXMLDeclaration) Writes the specified DOM to the given output stream.

Methods inherited from class java.lang.Object

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

Method Detail

createBuilder

public static javax.xml.parsers.DocumentBuilder createBuilder()

Creates a new DocumentBuilder via DocumentBuilderFactory or logs and throws a RuntimeException.

createDocument

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

Calls DocumentBuilder.newDocument() on a new builder.

parseDOM

public static org.w3c.dom.Document parseDOM(java.io.File file)
                                     throws javax.xml.parsers.ParserConfigurationException,
                                            org.xml.sax.SAXException,
                                            java.io.IOException

Parses a DOM from the given XML file on disk.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

parseDOM

public static org.w3c.dom.Document parseDOM(java.lang.String xml)
                                     throws javax.xml.parsers.ParserConfigurationException,
                                            org.xml.sax.SAXException,
                                            java.io.IOException

Parses a DOM from the given XML string.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

parseDOM

public static org.w3c.dom.Document parseDOM(java.io.InputStream is)
                                     throws javax.xml.parsers.ParserConfigurationException,
                                            org.xml.sax.SAXException,
                                            java.io.IOException

Parses a DOM from the given XML input stream.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getXML

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

Converts the given DOM back to a string.

Throws:

javax.xml.transform.TransformerConfigurationException

javax.xml.transform.TransformerException

dumpXML

public static java.lang.String dumpXML(java.lang.String schemaLocation,
                       org.w3c.dom.Document doc,
                       org.w3c.dom.Element r)

Dumps the given OME-XML DOM tree to a string.

Parameters:

schemaLocation - if null, no xmlns attribute will be added.

Returns:

OME-XML as a string.

dumpXML

public static java.lang.String dumpXML(java.lang.String schemaLocation,
                       org.w3c.dom.Document doc,
                       org.w3c.dom.Element r,
                       boolean includeXMLDeclaration)

Dumps the given OME-XML DOM tree to a string.

Parameters:

schemaLocation - if null, no xmlns attribute will be added.

Returns:

OME-XML as a string.

escapeXML

public static java.lang.String escapeXML(java.lang.String s)

Escape special characters.

sanitizeXML

public static java.lang.String sanitizeXML(java.lang.String s)

Remove invalid characters from an XML string.

indentXML

public static java.lang.String indentXML(java.lang.String xml)

Indents XML to be more readable.

indentXML

public static java.lang.String indentXML(java.lang.String xml,
                         int spacing)

Indents XML by the given spacing to be more readable.

indentXML

public static java.lang.String indentXML(java.lang.String xml,
                         boolean preserveCData)

Indents XML to be more readable, avoiding any whitespace injection into CDATA if the preserveCData flag is set.

indentXML

public static java.lang.String indentXML(java.lang.String xml,
                         int spacing,
                         boolean preserveCData)

Indents XML by the given spacing to be more readable, avoiding any whitespace injection into CDATA if the preserveCData flag is set.

parseXML

public static java.util.Hashtable<java.lang.String,java.lang.String> parseXML(java.lang.String xml)
                                                                       throws java.io.IOException

Parses the given XML string into a list of key/value pairs.

Throws:

java.io.IOException

parseXML

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

Parses the given XML string using the specified XML handler.

Throws:

java.io.IOException

parseXML

public static void parseXML(RandomAccessInputStream stream,
            org.xml.sax.helpers.DefaultHandler handler)
                     throws java.io.IOException

Parses the XML contained in the given input stream into using the specified XML handler. Be very careful, as 'stream' will be closed by the SAX parser.

Throws:

java.io.IOException

parseXML

public static void parseXML(byte[] xml,
            org.xml.sax.helpers.DefaultHandler handler)
                     throws java.io.IOException

Parses the XML contained in the given byte array into using the specified XML handler.

Throws:

java.io.IOException

parseXML

public static void parseXML(java.io.InputStream xml,
            org.xml.sax.helpers.DefaultHandler handler)
                     throws java.io.IOException

Parses the XML contained in the given InputStream using the specified XML handler.

Throws:

java.io.IOException

writeXML

public static void writeXML(java.io.OutputStream os,
            org.w3c.dom.Document doc)
                     throws javax.xml.transform.TransformerException

Writes the specified DOM to the given output stream.

Throws:

javax.xml.transform.TransformerException

writeXML

public static void writeXML(java.io.OutputStream os,
            org.w3c.dom.Document doc,
            boolean includeXMLDeclaration)
                     throws javax.xml.transform.TransformerException

Writes the specified DOM to the given output stream.

Throws:

javax.xml.transform.TransformerException

getStylesheet

public static javax.xml.transform.Templates getStylesheet(java.lang.String resourcePath,
                                          java.lang.Class<?> sourceClass)

Gets an XSLT template from the given resource location.

avoidUndeclaredNamespaces

public static java.lang.String avoidUndeclaredNamespaces(java.lang.String xml)

Replaces NS:tag with NS_tag for undeclared namespaces

transformXML

public static java.lang.String transformXML(java.lang.String xml,
                            javax.xml.transform.Templates xslt)
                                     throws java.io.IOException

Transforms the given XML string using the specified XSLT stylesheet.

Throws:

java.io.IOException

transformXML

public static java.lang.String transformXML(javax.xml.transform.Source xmlSource,
                            javax.xml.transform.Templates xslt)
                                     throws java.io.IOException

Transforms the given XML data using the specified XSLT stylesheet.

Throws:

java.io.IOException

validateXML

public static boolean validateXML(java.lang.String xml)

Attempts to validate the given XML string using Java's XML validation facility. Requires Java 1.5+.

Parameters:

xml - The XML string to validate.

Returns:

whether or not validation was successful.

validateXML

public static boolean validateXML(java.lang.String xml,
                  java.lang.String label)

Attempts to validate the given XML string using Java's XML validation facility. Requires Java 1.5+.

Parameters:

xml - The XML string to validate.

label - String describing the type of XML being validated.

Returns:

whether or not validation was successful.