io.scif.xml

Interface XMLService

All Superinterfaces:

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

All Known Implementing Classes:

DefaultXMLService

public interface XMLService
extends SCIFIOService

Interface for services that work with XML.

Author:

Curtis Rueden

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> handle, 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 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

Method Detail

parseDOM

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

Parses a DOM from the given XML file on disk.

Throws:

ParserConfigurationException

SAXException

IOException

parseDOM

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

Parses a DOM from the given XML string.

Throws:

ParserConfigurationException

SAXException

IOException

parseDOM

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

Parses a DOM from the given XML input stream.

Throws:

ParserConfigurationException

SAXException

IOException

getXML

String getXML(Document doc)
       throws TransformerConfigurationException,
              TransformerException

Converts the given DOM back to a string.

Throws:

TransformerConfigurationException

TransformerException

sanitizeXML

String sanitizeXML(String s)

Remove invalid characters from an XML string.

escapeXML

String escapeXML(String s)

Escape special characters.

indentXML

String indentXML(String xml)

Indents XML to be more readable.

indentXML

String indentXML(String xml,
                 int spacing)

Indents XML by the given spacing to be more readable.

indentXML

String indentXML(String xml,
                 boolean preserveCData)

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

indentXML

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.

parseXML

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

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

Throws:

IOException

parseXML

void parseXML(String xml,
              DefaultHandler handler)
       throws IOException

Parses the given XML string using the specified XML handler.

Throws:

IOException

parseXML

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

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.

Throws:

IOException

parseXML

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

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

Throws:

IOException

parseXML

void parseXML(InputStream xml,
              DefaultHandler handler)
       throws IOException

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

Throws:

IOException

getStylesheet

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

Gets an XSLT template from the given resource location.

avoidUndeclaredNamespaces

String avoidUndeclaredNamespaces(String xml)

Replaces NS:tag with NS_tag for undeclared namespaces

transformXML

String transformXML(String xml,
                    Templates xslt)
             throws IOException

Transforms the given XML string using the specified XSLT stylesheet.

Throws:

IOException

transformXML

String transformXML(Source xmlSource,
                    Templates xslt)
             throws IOException

Transforms the given XML data using the specified XSLT stylesheet.

Throws:

IOException

validateXML

boolean validateXML(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

boolean validateXML(String xml,
                    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.