Package org.openremote.container.xml

Class DOMParser<D extends DOM>

java.lang.Object

org.openremote.container.xml.DOMParser<D>

All Implemented Interfaces:

EntityResolver, ErrorHandler

public abstract class DOMParser<D extends DOM>
extends Object
implements ErrorHandler, EntityResolver

Condensed API for parsing of XML into DOM with (optional) XML schema validation.

Provides many XML utility features, like pretty printing, escaping, or node visitor.

NOTE: This class is not thread-safe because JAXP factories are not thread-safe!

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DOMParser.NodeVisitor

Field Summary

Fields

Modifier and Type	Field	Description
protected Schema	schema
protected Source[]	schemaSources

Constructor Summary

Constructors

Constructor	Description
DOMParser(Source... schemaSources)

Method Summary

Modifier and Type	Method	Description
static void	accept(Node node, DOMParser.NodeVisitor visitor)
D	createDocument()
protected abstract D	createDOM(Document document)
DocumentBuilderFactory	createFactory(boolean validating)
Transformer	createTransformer(String method, int indent, boolean standalone)
XPath	createXPath(NamespaceContext nsContext)
XPath	createXPath(XPathFactory factory, NamespaceContext nsContext)
XPathFactory	createXPathFactory()
void	error(SAXParseException e)
static String	escape(String string)
static String	escape(String string, boolean convertNewlines, boolean convertSpaces)
void	fatalError(SAXParseException e)
Schema	getSchema()
Object	getXPathResult(DOMElement<?,?> element, XPath xpath, String expr, QName result)
Object	getXPathResult(DOM dom, XPath xpath, String expr, QName result)
Object	getXPathResult(Node context, XPath xpath, String expr, QName result)
boolean	isIgnorableWSNode(Node node)
D	parse(File file)
D	parse(File file, boolean validate)
D	parse(InputStream stream)
D	parse(InputStream stream, boolean validate)
D	parse(String string)
D	parse(String string, boolean validate)
D	parse(URL url)
D	parse(URL url, boolean validate)
D	parse(InputSource source, boolean validate)
String	print(String string, int indent, boolean standalone)
String	print(Source source, int indent, boolean standalone)
String	print(DOM dom)
String	print(DOM dom, boolean standalone)
String	print(DOM dom, int indent)
String	print(DOM dom, int indent, boolean standalone)
String	print(Document document, int indent, boolean standalone)
String	printHTML(Document dom)
String	printHTML(Document dom, int indent, boolean standalone, boolean doctype)
void	removeIgnorableWSNodes(Element element)
InputSource	resolveEntity(String publicId, String systemId)
static String	stripElements(String xml)
protected ParserException	unwrapException(Exception ex)
void	validate(String string)
void	validate(URL url)
void	validate(Source source)
void	validate(DOM dom)
void	validate(Document document)
void	warning(SAXParseException e)
static String	wrap(String wrapperName, String fragment)
static String	wrap(String wrapperName, String xmlns, String fragment)

Methods inherited from class java.lang.Object

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

Field Details

schemaSources

protected Source[] schemaSources

schema

protected Schema schema

Constructor Details

DOMParser

public DOMParser(Source... schemaSources)

Method Details

getSchema

public Schema getSchema()

createDOM

protected abstract D createDOM(Document document)

createFactory

public DocumentBuilderFactory createFactory(boolean validating)
                                     throws ParserException

Throws:

ParserException

createTransformer

public Transformer createTransformer(String method,
 int indent,
 boolean standalone)
                              throws ParserException

Throws:

ParserException

createDocument

public D createDocument()

parse

public D parse(URL url)
        throws ParserException

Throws:

ParserException

parse

public D parse(String string)
        throws ParserException

Throws:

ParserException

parse

public D parse(File file)
        throws ParserException

Throws:

ParserException

parse

public D parse(InputStream stream)
        throws ParserException

Throws:

ParserException

parse

public D parse(URL url,
 boolean validate)
        throws ParserException

Throws:

ParserException

parse

public D parse(String string,
 boolean validate)
        throws ParserException

Throws:

ParserException

parse

public D parse(File file,
 boolean validate)
        throws ParserException

Throws:

ParserException

parse

public D parse(InputStream stream,
 boolean validate)
        throws ParserException

Throws:

ParserException

parse

public D parse(InputSource source,
 boolean validate)
        throws ParserException

Throws:

ParserException

validate

public void validate(URL url)
              throws ParserException

Throws:

ParserException

validate

public void validate(String string)
              throws ParserException

Throws:

ParserException

validate

public void validate(Document document)
              throws ParserException

Throws:

ParserException

validate

public void validate(DOM dom)
              throws ParserException

Throws:

ParserException

validate

public void validate(Source source)
              throws ParserException

Throws:

ParserException

createXPathFactory

public XPathFactory createXPathFactory()

createXPath

public XPath createXPath(NamespaceContext nsContext)

createXPath

public XPath createXPath(XPathFactory factory,
 NamespaceContext nsContext)

getXPathResult

public Object getXPathResult(DOM dom,
 XPath xpath,
 String expr,
 QName result)

getXPathResult

public Object getXPathResult(DOMElement<?,?> element,
 XPath xpath,
 String expr,
 QName result)

getXPathResult

public Object getXPathResult(Node context,
 XPath xpath,
 String expr,
 QName result)

print

public String print(DOM dom)
             throws ParserException

Throws:

ParserException

print

public String print(DOM dom,
 int indent)
             throws ParserException

Throws:

ParserException

print

public String print(DOM dom,
 boolean standalone)
             throws ParserException

Throws:

ParserException

print

public String print(DOM dom,
 int indent,
 boolean standalone)
             throws ParserException

Throws:

ParserException

print

public String print(Document document,
 int indent,
 boolean standalone)
             throws ParserException

Throws:

ParserException

print

public String print(String string,
 int indent,
 boolean standalone)
             throws ParserException

Throws:

ParserException

print

public String print(Source source,
 int indent,
 boolean standalone)
             throws ParserException

Throws:

ParserException

printHTML

public String printHTML(Document dom)
                 throws ParserException

Throws:

ParserException

printHTML

public String printHTML(Document dom,
 int indent,
 boolean standalone,
 boolean doctype)
                 throws ParserException

Throws:

ParserException

removeIgnorableWSNodes

public void removeIgnorableWSNodes(Element element)

isIgnorableWSNode

public boolean isIgnorableWSNode(Node node)

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Throws:

SAXException

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Throws:

SAXException

unwrapException

protected ParserException unwrapException(Exception ex)

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException,
IOException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

escape

public static String escape(String string)

escape

public static String escape(String string,
 boolean convertNewlines,
 boolean convertSpaces)

stripElements

public static String stripElements(String xml)

accept

public static void accept(Node node,
 DOMParser.NodeVisitor visitor)

wrap

public static String wrap(String wrapperName,
 String fragment)

wrap

public static String wrap(String wrapperName,
 String xmlns,
 String fragment)