io.scif.xml

Class DefaultXMLService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

io.scif.xml.DefaultXMLService

All Implemented Interfaces:

SCIFIOService, XMLService, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.service.Service, org.scijava.Versioned

public class DefaultXMLService
extends org.scijava.service.AbstractService
implements XMLService

Default service for working with XML.

Author:

Curtis Rueden, Chris Allan, Melissa Linkert

Constructor Summary

Constructors

Constructor and Description
DefaultXMLService()

Method Summary

Modifier and Type	Method and Description
String	avoidUndeclaredNamespaces(String xml) Replaces NS:tag with NS_tag for undeclared namespaces
String	escapeXML(String s) Escape special characters.
Templates	getStylesheet(String resourcePath, Class<?> sourceClass) Gets an XSLT template from the given resource location.
String	getXML(Document doc) Converts the given DOM back to a string.
String	indentXML(String xml) Indents XML to be more readable.
String	indentXML(String xml, boolean preserveCData) Indents XML to be more readable, avoiding any whitespace injection into CDATA if the preserveCData flag is set.
String	indentXML(String xml, int spacing) Indents XML by the given spacing to be more readable.
String	indentXML(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.
Document	parseDOM(File file) Parses a DOM from the given XML file on disk.
Document	parseDOM(InputStream is) Parses a DOM from the given XML input stream.
Document	parseDOM(String xml) Parses a DOM from the given XML string.
void	parseXML(byte[] xml, DefaultHandler handler) Parses the XML contained in the given byte array into using the specified XML handler.
void	parseXML(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, DefaultHandler handler) Parses the XML contained in the given data handle into using the specified XML handler.
void	parseXML(InputStream xml, DefaultHandler handler) Parses the XML contained in the given InputStream using the specified XML handler.
Map<String,String>	parseXML(String xml) Parses the given XML string into a list of key/value pairs.
void	parseXML(String xml, DefaultHandler handler) Parses the given XML string using the specified XML handler.
String	sanitizeXML(String s) Remove invalid characters from an XML string.
String	transformXML(Source xmlSource, Templates xslt) Transforms the given XML data using the specified XSLT stylesheet.
String	transformXML(String xml, Templates xslt) Transforms the given XML string using the specified XSLT stylesheet.
boolean	validateXML(String xml) Attempts to validate the given XML string using Java's XML validation facility.
boolean	validateXML(String xml, String label) Attempts to validate the given XML string using Java's XML validation facility.

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Constructor Detail

DefaultXMLService

public DefaultXMLService()

Method Detail

parseDOM

public Document parseDOM(File file)
                  throws ParserConfigurationException,
                         SAXException,
                         IOException

Description copied from interface: XMLService

Parses a DOM from the given XML file on disk.

Specified by:

parseDOM in interface XMLService

Throws:

ParserConfigurationException

SAXException

IOException

parseDOM

public Document parseDOM(String xml)
                  throws ParserConfigurationException,
                         SAXException,
                         IOException

Description copied from interface: XMLService

Parses a DOM from the given XML string.

Specified by:

parseDOM in interface XMLService

Throws:

ParserConfigurationException

SAXException

IOException

parseDOM

public Document parseDOM(InputStream is)
                  throws ParserConfigurationException,
                         SAXException,
                         IOException

Description copied from interface: XMLService

Parses a DOM from the given XML input stream.

Specified by:

parseDOM in interface XMLService

Throws:

ParserConfigurationException

SAXException

IOException

getXML

public String getXML(Document doc)
              throws TransformerException

Description copied from interface: XMLService

Converts the given DOM back to a string.

Specified by:

getXML in interface XMLService

Throws:

TransformerException

sanitizeXML

public String sanitizeXML(String s)

Description copied from interface: XMLService

Remove invalid characters from an XML string.

Specified by:

sanitizeXML in interface XMLService

escapeXML

public String escapeXML(String s)

Description copied from interface: XMLService

Escape special characters.

Specified by:

escapeXML in interface XMLService

indentXML

public String indentXML(String xml)

Description copied from interface: XMLService

Indents XML to be more readable.

Specified by:

indentXML in interface XMLService

indentXML

public String indentXML(String xml,
                        int spacing)

Description copied from interface: XMLService

Indents XML by the given spacing to be more readable.

Specified by:

indentXML in interface XMLService

indentXML

public String indentXML(String xml,
                        boolean preserveCData)

Description copied from interface: XMLService

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

Specified by:

indentXML in interface XMLService

indentXML

public String indentXML(String xml,
                        int spacing,
                        boolean preserveCData)

Description copied from interface: XMLService

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

Specified by:

indentXML in interface XMLService

parseXML

public Map<String,String> parseXML(String xml)
                            throws IOException

Description copied from interface: XMLService

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

Specified by:

parseXML in interface XMLService

Throws:

IOException

parseXML

public void parseXML(String xml,
                     DefaultHandler handler)
              throws IOException

Description copied from interface: XMLService

Parses the given XML string using the specified XML handler.

Specified by:

parseXML in interface XMLService

Throws:

IOException

parseXML

public void parseXML(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
                     DefaultHandler handler)
              throws IOException

Description copied from interface: XMLService

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

Specified by:

parseXML in interface XMLService

Throws:

IOException

parseXML

public void parseXML(byte[] xml,
                     DefaultHandler handler)
              throws IOException

Description copied from interface: XMLService

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

Specified by:

parseXML in interface XMLService

Throws:

IOException

parseXML

public void parseXML(InputStream xml,
                     DefaultHandler handler)
              throws IOException

Description copied from interface: XMLService

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

Specified by:

parseXML in interface XMLService

Throws:

IOException

getStylesheet

public Templates getStylesheet(String resourcePath,
                               Class<?> sourceClass)

Description copied from interface: XMLService

Gets an XSLT template from the given resource location.

Specified by:

getStylesheet in interface XMLService

avoidUndeclaredNamespaces

public String avoidUndeclaredNamespaces(String xml)

Description copied from interface: XMLService

Replaces NS:tag with NS_tag for undeclared namespaces

Specified by:

avoidUndeclaredNamespaces in interface XMLService

transformXML

public String transformXML(String xml,
                           Templates xslt)
                    throws IOException

Description copied from interface: XMLService

Transforms the given XML string using the specified XSLT stylesheet.

Specified by:

transformXML in interface XMLService

Throws:

IOException

transformXML

public String transformXML(Source xmlSource,
                           Templates xslt)
                    throws IOException

Description copied from interface: XMLService

Transforms the given XML data using the specified XSLT stylesheet.

Specified by:

transformXML in interface XMLService

Throws:

IOException

validateXML

public boolean validateXML(String xml)

Description copied from interface: XMLService

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

Specified by:

validateXML in interface XMLService

Parameters:

xml - The XML string to validate.

Returns:

whether or not validation was successful.

validateXML

public boolean validateXML(String xml,
                           String label)

Description copied from interface: XMLService

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

Specified by:

validateXML in interface XMLService

Parameters:

xml - The XML string to validate.

label - String describing the type of XML being validated.

Returns:

whether or not validation was successful.