-
public interface XPath
XPath
provides access to the XPath evaluation environment and expressions.Evaluation of XPath Expressions. context If a request is made to evaluate the expression in the absence of a context item, an empty document node will be used for the context. For the purposes of evaluating XPath expressions, a DocumentFragment is treated like a Document node. variables If the expression contains a variable reference, its value will be found through the XPathVariableResolver
set withsetXPathVariableResolver(XPathVariableResolver resolver)
. AnXPathExpressionException
is raised if the variable resolver is undefined or the resolver returnsnull
for the variable. The value of a variable must be immutable through the course of any single evaluation.functions If the expression contains a function reference, the function will be found through the XPathFunctionResolver
set withsetXPathFunctionResolver(XPathFunctionResolver resolver)
. AnXPathExpressionException
is raised if the function resolver is undefined or the function resolver returnsnull
for the function.QNames QNames in the expression are resolved against the XPath namespace context set with setNamespaceContext(NamespaceContext nsContext)
.result This result of evaluating an expression is converted to an instance of the desired return type. Valid return types are defined in XPathConstants
. Conversion to the return type follows XPath conversion rules.An XPath object is not thread-safe and not reentrant. In other words, it is the application's responsibility to make sure that one
XPath
object is not used from more than one thread at any given time, and while theevaluate
method is invoked, applications may not recursively call theevaluate
method.- Since:
- 1.5
- See Also:
- XML Path Language (XPath) Version 1.0
-
-
Method Summary
Methods Modifier and Type Method and Description XPathExpression
compile(String expression)
Compile an XPath expression for later evaluation.String
evaluate(String expression, InputSource source)
Evaluate an XPath expression in the context of the specifiedInputSource
and return the result as aString
.Object
evaluate(String expression, InputSource source, QName returnType)
Evaluate an XPath expression in the context of the specifiedInputSource
and return the result as the specified type.String
evaluate(String expression, Object item)
Evaluate an XPath expression in the specified context and return the result as aString
.Object
evaluate(String expression, Object item, QName returnType)
Evaluate anXPath
expression in the specified context and return the result as the specified type.NamespaceContext
getNamespaceContext()
Return the current namespace context.XPathFunctionResolver
getXPathFunctionResolver()
Return the current function resolver.XPathVariableResolver
getXPathVariableResolver()
Return the current variable resolver.void
reset()
Reset thisXPath
to its original configuration.void
setNamespaceContext(NamespaceContext nsContext)
Establish a namespace context.void
setXPathFunctionResolver(XPathFunctionResolver resolver)
Establish a function resolver.void
setXPathVariableResolver(XPathVariableResolver resolver)
Establish a variable resolver.
-
-
-
Method Detail
-
reset
void reset()
Reset this
XPath
to its original configuration.XPath
is reset to the same state as when it was created withXPathFactory.newXPath()
.reset()
is designed to allow the reuse of existingXPath
s thus saving resources associated with the creation of newXPath
s.The reset
XPath
is not guaranteed to have the sameXPathFunctionResolver
,XPathVariableResolver
orNamespaceContext
Object
s, e.g.Object.equals(Object obj)
. It is guaranteed to have a functionally equalXPathFunctionResolver
,XPathVariableResolver
andNamespaceContext
.
-
setXPathVariableResolver
void setXPathVariableResolver(XPathVariableResolver resolver)
Establish a variable resolver.
A
NullPointerException
is thrown ifresolver
isnull
.- Parameters:
resolver
- Variable resolver.- Throws:
NullPointerException
- Ifresolver
isnull
.
-
getXPathVariableResolver
XPathVariableResolver getXPathVariableResolver()
Return the current variable resolver.
null
is returned in no variable resolver is in effect.- Returns:
- Current variable resolver.
-
setXPathFunctionResolver
void setXPathFunctionResolver(XPathFunctionResolver resolver)
Establish a function resolver.
A
NullPointerException
is thrown ifresolver
isnull
.- Parameters:
resolver
- XPath function resolver.- Throws:
NullPointerException
- Ifresolver
isnull
.
-
getXPathFunctionResolver
XPathFunctionResolver getXPathFunctionResolver()
Return the current function resolver.
null
is returned in no function resolver is in effect.- Returns:
- Current function resolver.
-
setNamespaceContext
void setNamespaceContext(NamespaceContext nsContext)
Establish a namespace context.
A
NullPointerException
is thrown ifnsContext
isnull
.- Parameters:
nsContext
- Namespace context to use.- Throws:
NullPointerException
- IfnsContext
isnull
.
-
getNamespaceContext
NamespaceContext getNamespaceContext()
Return the current namespace context.
null
is returned in no namespace context is in effect.- Returns:
- Current Namespace context.
-
compile
XPathExpression compile(String expression) throws XPathExpressionException
Compile an XPath expression for later evaluation.
If
expression
contains anyXPathFunction
s, they must be available via theXPathFunctionResolver
. AnXPathExpressionException
will be thrown if theXPathFunction
cannot be resovled with theXPathFunctionResolver
.If
expression
contains any variables, theXPathVariableResolver
in effect at compile time will be used to resolve them.If
expression
isnull
, aNullPointerException
is thrown.- Parameters:
expression
- The XPath expression.- Returns:
- Compiled XPath expression.
- Throws:
XPathExpressionException
- Ifexpression
cannot be compiled.NullPointerException
- Ifexpression
isnull
.
-
evaluate
Object evaluate(String expression, Object item, QName returnType) throws XPathExpressionException
Evaluate an
XPath
expression in the specified context and return the result as the specified type.See Evaluation of XPath Expressions for context item evaluation, variable, function and
QName
resolution and return type conversion.If
returnType
is not one of the types defined inXPathConstants
(NUMBER
,STRING
,BOOLEAN
,NODE
orNODESET
) then anIllegalArgumentException
is thrown.If a
null
value is provided foritem
, an empty document will be used for the context. Ifexpression
orreturnType
isnull
, then aNullPointerException
is thrown.- Parameters:
expression
- The XPath expression.item
- The starting context (a node, for example).returnType
- The desired return type.- Returns:
- Result of evaluating an XPath expression as an
Object
ofreturnType
. - Throws:
XPathExpressionException
- Ifexpression
cannot be evaluated.IllegalArgumentException
- IfreturnType
is not one of the types defined inXPathConstants
.NullPointerException
- Ifexpression
orreturnType
isnull
.
-
evaluate
String evaluate(String expression, Object item) throws XPathExpressionException
Evaluate an XPath expression in the specified context and return the result as a
String
.This method calls
evaluate(String expression, Object item, QName returnType)
with areturnType
ofXPathConstants.STRING
.See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If a
null
value is provided foritem
, an empty document will be used for the context. Ifexpression
isnull
, then aNullPointerException
is thrown.- Parameters:
expression
- The XPath expression.item
- The starting context (a node, for example).- Returns:
- The
String
that is the result of evaluating the expression and converting the result to aString
. - Throws:
XPathExpressionException
- Ifexpression
cannot be evaluated.NullPointerException
- Ifexpression
isnull
.
-
evaluate
Object evaluate(String expression, InputSource source, QName returnType) throws XPathExpressionException
Evaluate an XPath expression in the context of the specified
InputSource
and return the result as the specified type.This method builds a data model for the
InputSource
and callsevaluate(String expression, Object item, QName returnType)
on the resulting document object.See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If
returnType
is not one of the types defined inXPathConstants
, then anIllegalArgumentException
is thrown.If
expression
,source
orreturnType
isnull
, then aNullPointerException
is thrown.- Parameters:
expression
- The XPath expression.source
- The input source of the document to evaluate over.returnType
- The desired return type.- Returns:
- The
Object
that encapsulates the result of evaluating the expression. - Throws:
XPathExpressionException
- If expression cannot be evaluated.IllegalArgumentException
- IfreturnType
is not one of the types defined inXPathConstants
.NullPointerException
- Ifexpression
,source
orreturnType
isnull
.
-
evaluate
String evaluate(String expression, InputSource source) throws XPathExpressionException
Evaluate an XPath expression in the context of the specified
InputSource
and return the result as aString
.This method calls
evaluate(String expression, InputSource source, QName returnType)
with areturnType
ofXPathConstants.STRING
.See Evaluation of XPath Expressions for context item evaluation, variable, function and QName resolution and return type conversion.
If
expression
orsource
isnull
, then aNullPointerException
is thrown.- Parameters:
expression
- The XPath expression.source
- TheInputSource
of the document to evaluate over.- Returns:
- The
String
that is the result of evaluating the expression and converting the result to aString
. - Throws:
XPathExpressionException
- If expression cannot be evaluated.NullPointerException
- Ifexpression
orsource
isnull
.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/xml/xpath/xpath.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.