Package org.opengis.cite.gmljpx20.util
Class XMLUtils
java.lang.Object
org.opengis.cite.gmljpx20.util.XMLUtils
Provides various utility methods for accessing or manipulating XML representations.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Element
createElement
(QName qName) Creates a new Element having the specified qualified name.static boolean
evaluateXPath
(Node context, String expr) Evaluates an XPath expression using the given context and returns the result as boolean.static NodeList
Evaluates an XPath 1.0 expression using the given context and returns the result as a node set.static Object
Evaluates an XPath expression using the given context and returns the result as the specified type.static net.sf.saxon.s9api.XdmValue
Evaluates an XPath 2.0 expression using the Saxon s9api interfaces.static String
expandReferencesInText
(String value) Expands character entity (&name;) and numeric references ( &#xhhhh; or &dddd;) that occur within a given string value.getElementsByNamespaceURI
(Node node, String namespaceURI) Returns a List of all descendant Element nodes having the specified [namespace name] property.static Document
Transforms the content of a DOM Node using a specified XSLT stylesheet.static void
writeNode
(Node node, OutputStream outputStream) Writes the content of a DOM Node to a byte stream.static String
writeNodeToString
(Node node) Writes the content of a DOM Node to a string.
-
Constructor Details
-
XMLUtils
public XMLUtils()
-
-
Method Details
-
writeNodeToString
Writes the content of a DOM Node to a string. The XML declaration is omitted and the character encoding is set to "US-ASCII" (any character outside of this set is serialized as a numeric character reference).- Parameters:
node
- The DOM Node to be serialized.- Returns:
- A String representing the content of the given node.
-
writeNode
Writes the content of a DOM Node to a byte stream. An XML declaration is always omitted.- Parameters:
node
- The DOM Node to be serialized.outputStream
- The destination OutputStream reference.
-
evaluateXPath
public static NodeList evaluateXPath(Node context, String expr, Map<String, String> namespaceBindings) throws XPathExpressionExceptionEvaluates an XPath 1.0 expression using the given context and returns the result as a node set.- Parameters:
context
- The context node.expr
- An XPath expression.namespaceBindings
- A collection of namespace bindings for the XPath expression, where each entry maps a namespace URI (key) to a prefix (value). Standard bindings do not need to be declared (seeNamespaceBindings.withStandardBindings()
.- Returns:
- A NodeList containing nodes that satisfy the expression (it may be empty).
- Throws:
XPathExpressionException
- If the expression cannot be evaluated for any reason.
-
evaluateXPath
public static Object evaluateXPath(Node context, String expr, Map<String, String> namespaceBindings, QName returnType) throws XPathExpressionExceptionEvaluates an XPath expression using the given context and returns the result as the specified type.Note: The Saxon implementation supports XPath 2.0 expressions when using the JAXP XPath APIs (the default implementation will throw an exception).
- Parameters:
context
- The context node.expr
- An XPath expression.namespaceBindings
- A collection of namespace bindings for the XPath expression, where each entry maps a namespace URI (key) to a prefix (value). Standard bindings do not need to be declared (seeNamespaceBindings.withStandardBindings()
.returnType
- The desired return type (as declared inXPathConstants
).- Returns:
- The result converted to the desired returnType.
- Throws:
XPathExpressionException
- If the expression cannot be evaluated for any reason.
-
evaluateXPath
Evaluates an XPath expression using the given context and returns the result as boolean. Standard bindings (seeNamespaceBindings.withStandardBindings()
) are used for evaluation of the XPath.Note: The Saxon implementation supports XPath 2.0 expressions when using the JAXP XPath APIs (the default implementation will throw an exception).
- Parameters:
context
- The context node.expr
- An XPath expression.- Returns:
- The result converted to the desired returnType.
- Throws:
XPathExpressionException
- If the expression cannot be evaluated for any reason.
-
evaluateXPath2
public static net.sf.saxon.s9api.XdmValue evaluateXPath2(Source xmlSource, String expr, Map<String, String> nsBindings) throws net.sf.saxon.s9api.SaxonApiExceptionEvaluates an XPath 2.0 expression using the Saxon s9api interfaces.- Parameters:
xmlSource
- The XML Source.expr
- The XPath expression to be evaluated.nsBindings
- A collection of namespace bindings required to evaluate the XPath expression, where each entry maps a namespace URI (key) to a prefix (value); this may benull
if not needed.- Returns:
- An XdmValue object representing a value in the XDM data model; this is a sequence of zero or more items, where each item is either an atomic value or a node.
- Throws:
net.sf.saxon.s9api.SaxonApiException
- If an error occurs while evaluating the expression; this always wraps some other underlying exception.
-
createElement
Creates a new Element having the specified qualified name. The element must beadopted
when inserted into another Document.- Parameters:
qName
- A QName object.- Returns:
- An Element node (with a Document owner but no parent).
-
getElementsByNamespaceURI
Returns a List of all descendant Element nodes having the specified [namespace name] property. The elements are listed in document order.- Parameters:
node
- The node to search from.namespaceURI
- An absolute URI denoting a namespace name.- Returns:
- A List containing elements in the specified namespace; the list is empty if there are no elements in the namespace.
-
transform
Transforms the content of a DOM Node using a specified XSLT stylesheet.- Parameters:
xslt
- A Source object representing a stylesheet (XSLT 1.0 or 2.0).source
- A Node representing the XML source. If it is an Element node it will be imported into a new DOM Document.- Returns:
- A DOM Document containing the result of the transformation.
-
expandReferencesInText
Expands character entity (&name;) and numeric references ( &#xhhhh; or &dddd;) that occur within a given string value. It may be necessary to do this before processing an XPath expression.- Parameters:
value
- A string representing text content.- Returns:
- A string with all included references expanded.
-