compact2, compact3

javax.xml.xpath

Интерфейс XPath

public interface XPath

XPath обеспечивает доступ к среде оценки XPath и выражениям.

Оценка Выражений XPath.
контекст	Если с просьбой обратятся, чтобы оценить выражение в отсутствие элемента контекста, то пустой узел документа будет использоваться для контекста. В целях оценить выражения XPath, DocumentFragment обрабатывается как узел Документа.
переменные	Если выражение будет содержать переменную ссылку, то ее значение будет найдено через XPathVariableResolver набор с setXPathVariableResolver(XPathVariableResolver resolver). XPathExpressionException повышается, если переменный преобразователь неопределен или возвраты преобразователя null для переменной. Значение переменной должно быть неизменным через курс любой единственной оценки.
функции	Если выражение будет содержать функциональную ссылку, то функция будет найдена через XPathFunctionResolver набор с setXPathFunctionResolver(XPathFunctionResolver resolver). XPathExpressionException повышается, если функциональный преобразователь неопределен или функциональные возвраты преобразователя null для функции.
QNames	QNames в выражении разрешаются против набора контекста пространства имен XPath с setNamespaceContext(NamespaceContext nsContext).
результат	Этот результат оценки выражения преобразовывается в экземпляр требуемого типа возврата. Допустимые типы возврата определяются в XPathConstants. Преобразование в тип возврата следует за правилами преобразования XPath.

Объект XPath не ориентирован на многопотоковое исполнение и не повторно используем. Другими словами это - обязанность приложения удостовериться что один XPath объект не используется больше чем от одного потока в любой момент времени, и в то время как evaluate метод вызывается, приложения, возможно, не рекурсивно вызывают evaluate метод.

С тех пор:

1.5

См. Также:

Язык Пути XML (XPath) Версия 1.0

Сводка метода

Модификатор и Тип	Метод и Описание
XPathExpression	compile(String expression) Скомпилируйте выражение XPath для более поздней оценки.
Строка	evaluate(String expression, InputSource source) Оцените выражение XPath в контексте указанного InputSource и возвратите результат как a String.
Объект	evaluate(String expression, InputSource source, QName returnType) Оцените выражение XPath в контексте указанного InputSource и возвратите результат как указанный тип.
Строка	evaluate(String expression, Object item) Оцените выражение XPath в указанном контексте и возвратите результат как a String.
Объект	evaluate(String expression, Object item, QName returnType) Оцените XPath выражение в указанном контексте и возврате результат как указанный тип.
NamespaceContext	getNamespaceContext() Возвратите текущий контекст пространства имен.
XPathFunctionResolver	getXPathFunctionResolver() Возвратите текущий функциональный преобразователь.
XPathVariableResolver	getXPathVariableResolver() Возвратите текущий переменный преобразователь.
void	reset() Сбросьте это XPath к его исходной конфигурации.
void	setNamespaceContext(NamespaceContext nsContext) Установите контекст пространства имен.
void	setXPathFunctionResolver(XPathFunctionResolver resolver) Установите функциональный преобразователь.
void	setXPathVariableResolver(XPathVariableResolver resolver) Установите переменный преобразователь.

Деталь метода

сброс

void reset()

Сбросьте это XPath к его исходной конфигурации.

XPath сбрасывается к тому же самому состоянию как тогда, когда оно создавалось с XPathFactory.newXPath(). reset() разрабатывается, чтобы позволить повторное использование существующих XPaths таким образом сохраняющий ресурсы, связанные с созданием новых XPaths.

Сброс XPath как гарантируют, не будет иметь то же самое XPathFunctionResolver, XPathVariableResolver или NamespaceContext Objects, например. Object.equals(Object obj). Это, как гарантируют, будет иметь функционально равный XPathFunctionResolver, XPathVariableResolver и NamespaceContext.

setXPathVariableResolver

void setXPathVariableResolver(XPathVariableResolver resolver)

Установите переменный преобразователь.

A NullPointerException бросается если resolver null.

Параметры:

resolver - Переменный преобразователь.

Броски:

NullPointerException - Если resolver null.

getXPathVariableResolver

XPathVariableResolver getXPathVariableResolver()

Возвратите текущий переменный преобразователь.

null не возвращается ни в каком переменном преобразователе, в действительности.

Возвраты:

Текущий переменный преобразователь.

setXPathFunctionResolver

void setXPathFunctionResolver(XPathFunctionResolver resolver)

Установите функциональный преобразователь.

A NullPointerException бросается если resolver null.

Параметры:

resolver - Преобразователь функции XPath.

Броски:

NullPointerException - Если resolver null.

getXPathFunctionResolver

XPathFunctionResolver getXPathFunctionResolver()

Возвратите текущий функциональный преобразователь.

null не возвращается ни в каком функциональном преобразователе, в действительности.

Возвраты:

Текущий функциональный преобразователь.

setNamespaceContext

void setNamespaceContext(NamespaceContext nsContext)

Установите контекст пространства имен.

A NullPointerException бросается если nsContext null.

Параметры:

nsContext - Контекст пространства имен, чтобы использовать.

Броски:

NullPointerException - Если nsContext null.

getNamespaceContext

NamespaceContext getNamespaceContext()

Возвратите текущий контекст пространства имен.

null не возвращается ни в каком контексте пространства имен, в действительности.

Возвраты:

Текущий контекст Пространства имен.

скомпилировать

XPathExpression compile(String expression)
                 throws XPathExpressionException

Скомпилируйте выражение XPath для более поздней оценки.

Если expression содержит любого XPathFunctions, они должны быть доступными через XPathFunctionResolver. XPathExpressionException будет брошен если XPathFunction не может быть resovled с XPathFunctionResolver.

Если expression содержит любые переменные, XPathVariableResolver в действительности во время компиляции будет использоваться, чтобы разрешить их.

Если expression null, a NullPointerException бросается.

Параметры:

expression - Выражение XPath.

Возвраты:

Скомпилированное выражение XPath.

Броски:

XPathExpressionException - Если expression не может быть скомпилирован.

NullPointerException - Если expression null.

оценить

Object evaluate(String expression,
                Object item,
                QName returnType)
         throws XPathExpressionException

Оцените XPath выражение в указанном контексте и возврате результат как указанный тип.

См. Оценку Выражений XPath для оценки элемента контекста, переменной, функции и QName разрешение и преобразование типов возврата.

Если returnType не один из типов, определенных в XPathConstants ( NUMBER, STRING, BOOLEAN, NODE или NODESET) тогда IllegalArgumentException бросается.

Если a null значение предусматривается item, пустой документ будет использоваться для контекста. Если expression или returnType null, тогда a NullPointerException бросается.

Параметры:

expression - Выражение XPath.

item - Запускающийся контекст (узел, например).

returnType - Требуемый тип возврата.

Возвраты:

Результат оценки выражения XPath как Object из returnType.

Броски:

XPathExpressionException - Если expression не может быть оценен.

IllegalArgumentException - Если returnType не один из типов, определенных в XPathConstants.

NullPointerException - Если expression или returnType null.

оценить

String evaluate(String expression,
                Object item)
         throws XPathExpressionException

Оцените выражение XPath в указанном контексте и возвратите результат как a String.

Это вызовы метода evaluate(String expression, Object item, QName returnType) с a returnType из XPathConstants.STRING.

См. Оценку Выражений XPath для оценки элемента контекста, переменной, функционального и разрешения QName и возвратите преобразование типов.

Если a null значение предусматривается item, пустой документ будет использоваться для контекста. Если expression null, тогда a NullPointerException бросается.

Параметры:

expression - Выражение XPath.

item - Запускающийся контекст (узел, например).

Возвраты:

String это - результат оценки выражения и преобразования результата к a String.

Броски:

XPathExpressionException - Если expression не может быть оценен.

NullPointerException - Если expression null.

оценить

Object evaluate(String expression,
                InputSource source,
                QName returnType)
         throws XPathExpressionException

Оцените выражение XPath в контексте указанного InputSource и возвратите результат как указанный тип.

Этот метод создает модель данных для InputSource и вызовы evaluate(String expression, Object item, QName returnType) на получающемся объекте документа.

См. Оценку Выражений XPath для оценки элемента контекста, переменной, функционального и разрешения QName и возвратите преобразование типов.

Если returnType не один из типов, определенных в XPathConstants, тогда IllegalArgumentException бросается.

Если expression, source или returnType null, тогда a NullPointerException бросается.

Параметры:

expression - Выражение XPath.

source - Входной источник документа, чтобы оценить.

returnType - Требуемый тип возврата.

Возвраты:

Object это инкапсулирует результат оценки выражения.

Броски:

XPathExpressionException - Если выражение не может быть оценено.

IllegalArgumentException - Если returnType не один из типов, определенных в XPathConstants.

NullPointerException - Если expression, source или returnType null.

оценить

String evaluate(String expression,
                InputSource source)
         throws XPathExpressionException

Оцените выражение XPath в контексте указанного InputSource и возвратите результат как a String.

Это вызовы метода evaluate(String expression, InputSource source, QName returnType) с a returnType из XPathConstants.STRING.

См. Оценку Выражений XPath для оценки элемента контекста, переменной, функционального и разрешения QName и возвратите преобразование типов.

Если expression или source null, тогда a NullPointerException бросается.

Параметры:

expression - Выражение XPath.

source - InputSource из документа, чтобы оценить.

Возвраты:

String это - результат оценки выражения и преобразования результата к a String.

Броски:

XPathExpressionException - Если выражение не может быть оценено.

NullPointerException - Если expression или source null.