Package org.frankframework.util

Class XmlUtils

java.lang.Object

org.frankframework.util.XmlUtils

public class XmlUtils
extends Object

Some utilities for working with XML.

Author:

Johan Verrips

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO_RELOAD_KEY
static final int	DEFAULT_XSLT_VERSION
static final XMLEventFactory	EVENT_FACTORY
static final int	HTML_MAX_PREAMBLE_SIZE
static final String	INCLUDE_FIELD_DEFINITION_BY_DEFAULT_KEY
static final XMLInputFactory	INPUT_FACTORY
static final String	NAMESPACE_AWARE_BY_DEFAULT_KEY
static final XMLOutputFactory	OUTPUT_FACTORY
static final XMLOutputFactory	REPAIR_NAMESPACES_OUTPUT_FACTORY
static final String	XPATH_GETROOTNODENAME
static final int	XSLT_BUFFERSIZE_DEFAULT
static final String	XSLT_BUFFERSIZE_KEY
static final String	XSLT_STREAMING_BY_DEFAULT_KEY

Constructor Summary

Constructors

Constructor	Description
XmlUtils()

Method Summary

Modifier and Type	Method	Description
static String	addRootNamespace(String input, String namespace)
static Message	addRootNamespace(Message input, String namespace)
static boolean	attributesEqual(Attribute attribute1, Attribute attribute2)
static Document	buildDomDocument(Reader in)
static Document	buildDomDocument(Reader in, boolean namespaceAware)
static Document	buildDomDocument(Reader in, boolean namespaceAware, boolean resolveExternalEntities)
static Document	buildDomDocument(String s)	Convert an XML string to a Document Creation date: (20-02-2003 8:12:52)
static Document	buildDomDocument(String s, boolean namespaceAware)
static Document	buildDomDocument(String s, boolean namespaceAware, boolean resolveExternalEntities)
static Document	buildDomDocument(URL url)	Build a Document from a URL
static Document	buildDomDocument(InputSource src, boolean namespaceAware)
static Document	buildDomDocument(InputSource src, boolean namespaceAware, boolean resolveExternalEntities)
static Element	buildElement(String s)	Convert an XML string to a Document, then return the root-element.
static Element	buildElement(String s, boolean namespaceAware)	Convert an XML string to a Document, then return the root-element
static Element	buildElement(Message s)
static Node	buildNode(String s)
static Node	buildNode(String s, boolean namespaceAware)	Convert an XML string to a Document, then return the root-element as a Node
static String	canonicalize(String input)
static String	canonicalize(String input, boolean removeNamespaces)
static String	cdataToText(String input)
static String	cleanseElementName(String candidateName)
static String	convertEndOfLines(String input)
static String	copyOfSelect(String input, String xpath)
static Transformer	createTransformer(String xsltString)
static Transformer	createTransformer(String xsltString, int xsltVersion)
static Transformer	createTransformer(URL url)
static Transformer	createTransformer(URL url, int xsltVersion)
static Transformer	createTransformer(Source source, int xsltVersion)
static String	createXPathEvaluatorSource(String xPathExpression)	Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in.
static String	createXPathEvaluatorSource(String namespaceDefs, String xPathExpression, TransformerPool.OutputType outputMethod)	Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces.
static String	createXPathEvaluatorSource(String namespaceDefs, String xPathExpression, TransformerPool.OutputType outputMethod, boolean includeXmlDeclaration, boolean stripSpace)	Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces.
static String	createXPathEvaluatorSource(String namespaceDefs, String xPathExpression, TransformerPool.OutputType outputMethod, boolean includeXmlDeclaration, ParameterList params, boolean stripSpace, boolean ignoreNamespaces, String separator, int xsltVersion)	Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces.
static String	createXPathEvaluatorSource(UnaryOperator<String> xpathContainerSupplier, String xPathExpression, TransformerPool.OutputType outputMethod, boolean includeXmlDeclaration, ParameterList params, boolean stripSpace, boolean ignoreNamespaces, int xsltVersion)	Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces.
static int	detectXsltVersion(String xsltString)
static int	detectXsltVersion(URL xsltUrl)
static String	encodeURL(String url)	encodes a url
static Collection<String>	evaluateXPathNodeSet(String input, String xpathExpr)
static Map<String,String>	evaluateXPathNodeSet(String input, String xpathExpr, String keyElement, String valueElement)
static String	evaluateXPathNodeSetFirstElement(String input, String xpathExpr)
static Double	evaluateXPathNumber(String input, String xpathExpr)
static int	getBufSize()
static boolean	getChildTagAsBoolean(Element el, String tag)	Method getChildTagAsBoolean.
static boolean	getChildTagAsBoolean(Element el, String tag, boolean defaultValue)	Method getChildTagAsBoolean.
static long	getChildTagAsLong(Element el, String tag)	Method getChildTagAsLong.
static long	getChildTagAsLong(Element el, String tag, long defaultValue)	Method getChildTagAsLong.
static String	getChildTagAsString(Element el, String tag)	Method getChildTagAsString.
static String	getChildTagAsString(Element el, String tag, String defaultValue)	Method getChildTagAsString.
static Collection<Node>	getChildTags(Element el, String tag)	Method getChildTags.
static DocumentBuilderFactory	getDocumentBuilderFactory()
static DocumentBuilderFactory	getDocumentBuilderFactory(boolean namespaceAware)
static Element	getFirstChildTag(Element el, String tag)	Method getFirstChildTag.
static String	getNamespaceClause(String namespaceDefs)
static Map<String,String>	getNamespaceMap(String namespaceDefs)
static String	getRootNamespace(String input)
static String	getRootNamespace(Message input)
static SAXParserFactory	getSAXParserFactory()
static SAXParserFactory	getSAXParserFactory(boolean namespaceAware)
static String	getStringValue(Element el)
static String	getStringValue(Element el, boolean trimWhitespace)
static TransformerFactory	getTransformerFactory()
static TransformerFactory	getTransformerFactory(int xsltVersion)
static TransformerFactory	getTransformerFactory(int xsltVersion, ErrorListener errorListener)
static ValidatorHandler	getValidatorHandler(URL schemaURL)
static ValidatorHandler	getValidatorHandler(Source schemaSource)
static Map<String,String>	getVersionInfo()
static XMLReader	getXMLReader(IScopeProvider scopeProvider)
static XMLReader	getXMLReader(ContentHandler handler)
static XPathFactory	getXPathFactory()
static XPathFactory	getXPathFactory(int xsltVersion)
static SAXSource	inputSourceToSAXSource(Resource resource)
static SAXSource	inputSourceToSAXSource(InputSource is)
static SAXSource	inputSourceToSAXSource(InputSource is, boolean namespaceAware, Resource scopeProvider)	TODO: This does not appear to always properly honour namespaceAware=false
static int	interpretXsltVersion(String xsltVersion)
static boolean	isAutoReload()
static boolean	isIncludeFieldDefinitionByDefault()
static boolean	isNamespaceAwareByDefault()
static boolean	isWellFormed(String input)
static boolean	isWellFormed(String input, String root)
static boolean	isWellFormed(Message input, String root)
static boolean	isXsltStreamingByDefault()
static StartElement	mergeAttributes(StartElement tag, Iterator<? extends Attribute> attrs, Iterator<? extends Namespace> nsps, XMLEventFactory factory)	Like XMLStreamUtils.mergeAttributes(javax.xml.stream.events.StartElement, java.util.Iterator, javax.xml.stream.XMLEventFactory) but it can also merge namespaces
static byte[]	nodeToByteArray(Node node)
static byte[]	nodeToByteArray(Node node, boolean omitXmlDeclaration)
static String	nodeToString(Node node)
static String	nodeToString(Node node, boolean useIndentation)
static String	normalizeAttributeValue(String input)
static String	normalizeWhitespace(String input)
static void	parseNodeSet(String source, ContentHandler handler)	like parseXml(String source, ContentHandler handler), but skips startDocument() and endDocument().
static void	parseXml(Reader source, ContentHandler handler)
static void	parseXml(String source, ContentHandler handler)
static void	parseXml(Resource resource, ContentHandler handler)
static void	parseXml(InputSource inputSource, ContentHandler handler)
static void	parseXml(InputSource inputSource, ContentHandler handler, ErrorHandler errorHandler)
static Date	parseXmlDateTime(String s)	Parses a string to a Date using XML Schema dateTime data type (GDate)
static String	removeNamespaces(String input)
static Message	removeNamespaces(Message input)
static Message	removeNamespaces(Message input, boolean includeXmlDeclaration)
static Message	removeXmlDeclaration(Message input)
static void	setTransformerParameters(Transformer t, Map<String,Object> parameters)	sets all the parameters of the transformer using a Map with parameter values.
static String	skipDocTypeDeclaration(String xmlString)
static String	skipXmlDeclaration(String xmlString)
static String	source2String(Source source)
static Source	stringToSource(String xmlString)
static Source	stringToSource(String xmlString, boolean namespaceAware)	Converts a string containing xml-markup to a Source-object, that can be used as the input of a XSLT-transformer.
static Source	stringToSourceForSingleUse(String xmlString)
static Source	stringToSourceForSingleUse(String xmlString, boolean namespaceAware)
static Message	toXhtml(Message message)
static String	transformXml(Transformer t, String s)
static String	transformXml(Transformer t, String s, boolean namespaceAware)
static String	transformXml(Transformer t, Source s)

Methods inherited from class java.lang.Object

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

Field Details

HTML_MAX_PREAMBLE_SIZE

public static final int HTML_MAX_PREAMBLE_SIZE

See Also:

• Constant Field Values

DEFAULT_XSLT_VERSION

public static final int DEFAULT_XSLT_VERSION

NAMESPACE_AWARE_BY_DEFAULT_KEY

public static final String NAMESPACE_AWARE_BY_DEFAULT_KEY

See Also:

• Constant Field Values

XSLT_STREAMING_BY_DEFAULT_KEY

public static final String XSLT_STREAMING_BY_DEFAULT_KEY

See Also:

• Constant Field Values

AUTO_RELOAD_KEY

public static final String AUTO_RELOAD_KEY

See Also:

• Constant Field Values

XSLT_BUFFERSIZE_KEY

public static final String XSLT_BUFFERSIZE_KEY

See Also:

• Constant Field Values

XSLT_BUFFERSIZE_DEFAULT

public static final int XSLT_BUFFERSIZE_DEFAULT

See Also:

• Constant Field Values

INCLUDE_FIELD_DEFINITION_BY_DEFAULT_KEY

public static final String INCLUDE_FIELD_DEFINITION_BY_DEFAULT_KEY

See Also:

• Constant Field Values

XPATH_GETROOTNODENAME

public static final String XPATH_GETROOTNODENAME

See Also:

• Constant Field Values

EVENT_FACTORY

public static final XMLEventFactory EVENT_FACTORY

INPUT_FACTORY

public static final XMLInputFactory INPUT_FACTORY

OUTPUT_FACTORY

public static final XMLOutputFactory OUTPUT_FACTORY

REPAIR_NAMESPACES_OUTPUT_FACTORY

public static final XMLOutputFactory REPAIR_NAMESPACES_OUTPUT_FACTORY

Constructor Details

XmlUtils

public XmlUtils()

Method Details

parseXmlDateTime

public static Date parseXmlDateTime(String s)

Parses a string to a Date using XML Schema dateTime data type (GDate)

isNamespaceAwareByDefault

public static boolean isNamespaceAwareByDefault()

isXsltStreamingByDefault

public static boolean isXsltStreamingByDefault()

isIncludeFieldDefinitionByDefault

public static boolean isIncludeFieldDefinitionByDefault()

isAutoReload

public static boolean isAutoReload()

getBufSize

public static int getBufSize()

parseXml

public static void parseXml(Resource resource,
 ContentHandler handler)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

parseXml

public static void parseXml(String source,
 ContentHandler handler)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

parseXml

public static void parseXml(Reader source,
 ContentHandler handler)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

parseNodeSet

public static void parseNodeSet(String source,
 ContentHandler handler)
                         throws IOException,
SAXException

like parseXml(String source, ContentHandler handler), but skips startDocument() and endDocument(). Can be used to parse a string and inject its events in an existing SAX event stream.

Throws:

IOException

SAXException

parseXml

public static void parseXml(InputSource inputSource,
 ContentHandler handler)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

parseXml

public static void parseXml(InputSource inputSource,
 ContentHandler handler,
 ErrorHandler errorHandler)
                     throws IOException,
SAXException

Throws:

IOException

SAXException

getXMLReader

public static XMLReader getXMLReader(ContentHandler handler)
                              throws ParserConfigurationException,
SAXException

Throws:

ParserConfigurationException

SAXException

getXMLReader

public static XMLReader getXMLReader(IScopeProvider scopeProvider)
                              throws ParserConfigurationException,
SAXException

Throws:

ParserConfigurationException

SAXException

buildDomDocument

public static Document buildDomDocument(Reader in)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(Reader in,
 boolean namespaceAware)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(InputSource src,
 boolean namespaceAware)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(InputSource src,
 boolean namespaceAware,
 boolean resolveExternalEntities)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(Reader in,
 boolean namespaceAware,
 boolean resolveExternalEntities)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(String s)
                                 throws DomBuilderException

Convert an XML string to a Document Creation date: (20-02-2003 8:12:52)

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(String s,
 boolean namespaceAware)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(String s,
 boolean namespaceAware,
 boolean resolveExternalEntities)
                                 throws DomBuilderException

Throws:

DomBuilderException

buildDomDocument

public static Document buildDomDocument(URL url)
                                 throws DomBuilderException

Build a Document from a URL

Throws:

DomBuilderException

buildElement

public static Element buildElement(String s,
 boolean namespaceAware)
                            throws DomBuilderException

Convert an XML string to a Document, then return the root-element

Throws:

DomBuilderException

buildNode

public static Node buildNode(String s,
 boolean namespaceAware)
                      throws DomBuilderException

Convert an XML string to a Document, then return the root-element as a Node

Throws:

DomBuilderException

buildNode

public static Node buildNode(String s)
                      throws DomBuilderException

Throws:

DomBuilderException

buildElement

public static Element buildElement(String s)
                            throws DomBuilderException

Convert an XML string to a Document, then return the root-element. (namespace aware)

Throws:

DomBuilderException

buildElement

public static Element buildElement(Message s)
                            throws DomBuilderException

Throws:

DomBuilderException

skipXmlDeclaration

public static String skipXmlDeclaration(String xmlString)

skipDocTypeDeclaration

public static String skipDocTypeDeclaration(String xmlString)

getNamespaceClause

public static String getNamespaceClause(String namespaceDefs)

getNamespaceMap

public static Map<String,String> getNamespaceMap(String namespaceDefs)

createXPathEvaluatorSource

@Nonnull
public static String createXPathEvaluatorSource(@Nonnull
 String xPathExpression)

Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in. The stylesheet will result in TEXT output. The stylesheet XSLT version will be DEFAULT_XSLT_VERSION.

Parameters:

xPathExpression - The XPath Expression to evaluate

Returns:

An XSLT stylesheet generated to evaluate the XPath Expression

createXPathEvaluatorSource

@Nonnull
public static String createXPathEvaluatorSource(@Nullable
 String namespaceDefs,
 @Nonnull
 String xPathExpression,
 @Nonnull
 TransformerPool.OutputType outputMethod)

Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces. The stylesheet output type will be determined by the outputMethod parameter. The stylesheet XSLT version will be DEFAULT_XSLT_VERSION.

Parameters:

namespaceDefs - Definitions of the namespaces in which to evaluate the XPath Expression.

xPathExpression - The XPath Expression to evaluate

outputMethod - Type of output as per TransformerPool.OutputType.

Returns:

An XSLT stylesheet generated to evaluate the XPath Expression

createXPathEvaluatorSource

@Nonnull
public static String createXPathEvaluatorSource(@Nullable
 String namespaceDefs,
 @Nonnull
 String xPathExpression,
 @Nonnull
 TransformerPool.OutputType outputMethod,
 boolean includeXmlDeclaration,
 boolean stripSpace)

Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces. The stylesheet output type will be determined by the outputMethod parameter. The stylesheet XSLT version will be DEFAULT_XSLT_VERSION.

Parameters:

namespaceDefs - Definitions of the namespaces in which to evaluate the XPath Expression.

xPathExpression - The XPath Expression to evaluate

outputMethod - Type of output as per TransformerPool.OutputType. If outputMethod is TransformerPool.OutputType.XML then the resulting stylesheet will use the copy-of method instead of value-of.

includeXmlDeclaration - If true, and outputMethod is TransformerPool.OutputType.XML then include XML declaration in the output after the XSLT is applied.

stripSpace - If true then strip spaces in the output.

Returns:

An XSLT stylesheet generated to evaluate the XPath Expression

createXPathEvaluatorSource

@Nonnull
public static String createXPathEvaluatorSource(@Nullable
 String namespaceDefs,
 @Nonnull
 String xPathExpression,
 @Nonnull
 TransformerPool.OutputType outputMethod,
 boolean includeXmlDeclaration,
 @Nullable
 ParameterList params,
 boolean stripSpace,
 boolean ignoreNamespaces,
 String separator,
 int xsltVersion)

Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces. The stylesheet output type will be determined by the outputMethod parameter.

Parameters:

namespaceDefs - Definitions of the namespaces in which to evaluate the XPath Expression.

xPathExpression - The XPath Expression to evaluate

outputMethod - Type of output as per TransformerPool.OutputType. If outputMethod is TransformerPool.OutputType.XML then the resulting stylesheet will use the copy-of method instead of value-of.

includeXmlDeclaration - If true, and outputMethod is TransformerPool.OutputType.XML then include XML declaration in the output after the XSLT is applied.

params - A ParameterList to evaluate while generating the stylesheet.

stripSpace - If true then strip spaces in the output.

ignoreNamespaces - If true then namespaces are ignored during the evaluation.

separator - Separator between values if output method is TransformerPool.OutputType.TEXT.

xsltVersion - Version of XSLT for which to generate the stylesheet. Can be 0, 1, or 2. If 0, then DEFAULT_XSLT_VERSION is used.

Returns:

An XSLT stylesheet generated to evaluate the XPath Expression

createXPathEvaluatorSource

@Nonnull
public static String createXPathEvaluatorSource(@Nonnull
 UnaryOperator<String> xpathContainerSupplier,
 @Nonnull
 String xPathExpression,
 @Nonnull
 TransformerPool.OutputType outputMethod,
 boolean includeXmlDeclaration,
 @Nullable
 ParameterList params,
 boolean stripSpace,
 boolean ignoreNamespaces,
 int xsltVersion)

Create an XSLT stylesheet that can be used to evaluate the xpath expression passed in, in the given namespaces. The stylesheet output type will be determined by the outputMethod parameter.

Parameters:

xpathContainerSupplier - A supplier function to transform the XPath expression to the required XSLT tags for generating the output that is desired.

xPathExpression - The XPath Expression to evaluate

outputMethod - Type of output as per TransformerPool.OutputType. If outputMethod is TransformerPool.OutputType.XML then the resulting stylesheet will use the copy-of method instead of value-of.

includeXmlDeclaration - If true, and outputMethod is TransformerPool.OutputType.XML then include XML declaration in the output after the XSLT is applied.

params - A ParameterList to evaluate while generating the stylesheet.

stripSpace - If true then strip spaces in the output.

ignoreNamespaces - If true then namespaces are ignored during the evaluation.

xsltVersion - Version of XSLT for which to generate the stylesheet. Can be 0, 1, or 2. If 0, then DEFAULT_XSLT_VERSION is used.

Returns:

An XSLT stylesheet generated to evaluate the XPath Expression

stringToSource

public static Source stringToSource(String xmlString,
 boolean namespaceAware)
                             throws DomBuilderException

Converts a string containing xml-markup to a Source-object, that can be used as the input of a XSLT-transformer. The source may be used multiple times.

Throws:

DomBuilderException

stringToSource

public static Source stringToSource(String xmlString)
                             throws DomBuilderException

Throws:

DomBuilderException

stringToSourceForSingleUse

public static Source stringToSourceForSingleUse(String xmlString)
                                         throws SAXException

Throws:

SAXException

stringToSourceForSingleUse

public static Source stringToSourceForSingleUse(String xmlString,
 boolean namespaceAware)
                                         throws SAXException

Throws:

SAXException

inputSourceToSAXSource

public static SAXSource inputSourceToSAXSource(Resource resource)
                                        throws SAXException,
IOException

Throws:

SAXException

IOException

inputSourceToSAXSource

public static SAXSource inputSourceToSAXSource(InputSource is)
                                        throws SAXException

Throws:

SAXException

inputSourceToSAXSource

public static SAXSource inputSourceToSAXSource(InputSource is,
 boolean namespaceAware,
 Resource scopeProvider)
                                        throws SAXException

TODO: This does not appear to always properly honour namespaceAware=false

Throws:

SAXException

interpretXsltVersion

public static int interpretXsltVersion(String xsltVersion)

detectXsltVersion

public static int detectXsltVersion(String xsltString)
                             throws TransformerConfigurationException

Throws:

TransformerConfigurationException

detectXsltVersion

public static int detectXsltVersion(URL xsltUrl)
                             throws TransformerConfigurationException

Throws:

TransformerConfigurationException

createTransformer

public static Transformer createTransformer(String xsltString)
                                     throws TransformerConfigurationException

Throws:

TransformerConfigurationException

createTransformer

public static Transformer createTransformer(String xsltString,
 int xsltVersion)
                                     throws TransformerConfigurationException

Throws:

TransformerConfigurationException

createTransformer

public static Transformer createTransformer(URL url)
                                     throws TransformerConfigurationException

Throws:

TransformerConfigurationException

createTransformer

public static Transformer createTransformer(URL url,
 int xsltVersion)
                                     throws TransformerConfigurationException,
IOException

Throws:

TransformerConfigurationException

IOException

createTransformer

public static Transformer createTransformer(Source source,
 int xsltVersion)
                                     throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getTransformerFactory

public static TransformerFactory getTransformerFactory()

getTransformerFactory

public static TransformerFactory getTransformerFactory(int xsltVersion)

getTransformerFactory

public static TransformerFactory getTransformerFactory(int xsltVersion,
 ErrorListener errorListener)

getDocumentBuilderFactory

public static DocumentBuilderFactory getDocumentBuilderFactory()

getDocumentBuilderFactory

public static DocumentBuilderFactory getDocumentBuilderFactory(boolean namespaceAware)

getSAXParserFactory

public static SAXParserFactory getSAXParserFactory()

getSAXParserFactory

public static SAXParserFactory getSAXParserFactory(boolean namespaceAware)

convertEndOfLines

public static String convertEndOfLines(String input)

normalizeWhitespace

public static String normalizeWhitespace(String input)

normalizeAttributeValue

public static String normalizeAttributeValue(String input)

cleanseElementName

public static String cleanseElementName(String candidateName)

encodeURL

public static String encodeURL(String url)

encodes a url

getChildTagAsBoolean

public static boolean getChildTagAsBoolean(Element el,
 String tag)

Method getChildTagAsBoolean. Return the boolean-value of the first element with tag tag in the DOM subtree el.

To determine true or false, the value of the tag is compared case- insensitive with the values

true

,

yes

, or

on

. If it matches, true is returned. If not, false is returned.

If the tag can not be found, false is returned.

Parameters:

el - DOM subtree

tag - Name of tag to find

Returns:

boolean The value found.

getChildTagAsBoolean

public static boolean getChildTagAsBoolean(Element el,
 String tag,
 boolean defaultValue)

Method getChildTagAsBoolean. Return the boolean-value of the first element with tag tag in the DOM subtree el.

To determine true or false, the value of the tag is compared case- insensitive with the values

true

,

yes

, or

on

. If it matches, true is returned. If not, false is returned.

If the tag can not be found, the default-value is returned.

Parameters:

el - DOM subtree

tag - Name of tag to find

defaultValue - Default-value in case tag can not be found.

Returns:

boolean The value found.

getChildTagAsLong

public static long getChildTagAsLong(Element el,
 String tag)

Method getChildTagAsLong. Return the long integer-value of the first element with tag tag in the DOM subtree el.

Parameters:

el - DOM subtree

tag - Name of tag to find

Returns:

long The value found. Returns 0 if no tag can be found, or if the tag doesn't have an integer-value.

getChildTagAsLong

public static long getChildTagAsLong(Element el,
 String tag,
 long defaultValue)

Method getChildTagAsLong. Return the long integer-value of the first element with tag tag in the DOM subtree el.

Parameters:

el - DOM subtree

tag - Name of tag to find

defaultValue - Default-value in case tag can not be found, or is not numeric.

Returns:

long The value found.

getChildTagAsString

public static String getChildTagAsString(Element el,
 String tag)

Method getChildTagAsString. Return the value of the first element with tag tag in the DOM subtree el.

Parameters:

el - DOM subtree

tag - Name of tag to find

Returns:

String The value found, or null if no matching tag is found.

getChildTagAsString

public static String getChildTagAsString(Element el,
 String tag,
 String defaultValue)

Method getChildTagAsString. Return the value of the first element with tag tag in the DOM subtree el.

Parameters:

el - DOM subtree

tag - Name of tag to find

defaultValue - Default-value in case tag can not be found.

Returns:

String The value found.

getChildTags

public static Collection<Node> getChildTags(Element el,
 String tag)

Method getChildTags. Get all direct children of given element which match the given tag. This method only looks at the direct children of the given node, and doesn't descent deeper into the tree. If a '*' is passed as tag, all elements are returned.

Parameters:

el - Element where to get children from

tag - Tag to match. Use '*' to match all tags.

Returns:

Collection Collection containing all elements found. If size() returns 0, then no matching elements were found. All items in the collection can be safely cast to type org.w3c.dom.Element.

getFirstChildTag

public static Element getFirstChildTag(Element el,
 String tag)

Method getFirstChildTag. Return the first child-node which is an element with tagName equal to given tag. This method only looks at the direct children of the given node, and doesn't descent deeper into the tree.

Parameters:

el - Element where to get children from

tag - Tag to match

Returns:

Element The element found, or null if no match found.

getStringValue

public static String getStringValue(Element el)

getStringValue

public static String getStringValue(Element el,
 boolean trimWhitespace)

setTransformerParameters

public static void setTransformerParameters(Transformer t,
 Map<String,Object> parameters)
                                     throws IOException

sets all the parameters of the transformer using a Map with parameter values.

Throws:

IOException - If an IOException occurs.

transformXml

public static String transformXml(Transformer t,
 String s)
                           throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformXml

public static String transformXml(Transformer t,
 String s,
 boolean namespaceAware)
                           throws TransformerException,
IOException,
SAXException

Throws:

TransformerException

IOException

SAXException

transformXml

public static String transformXml(Transformer t,
 Source s)
                           throws TransformerException,
IOException

Throws:

TransformerException

IOException

isWellFormed

public static boolean isWellFormed(String input)

isWellFormed

public static boolean isWellFormed(String input,
 String root)

isWellFormed

public static boolean isWellFormed(Message input,
 String root)

getVersionInfo

public static Map<String,String> getVersionInfo()

source2String

public static String source2String(Source source)
                            throws TransformerException

Throws:

TransformerException

removeNamespaces

public static String removeNamespaces(String input)
                               throws XmlException

Throws:

XmlException

removeNamespaces

public static Message removeNamespaces(Message input)
                                throws XmlException

Throws:

XmlException

removeNamespaces

public static Message removeNamespaces(Message input,
 boolean includeXmlDeclaration)
                                throws XmlException

Throws:

XmlException

removeXmlDeclaration

public static Message removeXmlDeclaration(Message input)
                                    throws XmlException

Throws:

XmlException

getRootNamespace

public static String getRootNamespace(String input)

getRootNamespace

public static String getRootNamespace(Message input)

addRootNamespace

public static String addRootNamespace(String input,
 String namespace)

addRootNamespace

public static Message addRootNamespace(Message input,
 String namespace)

copyOfSelect

public static String copyOfSelect(String input,
 String xpath)

canonicalize

public static String canonicalize(String input)
                           throws IOException

Throws:

IOException

canonicalize

public static String canonicalize(String input,
 boolean removeNamespaces)
                           throws IOException

Throws:

IOException

nodeToString

public static String nodeToString(Node node)
                           throws TransformerException

Throws:

TransformerException

nodeToString

public static String nodeToString(Node node,
 boolean useIndentation)
                           throws TransformerException

Throws:

TransformerException

nodeToByteArray

public static byte[] nodeToByteArray(Node node)
                              throws TransformerException

Throws:

TransformerException

nodeToByteArray

public static byte[] nodeToByteArray(Node node,
 boolean omitXmlDeclaration)
                              throws TransformerException

Throws:

TransformerException

cdataToText

public static String cdataToText(String input)

mergeAttributes

public static StartElement mergeAttributes(StartElement tag,
 Iterator<? extends Attribute> attrs,
 Iterator<? extends Namespace> nsps,
 XMLEventFactory factory)

Like XMLStreamUtils.mergeAttributes(javax.xml.stream.events.StartElement, java.util.Iterator, javax.xml.stream.XMLEventFactory) but it can also merge namespaces

attributesEqual

public static boolean attributesEqual(@Nullable
 Attribute attribute1,
 @Nullable
 Attribute attribute2)

evaluateXPathNodeSet

@Nonnull
public static Collection<String> evaluateXPathNodeSet(String input,
 String xpathExpr)
                                               throws XmlException

Throws:

XmlException

evaluateXPathNodeSetFirstElement

@Nullable
public static String evaluateXPathNodeSetFirstElement(String input,
 String xpathExpr)
                                               throws XmlException

Throws:

XmlException

evaluateXPathNumber

@Nullable
public static Double evaluateXPathNumber(String input,
 String xpathExpr)
                                  throws XmlException

Throws:

XmlException

evaluateXPathNodeSet

@Nonnull
public static Map<String,String> evaluateXPathNodeSet(String input,
 String xpathExpr,
 String keyElement,
 String valueElement)
                                               throws XmlException

Throws:

XmlException

toXhtml

@Nonnull
public static Message toXhtml(Message message)
                       throws IOException

Throws:

IOException

getXPathFactory

public static XPathFactory getXPathFactory()

getXPathFactory

public static XPathFactory getXPathFactory(int xsltVersion)

getValidatorHandler

public static ValidatorHandler getValidatorHandler(URL schemaURL)
                                            throws SAXException

Throws:

SAXException

getValidatorHandler

public static ValidatorHandler getValidatorHandler(Source schemaSource)
                                            throws SAXException

Throws:

SAXException