iaik.ixsil.util

Class XPathUtilsImpl

java.lang.Object

iaik.ixsil.util.XPathUtilsInterface

iaik.ixsil.util.XPathUtilsImpl

public class XPathUtilsImpl
extends XPathUtilsInterface

The standard implementation of the XPathUtilsInterface, which is shipped with the IXSIL toolkit. This implementation is based on Apache Xalan 2.5.1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XPathUtilsImpl.IXSILPrefixResolver Special extension of the PrefixResolverDefault interface.
protected class	XPathUtilsImpl.XPathUtilsXPathContextOwner ExtensionsProvider implementation used for integrating the XMLDSIG here() function as extension function into the Xalan engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.xml.utils.PrefixResolver	prefixResolver_ The prefix resolver for the XPath engine.
protected org.apache.xpath.XPath	xPath_ The XPath engine.
protected org.apache.xpath.XPathContext	xPathContext_ The XPath context for the XPath engine.

Constructor Summary

Constructors

Constructor and Description
XPathUtilsImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	selectBoolean(org.w3c.dom.Node contextNode) Uses an XPath epression to compute a boolean result.
org.w3c.dom.Element	selectElement(org.w3c.dom.Node contextNode) Uses an XPath epression to select a single Element node.
org.w3c.dom.NodeList	selectNodeSet(org.w3c.dom.Node contextNode) Uses an XPath epression to select a set of nodes.
void	setupContext(java.lang.String xPathExpr, org.w3c.dom.Node namespaceNode, java.lang.String additionalNSPrefixes, org.w3c.dom.NodeList hereResult) Sets up the XPath context.

Methods inherited from class iaik.ixsil.util.XPathUtilsInterface

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

xPathContext_

protected org.apache.xpath.XPathContext xPathContext_

The XPath context for the XPath engine.

prefixResolver_

protected org.apache.xml.utils.PrefixResolver prefixResolver_

The prefix resolver for the XPath engine.

xPath_

protected org.apache.xpath.XPath xPath_

The XPath engine.

Constructor Detail

XPathUtilsImpl

public XPathUtilsImpl()

Method Detail

setupContext

public void setupContext(java.lang.String xPathExpr,
                org.w3c.dom.Node namespaceNode,
                java.lang.String additionalNSPrefixes,
                org.w3c.dom.NodeList hereResult)
                  throws XPathUtilsException

Description copied from class: XPathUtilsInterface

Sets up the XPath context. Later invocations of XPathUtilsInterface.selectBoolean(org.w3c.dom.Node), XPathUtilsInterface.selectElement(org.w3c.dom.Node) and XPathUtilsInterface.selectNodeSet(org.w3c.dom.Node) will operate on this context.

Specified by:

setupContext in class XPathUtilsInterface

Parameters:

xPathExpr - A string specifying the XPath expression. Must not be null.

namespaceNode - The namespace declarations in scope for this node will be used as the set of namespace declarations for the XPath computation. May be null.

additionalNSPrefixes - Allows the specification of additional namespace prefixes which can be used in the XPath expression. The value of the parameter consists of pairs of prefix to namespace URI attributions separated by spaces, i. e. "prefix1 uri1 prefix2 uri2 ...". May be null.

hereResult - The result which should be returned by the XPath extension function call here() . The here() extension function has been introduced in XML Signature, XPath Filtering. May be null if the here() function will not be used. If not null, the NodeList must contain a single Element, Attr or ProcessingInstruction node.

Throws:

XPathUtilsException - if the XPath engine returns an error.

See Also:

XPathUtilsInterface.setupContext(java.lang.String, org.w3c.dom.Node, java.lang.String, org.w3c.dom.NodeList)

selectNodeSet

public org.w3c.dom.NodeList selectNodeSet(org.w3c.dom.Node contextNode)
                                   throws XPathUtilsException

Description copied from class: XPathUtilsInterface

Uses an XPath epression to select a set of nodes. The XPath processing must result in a set of nodes.

Specified by:

selectNodeSet in class XPathUtilsInterface

Parameters:

contextNode - The node specifiying the context for the XPath manipulation. Must not be null .

Returns:

the node set which results by applying the XPath expression to the specified context node.

Throws:

XPathUtilsException - if the XPath engine returns an error, or if the result of processing the XPath is not a set of nodes.

See Also:

XPathUtilsInterface.selectNodeSet(org.w3c.dom.Node)

selectBoolean

public boolean selectBoolean(org.w3c.dom.Node contextNode)
                      throws XPathUtilsException

Description copied from class: XPathUtilsInterface

Uses an XPath epression to compute a boolean result. The XPath processing result must be convertable into a boolean value.

Specified by:

selectBoolean in class XPathUtilsInterface

Parameters:

contextNode - The node specifiying the context for the XPath manipulation. Must not be null .

Returns:

the result of the XPath processing, converted into a boolean value.

Throws:

XPathUtilsException - if the XPath engine returns an error, or if the result cannot be converted into a boolean value.

See Also:

XPathUtilsInterface.selectBoolean(org.w3c.dom.Node)

selectElement

public org.w3c.dom.Element selectElement(org.w3c.dom.Node contextNode)
                                  throws XPathUtilsException

Description copied from class: XPathUtilsInterface

Uses an XPath epression to select a single Element node. The XPath must lead to a node set result consisting of exactly one node, which must be of type Element.

Specified by:

selectElement in class XPathUtilsInterface

Parameters:

contextNode - The node specifiying the context for the XPath manipulation. Must not be null .

Returns:

the Element node selected by applying the XPath expression to the specified context node.

Throws:

XPathUtilsException - if the XPath engine returns an error, or if the result is not a single Element Node.

See Also:

XPathUtilsInterface.selectElement(org.w3c.dom.Node)