org.jdom2.xpath

类 XPath

java.lang.Object

org.jdom2.xpath.XPath

所有已实现的接口:

java.io.Serializable

直接已知子类:

JDOMXPath

已过时。

Use XPathFactory/XPathExpression/XPathBuilder instead.

@Deprecated
public abstract class XPath
extends java.lang.Object
implements java.io.Serializable

A utility class for performing XPath calls on JDOM 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(java.lang.Class<? extends org.jdom2.xpath.XPath>) or the system property "org.jdom2.xpath.class".

作者:

Laurent Bihanic

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	JDOM_OBJECT_MODEL_URI 已过时。 The string passable to the JAXP 1.3 XPathFactory isObjectModelSupported() method to query an XPath engine regarding its support for JDOM.

构造器概要

构造器

构造器和说明
XPath() 已过时。

方法概要

限定符和类型	方法和说明
abstract void	addNamespace(Namespace namespace) 已过时。 Adds a namespace definition to the list of namespaces known of this XPath expression.
void	addNamespace(java.lang.String prefix, java.lang.String uri) 已过时。 Adds a namespace definition (prefix and URI) to the list of namespaces known of this XPath expression.
abstract java.lang.String	getXPath() 已过时。 Returns the wrapped XPath expression as a string.
static XPath	newInstance(java.lang.String path) 已过时。 Creates a new XPath wrapper object, compiling the specified XPath expression.
abstract java.lang.Number	numberValueOf(java.lang.Object context) 已过时。 Returns the number value of the first node selected by applying the wrapped XPath expression to the given context.
abstract java.util.List<?>	selectNodes(java.lang.Object context) 已过时。 Evaluates the wrapped XPath expression and returns the list of selected items.
static java.util.List<?>	selectNodes(java.lang.Object context, java.lang.String path) 已过时。 Evaluates an XPath expression and returns the list of selected items.
abstract java.lang.Object	selectSingleNode(java.lang.Object context) 已过时。 Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).
static java.lang.Object	selectSingleNode(java.lang.Object context, java.lang.String path) 已过时。 Evaluates the wrapped XPath expression and returns the first entry in the list of selected nodes (or atomics).
abstract void	setVariable(java.lang.String name, java.lang.Object value) 已过时。 Defines an XPath variable and sets its value.
static void	setXPathClass(java.lang.Class<? extends XPath> aClass) 已过时。 Sets the concrete XPath subclass to use when allocating XPath instances.
abstract java.lang.String	valueOf(java.lang.Object context) 已过时。 Returns the string value of the first node selected by applying the wrapped XPath expression to the given context.

从类继承的方法 java.lang.Object

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

字段详细资料

JDOM_OBJECT_MODEL_URI

public static final java.lang.String JDOM_OBJECT_MODEL_URI

已过时。

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

另请参阅:

常量字段值

构造器详细资料

XPath

public XPath()

已过时。

方法详细资料

newInstance

public static XPath newInstance(java.lang.String path)
                         throws JDOMException

已过时。

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

参数:

path - the XPath expression to wrap.

返回:

an XPath instance representing the input path

抛出:

JDOMException - if the XPath expression is invalid.

setXPathClass

public static void setXPathClass(java.lang.Class<? extends XPath> aClass)
                          throws JDOMException

已过时。

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

参数:

aClass - the concrete subclass of XPath.

抛出:

java.lang.IllegalArgumentException - if aClass is null.

JDOMException - if aClass is not a concrete subclass of XPath.

selectNodes

public abstract java.util.List<?> selectNodes(java.lang.Object context)
                                       throws JDOMException

已过时。

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

参数:

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

返回:

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

抛出:

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

selectSingleNode

public abstract java.lang.Object selectSingleNode(java.lang.Object context)
                                           throws JDOMException

已过时。

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

参数:

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

返回:

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.

抛出:

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

valueOf

public abstract java.lang.String valueOf(java.lang.Object context)
                                  throws JDOMException

已过时。

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

参数:

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

返回:

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

抛出:

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

numberValueOf

public abstract java.lang.Number numberValueOf(java.lang.Object context)
                                        throws JDOMException

已过时。

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

参数:

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

返回:

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.

抛出:

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

setVariable

public abstract void setVariable(java.lang.String name,
                                 java.lang.Object value)

已过时。

Defines an XPath variable and sets its value.

参数:

name - the variable name.

value - the variable value.

抛出:

java.lang.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.

参数:

namespace - the namespace.

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.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.

参数:

prefix - the namespace prefix.

uri - the namespace URI.

抛出:

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

getXPath

public abstract java.lang.String getXPath()

已过时。

Returns the wrapped XPath expression as a string.

返回:

the wrapped XPath expression as a string.

selectNodes

public static java.util.List<?> selectNodes(java.lang.Object context,
                                            java.lang.String path)
                                     throws JDOMException

已过时。

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, allocating an XPath wrapper instance and evaluating it several times is way more efficient.

参数:

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

path - the XPath expression to evaluate.

返回:

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

抛出:

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

selectSingleNode

public static java.lang.Object selectSingleNode(java.lang.Object context,
                                                java.lang.String path)
                                         throws JDOMException

已过时。

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, allocating an XPath wrapper instance and evaluating it several times is way more efficient.

参数:

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

path - the XPath expression to evaluate.

返回:

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.

抛出:

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