org.cdmckay.coffeedom.xpath
Class XPath

java.lang.Object
  org.cdmckay.coffeedom.xpath.XPath

All Implemented Interfaces:

Serializable

public abstract class XPath
extends Object
implements Serializable

A utility class for performing XPath calls on CoffeeDOM nodes, with a factory interface for obtaining a first XPath instance. Users operate against this class while XPath vendors can plug-in implementations underneath. Users can choose an implementation using either setXPathClass(Class) or the system property "org.cdmckay.coffeedom.xpath.class".

Author:

Laurent Bihanic, Cameron McKay

See Also:

Serialized Form

Field Summary

static String

COFFEEDOM_OBJECT_MODEL_URI The string passable to the JAXP 1.3 XPathFactory isObjectModelSupported() method to query an XPath engine regarding its support for CoffeeDOM.

Constructor Summary

XPath()

Method Summary

abstract void	addNamespace(Namespace namespace) Adds a namespace definition to the list of namespaces known of this XPath expression.
void	addNamespace(String prefix, String uri) Adds a namespace definition (prefix and URI) to the list of namespaces known of this XPath expression.
abstract String	getXPath() Returns the wrapped XPath expression as a string.
static XPath	newInstance(String path) Creates a new XPath wrapper object, compiling the specified XPath expression.
abstract Number	numberValueOf(Object context) Returns the number value of the first node selected by applying the wrapped XPath expression to the given context.
abstract List<Object>	selectNodes(Object context) Evaluates the wrapped XPath expression and returns the list of selected items.
static List	selectNodes(Object context, String path) Evaluates an XPath expression and returns the list of selected items.
abstract Object	selectSingleNode(Object context) Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).
static Object	selectSingleNode(Object context, String path) Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).
abstract void	setVariable(String name, Object value) Defines an XPath variable and sets its value.
static void	setXPathClass(Class<?> clazz) Sets the concrete XPath subclass to use when allocating XPath instances.
abstract String	valueOf(Object context) Returns the string value of the first node selected by applying the wrapped XPath expression to the given context.
protected Object	writeReplace() [Serialization support] Returns the alternative object to write to the stream when serializing this object.

Methods inherited from class java.lang.Object

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

Field Detail

COFFEEDOM_OBJECT_MODEL_URI

public static final String COFFEEDOM_OBJECT_MODEL_URI

The string passable to the JAXP 1.3 XPathFactory isObjectModelSupported() method to query an XPath engine regarding its support for CoffeeDOM. Defined to be the well-known URI "http://coffeedom.cdmckay.org/jaxp/xpath/jdom".

See Also:

Constant Field Values

Constructor Detail

XPath

public XPath()

Method Detail

newInstance

public static XPath newInstance(String path)
                         throws CoffeeDOMException

Creates a new XPath wrapper object, compiling the specified XPath expression.

Parameters:

path - the XPath expression to wrap.

Returns:

Throws:

CoffeeDOMException - if the XPath expression is invalid.

setXPathClass

public static void setXPathClass(Class<?> clazz)
                          throws CoffeeDOMException

Sets the concrete XPath subclass to use when allocating XPath instances.

Parameters:

clazz - the concrete subclass of XPath.

Throws:

IllegalArgumentException - if clazz is null.

CoffeeDOMException - if clazz is not a concrete subclass of XPath.

selectNodes

public abstract List<Object> selectNodes(Object context)
                                  throws CoffeeDOMException

Evaluates the wrapped XPath expression and returns the list of selected items.

Parameters:

context - the node to use as context for evaluating the XPath expression.

Returns:

the list of selected items, which may be of types: Element, Attribute, Text, CDATA, Comment, ProcessingInstruction, Boolean, Double, or String.

Throws:

CoffeeDOMException - if the evaluation of the XPath expression on the specified context failed.

selectSingleNode

public abstract Object selectSingleNode(Object context)
                                 throws CoffeeDOMException

Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).

Parameters:

context - the node to use as context for evaluating the XPath expression.

Returns:

the first selected item, which may be of types: Element, Attribute, Text, CDATA, Comment, ProcessingInstruction, Boolean, Double, String, or null if no item was selected.

Throws:

CoffeeDOMException - if the evaluation of the XPath expression on the specified context failed.

valueOf

public abstract String valueOf(Object context)
                        throws CoffeeDOMException

Returns the string value of the first node selected by applying the wrapped XPath expression to the given context.

Parameters:

context - the element to use as context for evaluating the XPath expression.

Returns:

the string value of the first node selected by applying the wrapped XPath expression to the given context.

Throws:

CoffeeDOMException - if the XPath expression is invalid or its evaluation on the specified context failed.

numberValueOf

public abstract Number numberValueOf(Object context)
                              throws CoffeeDOMException

Returns the number value of the first node selected by applying the wrapped XPath expression to the given context.

Parameters:

context - the element to use as context for evaluating the XPath expression.

Returns:

the number value of the first node selected by applying the wrapped XPath expression to the given context, null if no node was selected or the special value Double.NaN (Not-a-Number) if the selected value can not be converted into a number value.

Throws:

CoffeeDOMException - if the XPath expression is invalid or its evaluation on the specified context failed.

setVariable

public abstract void setVariable(String name,
                                 Object value)

Defines an XPath variable and sets its value.

Parameters:

name - the variable name.

value - the variable value.

Throws:

IllegalArgumentException - if name is not a valid XPath variable name or if the value type is not supported by the underlying implementation

addNamespace

public abstract void addNamespace(Namespace namespace)

Adds a namespace definition to the list of namespaces known of this XPath expression.

Note: In XPath, there is no such thing as a 'default namespace'. The empty prefix always resolves to the empty namespace URI.

Parameters:

namespace - the namespace.

addNamespace

public void addNamespace(String prefix,
                         String uri)

Adds a namespace definition (prefix and URI) to the list of namespaces known of this XPath expression.

Note: In XPath, there is no such thing as a 'default namespace'. The empty prefix always resolves to the empty namespace URI.

Parameters:

prefix - the namespace prefix.

uri - the namespace URI.

Throws:

IllegalNameException - if the prefix or uri are null or empty strings or if they contain illegal characters.

getXPath

public abstract String getXPath()

Returns the wrapped XPath expression as a string.

Returns:

the wrapped XPath expression as a string.

selectNodes

public static List selectNodes(Object context,
                               String path)
                        throws CoffeeDOMException

Evaluates an XPath expression and returns the list of selected items.

Note: This method should not be used when the same XPath expression needs to be applied several times (on the same or different contexts) as it requires the expression to be compiled before being evaluated. In such cases, newInstance(String) allocating} an XPath wrapper instance and evaluating it several times is way more efficient.

Parameters:

context - the node to use as context for evaluating the XPath expression.

path - the XPath expression to evaluate.

Returns:

the list of selected items, which may be of types: Element, Attribute, Text, CDATA, Comment, ProcessingInstruction, Boolean, Double, or String.

Throws:

CoffeeDOMException - if the XPath expression is invalid or its evaluation on the specified context failed.

selectSingleNode

public static Object selectSingleNode(Object context,
                                      String path)
                               throws CoffeeDOMException

Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).

Note: This method should not be used when the same XPath expression needs to be applied several times (on the same or different contexts) as it requires the expression to be compiled before being evaluated. In such cases, newInstance(String) allocating} an XPath wrapper instance and evaluating it several times is way more efficient.

Parameters:

context - the element to use as context for evaluating the XPath expression.

path - the XPath expression to evaluate.

Returns:

the first selected item, which may be of types: Element, Attribute, Text, CDATA, Comment, ProcessingInstruction, Boolean, Double, String, or null if no item was selected.

Throws:

CoffeeDOMException - if the XPath expression is invalid or its evaluation on the specified context failed.

writeReplace

protected final Object writeReplace()
                             throws ObjectStreamException

[Serialization support] Returns the alternative object to write to the stream when serializing this object. This method returns an instance of a dedicated nested class to serialize XPath expressions independently of the concrete implementation being used.

Note: Subclasses are not allowed to override this method to ensure valid serialization of all implementations.

Returns:

an XPathString instance configured with the wrapped XPath expression.

Throws:

ObjectStreamException - never.