iaik.ixsil.util

Class XPathUtilsInterface

java.lang.Object

iaik.ixsil.util.XPathUtilsInterface

Direct Known Subclasses:

XPathUtilsImpl

public abstract class XPathUtilsInterface
extends java.lang.Object

Defines the interface for all methods IXSIL relies on to perform XPath manipulations.

Constructor Summary

Constructors

Constructor and Description
XPathUtilsInterface()

Method Summary

Methods

Modifier and Type	Method and Description
static XPathUtilsInterface	getInstance() Gets an instance of the implementation class of this interface, as specified by the IXSIL init property named XPathUtils.ImplementingClass.
abstract boolean	selectBoolean(org.w3c.dom.Node contextNode) Uses an XPath epression to compute a boolean result.
abstract org.w3c.dom.Element	selectElement(org.w3c.dom.Node contextNode) Uses an XPath epression to select a single Element node.
abstract org.w3c.dom.NodeList	selectNodeSet(org.w3c.dom.Node contextNode) Uses an XPath epression to select a set of nodes.
abstract 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 java.lang.Object

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

Constructor Detail

XPathUtilsInterface

public XPathUtilsInterface()

Method Detail

getInstance

public static XPathUtilsInterface getInstance()

Gets an instance of the implementation class of this interface, as specified by the IXSIL init property named XPathUtils.ImplementingClass.

Returns:

an instance of the implementation class of this interface.

selectNodeSet

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

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

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.

selectBoolean

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

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

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.

selectElement

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

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.

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.

setupContext

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

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

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.