This is a
This Proposed Recommendation makes
several editorial changes adopted since the Candidate Recommendation was published.
Please note that this Proposed Recommendation of XPath 3.0 represents the
second version of
This specification is designed to be referenced normatively from
other specifications defining a host language for it; it is not
intended to be implemented outside a host language. The
implementability of this specification has been tested in the context
of its normative inclusion in host languages defined by the
This document incorporates changes made against the
Please report errors in this document using W3C's
Publication as a Proposed Recommendation does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by groups operating under the
XPath 3.0 is an expression
language that allows the processing of values conforming to the data
model defined in Dynamic function Inline function Support for union types. Support for literal URLs in names, using A string concatenation operator ( A mapping operator (
The primary purpose of XPath is to address the
nodes of
XPath is designed to be embedded in a
XQuery Version 3.0 is an extension of XPath Version
3.0.
In general, any expression that is syntactically valid and executes
successfully in both XPath 3.0 and XQuery 3.0 will return the
same result in both languages. There are a few exceptions to this
rule:
Because XQuery expands
If XPath 1.0 compatibility mode is enabled, XPath behaves differently from XQuery in a number of ways,
"&"
is &
in XQuery, and &
in XPath. (XPath is often embedded in other languages, which may expand predefined entity references or character references before the XPath expression is evaluated.)
Because these languages are so closely related, their grammars and language descriptions are generated from a common source to ensure consistency, and the editors of these specifications work together closely.
XPath 3.0 also depends on and is closely related to the following specifications:
The type system of XPath 3.0 is based on XML Schema. It is
implementation-defined whether the type system is based on
The built-in function library and the operators supported by
XPath 3.0 are defined in
This document specifies a grammar for XPath 3.0, using the
same basic EBNF notation used in
In the grammar productions in this document,
named symbols are underlined and literal text is enclosed in double quotes.
For example, the following productions describe the syntax of a
The productions should be read as follows: A
This document normatively defines the static and dynamic semantics of XPath 3.0. In this document, examples and material labeled as "Note" are provided for explanatory purposes and are not normative.
Certain aspects of language
processing are described in this specification as
A language aspect described in this specification as
The basic building block of XPath 3.0 is the
This specification contains no
assumptions or requirements regarding the character set encoding of strings
of
Like XML, XPath 3.0 is a case-sensitive language. Keywords in
XPath 3.0 use lower-case characters and are not reserved—that is, names in XPath 3.0 expressions are allowed to be the same as language keywords, except for certain unprefixed function-names listed in
xs:string
. The xs:QName
.
In the XPath 3.0 grammar, most names are specified using the
Names in XPath 3.0 can be bound to namespaces, and are
based on the syntax and semantics defined in
The xs:anyURI
type in http://www.w3.org/2000/xmlns/
.
Here are some examples of
pi
is a
math:pi
is a
Q{http://www.w3.org/2005/xpath-functions/math}pi
specifies the namespace URI using a
xs = http://www.w3.org/2001/XMLSchema
fn = http://www.w3.org/2005/xpath-functions
err = http://www.w3.org/2005/xqt-errors
(see
Element nodes have a property called
In
In most contexts, processors are not required to raise errors if a URI is not lexically valid according to
This information is organized into two categories
called the
The individual components of the
true
if rules for backward compatibility with XPath Version 1.0 are in effect; otherwise it is false
.
xs:anyURI
type in
xs:anyURI
type in
xs:anyURI
type in
let
, for
,
some
, or every
expression) extends the
The
xs:string
and xs:anyURI
(and types derived from them) when no
explicit collation is
specified.
xs:anyURI
type in
fn:static-base-uri
function, and is used implicitly during dynamic
evaluation by functions such as fn:doc
. Relative URI references are
resolved as described in
fn:doc
function. The type is the fn:doc
with the given URI as its
literal argument. fn:doc
is a
string literal that is not present in fn:doc
is document-node()?
.
The purpose of the fn:doc
.
fn:collection
function. The type is the type of the
sequence of nodes that would result from calling the
fn:collection
function with this URI as its
argument.fn:collection
is a string literal that is not present in
fn:collection
is node()*
.
The purpose of the fn:collection
.
fn:collection
function with no arguments.node()*
.
fn:format-number()
.
fn:format-number
function, and also specify characters that may appear in the result
of formatting the number.
The following attributes specify characters used to format the number per se:
The following attributes control the interpretation of characters in the picture string supplied to the format-number function. In each case the value must be a single character.
The following attributes specify characters or strings that may appear in the result of formatting the number:
The individual
components of the
The
Certain language constructs, notably the E1/E2
, E1[E2]
, create a new focus
for the evaluation of a sub-expression. In these constructs, E2
is evaluated once for each item in the
sequence that results from evaluating E1
. Each time E2
is evaluated, it is evaluated with a
different focus. The focus for evaluating E2
is referred to below as the E1
is referred to as the E2
is being evaluated. When this evaluation
is complete, evaluation of the containing expression continues with
its original focus unchanged.
.
). When an expression E1/E2
or E1[E2]
is evaluated, each item in the
sequence obtained by evaluating E1
becomes the context item in the inner focus for an evaluation of E2
.
fn:position()
. When an expression E1/E2
or E1[E2]
is evaluated, the context position in
the inner focus for an evaluation of E2
is the position of the context item in the sequence obtained by
evaluating E1
. The position of the
first item in a sequence is always 1 (one). The context position is
always less than or equal to the context size.
fn:last()
. When an expression
E1/E2
or E1[E2]
is evaluated, the context size in the
inner focus for an evaluation of E2
is
the number of items in the sequence obtained by evaluating E1
.
xs:anyURI
type in
fn:current-dateTime
function. If invoked multiple times during the execution of
xs:dayTimeDuration
. See
fn:format-date
and fn:format-integer
)
if no other language is requested.
The value is a language code as defined by the type xs:language
.
fn:format-date
and fn:format-dateTime
)
if no other calendar is requested.
The value is a string.
fn:format-date
and fn:format-dateTime
,
if no other place is specified. It is used when translating timezone offsets to civil timezone names,
and when using calendars where the translation from ISO dates/times to a local representation is dependent
on geographical location. Possible representations of this information are an ISO country code or an
Olson timezone name, but implementations are free to use other representations from which the above
information can be derived.
fn:doc
function when applied to that URI.
If there are one or more
URIs in D
, then the document-uri property of D
must either be absent, or must
be one of these URIs.
This means that given a document node $N
, the result of
fn:doc(fn:document-uri($N)) is $N
will always be true
, unless
fn:document-uri($N)
is an empty sequence.
fn:unparsed-text
function when applied to that
URI.
fn:collection
function when that URI is supplied as the
argument.
For every document node D
that is in the target of a mapping in D
must either be absent, or must be a
URI U
such that U
to D
.
This means that for any document node $N
retrieved using the
fn:collection
function, either directly or by navigating to the root of a
node that was returned, the result of fn:doc(fn:document-uri($N)) is $N
will always be true
, unless fn:document-uri($N)
is an empty sequence. This
implies a requirement for the fn:doc
and fn:collection
functions to be
consistent in their effect. If the implementation uses catalogs or
user-supplied URI resolvers to dereference URIs supplied to the fn:doc
function, the implementation of the fn:collection
function must take these
mechanisms into account. For example, an implementation might achieve this
by mapping the collection URI to a set of document URIs, which are then
resolved using the same catalog or URI resolver that is used by the fn:doc
function.
fn:collection
function
with no arguments.
fn:uri-collection
function when that URI is supplied as the
argument.
An implementation fn:uri-collection(X)!fn:doc(.)
is the same as the result of fn:collection(X)
.
However, this is not required. The fn:uri-collection
function is more
general than fn:collection
in that it allows access to resources other
than XML documents; at the same time, fn:collection
allows access to
nodes that might lack individual URIs, for example nodes corresponding
to XML fragments stored in the rows of a relational database.
fn:uri-collection
function
with no arguments.
A possible implementation is to provide the set of POSIX environment variables (or their equivalent on other
operating systems) appropriate to the process in which the
XPath 3.0 is defined in terms
of the
Figure 1: Processing Model Overview
Figure 1 provides a schematic overview of the processing steps that
are discussed in detail below. Some of these steps are completely
outside the domain of XPath 3.0; in Figure 1, these are depicted
outside the line that represents the boundaries of the language, an
area labeled
Before
A document may be parsed using an XML parser that
generates an
The Information Set or PSVI may be
transformed into an
The above steps provide an example of how an
type-name
property.type-name
of a node is the name of the type referenced by its
The value of an attribute is represented directly within the
attribute node. An attribute node whose type is unknown (such as might
occur in a schemaless document) is given the xs:untypedAtomic
.
The value of an element is represented by the children of the
element node, which may include text nodes and other element
nodes. The xs:untyped
. An element that has been validated and found to be partially valid is annotated with the schema type xs:anyType
. If an element node is annotated as xs:untyped
, all its descendant element nodes are also annotated as xs:untyped
. However, if an element node is annotated as xs:anyType
, some of its descendant element nodes may have a more specific
The
XPath 3.0 defines two phases of processing called
the
Within each phase, an implementation is free to use any strategy or algorithm whose result conforms to the specifications in this document.
During the static analysis phase, the
The
During the
Examples of inferred static types might be:
For the expression concat(a,b)
the inferred static type is xs:string
For the expression $a = $v
the inferred static type is xs:boolean
For the expression $s[exp]
the inferred static
type has the same item type as the static type of $s
,
but a cardinality that allows the empty sequence even if the
static type of $s
does not allow an empty
sequence.
The inferred static type of the expression data($x)
(whether written
explicitly or inserted into the operation tree in places where atomization
is implicit) depends on the inferred static type of $x
: for example, if $x
has type element(*, xs:integer)
then data($x)
has static type xs:integer
.
In XQuery 1.0 and XPath 2.0, rules for static type inferencing were published
normatively in
Every kind of expression also imposes requirements on the type of its
operands. For example, with the expression substring($a, $b, $c)
, $a
must be
of type xs:string
(or something that can be converted to xs:string
by the
function calling rules), while $b
and $c
must be of type xs:double
.
If the Static Typing Feature is in effect, a processor must raise a
type error during static analysis if the inferred static type of an
expression is not subsumed by the required type of the context where the
expression is used. For example, the call of substring above would cause a
type error if the inferred static type of $a
is xs:integer
; equally, a type
error would be reported during static analysis if the inferred static type
is xs:anyAtomicType
.
If the Static Typing Feature is not in effect, a processor may raise a type
error during static analysis only if the inferred static type of an
expression has no overlap (intersection) with the required type: so for the
first argument of substring, the processor may raise an error if the
inferred type is xs:integer
, but not if it is xs:anyAtomicType
.
Alternatively, if the Static Typing Feature is not in effect, the processor
may defer all type checking until the dynamic evaluation phase.
The dynamic evaluation phase can occur only if no errors were detected during the
The dynamic evaluation phase depends on the
xs:integer*
, denoting a sequence of zero or more integers, but at evaluation time its value may have the dynamic type xs:integer
, denoting exactly one integer.)
If an operand of an expression is found
to have a
Even though static typing can catch many xs:untypedAtomic
. This is not a
When the
In order for XPath 3.0 to
be well defined, the input
Some of the consistency constraints use the term
For every node that has a type annotation, if that type annotation is found in the
For every element name
Every element name, attribute name, or schema type name referenced in
Any reference to a global element, attribute, or type name in
the
For each mapping of a string to a
document node in
For each mapping of a string to a sequence of nodes in
The sequence of nodes in the
The value of the
For each (variable, type) pair in
In the xml
must not be bound to any namespace URI other than http://www.w3.org/XML/1998/namespace
, and no prefix other than xml
may be bound to this namespace URI.
The prefix xmlns
must not be bound to any namespace URI, and no prefix may be bound to the namespace URI http://www.w3.org/2000/xmlns/
.
For each
(expanded QName, arity) -> FunctionTest
entry in
(expanded QName, arity) -> function
entry in
FunctionTest
.
As described in
The outcome of the
If more than one error is present, or if an error condition comes within the scope of more than one error defined in this specification, then any non-empty subset of these errors may be reported.
During the ()
or data(())
is empty-sequence()
, a
Independently of whether the
An implementation can raise a dynamic error for a
The following example contains a type error, which can be reported statically even if the implementation can not prove that the expression will actually be evaluated.
In addition to the errors defined in this
specification, an implementation may raise a
The errors defined in this specification are identified by QNames that have the form err:XPYYnnnn
, where:
err
denotes the namespace for XPath and XQuery errors, http://www.w3.org/2005/xqt-errors
. This binding of the namespace prefix err
is used for convenience in this document, and is not normative.
XP
identifies the error as an XPath error (some errors, originally defined by XQuery and later added to XPath, use the code XQ
instead).
YY
denotes the error category, using the following encoding:
ST
denotes a static error.
DY
denotes a dynamic error.
TY
denotes a type error.
nnnn
is a unique numeric code.
The namespace URI for XPath and XQuery errors is not expected to
change from one version of
The method by which an XPath 3.0 processor reports error information to the external environment is
An error can be represented by a URI reference that is derived from the error QName as follows: an error with namespace URI NS
LP
NS
#
LP
err:XPST0017
could be represented as http://www.w3.org/2005/xqt-errors#XPST0017
.
Along with a code identifying an error, implementations may wish to return additional information, such
as the location of the error or the processing phase in which it was detected. If an implementation chooses to do so, then the mechanism that
it uses to return this information is
Except as noted in this document, if any operand of an expression
raises a expr1 and expr2
may return the value false
if either operand returns false
,
or may raise a dynamic error if either operand raises a dynamic
error.
If more than one operand of an expression raises an error, the implementation may choose which error is raised by the expression. For example, in this expression:
both the sub-expressions ($x div $y)
and xs:decimal($z)
may
raise an error. The
implementation may choose which error is raised by the "+
"
expression. Once one operand raises an error, the implementation is
not required, but is permitted, to evaluate any other operands.
A dynamic error may be raised by a div
operator raises an error if its operands are xs:decimal
values and its second operand
is equal to zero. Errors raised by built-in functions and operators are defined in
A dynamic error can also be raised explicitly by calling the
fn:error
function, which app
is bound to a namespace containing application-defined error codes):
Because different implementations may
choose to evaluate or optimize an expression in different ways,
certain aspects of raising
An implementation is always free to evaluate the operands of an operator in any order.
In some cases, a processor can determine the result of an expression without accessing all the data that would be implied by the formal expression semantics. For example, the formal description of $s[1]
should be evaluated by examining all the items in sequence $s
, and selecting all those that satisfy the predicate position()=1
. In practice, many implementations will recognize that they can evaluate this expression by taking the first item in the sequence and then exiting. If $s
is defined by an expression such as //book[author eq 'Berners-Lee']
, then this strategy may avoid a complete scan of a large document and may therefore greatly improve performance. However, a consequence of this strategy is that a dynamic error or type error that would be detected if the expression semantics were followed literally might not be detected at all if the evaluation exits early. In this example, such an error might occur if there is a book
element in the input data with more than one author
subelement.
The extent to which a processor may optimize its access to data, at the cost of not raising errors, is defined by the following rules.
Consider an expression
There is an exception to this rule: If a processor evaluates an operand $e eq 0
results in a type error if the value of $e
contains two or more items. A processor is not allowed to decide, after evaluating the first item in the value of $e
and finding it equal to zero, that the only possible outcomes are the value true
or a type error caused by the cardinality violation. It must establish that the value of $e
contains no more than one item.
These rules apply to all the operands of an expression considered in combination: thus if an expression has two operands
The rules cascade: if
The effect of these rules is that the processor is free to stop examining further items in a sequence as soon as it can establish that further items would not affect the result except possibly by causing an error. For example, the processor may return true
as the result of the expression S1 = S2
as soon as it finds a pair of equal values from the two sequences.
Another consequence of these rules is that where none of the items in a sequence contributes to the result of an expression, the processor is not obliged to evaluate any part of the sequence. Again, however, the processor cannot dispense with a required cardinality check: if an empty sequence is not permitted in the relevant context, then the processor must ensure that the operand is not an empty sequence.
Examples:
If an implementation can find (for example, by using an index) that at
least one item returned by $expr1
in the following example has the value 47
, it is allowed to
return true
as the result of the some
expression, without searching for
another item returned by $expr1
that would raise an error if it were evaluated.
In the following example, if an implementation can find (for example, by using an index) the
product
element-nodes that have an id
child with the value 47
, it is allowed to return these nodes as the
result of the product
node that
would raise an error because it has an id
child whose value is not an integer.
For a variety of reasons, including optimization, implementations may rewrite expressions into a different form. There are a number of rules that limit the extent of this freedom:
Other than the raising or not raising of errors, the result of evaluating a rewritten expression must conform to the semantics defined in this specification for the original expression.
This allows an implementation to return a result in cases where the original expression would have raised an error, or to raise an error in cases where the original expression would have returned a result. The main cases where this is likely to arise in practice are (a) where a rewrite changes the order of evaluation, such that a subexpression causing an error is evaluated when the expression is written one way and is not evaluated when the expression is written a different way, and (b) where intermediate results of the evaluation cause overflow or other out-of-range conditions.
This rule does not mean that the result of the expression will always
be the same in non-error cases as if it had not been rewritten, because there
are many cases where the result of an expression is to some degree
Conditional and typeswitch expressions
must not raise a dynamic error in
respect of subexpressions occurring in a branch that is not selected,
and must not
return the value delivered by a branch unless that branch is selected.
Thus, the following example must not raise a
dynamic error if the document abc.xml
does not exist:
As stated earlier, an expression
must not be rewritten to dispense with a
required cardinality check: for example, string-length(//title)
must raise an
error if the document contains more than one title element.
Expressions must not be rewritten in such a way as to create or remove static errors. The static errors in this specification are defined for the original expression, and must be preserved if the expression is rewritten.
Expression rewrite is illustrated by the following examples.
Consider the expression Parts that have exactly one color that is Red are returned. If some part has color Red together with some other color, an error is
raised. The existence of some part that has no color Red but has multiple non-Red
colors does not trigger an error.//part[color eq "Red"]
. An implementation might
choose to rewrite this expression as //part[color = "Red"][color eq
"Red"]
. The implementation might then process the expression as follows:
First process the "=
" predicate by probing an index on parts by color to
quickly find all the parts that have a Red color; then process the "eq
"
predicate by checking each of these parts to make sure it has only a
single color. The result would be as follows:
The expression in the following example cannot raise a casting error if it is evaluated exactly as written (i.e., left to right). Since neither predicate depends on the context position, an implementation might choose to reorder the predicates to achieve better performance (for example, by taking advantage of an index). This reordering could cause the expression to raise an error.
To avoid unexpected errors caused by expression rewrite, tests that are designed to prevent dynamic errors should be expressed using conditional expressions. For example, the above expression can be written as follows:
This section explains some concepts that are important to the processing of XPath 3.0 expressions.
An ordering called
Within a tree, document order satisfies the following constraints:
The root node is the first node.
Every node occurs before all of its children and descendants.
Namespace nodes immediately follow the element node with
which they are associated. The relative order of namespace nodes is
stable but
Attribute nodes immediately follow the
The relative order of siblings is the order in which they occur
in the children
property of their parent node.
Children and descendants occur before following siblings.
The relative order of nodes in distinct trees is stable but
The semantics of some
XPath 3.0 operators depend on a process called fn:data
function
on the sequence, as defined in
The semantics of
fn:data
are repeated here for convenience. The result of
fn:data
is the sequence of atomic values produced by
applying the following rules to each item in the input
sequence:
If the item is an atomic value, it is returned.
If the item is a node,
its
If the item is a
Atomization is used in processing the following types of expressions:
Arithmetic expressions
Comparison expressions
Function calls and returns
Cast expressions
Under certain circumstances (listed below), it is necessary to find
the fn:boolean
function to the value, as
defined in
The dynamic semantics of fn:boolean
are repeated here for convenience:
If its operand is an empty sequence, fn:boolean
returns false
.
If its operand is a sequence whose first item is a node, fn:boolean
returns true
.
If its operand is a xs:boolean
or derived from xs:boolean
, fn:boolean
returns the value of its operand unchanged.
If its operand is a xs:string
, xs:anyURI
, xs:untypedAtomic
, or a type derived from one of these, fn:boolean
returns false
if the operand value has zero length; otherwise it returns true
.
If its operand is a fn:boolean
returns false
if the operand value is NaN
or is numerically equal to zero; otherwise it returns true
.
In all other cases, fn:boolean
raises a type error [err:FORG0006].
The
Logical expressions (and
, or
)
The fn:not
function
Certain types of a[b]
Conditional expressions (if
)
Quantified expressions (some
, every
)
General comparisons, in
The definition of xs:boolean
, for example in a cast
expression or when passing a value to a function whose expected
parameter is of type xs:boolean
.
XPath 3.0 has a set of functions that provide access to
input data. These functions are of particular importance because they provide a way in which an expression can reference a document or a collection of documents. The input functions are described informally here; they are defined in
An expression can access input data either by calling one
of the input functions or by referencing some part of the
The input functions supported by XPath 3.0 are as follows:
The fn:doc
function takes a string containing a URI. If that URI is associated with a document in fn:doc
returns a document node whose content is the
The fn:unparsed-text
function takes a string containing a URI, which must identify a resource that can be read as text; otherwise it raises a
The fn:environment-variable
and fn:available-environment-variables
identify environment variables that are available in the dynamic context.
The fn:collection
function with one argument takes a string containing a URI.
If that URI is associated with a collection in fn:collection
returns the data model representation of that collection; otherwise it raises a fn:collection("http://example.org")//customer
identifies all the customer
elements that are
descendants of nodes found in the collection whose URI is
http://example.org
.
The fn:collection
function with zero arguments returns the
The fn:uri-collection
function returns a sequence of xs:anyURI
values representing the URIs in a resource collection.
The fn:uri-collection
function with zero arguments returns the URIs in the
These input functions are all specified in
XPath 3.0 requires a statically known, valid URI in a xs:anyURI
The xs:anyURI
type is designed to anticipate the introduction of
Internationalized Resource Identifiers (IRI's) as defined in
A Braced URI Literal or URI Literal is subjected
to whitespace normalization as defined for the
xs:anyURI
type in
Whitespace is normalized using the whitespace normalization rules
of fn:normalize-space
. If the result of whitespace
normalization contains only whitespace, the corresponding URI
consists of the empty string.
A Braced URI Literal or URI Literal is not
$rel
against a
base URI $base
is to expand it to an absolute URI,
as if by calling the function fn:resolve-uri($rel,
$base)
.
Any process that attempts to
The type system of XPath 3.0 is based on
xs:NOTATION
or xs:anyAtomicType
, in which case its derived
types can be so used). Every schema type is either a
{variety}
is union
, (2) the {facets}
property is empty, (3) no type in the transitive membership of the union type has {variety}
list
, and (4) no type in the transitive membership of the union type is a type with {variety}
union
having a non-empty {facets}
property
The definition of
The current (second) edition of XML Schema 1.0 contains an error in respect of the substitutability of a union type by one of its members: it fails to recognize that this is unsafe if the union is derived by restriction from another union.
This problem is fixed in XSD 1.1, but the effect of the resolution is that an atomic value labeled with an atomic type cannot be treated as being substitutable for a union type without explicit validation. This specification therefore allows union types to be used as item types only if they are defined directly as the union of a number of atomic types.
xs:integer
or my:hatsize
, is both a
The http://www.w3.org/2001/XMLSchema
,
represented in this document by the namespace prefix
xs
. The schema types in this namespace are defined in xs:dateTimeStamp
type.
The schema types defined in
xs:untyped
is used as the skip
mode.xs:untyped
.
xs:untypedAtomic
is an atomic type that is used to denote untyped atomic data, such as text that has not been assigned a more specific type.skip
mode is represented in the xs:untypedAtomic
. No predefined schema types are derived from xs:untypedAtomic
.
xs:dayTimeDuration
is derived by restriction from xs:duration
. The lexical representation of xs:dayTimeDuration
is restricted to contain only day, hour, minute, and second
components.
xs:yearMonthDuration
is derived by restriction from xs:duration
. The lexical representation of xs:yearMonthDuration
is
restricted to contain only year and month
components.
xs:anyAtomicType
is an atomic type that includes all atomic values (and no values that
are not atomic). Its base type is
xs:anySimpleType
from which all simple types, including atomic,
list, and union types, are derived. All primitive atomic types, such as
xs:decimal
and xs:string
, have xs:anyAtomicType
as their base type.
xs:anyAtomicType
will not appear as the type of an actual value in an
xs:error
is a simple type with no value space, defined in
The relationships among the schema types in the xs
namespace are illustrated in Figure 2. A more complete description of the XPath 3.0 type hierarchy can be found in
Figure 2: Hierarchy of Schema Types used in XPath 3.0.
xs:QName
, xs:NOTATION
, types
derived by restriction from xs:QName
or
xs:NOTATION
, list types that have a namespace-sensitive
item type, and union types with a namespace-sensitive type in their
transitive membership.
It is not possible to preserve the type of a [err:FONS0004]
Every node has a fn:data
function to
the node.fn:string
function to the node.fn:data
and fn:string
can be found in
An implementation may store both the xs:integer
value 30
, its string value might be "30
" or "0030
".
The
As a convenience to the reader, the relationship between
For text and document nodes, the typed value of the node is the same as its
string value, as an instance of the type xs:untypedAtomic
. The
string value of a document node is formed by concatenating the string
values of all its descendant text nodes, in
The typed value of a commentxs:string
.
The typed value of an attribute node with
the xs:anySimpleType
or xs:untypedAtomic
is the same as its
string value, as an instance of xs:untypedAtomic
. The
typed value of an attribute node with any other type annotation is
derived from its string value and type annotation using the lexical-to-value-space mapping defined in
Example: A1 is an attribute
having string value "3.14E-2"
and type annotation
xs:double
. The typed value of A1 is the
xs:double
value whose lexical representation is
3.14E-2
.
Example: A2 is an attribute with type
annotation xs:IDREFS
, which is a list datatype whose item type is the atomic datatype xs:IDREF
. Its string value is
"bar baz faz
". The typed value of A2 is a sequence of
three atomic values ("bar
", "baz
",
"faz
"), each of type xs:IDREF
. The typed
value of a node is never treated as an instance of a named list
type. Instead, if the type annotation of a node is a list type (such
as xs:IDREFS
), its typed value is treated as a sequence
of the xs:IDREF
).
For an element node, the
relationship between typed value and string value depends on the
node's
If the type annotation is xs:untyped
or xs:anySimpleType
or
denotes a complex type with mixed content (including xs:anyType
), then the typed value of the
node is equal to its string value, as an instance of
xs:untypedAtomic
. However, if the nilled
property of the node is true
, then its typed value is the empty sequence.
Example: E1 is an element node
having type annotation xs:untyped
and string value
"1999-05-31
". The typed value of E1 is
"1999-05-31
", as an instance of
xs:untypedAtomic
.
Example: E2 is an element node
with the type annotation formula
, which is a complex type
with mixed content. The content of E2 consists of the character
"H
", a child element named subscript
with
string value "2
", and the character "O
". The
typed value of E2 is "H2O
" as an instance of
xs:untypedAtomic
.
If the type
annotation denotes a simple type or a complex type with simple
content, then the typed value of the node is derived from its string
value and its type annotation in a way that is consistent with schema
validation. However, if the nilled
property of the node is true
, then its typed value is the empty sequence.
Example: E3 is an element node with the type
annotation cost
, which is a complex type that has several
attributes and a simple content type of xs:decimal
. The
string value of E3 is "74.95
". The typed value of E3 is
74.95
, as an instance of
xs:decimal
.
Example: E4 is an element node with the
type annotation hatsizelist
, which is a simple type
derived from the atomic type hatsize
, which in turn is
derived from xs:integer
. The string value of E4 is
"7 8 9
". The typed value of E4 is a sequence of three
values (7
, 8
, 9
), each of type
hatsize
.
Example: E5 is an element node with the type annotation my:integer-or-string
which is a union type with member types xs:integer
and xs:string
. The string value of E5 is "47
". The typed value of E5 is 47
as an xs:integer
, since xs:integer
is the member type that validated the content of E5. In general, when the type annotation of a node is a union type, the typed value of the node will be an instance of one of the member types of the union.
If an implementation stores only the string value of a node, and the type annotation of the node is a union type, the implementation must be able to deliver the typed value of the node as an instance of the appropriate member type.
If the type annotation denotes a complex type with empty content, then the typed value of the node is the empty sequence and its string value is the zero-length string.
If the type annotation
denotes a complex type with element-only content, then the typed value
of the node is fn:data
function raises a
[err:FOTY0012]
when applied to such a node. The string value of such a node is equal to the concatenated string values of all its text node descendants, in document order.
Example: E6 is an
element node with the type annotation weather
, which is a
complex type whose content type specifies
element-only
. E6 has two child elements named
temperature
and precipitation
. The typed
value of E6 is fn:data
function
applied to E6 raises an error.
Whenever it is necessary to refer to a type in an XPath 3.0 expression, the
With the exception of the special type
empty-sequence()
, a item()
,
which permits any kind of item, item types divide into element()
), xs:integer
) and function types
(such as function() as item()*).
eq
operator.
Item types representing element
and attribute nodes may specify the required element(*, us:address)
denotes any element node whose type annotation is (or is derived from)
the schema type named us:address
.
The occurrence indicators '+', '*', and '?' bind to the last
Here are some examples of
xs:date
refers to the built-in atomic schema type named xs:date
attribute()?
refers to an optional attribute node
element()
refers to any element node
element(po:shipto, po:address)
refers to an element node that has the name po:shipto
and has the type annotation po:address
(or a schema type derived from po:address
)
element(*, po:address)
refers to an element node of any name that has the type annotation po:address
(or a type derived from po:address
)
element(customer)
refers to an element node named customer
with any type annotation
schema-element(customer)
refers to an element node whose name is customer
(or is in the substitution group headed by customer
) and whose type annotation matches the schema type declared for a customer
element in the
node()*
refers to a sequence of zero or more nodes of any kind
item()+
refers to a sequence of one or more
function(*)
refers to any
function(node()) as xs:string*
refers to a
(function(node()) as xs:string)*
refers to a sequence of zero or more
instance of
expression returns true
if the false
if it does not.
An XPath 3.0 implementation must be able to determine relationships among the types in type annotations in an
Some of the rules for
the in-scope schema definitions in the static context .
potentially, the schema used for validating the instance
document; whether a processor adds this schema to
potentially, further schema components that have been made
available to the processor in an
A type error
Whether the schema used to validate the instance document is in
xs:integer
value is used where an
xs:decimal
value is expected, the value retains its type
as xs:integer
.
The definition of derives-from(
)
, which takes an actual simple or complex
schema type
derives-from(
)
raises a type error
There is a type derives-from(
)
returns true
derives-from(
)
and derives-from(
)
Formally, it returns true
if
Otherwise, derives-from(
)
returns false
The rules for
The empty-sequence()
matches a value that is the empty sequence.
An
An
An
?
matches zero or one items
*
matches zero or more items
+
matches one or more items
As a consequence of these rules, any *
or ?
matches a
value that is an empty sequence.
An derives-from(
)
is true
.
derives-from()
is defined for both union types and atomic types.
The name of an
Example: The xs:decimal
matches any value of type
xs:decimal
. It also matches any value of type
shoesize
, if shoesize
is an atomic type
derived by restriction from xs:decimal
.
Example: Suppose dress-size
is a union type that allows
either xs:decimal
values for numeric sizes (e.g. 4, 6, 10, 12),
or one of an enumerated set of xs:strings
(e.g. "small", "medium", "large"). The dress-size
matches any of these values.
The names of non-atomic
types such as xs:IDREFS
are not accepted in this context,
but can often be replaced by a xs:IDREF+
.
item()
matches
any single
Example: item()
matches the atomic
value 1
, the element <a/>
, or the functionfn:concat#3
.
node()
matches any node.
text()
matches any
text node.
processing-instruction()
matches any processing-instruction
node.
processing-instruction(
)
matches any processing-instruction node whose PITarget is equal to fn:normalize-space(N)
. If fn:normalize-space(N)
is not in the lexical space of NCName, a type error is raised
Example:
processing-instruction(xml-stylesheet)
matches any
processing instruction whose PITarget is
xml-stylesheet
.
For backward compatibility with
XPath 1.0, the PITarget of a
processing instruction may also be expressed as a
string literal, as in this example:
processing-instruction("xml-stylesheet")
.
If the specified PITarget is not a syntactically valid NCName, a type error is raised
comment()
matches any comment node.
namespace-node()
matches any
namespace node.
document-node()
matches any document
node.
document-node(
)
matches any document node that contains exactly one element node, optionally accompanied by one or more comment and processing instruction nodes, if
Example:
document-node(element(book))
matches a document node
containing
exactly one element node that is matched by the ElementTest
element(book)
.
A
An
An
The
An
element()
and
element(*)
match any
single element node, regardless of its name or
type annotation.
element(
)
matches any element node whose name is nilled
property.
Example: element(person)
matches any element node whose name is person
.
element(
,
)
matches an element node whose name is derives-from(
)
is true
, where nilled
property of the node is false
.
Example: element(person, surgeon)
matches a
non-nilled element node whose name is person
and whose
type annotation is surgeon
(or is derived from surgeon
).
element(
?)
matches an element node whose name is derives-from(
)
is true
, where nilled
property of the node may be either true
or false
.
Example: element(person, surgeon?)
matches a nilled or non-nilled element node whose name is person
and whose type
annotation is surgeon
(or is derived from surgeon
).
element(*,
)
matches an element
node regardless of its name, if
derives-from(
)
is
true
, where nilled
property of the node is false
.
Example: element(*, surgeon)
matches any non-nilled element node whose type annotation is
surgeon
(or is derived from surgeon
), regardless of its name.
element(*,
?)
matches an element
node regardless of its name, if
derives-from(
)
is
true
, where nilled
property of the node may be either true
or false
.
Example: element(*, surgeon?)
matches any nilled or non-nilled element node whose type annotation is
surgeon
(or is derived from surgeon
), regardless of its name.
A
The
A
The name of the candidate node matches the specified
derives-from(
)
is true
, where
If the nillable
, then the
nilled
property of the candidate node is false
.
Either:
The name
The name
The term "actual substitution group" is defined in
The schema element declaration named
derives-from( AT, ET )
is true, where
If the schema element declaration named
Example: The customer is a top-level element declaration in the in-scope element declarations; the name of the candidate node is customer; the element declaration of customer is not abstract; the type annotation of the candidate node is the same as or derived from the schema type declared in the customer element declaration; and either the candidate node is not nilled, or customer is declared to be nillable. customer is a top-level element declaration in the in-scope element declarations; the name of the candidate node is client; client is an actual (non-abstract and non-blocked) member of the substitution group of customer; the type annotation of the candidate node is the same as or derived from the schema type declared for the client element; and either the candidate node is not nilled, or client is declared to be nillable.schema-element(customer)
matches a candidate element node
customer
is a top-level element declaration in the customer
or is in a customer
, the type annotation of the candidate node is the same as or derived from the schema type declared for the customer
element, and either the candidate node is not nilled
or customer
is declared to be nillable
.
An
The
An
attribute()
and attribute(*)
match any single attribute node,
regardless of its name or type annotation.
attribute(
)
matches any attribute node whose name is
Example: attribute(price)
matches any attribute node whose name is price
.
attribute(
)
matches an attribute node whose name is derives-from(
)
is true
, where
Example: attribute(price, currency)
matches an
attribute node whose name is price
and whose type
annotation is
currency
(or is derived from currency
).
attribute(*,
)
matches an attribute
node regardless of its name, if
derives-from(
)
is
true
, where
Example:
attribute(*, currency)
matches any attribute node whose
type annotation is currency
(or is derived from currency
), regardless of its
name.
A
The
A
The name of the candidate node matches the specified
derives-from(
)
is true
, where
Example: The schema-attribute(color)
matches a candidate attribute node if color
is a top-level attribute declaration in the color
, and the type annotation of the candidate node is the same as or derived from the schema type declared for the color
attribute.
A
Here are some examples of
function(*)
matches any
function(int, int) as int
matches any function(int, int) as int
.
Given two A
is a B
if the judgement subtype(A, B)
is true.subtype(A, B)
is true, it is always the case that for any value V
, (V instance of A)
implies (V instance of B)
.
The converse is not necessarily true: for example every
instance of union(P, Q)
is also an instance of
union(P, Q, R)
, but there is no subtype relationship
between these two types.
subtype(A, B)
The judgement subtype(A, B)
determines if the A
is a B
.
A
can either be empty-sequence()
xs:error
,Ai
, possibly followed by an occurrence indicator. Similarly
B
can either be empty-sequence()
xs:error
,Bi
, possibly followed by an occurrence indicator.
The result of the subtype(A, B)
judgement can be determined from the table below, which makes use of the auxiliary judgement subtype-itemtype(Ai, Bi)
defined
in
B
| |||||||
---|---|---|---|---|---|---|---|
empty-sequence()
|
Bi?
|
Bi*
|
Bi
|
Bi+
| xs:error | ||
A
|
empty-sequence()
| true | true | true | false | false | false |
Ai?
| false |
subtype-itemtype(Ai, Bi)
|
subtype-itemtype(Ai, Bi)
| false | false | false | |
Ai*
| false | false |
subtype-itemtype(Ai, Bi)
| falsetrue when Ai is a pure union type with no member types) | false | false | |
Ai
| false |
subtype-itemtype(Ai, Bi)
|
subtype-itemtype(Ai, Bi)
|
subtype-itemtype(Ai, Bi)
|
subtype-itemtype(Ai, Bi)
| false | |
Ai+
| false | false |
subtype-itemtype(Ai, Bi)
| false |
subtype-itemtype(Ai, Bi)
| false | |
xs:error
| true | true | true | true | true | true |
xs:error+
is treated the same way as xs:error
in the above table. xs:error?
and xs:error*
are treated the same way as empty-sequence()
.
xs:error
is a pure union type with no member types; this is the main motivation for the exception noted in the above table.
subtype-itemtype(Ai, Bi)
The judgement subtype-itemtype(Ai, Bi)
determines if the Ai
is a Bi
. Ai
is a subtype of Bi
if and only if at least one of the following conditions applies:
Ai
and Bi
are derives-from(Ai, Bi)
returns true
.
Ai
and Bi
are both t
in the transitive membership of Ai
is also in the transitive membership of Bi
.
Ai
is a pure union type,
and every type t
in the transitive membership of Ai
satisfies subtype-itemType(t, Bi)
.
Ai
is xs:error
and Bi
is a
Bi
is item()
.
Bi
is node()
, and Ai
is a
Bi
is text()
and Ai
is also text()
.
Bi
is comment()
and Ai
is also comment()
.
Bi
is namespace-node()
and Ai
is also namespace-node()
.
Bi
is processing-instruction()
and Ai
is either processing-instruction()
or
processing-instruction(N)
for any name N.
Bi
is processing-instruction(Bn)
, and Ai
is also processing-instruction(Bn)
.
Bi
is document-node()
and Ai
is either document-node()
or
document-node(E)
for any
Bi
is document-node(Be)
and Ai
is document-node(Ae)
, and subtype-itemtype(Ae, Be)
.
Bi
is either element()
or element(*)
, and Ai
is an
Bi
is either element(Bn)
or element(Bn, xs:anyType?)
,
the An
equals the Bn
,
and Ai
is either element(An)
,
or element(An, T?)
for any type T.
Bi
is element(Bn, Bt)
,
the An
equals the Bn
,
Ai
is element(An, At)
, and derives-from(At, Bt)
returns true
.
Bi
is element(Bn, Bt?)
,
the An
equals the Bn
,
Ai
is either element(An, At)
or element(An, At?)
,
and derives-from(At, Bt)
returns true
.
Bi
is element(*, Bt)
, Ai
is either element(*, At)
or element(N, At)
for any name N, and derives-from(At, Bt)
returns true
.
Bi
is element(*, Bt?)
, Ai
is either element(*, At)
, element(*, At?)
, element(N, At)
, or element(N, At?)
for any name N, and derives-from(At, Bt)
returns true
.
The fact that Bi
is schema-element(Bn)
,
Ai
is schema-element(An)
,
and every element declaration that is an actual member of the substitution group of An
is also an actual member of the substitution group of Bn
.
P
is a member of the substitution group of Q
does not mean that every element declaration in the substitution group of P
is also in the substitution group of Q
. For example, Q
might block substitution of elements whose type is derived by extension, while P
does not.
Bi
is either attribute()
or attribute(*)
, and Ai
is an
Bi
is either attribute(Bn)
or attribute(Bn, xs:anyType)
,
the An
equals the Bn
,
and Ai
is either attribute(An)
, or attribute(An, T)
for any type T.
Bi
is attribute(Bn, Bt)
,
the An
equals the Bn
,
Ai
is attribute(An, At)
,
and derives-from(At, Bt)
returns true
.
Bi
is attribute(*, Bt)
, Ai
is either attribute(*, At)
, or attribute(N, At)
for any name N, and derives-from(At, Bt)
returns true
.
Bi
is schema-attribute(Bn)
,
the An
equals the Bn
,
and Ai
is schema-attribute(An)
.
Bi
is function(*)
.
Bi
is function(Ba_1, Ba_2, ... Ba_N) as Br
,
Ai
is function(Aa_1, Aa_2, ... Aa_M) as Ar
,
where
;
N
(arity of Bi) equals M
(arity of Ai);
subtype(Ar, Br)
;
I
between 1 and N
, subtype(Ba_I, Aa_I)
.
Function return types are covariant because this rule invokes subtype(Ar, Br) for return types. Function arguments are contravariant because this rule invokes subtype(Ba_I, Aa_I) for arguments.
The type xs:error
has an empty value space; it never appears as a dynamic type or as the content type of a dynamic element or attribute type.
xs:error
offers an alternative way of raising errors, in addition to fn:error.
A cast to xs:error
raises an error or returns the empty sequence. Promotion to xs:error
is not possible.
Neither xs:error
nor xs:error+
can ever match a value. xs:error
is a subtype of all simple types, and a supertype only of itself.
xs:error?
and xs:error*
are identical to empty-sequence(). A variable binding with a type declaration xs:error always raises a type error.
xs:error
appears always raises a type error
Comments may be used to provide
Comments are strings, delimited by the symbols (:
and :)
. Comments may be nested.
A comment may be used anywhere
The following is an example of a comment:
This section discusses each of the basic kinds of expression. Each kind of expression has a name such as PathExpr
, which is introduced on the left side of the grammar production that defines the expression. Since XPath 3.0 is a composable language, each kind of expression is defined in terms of other expressions whose operators have a higher precedence. In this way, the precedence of operators is represented explicitly in the grammar.
The order in which expressions are discussed in this document does not reflect the order of operator precedence. In general, this document introduces the simplest kinds of expressions first, followed by more complex expressions. For the complete grammar, see Appendix [
The XPath 3.0 operator that has lowest precedence is the
The symbol
After the comma, the expressions that have next lowest precedence are
The value of a .
" and no e
or E
character is an atomic value of type xs:integer
. The value of a numeric literal containing ".
" but no e
or E
character is an atomic value of type xs:decimal
. The value of a numeric literal containing an e
or E
character is an atomic value of type xs:double
. The value of the numeric literal is determined by casting it to the
appropriate type according to the rules for casting from xs:untypedAtomic
to a numeric type as specified in
The value of a xs:string
and whose value is the string denoted by the characters between the
delimiting apostrophes or quotation marks. If the literal is delimited by apostrophes, two adjacent apostrophes within the literal are interpreted as a single apostrophe. Similarly, if the literal is delimited by quotation marks, two adjacent quotation marks within the literal are interpreted as one quotation mark.
Here are some examples of literal expressions:
"12.5"
denotes the string containing the characters '1', '2', '.', and
'5'.
12
denotes the xs:integer
value twelve.
12.5
denotes the xs:decimal
value twelve and one half.
125E2
denotes the xs:double
value twelve thousand, five hundred.
"He said, ""I don't like it."""
denotes a string containing two quotation marks and one apostrophe.
When XPath expressions are embedded in contexts where quotation marks have special significance, such as inside XML attributes, additional escaping may be needed.
The xs:boolean
values true
and false
can be constructed by calls to the
fn:true()
and fn:false()
, respectively.
Values of other atomic types can be constructed by
calling the
xs:integer("12")
returns the integer value twelve.
xs:date("2001-08-25")
returns an item whose type is xs:date
and whose value represents the date 25th August 2001.
xs:dayTimeDuration("PT5H")
returns an item whose type is xs:dayTimeDuration
and whose value represents a duration of five hours.
Constructor functions can also be used to create special values that have no literal representation, as in the following examples:
xs:float("NaN")
returns the special floating-point value, "Not a Number."xs:double("INF")
returns the special double-precision value, "positive infinity."
Constructor functions are available for all my:dt
is a user-defined union
type whose member types are xs:date
, xs:time
, and xs:dateTime
, then
the expression my:dt("2011-01-10")
creates an atomic value of type
xs:date
. The rules follow XML Schema validation rules for union types:
the effect is to choose the first member type that accepts the given
string in its lexical space.
It is also possible to construct values of various types by using a cast
expression. For example:
9 cast as
hatsize
returns the atomic value 9
whose type is hatsize
.
eq
operator).
Every variable reference must match a name in the
The
A variable may be bound by an XPath 3.0 expression. for
expressions (
Every variable binding has a static scope. The scope defines where
references to the variable can validly occur.
It is a
Parentheses may be used to override the precedence rules.
For example, the expression (2 + 4)
* 5
evaluates to thirty, since the parenthesized expression (2 + 4)
is evaluated first and its result is multiplied by five. Without
parentheses, the expression 2 + 4 * 5
evaluates to twenty-two, because the multiplication operator has higher
precedence than the addition operator.
Empty parentheses are used to denote an empty sequence, as
described in
A fn:doc("bib.xml")/books/book[fn:count(./author)>1]
),
or an atomic value or function(1 to
100)[. mod 5 eq 0]
).
If the
If the
Evaluation of
Since the arguments of a function call are separated by commas, any
my:three-argument-function(1,
2, 3)
denotes a
my:two-argument-function((1,
2), 3)
denotes a
my:two-argument-function(1,
())
denotes a
my:one-argument-function((1, 2,
3))
denotes a
my:one-argument-function(( ))
denotes a
my:zero-argument-function( )
denotes a
The result of a function call on a function or $f
(including
When a static or dynamic function call FC is evaluated
with respect to
Argument
s
in an ArgumentList
is its
The function to be called or partially applied (call it F) is obtained as follows:
If FC is a static function call:
Using
the expanded QName corresponding to FC's EQName
,
and
the arity of FC's ArgumentList
,
the corresponding function
is looked up
in the
If FC is a dynamic function call:
FC's base expression is evaluated with respect to ArgumentList
,
let F denote that function.
Otherwise, a type error is raised
Each argument value is converted
If the value of any $f
by applying the
The remainder depends on whether or not FC
is a
If FC is a partial function application:
ArgumentList
has an argument expression
(as opposed to an ArgumentPlaceholder
).
A $new
$new
is the same as $f
,
removing the parameters in the positions for which any $new
is the arity of $f
minus the number of argument expressions provided.
$f
with the argument expressions from the invocation of $new
, inserting any
The static context for evaluation of the function item $f
is inherited from the location of the partial function application expression,
with the exception of the static type of the context item which is initially
Partially applied function items cannot access the
If FC is not a partial function application:
If $f
is a built-in function, it is evaluated using the converted argument values.
The result is either an instance of the function's declared return type or a dynamic error.
Errors raised by built-in functions are defined in
If F's implementation is
F's implementation is invoked with the
converted argument values
The result is either an instance of F's return type or a dynamic error. This result is then the result of evaluating FC.
Errors raised by built-in functions are defined in
Errors raised by external functions are
Errors raised by host-language-dependent functions
If $f
is an $f
, and the function body is
evaluated. The value returned by the function body is
then converted to the declared return type of
$f
by applying the
If F's implementation is a FunctionBody
:
The FunctionBody
's static and dynamic contexts are augmented as follows:
The FunctionBody
is evaluated.
The dynamic context for this evaluation is obtained
by taking the dynamic context of the
InlineFunctionExpr
FunctionBody
, and
making the following changes:
The static context of the FunctionBody
is as defined in
In the
When
$p
of type xs:decimal
can be invoked with an argument of type xs:integer
,
which is derived from xs:decimal
.
During the processing of this function
$p
inside the body of the function
is considered to be xs:integer
.
If $f
is a
F's nonlocal variable bindings
are also added to the
QueryBody
of the main module.
The value returned by evaluating the function body
is then converted to the declared return type of F
by applying the
xs:decimal
may in fact return a value of dynamic type xs:integer
.
true
and an
argument
If the expected type calls for a single item or optional single item (examples: xs:string
, xs:string?
, xs:untypedAtomic
, xs:untypedAtomic?
, node()
, node()?
, item()
, item()?
), then the value V is effectively replaced by V[1].
If the expected type is
xs:string
or xs:string?
,
then the value V
is effectively
replaced by
fn:string(V)
.
If
the expected type is xs:double
or xs:double?
, then the value V
is effectively replaced by
fn:number(V)
.
If the expected type is a sequence of a *
, +
, or ?
), the following conversions are applied:
Each item in the atomic
sequence that is of type
xs:untypedAtomic
is cast to the expected xs:untypedAtomic
are cast to xs:double
. xs:untypedAtomic
and the expected type is
For each
For each item of type xs:anyURI
in the atomic sequence that can be
If the
expected type is a *
,
+
, or ?
),
If, after the
above conversions, the resulting value does not match
the expected type according to the rules for
Function
Function
$function
$function
Annotations
is set to the annotations of F. TypedFunctionTest
is set to the expected type.
$function
with the arguments that were specified at the new
function's invocation.
FunctionBody
that calls F,
passing it the parameters of this new function,
in order.
If the result of invoking the new function
These rules have the following consequences:
SequenceType matching of the function
The function conversion rules applied to the function
If an implementation has static type information about a function
The function
The function conversion rules result in applying function coercion to
$p is matched against the SequenceType of
When $p is invoked inside the predicate, function conversion and SequenceType matching rules are applied to the context item argument,
resulting in an
$f is invoked with the
$p applies function conversion rules to the result sequence from $f, which already matches its declared return type of
The $f
has a static type of function(item()*) as item()*
. When the local:filter()
function
is called, the following occurs to the function$f
,
wrapping $f in a new function(xs:string) as xs:boolean
.
function(xs:string) as xs:boolean
, and succeeds.
xs:string
value or a type error.
xs:string
, which returns an xs:boolean
.
xs:boolean
.
xs:boolean
is returned as the result of $p.
Although the semantics of function
The result of a $f
is computed as follows:
...
If the EQName is a
If the
The result of a
An empty set of variable values.
The name specified in the
The
The implementation of the function from the static context that matches the name and arity given.
The value of a NamedFunctionRef
is the function obtained by looking up
the expanded QName and arity
in the
Furthermore, if the function referenced by a
NamedFunctionRef
has an implementation-dependent
implementation, then the implementation of the function
returned by the NamedFunctionRef
is associated with the
static context of this NamedFunctionRef
expression and to
the dynamic context in which it is currently being
evaluated.
NamedFunctionRef
is a
It is a static error if the function
referenced by a NamedFunctionRef
is a
Certain functions in the
fn:abs
fn:ceiling
fn:floor
fn:round
fn:round-half-to-even
The above way of modeling polymorphic functions is semantically backwards compatible with
The following are examples of
fn:abs#1
references the fn:abs function which takes a single argument.
fn:concat#5
references the fn:concat function which takes 5 arguments.
local:myfunc#2
references a function named local:myfunc which takes 2 arguments.
If a function parameter is declared using a name but no type, its default type is item()*. If the result type is omitted from an inline function expression, its default result type is item()*.
The parameters of an inline function expression are considered to be variables whose scope is the function body. It is a static error
The static context for the function body is inherited from the location of the inline function expression, with the exception of the
static type of the context item which is initially
The variables in scope for the function body include all variables representing the function parameters, as well as all variables that
are in scope for the inline function expression.
Function parameter names can mask variables that would otherwise be in scope for the function body.
The result of an inline function
InlineFunctionExpr
's
ParamList
.
FunctionTest
constructed from the
SequenceType
s in the InlineFunctionExpr
.
InlineFunctionExpr
's FunctionBody
.
InlineFunctionExpr
.
The following are examples of some inline function
This example creates a
This example creates a
This example creates a
This example creates a sequence of function
E1[E2]
)
is referred to as a E1
that
satisfy the predicate in E2.
An expression (other than a raw EQName) followed by an argument
list in parentheses (that is, E1(E2, E3, ...)
) is
referred to as a E1
to obtain a functionE2
, E3
, ...
as
arguments. Dynamic function
A filter expression consists of a base expression followed by a predicate, which is an expression written in square brackets. The result of the filter expression consists of the items returned by the base expression, filtered by applying the predicate to each item in turn. The ordering of the items returned by a filter expression is the same as their order in the result of the primary expression.
Where the expression before the square brackets is a
Here are some examples of filter expressions:
Given a sequence of products in a variable, return only those products whose price is greater than 100.
List all the integers from 1 to 100 that are divisible by 5. (See to
operator.)
The result of the following expression is the integer 25:
The following example returns the fifth through ninth items in the sequence bound to variable $orders
.
The following example illustrates the use of a filter expression as a $book
:
For each item in the input sequence, the predicate expression
is evaluated using an
For each item in the input sequence, the result of the
predicate expression is coerced to an xs:boolean
value, called the true
are retained, and those for which the
predicate truth value is false
are discarded.
The predicate truth value is derived by applying the following rules, in order:
If the value of the predicate expression is a true
if the value
of the predicate expression is equal (by the
eq
operator) to the false
otherwise.
Otherwise, the predicate truth value is the
If the PrimaryExpr does not return a sequence consisting of a single function item with the same
arity as the number of specified arguments, a type error is raised
A dynamic function invocation is a
A dynamic function invocation that is not a
A dynamic function call
is evaluated as described in
The following are examples of some dynamic function
This example invokes the function
This example fetches the second item from sequence $f, treats it as a functionxs:string
argument:
This example invokes the function
/
" or
"//
", and optionally beginning with
"/
" or "//
"./
" or "//
" is an abbreviation for
one or more initial steps that are implicitly added to the
beginning of the path expression, as described below.
A
path expression consisting of a single step is evaluated as
described in
A "/
"
at the beginning of a path expression is an abbreviation for
the initial step
(however, if the
"/
" is the entire path expression, the trailing "/
" is omitted from the expansion.) The effect
of this initial step is to begin the path at the root node of
the tree that contains the context node. If the context item
is not a node, a
A "//
" at the beginning of a path expression
is an abbreviation for the initial steps
(however, "//
" by itself is not a valid path expression
The descendants of a node do not include attribute
nodes
Relative path expressions are binary operators on step expressions, which are named E1
and E2
in this section.
Each non-initial occurrence of "//
" in a path expression is
expanded as described in /
" !
", which have the same precedenceE1
is used as the E2
; the sequences resulting from all the evaluations of E2
are combined to produce a result.
The following example illustrates the use of relative path expressions.
child::div1/child::para
Selects the
para
element children of the div1
element children of the context node; that is, the
para
element grandchildren of the context node
that have div1
parents.
Since each step in a path provides context nodes for the following step, in effect, only the last step in a path is allowed to return a sequence of non-nodes.
The "/
" character
can be used either as a complete path expression or as the
beginning of a longer path expression such as
"/*
". Also, "*
"
is both the multiply operator and a wildcard in path
expressions. This can cause parsing difficulties when
"/
" appears on the left-hand side of
"*
". This is resolved using the /*
" and "/
*
" are valid path expressions containing wildcards,
but "/*5
" and "/ * 5
" raise syntax
errors. Parentheses must be used when "/
" is
used on the left-hand side of an operator, as in "(/) * 5
". Similarly, "4 + / *
5
" raises a syntax error, but "4 + (/) * 5
" is a valid expression.
The expression "4 + /
" is also
valid, because /
does not occur on the left-hand
side of the operator.
Similarly, in the expression /
union /*
, "union" is interpreted as an element name
rather than an operator. For it to be parsed as an operator,
the expression should be written (/)
union /*
.
/
)The path operator "/" is used to build expressions for locating nodes within trees. Its left-hand side expression must return a sequence of nodes.
Each operation E1/E2
is evaluated as follows: Expression E1
is evaluated, and if the result is not a (possibly empty) sequence S
of nodes, a S
then serves in turn to provide an inner focus (the node as the context item, its position in S
as the context position, the length of S
as the context size) for an evaluation of E2
, as described in E2
are combined as follows:
If every evaluation of E2
returns a (possibly empty) sequence of nodes, these sequences are combined, and duplicate nodes are eliminated based on node identity.
If every evaluation of E2
returns a (possibly empty) sequence of non-nodes, these sequences are concatenated
If the multiple evaluations of E2
return at least one node and at least one non-node, a
The semantics of the path operator can also be defined using the simple mapping operator as follows (forming the union with an empty sequence ($R | ())
has the effect of eliminating duplicates and sorting nodes into document order):
In the
The unabbreviated syntax for an axis step consists of the axis name
and node test separated by a double colon. The result of the step consists of the nodes
reachable from the context node via the specified axis that have the node kind, name,
and/or child::para
selects the para
element children of the context node: child
is the name of the axis, and para
is the name of the element nodes to be selected on this axis. The available axes are described in
XPath defines a full set of
The child
axis
contains the children of the context
node, which are the nodes returned by
the dm:children
accessor
in
Only document
nodes and element
nodes have
children. If the
context node is any
other kind of node,
or if the context
node is an empty
document or element
node, then the child
axis is an empty
sequence. The
children of a
document node or
element node may be
element, processing
instruction,
comment, or text
nodes. Attribute
the descendant
axis is defined as the transitive closure of
the child axis; it contains the descendants
of the context node (the children, the children of the children, and so on)
the parent
axis contains the sequence
returned by the
dm:parent
accessor in
An attribute node may have an element node as its parent, even though the attribute node is not a child of the element node.
the
ancestor
axis is
defined as the transitive
closure of the parent axis; it
contains the ancestors of the
context node (the parent, the
parent of the parent, and so
on)
The ancestor axis includes the root node of the tree in which the context node is found, unless the context node is the root node.
the following-sibling
axis contains the context node's following
siblings, those children of the context
node's parent that occur after the context
node in following-sibling
axis is
empty
the preceding-sibling
axis contains the context node's preceding
siblings, those children of the context
node's parent that occur before the context
node in preceding-sibling
axis is
empty
the following
axis
contains all nodes that are
descendants of the root of the tree in
which the context node is found, are
not descendants of the context node,
and occur after the context node in
the preceding
axis
contains all nodes that are
descendants of the root of the tree in
which the context node is found, are
not ancestors of the context node, and
occur before the context node in
the attribute
axis
contains the attributes of the context node,
which are the nodes returned by the
dm:attributes
accessor in
the self
axis contains just the context node itself
the descendant-or-self
axis contains the context node and the descendants of the context
node
the ancestor-or-self
axis contains the context node and the ancestors of the context node;
thus, the ancestor-or-self axis will always include the root node
the namespace
axis
contains the namespace nodes of the
context node, which are the nodes
returned by the
dm:namespace-nodes
accessor in
namespace
axis is
deprecated true
, the namespace
axis must be supported. If false
, then support for the
namespace
axis is
namespace
axis when false
must raise
a fn:in-scope-prefixes
and
fn:namespace-uri-for-prefix
defined in
Axes can be categorized as
The parent
, ancestor
, ancestor-or-self
, preceding
, and preceding-sibling
axes are reverse axes; all other axes are forward axes. The ancestor
, descendant
, following
, preceding
and self
axes partition a document (ignoring attribute
For the attribute axis, the principal node kind is attribute.
For the namespace axis, the principal node kind is namespace.
For all other axes, the principal node kind is element.
eq
operator) to the
child::para
selects the para
element children of
the context node; if the context node has no
para
children, it selects an empty set
of nodes. attribute::abc:href
selects
the attribute of the context node with the QName
abc:href
; if the context node has no
such attribute, it selects an empty set of
nodes.
If the EQName is a
A name test is not satisfied by an element node whose name does not match the
A node test *
is true for any node of the
child::*
will select all element
children of the context node, and attribute::*
will select all
attributes of the context node.
A node test can have the form
NCName:*
. In this case, the prefix is
expanded in the same way as with a
A node test can contain a BracedURILiteral, e.g.
Q{http://example.com/msg}*
Such a node test is true for any node of the principal node kind of the step axis whose expanded QName has the namespace URI specified in the BracedURILiteral, regardless of the local part of the name.
A node test can also
have the form *:NCName
. In this case,
the node test is true for any node of the
node()
matches any
node.
text()
matches
any text
node.
comment()
matches any comment
node.
namespace-node()
matches any
namespace node.
element()
matches any element
node.
schema-element(person)
matches any element node whose name is
person
(or is in the person
), and whose type
annotation is the same as (or is derived from) the declared type of the person
element in the
element(person)
matches any element node whose name is
person
, regardless of its type annotation.
element(person, surgeon)
matches any non-nilled element node whose name
is person
, and whose type
annotation is
surgeon
or is derived from surgeon
.
element(*,
surgeon)
matches any non-nilled element node whose type
annotation is surgeon
(or is derived from surgeon
), regardless of
its
name.
attribute()
matches any
attribute node.
attribute(price)
matches
any attribute whose name is price
,
regardless of its type annotation.
attribute(*,
xs:decimal)
matches any attribute whose type
annotation is xs:decimal
(or is derived from xs:decimal
), regardless of
its
name.
document-node()
matches any document
node.
document-node(element(book))
matches any document node whose content consists of
a single element node that satisfies the element(book)
, interleaved with zero or more
comments and processing
instructions.
A predicate within a Step has similar syntax and semantics
to a predicate within a
For the purpose of evaluating the context position within a predicate, the input sequence is considered to be sorted as follows: into document order if the predicate is in a forward-axis step, into reverse document order if the predicate is in a reverse-axis step, or in its original order if the predicate is not in a step.
Here are some examples of
This example selects the second chapter
element that is a child
of the context node:
This example selects all the descendants of the
context node that are elements named
"toy"
and whose color
attribute has the value "red"
:
This example selects all the employee
children of the context node
that have both a secretary
child element and an assistant
child element:
When using preceding::foo[1]
returns the first qualifying foo
element in (preceding::foo)[1]
returns the first qualifying foo
element in (preceding::foo)
to be parsed as a ancestor::*[1]
returns the nearest ancestor element, because the ancestor
axis is a
reverse axis, whereas (ancestor::*)[1]
returns the root element (first ancestor in document order).
The fact that a reverse-axis step assigns context positions in reverse document order for the purpose of evaluating predicates does not alter the fact that the final result of the step is always in document order.
This section provides a number of examples of path expressions in which the
axis is explicitly specified in each
child::para
selects
the para
element children of the context node
child::*
selects all element children of the context node
child::text()
selects all text node children of the context node
child::node()
selects all the children of the context node. Note that no attribute nodes are returned, because attributes are not children.
attribute::name
selects the name
attribute of the context node
attribute::*
selects all the attributes of the context node
parent::node()
selects the parent of the context node. If the context node is an attribute node, this expression returns the element node (if any) to which the attribute node is attached.
descendant::para
selects the para
element descendants of the context node
ancestor::div
selects all div
ancestors of the context node
ancestor-or-self::div
selects the div
ancestors of the context node and, if the context node is a div
element, the context node as well
descendant-or-self::para
selects the para
element descendants of the context node and, if the context node is a para
element, the context node as well
self::para
selects the context node if it is a para
element, and otherwise returns an empty sequence
child::chapter/descendant::para
selects the para
element
descendants of the chapter
element children of the context node
child::*/child::para
selects all para
grandchildren of the context node
/
selects the root of the tree that contains the context node, but raises a dynamic error if this root is not a document node
/descendant::para
selects all the para
elements in the same document as the context node
/descendant::list/child::member
selects all
the member
elements that have a list
parent and that are in the same document as the context node
child::para[fn:position() = 1]
selects the first para
child of the context node
child::para[fn:position() = fn:last()]
selects the last para
child of the context node
child::para[fn:position() = fn:last()-1]
selects the last but one para
child of the context node
child::para[fn:position() > 1]
selects all the para
children of the context node other than the first para
child of the context node
following-sibling::chapter[fn:position() = 1]
selects the next chapter
sibling of the context node
preceding-sibling::chapter[fn:position() = 1]
selects the previous chapter
sibling of the context node
/descendant::figure[fn:position() = 42]
selects the forty-second figure
element in the document containing the context node
/child::book/child::chapter[fn:position() = 5]/child::section[fn:position() = 2]
selects the
second section
of the fifth chapter
of the book
whose parent is the document node that contains the context node
child::para[attribute::type eq "warning"]
selects
all para
children of the context node that have a type
attribute with value warning
child::para[attribute::type eq 'warning'][fn:position() = 5]
selects the fifth para
child of the context node that has a type
attribute with value warning
child::para[fn:position() = 5][attribute::type eq "warning"]
selects the fifth para
child of the context node if that child has a type
attribute with value warning
child::chapter[child::title = 'Introduction']
selects
the chapter
children of the context node that have one or
more title
children whose Introduction
child::chapter[child::title]
selects the chapter
children of the context node that have one or more title
children
child::*[self::chapter or self::appendix]
selects the chapter
and appendix
children of the context node
child::*[self::chapter or
self::appendix][fn:position() = fn:last()]
selects the
last chapter
or appendix
child of the context node
The abbreviated syntax permits the following abbreviations:
The attribute axis attribute::
can be
abbreviated by @
. For example, a path expression para[@type="warning"]
is short
for child::para[attribute::type="warning"]
and
so selects para
children with a type
attribute with value
equal to warning
.
If the axis name is omitted from an In an implementation that does not support the namespace
axis, an attempt to access it always raises an error. Thus, an
XQuery implementation will always raise an error in this case,
since XQuery does not support the namespace axis. The namespace
axis is deprecated child
, with two exceptions:
if the attribute
;
if the namespace-node()
then the default axis is namespace
section/para
is an abbreviation for child::section/child::para
, and the path
expression section/@id
is an
abbreviation for child::section/attribute::id
. Similarly,
section/attribute(id)
is an
abbreviation for child::section/attribute::attribute(id)
. Note
that the latter expression contains both an axis specification and
a
Each non-initial occurrence of //
is effectively replaced by /descendant-or-self::node()/
during processing of a path expression. For example, div1//para
is
short for child::div1/descendant-or-self::node()/child::para
and so will select all para
descendants of div1
children.
The path expression //para[1]
does /descendant::para[1]
. The latter selects the first descendant para
element; the former
selects all descendant para
elements that are the first para
children of their respective parents.
A step consisting
of ..
is short
for parent::node()
. For example, ../title
is short for parent::node()/child::title
and so will select the title
children of the parent of the context node.
The expression .
, known as a
Here are some examples of path expressions that use the abbreviated syntax:
para
selects the para
element children of the context node
*
selects all element children of the context node
text()
selects all text node children of the context node
@name
selects
the name
attribute of the context node
@*
selects all the attributes of the context node
para[1]
selects the first para
child of the context node
para[fn:last()]
selects the last para
child of the context node
*/para
selects
all para
grandchildren of the context node
/book/chapter[5]/section[2]
selects the
second section
of the fifth chapter
of the book
whose parent is the document node that contains the context node
chapter//para
selects the para
element descendants of the chapter
element children of the context node
//para
selects all
the para
descendants of the root document node and thus selects all para
elements in the same document as the context node
//@version
selects all the version
attribute nodes that are in the same document as the context node
//list/member
selects all the member
elements in the same document as the context node that have a list
parent
.//para
selects
the para
element descendants of the context node
..
selects the parent of the context node
../@lang
selects
the lang
attribute of the parent of the context node
para[@type="warning"]
selects all para
children of the context node that have a type
attribute with value warning
para[@type="warning"][5]
selects the fifth para
child of the context node that has a type
attribute with value warning
para[5][@type="warning"]
selects the fifth para
child of the context node if that child has a type
attribute with value warning
chapter[title="Introduction"]
selects the chapter
children of the context node that have one
or more title
children whose Introduction
chapter[title]
selects the chapter
children of the context node that have one or more title
children
employee[@secretary and @assistant]
selects all
the employee
children of the context node that have both a secretary
attribute and
an assistant
attribute
book/(chapter|appendix)/section
selects
every section
element that has a parent that is either a chapter
or an appendix
element, that in turn is a child of a book
element that is a child of the context node.
If E
is any expression that returns a sequence of nodes, then the expression E/.
returns the same nodes in
XPath 3.0 supports operators to construct, filter, and combine
1
, (2, 3)
, and ( )
into a single sequence results
in the sequence (1, 2, 3)
.
A sequence may contain duplicate
In places where the grammar calls for
Here are some examples of expressions that construct sequences:
The result of this expression is a sequence of five integers:
This expression combines four sequences of length one, two, zero, and two, respectively, into a single sequence of length five. The result of this expression is the sequence 10, 1, 2, 3, 4
.
The result of this expression is a sequence containing
all salary
children of the context node followed by all bonus
children.
Assuming that $price
is bound to
the value 10.50
, the result of this expression is the sequence 10.50, 10.50
.
A to
operator is
converted as though it was an argument of a function with the expected
parameter type xs:integer?
.
If either operand is an empty sequence, or if the integer derived from the first operand is greater than the integer derived from the second operand, the result of the range expression is an empty sequence. If the two operands convert to the same integer, the result of the range expression is that integer. Otherwise, the result is a sequence containing the two integer operands and
every integer between the two operands, in increasing order.
This example uses a range expression as one operand in constructing a sequence. It evaluates to the sequence 10, 1, 2, 3, 4
.
This example constructs a sequence of length one containing the single integer 10
.
The result of this example is a sequence of length zero.
This example uses the fn:reverse
function to construct a sequence of six integers in decreasing order. It evaluates to the sequence 15, 14, 13, 12, 11, 10
.
XPath 3.0 provides the following operators for combining sequences of nodes:
The union
and |
operators are equivalent. They take two node sequences as operands and
return a sequence containing all the nodes that occur in either of the
operands.
The intersect
operator takes two node sequences as operands and returns a sequence
containing all the nodes that occur in both operands.
The except
operator takes two node sequences as operands and returns a sequence
containing all the nodes that occur in the first operand but not in the second
operand.
All these operators eliminate duplicate nodes from their result sequences based on node identity.
If an operand
of union
, intersect
, or except
contains an item that is not a node, a
If an IntersectExceptExpr contains more than two InstanceofExprs, they are grouped from left to right. With a UnionExpr, it makes no difference how operands are grouped, the results are the same.
Here are some examples of expressions that combine sequences. Assume the existence of three element nodes that we will refer to by symbolic names A, B, and C. Assume that the variables $seq1
, $seq2
and $seq3
are bound to the following sequences of these nodes:
$seq1
is bound to (A, B)
$seq2
is bound to (A, B)
$seq3
is bound to (B, C)
Then:
$seq1 union $seq2
evaluates to the sequence (A, B).
$seq2 union $seq3
evaluates to the sequence (A, B, C).
$seq1 intersect $seq2
evaluates to the sequence (A, B).
$seq2 intersect $seq3
evaluates to the sequence containing B only.
$seq1 except $seq2
evaluates to the empty sequence.
$seq2 except $seq3
evaluates to the sequence containing A only.
In addition to the sequence operators described here,
XPath 3.0 provides arithmetic operators for addition, subtraction, multiplication, division, and modulus, in their usual binary and unary forms.
A subtraction operator must be preceded by whitespace if
it could otherwise be interpreted as part of the previous token. For
example, a-b
will be interpreted as a
name, but a - b
and a -b
will be interpreted as arithmetic expressions. (See
If an AdditiveExpr contains more than two MultiplicativeExprs,
they are grouped from left to right. So, for instance,
The first step in evaluating an arithmetic expression is to evaluate its operands. The order in which the operands are evaluated is
If true
, each operand is evaluated by applying the following steps, in order:
If the atomized operand is an empty sequence, the result of
the arithmetic expression is the xs:double
value NaN
, and the implementation
need not evaluate the other operand or apply the operator. However,
an implementation may choose to evaluate the other operand in order
to determine whether it raises an error.
If the atomized operand is a sequence of length greater than one, any items after the first item in the sequence are discarded.
If the atomized operand is now an instance of type xs:boolean
, xs:string
,
xs:decimal
(including xs:integer
), xs:float
, or xs:untypedAtomic
, then it
is converted to the type xs:double
by applying the fn:number
function. (Note that fn:number
returns the value NaN
if its operand cannot be converted to a number.)
false
, each
If the atomized operand is an empty sequence, the result of the arithmetic expression is an empty sequence, and the implementation need not evaluate the other operand or apply the operator. However, an implementation may choose to evaluate the other operand in order to determine whether it raises an error.
If the atomized operand is a sequence of
length greater than one, a
If the atomized operand is of type xs:untypedAtomic
, it is cast to xs:double
. If
the cast fails, a
After evaluation of the operands, if the types of the operands are a valid combination
for the given arithmetic operator, the operator is applied to the operands,
resulting in an atomic value or a
If the types of the operands, after evaluation, are not a valid combination for the given operator, according to the rules in
XPath 3.0 supports two division operators named div
and idiv
. Each of these operators accepts two operands of any $arg1 idiv $arg2
is equivalent to ($arg1 div $arg2) cast as xs:integer?
except for error cases.
Here are some examples of arithmetic expressions:
The first expression below returns the xs:decimal
value -1.5
, and the second expression returns the xs:integer
value -1
:
Subtraction of two date values results in a value of type xs:dayTimeDuration
:
This example illustrates the difference between a subtraction operator and a hyphen:
Unary operators have higher precedence than binary operators, subject of course to the use of parentheses. Therefore, the following two examples have different meanings:
Multiple consecutive unary arithmetic operators are permitted by XPath 3.0 for compatibility with
String concatenation expressions allow the string representations of values to be concatenated. In XPath 3.0, $a || $b
is equivalent to fn:concat($a, $b)
. The following expression evaluates to the string concatenate
:
Comparison expressions allow two values to be compared. XPath 3.0 provides three kinds of comparison expressions, called value comparisons, general comparisons, and node comparisons.
When an XPath expression is written
within an XML document, the XML escaping rules for special characters
must be followed; thus "<
" must be written as
"<
".
The value comparison operators are eq
, ne
, lt
, le
, gt
, and ge
. Value comparisons are used for comparing single values.
The first step in evaluating a value comparison is to evaluate its operands. The order in which the operands are evaluated is
If the atomized operand is an empty sequence, the result of the value comparison is an empty sequence, and the implementation need not evaluate the other operand or apply the operator. However, an implementation may choose to evaluate the other operand in order to determine whether it raises an error.
If the atomized operand is a sequence of
length greater than one, a
If the atomized operand is of type xs:untypedAtomic
, it is cast to xs:string
.
The purpose of this rule is to make value comparisons transitive. Users should be aware that the general comparison operators have a different rule for casting of xs:untypedAtomic
operands. Users should also be aware that transitivity of value comparisons may be compromised by loss of precision during type conversion (for example, two xs:integer
values that differ slightly may both be considered equal to the same xs:float
value because xs:float
has less precision than xs:integer
).
Next, if possible, the two operands are converted to their least common
type by a combination of hatsize
(derived from xs:integer
) and
shoesize
(derived from xs:float
), their least common type is xs:float
.
Finally, if the types of the operands are a valid combination for the
given operator, the operator is applied to the operands. The combinations of atomic types
that are accepted by the various value comparison operators, and their
respective result types, are listed in
Informally, if both atomized operands consist of exactly one atomic
value, then the result of the comparison is true
if the value of the
first operand is (equal, not equal, less than, less than or equal,
greater than, greater than or equal) to the value of the second
operand; otherwise the result of the comparison is false
.
If the types of the operands, after evaluation, are not a valid combination for the given operator, according to the rules in
Here are some examples of value comparisons:
The following comparison atomizes the node(s) that are returned by the expression $book/author
. The comparison is true only if the result of atomization is the value "Kennedy" as an instance of xs:string
or xs:untypedAtomic
. If the result of atomization is an empty sequence, the result of the comparison is an empty sequence. If the result of atomization is a sequence containing more than one value, a
The following weight
subelement, the value of the predicate is the empty sequence, and the product is not selected. This example assumes that weight
is a validated element with a numeric type.
The following comparison is true if my:hatsize
and my:shoesize
are both user-defined types that are derived by restriction from a primitive
The following comparison is true. The eq
operator compares two QNames by performing codepoint-comparisons of their namespace URIs and their local names, ignoring their namespace prefixes.
The general comparison operators are =
, !=
, <
, <=
, >
, and >=
. General comparisons are existentially quantified comparisons that may be applied to operand sequences of any length. The result of a general comparison that does not raise an error is
always true
or false
.
If true
, a general comparison is evaluated by applying the following rules, in order:
If either operand is a single atomic value that is an instance of
xs:boolean
, then the other operand is converted to xs:boolean
by taking its
If the comparison operator is <
, <=
, >
, or >=
, then each item in both of the
operand sequences is converted to the type xs:double
by applying the
fn:number
function. (Note that fn:number
returns the value NaN
if its operand cannot be converted to a number.)
The result of the comparison is true
if and only if there is a pair of
atomic values, one in the first operand sequence and the other in the second operand sequence, that have the required
false
. The cast
operation called for by these rules is not successful, a dynamic error is raised. [err:FORG0001]
If at least one of the two atomic values is an instance of a xs:double
by
applying the fn:number
function.
If at least one of the two atomic values is an instance of xs:string
,
or if both atomic values are instances of xs:untypedAtomic
, then both
atomic values are cast to the type xs:string
.
If one of the atomic values is an instance of xs:untypedAtomic
and the other is not an instance of xs:string
, xs:untypedAtomic
, or any xs:untypedAtomic
value is
cast to the
After performing the conversions described above, the atomic values are
compared using one of the value comparison operators eq
, ne
, lt
, le
, gt
, or
ge
, depending on whether the general comparison operator was =
, !=
, <
, <=
,
>
, or >=
. The values have the required true
.
false
, a
The result of the comparison is true
if and only if there is a pair of
atomic values, one in the first operand sequence and the other in the second operand sequence, that have the required
false
. The cast
operation called for by these rules is not successful, a dynamic error is raised. [err:FORG0001]
If both atomic values are instances of xs:untypedAtomic
,
then the values are cast to the type xs:string
.
If exactly one of the atomic values is an instance of
xs:untypedAtomic
, it is cast to a type depending on
the other value's dynamic type T according to the following rules,
in which V denotes the value to be cast:
If T is a numeric type or is derived from a numeric type,
then V is cast to xs:double
.
If T is xs:dayTimeDuration
or is derived from
xs:dayTimeDuration
,
then V is cast to xs:dayTimeDuration
.
If T is xs:yearMonthDuration
or is derived from
xs:yearMonthDuration
,
then V is cast to xs:yearMonthDuration
.
In all other cases, V is cast to the primitive base type of T.
The special treatment of the duration types is required to avoid
errors that may arise when comparing the primitive type
xs:duration
with any duration type.
After performing the conversions described above, the atomic values are
compared using one of the value comparison operators eq
, ne
, lt
, le
, gt
, or
ge
, depending on whether the general comparison operator was =
, !=
, <
, <=
,
>
, or >=
. The values have the required true
.
When evaluating a general comparison in which either operand is a sequence of items, an implementation may return true
as soon as it finds an item in the first operand and an item in the second operand that have the required
Here are some examples of general comparisons:
The following comparison is true if the author
subelement of $book1
is "Kennedy" as an instance of xs:string
or xs:untypedAtomic
:
The following example contains three general comparisons. The value of the first two comparisons is true
, and the value of the third comparison is false
. This example illustrates the fact that general comparisons are not transitive.
The following example contains two general comparisons, both of which are true
. This example illustrates the fact that the =
and !=
operators are not inverses of each other.
Suppose that $a
, $b
, and $c
are bound to element nodes with type annotation xs:untypedAtomic
, with 1
", "2
", and "2.0
" respectively. Then ($a, $b) = ($c, 3.0)
returns false
, because $b
and $c
are compared as strings. However, ($a, $b) = ($c, 2.0)
returns true
, because $b
and 2.0
are compared as numbers.
Node comparisons are used to compare two nodes, by their identity or by their
The operands of a node comparison are evaluated in
If either operand is an empty sequence, the result of the comparison is an empty sequence, and the implementation need not evaluate the other operand or apply the operator. However, an implementation may choose to evaluate the other operand in order to determine whether it raises an error.
Each operand must be either a single node or an empty sequence; otherwise
a
A comparison with the is
operator is true
if the two operand nodes have the same identity, and are thus the same node; otherwise it
is false
. See
A comparison with the <<
operator returns true
if the left operand node precedes the right operand node in
false
.
A comparison with the >>
operator returns true
if the left operand node follows the right operand node in
false
.
Here are some examples of node comparisons:
The following comparison is true only if the left and right sides each evaluate to exactly the same single node:
The following comparison is true only if the node identified by the left side occurs before the node identified by the right side in document order:
A true
or false
.
The first step in evaluating a logical expression is to find the
The value of an and-expression is determined by the effective boolean values (EBV's) of its operands, as shown in the following table:
AND: | EBV2 =
true
| EBV2 = false
| error in EBV2 |
EBV1 =
true
|
true
|
false
| error |
EBV1
= false
|
false
|
false
|
true , then false ; otherwise either false or error. |
error in EBV1 | error |
true , then error; otherwise either false or error. | error |
The value of an or-expression is determined by the effective boolean values (EBV's) of its operands, as shown in the following table:
OR: | EBV2 =
true
| EBV2 = false
| error in EBV2 |
EBV1 =
true
|
true
|
true
|
true , then true ; otherwise either true or error. |
EBV1 =
false
|
true
|
false
| error |
error in EBV1 |
true , then error; otherwise either true or error. | error | error |
If true
, the order in which the operands of a logical expression are evaluated is effectively prescribed. Specifically, it is defined that when there is no
need to evaluate the second operand in order to determine the result, then
no error can occur as a result of evaluating the second operand.
false
, the
order in which the operands of a logical expression are evaluated is
true
if the first
expression evaluated is true, and it can raise an error if evaluation
of the first expression raises an error. Similarly, an and-expression
can return false
if the first expression evaluated is
false, and it can raise an error if evaluation of the first expression
raises an error. As a result of these rules, a logical expression is
not deterministic in the presence of errors, as illustrated in the examples
below.
Here are some examples of logical expressions:
The following expressions return
true
:
The following
expression may return either false
or raise a false
)
The
following expression may return either true
or raise a
true
)
The
following expression must raise a
In addition to and- and or-expressions, XPath 3.0 provides a
function named fn:not
that takes a general sequence as
parameter and returns a boolean value. The fn:not
function
is defined in fn:not
function reduces its parameter to an true
if the effective boolean value of its parameter is
false
, and false
if the effective boolean
value of its parameter is true
. If an error is
encountered in finding the effective boolean value of its operand,
fn:not
raises the same error.
XPath provides an iteration facility called a
A for
expression is evaluated as follows:
If the for
expression uses multiple variables, it is first expanded to a set of nested for
expressions, each of which uses only one variable. For example, the expression
for $x in X, $y in Y return $x + $y
is expanded to
for $x in X return
for $y in Y return $x + $y
.
In a single-variable for
expression, the variable is called the in
keyword is called the return
keyword is called the for
expression is obtained by evaluating the return
expression once for each item in the binding sequence, with the range variable bound to that item. The resulting sequences are concatenated (as if by the
The following example illustrates the use of a for
expression in restructuring an input document. The example is based on the following
input:
The following example transforms the input document into a list in
which each author's name appears only once, followed by a list of
titles of books written by that author. This example assumes that the
context item is the bib
element in the input
document.
The result of the above expression consists of the following
sequence of elements. The titles of books written by a given author
are listed after the name of the author.
The ordering of author
elements in the result is fn:distinct-values
function.
The following example illustrates a for
expression containing more than one variable:
The result of the above expression, expressed as a sequence of numbers, is as follows: 11, 12, 21, 22
The scope of a variable bound in a for
expression comprises all subexpressions of the for
expression
that appear after the variable binding. The scope does not
include the expression to which the variable is bound. The following example illustrates how a variable binding may reference another variable bound earlier in the same for
expression:
The focus for evaluation of the return
clause of a for
expression
is the same as the focus for evaluation of the for
expression itself. The
following example, which attempts to find the total value of a set of
order-items, is therefore incorrect:
Instead, the expression must be written to use the variable bound in the for
clause:
XPath allows a variable to be declared and bound to a value using a
A let expression is evaluated as follows:
If the let expression uses multiple variables, it is first expanded to a
set of nested let expressions, each of which uses only one variable. For
example, the expression let $x := 4, $y := 3 return $x + $y
is expanded to
let $x := 4 return let $y := 3 return $x + $y
.
In a single-variable let expression, the variable is called the range
variable, the value of the expression that follows the :=
symbol is called
the binding sequence, and the expression that follows the return keyword is
called the return expression. The result of the let expression is obtained
by evaluating the return expression with the range variable bound to the
binding sequence.
The scope of a variable bound in a let expression comprises all subexpressions of the let expression that appear after the variable binding. The scope does not include the expression to which the variable is bound. The following example illustrates how a variable binding may reference another variable bound earlier in the same let expression:
XPath 3.0 supports a conditional expression based on the keywords if
, then
, and else
.
The expression following the if
keyword is called the then
and else
keywords are called the
The first step in processing a conditional expression is to find
the
The value of a conditional expression is defined as follows: If the
effective boolean value of the test expression is true
, the value of the then-expression is returned. If the
effective boolean value of the test expression is false
,
the value of the else-expression is returned.
Conditional expressions have a special rule for propagating true
, the conditional expression ignores (does not raise) any dynamic errors encountered in the else-expression. In this case, since the else-expression can have no observable effect, it need not be evaluated. Similarly, if the effective value of the test expression is false
, the conditional expression ignores any
Here are some examples of conditional expressions:
In this example, the test expression is a comparison expression:
In this example, the test expression tests for the existence of an attribute
named discounted
, independently of its value:
Quantified expressions support existential and universal quantification. The
value of a quantified expression is always true
or false
.
A some
or every
, followed by one or more in-clauses that are used to bind variables,
followed by the keyword satisfies
and a test expression. Each in-clause associates a variable with an
expression that returns a sequence of items, called the binding sequence for that variable. The in-clauses generate tuples of variable bindings, including a tuple for each combination of items in the binding sequences of the respective variables. Conceptually, the test expression is evaluated for each
tuple of variable bindings. Results depend on the
If the quantifier is some
, the quantified expression is true
if at least one evaluation of the test expression has the true
; otherwise the quantified expression is false
. This rule implies that, if the in-clauses generate zero binding
tuples, the value of the quantified expression is false
.
If the quantifier is every
, the quantified expression is true
if every evaluation of the test expression has the true
; otherwise the quantified expression is false
. This rule implies that, if the in-clauses generate zero binding
tuples, the value of the quantified
expression is true
.
The scope of a variable bound in a quantified expression comprises all subexpressions of the quantified expression that appear after the variable binding. The scope does not include the expression to which the variable is bound.
The order in which test expressions are evaluated for the various binding
tuples is some
, an implementation may
return true
as soon as it finds one binding tuple for which the test expression has
an true
, and it may raise a every
, an implementation may return false
as soon as it finds one binding tuple for which the test expression has
an false
, and it may raise a
Here are some examples of quantified expressions:
This expression is true
if every part
element has a discounted
attribute (regardless of the values of these attributes):
This expression is true
if at least
one employee
element satisfies the given comparison expression:
In the following examples, each quantified expression evaluates its test
expression over nine tuples of variable bindings, formed from the Cartesian
product of the sequences (1, 2, 3)
and (2, 3, 4)
. The expression beginning with some
evaluates to true
, and the expression beginning with every
evaluates to false
.
This quantified expression may either return true
or raise a true
for one variable binding
and raises a
This quantified expression may either return false
or raise a false
for one variable binding and raises a
instance of
, cast
, castable
, and treat
expressions.
The boolean
operator instance of
returns true
if the value of its first operand matches
the false
. For example:
5 instance of xs:integer
This example returns true
because the given value is an instance of the given type.
5 instance of xs:decimal
This example returns true
because the given value is an integer literal, and xs:integer
is derived by restriction from xs:decimal
.
(5, 6) instance of xs:integer+
This example returns true
because the given sequence contains two integers, and is a valid instance of the specified type.
. instance of element()
This example returns true
if the context item is an element node or false
if the context item is defined but is not an element node. If the context item is
Occasionally
it is necessary to convert a value to a specific datatype. For this
purpose, XPath 3.0 provides a cast
expression that
creates a new value of a specific type based on an existing value. A
cast
expression takes two operands: an {variety}
of the simple
xs:NOTATION
xs:anySimpleType
,xs:anyAtomicType
?
" denotes that an empty
sequence is permitted. If the target type
Casting a node to xs:QName
xs:QName
, it is generally preferable tofn:QName
function, which allows the namespace context to be taken from the document containing the QName.
The semantics of the cast
expression
are as follows:
The input expression is evaluated.
If the result contains a node, and the target type is
The result of the first step is
If the result of atomization is a
sequence of more than one atomic value, a
If the result of atomization is an empty sequence:
If
?
is specified after the target type, the result of the
cast
expression is an empty sequence.
If ?
is not specified after the target type, a
If the result of atomization is a single atomic value, the result
of the cast expression depends on the input type and the target
type. In general, the cast expression attempts to create a new value
of the target type based on the input value. Only certain combinations
of input type and target type are supported. A summary of the rules
are listed below—the normative definition of these rules is
given in
cast
is supported for the combinations of
input type and target type listed in xs:string
can be cast into the
schema type xs:decimal
. For each of these built-in combinations,
the semantics of casting are specified in
cast
is
supported if the input type is a non-primitive atomic type that is derived by restriction from the target
type. In this case, the input value
is mapped into the value space of the target type, unchanged except
for its type. For example, if shoesize
is derived by
restriction from xs:integer
, a value of type
shoesize
can be cast into the schema type
xs:integer
.
cast
is supported if the target type is a
non-primitive atomic type and the input type is
xs:string
or xs:untypedAtomic
. The
input value is first converted to a value in the lexical space of
the target type by applying the whitespace normalization rules
for the target type (as defined in
cast
is supported to any target type
if the input type is xs:string
or
xs:untypedAtomic
. The target type may be an atomic
type, a union type, or a list type. The semantics are based on
the rules for validation in
The effect of casting a string S to a simple type
T is the same as constructing an element or attribute
node whose string value is S, validating it using
T as the governing type, and atomizing the resulting
node.
The result may be a single atomic value or (if list types are
involved) a sequence of zero or more atomic values.
If the target type is
cast
is supported if
the target type is a non-primitive atomic type that is derived by restriction from the input type. The input value must satisfy all the
facets of the target type (in the case of the pattern facet, this is
checked by generating a string representation of the input value,
using the rules for casting to xs:string
). The resulting
value is the same as the input value, but with a different
If a primitive type P1 can be cast into a primitive type P2, then any type derived by restriction from P1 can be cast into any type derived by restriction from P2, provided that the facets of the target type are satisfied. First the input value is cast to P1 using rule (b) above. Next, the value of type P1 is cast to the type P2, using rule (a) above. Finally, the value of type P2 is cast to the target type, using rule (d) above.
For any combination of input
type and target type that is not in the above list, a
cast
expression raises a
If casting from the input type to the target type is supported but nevertheless it is not possible to cast the input value into the value space of the target type, a "2003-02-31" cast as xs:date
would raise a
XPath 3.0
provides an expression that tests whether a given value
is castable into a given target type.
{variety}
of thesimple
xs:NOTATION
xs:anySimpleType
,xs:anyAtomicType
?
" denotes that an empty
sequence is permitted.
The expression E castable as T
returns true
if the result of evaluating E
can be successfully cast into the target type T
by using a cast
expression;
otherwise it returns false
.
If evaluation of E
fails with a dynamic error,
the castable
expression as a whole fails.
The castable
expression can be used as a
For every xs:NOTATION
and xs:anyAtomicType
, which are not instantiable), a
T($arg)
are defined to be equivalent to the expression (($arg) cast as T?)
.
The following examples illustrate the use of constructor functions:
This
example is equivalent to ("2000-01-01" cast as
xs:date?)
.
This
example is equivalent to
(($floatvalue * 0.2E-5) cast as xs:decimal?)
.
This example returns an
xs:dayTimeDuration
value equal to 21 days. It is
equivalent to ("P21D" cast as xs:dayTimeDuration?)
.
If
usa:zipcode
is a user-defined atomic type
in the ("12345" cast as
usa:zipcode?)
.
An instance of an atomic type that is not in a namespace can be constructed in either of the following ways:
By using a cast
expression, if the
By using a constructor function, if the
XPath 3.0 provides an
expression called treat
that can be used to modify the
Like cast
, the treat
expression takes two operands: an expression and a cast
, however, treat
does not change the
treat
is to ensure that an expression has an expected
dynamic type at evaluation time.
The semantics of expr1
treat as
type1
During static analysis:
The
treat
expression is type1
type1
During expression evaluation:
If expr1
type1
treat
expression returns the value of
expr1
expr1
treat
expression ensures that the value of
its expression operand conforms to the expected type at
run-time.
Example:
The
$myaddress
may be element(*, Address)
, a
less specific type than element(*, USAddress)
. However,
at run-time, the value of $myaddress
must match the type
element(*, USAddress)
using rules for
!
)The simple map operator "!
" is used for simple mappings. Both its left-hand side expression and its right-hand-side expression may return a mixed sequence of nodes and non-nodes.
Each operation E1!E2
is evaluated as follows: Expression E1
is evaluated to a sequence S
. Each item in S
then serves in turn to provide an inner focus (the item as the context item, its position in S
as the context position, the length of S
as the context size) for an evaluation of E2
in the E2
are combined as follows: Every evaluation of E2
returns a (possibly empty) sequence of items. These sequences are concatenated and returned. If ordering mode is ordered, the returned sequence preserves the orderings within and among the subsequences generated by the evaluations of E2
; otherwise the order of the returned sequence is implementation-dependent.
Simple map operators have functionality similar to
Operator | Path operator (E1 / E2 ) | Simple map operator (E1 ! E2 ) |
---|---|---|
E1 | Any sequence of nodes | Any sequence of items |
E2 | Either a sequence of nodes or a sequence of non-node items | A sequence of items |
Additional processing | Duplicate elimination and document ordering | Simple sequence concatenation |
The following examples illustrate the use of simple map operators combined with path expressions.
child::div1 / child::para / string() ! concat("id-", .)
Selects the para
element children of the div1
element children of the context node; that is, the para
element grandchildren of the context node that have div1
parents. It then outputs the strings obtained by prepending "id-"
to each of the string values of these grandchildren.
$emp ! (@first, @middle, @last)
Returns the values of the attributes first
, middle
, and last
for element $emp
, in the order given. (The /
operator here returns the attributes in an unpredictable order.)
$docs ! ( //employee)
Returns all the employees within all the documents identified by the variable docs, in document order within each document, but retaining the order of documents.
avg( //employee / salary ! translate(., '$', '') ! number(.))
Returns the average salary of the employees, having converted the salary to a number by removing any $
sign and then converting to a number. (The second occurrence of !
could not be written as /
because the left-hand operand of /
cannot be an atomic value.)
The grammar of XPath 3.0 uses the same simple Extended
Backus-Naur Form (EBNF) notation as
All named symbols have a name that begins with an uppercase letter.
It adds a notation for referring to productions in external specs.
Comments or extra-grammatical constraints on grammar productions are between '/*' and '*/' symbols.
A 'xgc:' prefix is an extra-grammatical constraint,
the details of which are explained in
A 'ws:' prefix explains the whitespace rules for the
production, the details of which are explained in
A 'gn:' prefix means a 'Grammar Note', and is meant
as a clarification for parsing rules, and is explained
in
The terminal symbols for this grammar include the quoted
strings used in the production rules below, and the terminal
symbols defined in section
The EBNF notation is described in more detail in
To increase readability, the EBNF in the main body of this document omits some of these notational features. This appendix is the normative version of the EBNF.
The following definitions will be helpful in defining precisely this exposition.
matches any
matches any
matches any
matches the sequence of characters that appear inside the double quotes.
matches the sequence of characters that appear inside the single quotes.
matches any string matched by the production defined in the external specification as per the provided reference.
Patterns (including the above constructs) can be combined with grammatical operators to form more complex patterns, matching more complex sets of character strings. In the examples that follow, A and B represent (sub-)patterns.
A
is treated as a unit and may be combined
as described in this list.
matches
A
or nothing; optional
A
.
matches
A
followed by
B
. This operator has higher precedence
than alternation; thus
A B | C D
is identical to
(A B) | (C D)
.
matches
A
or
B
but not both.
matches any string that matches
A
but does not match
B
.
matches one or more occurrences of
A
. Concatenation has higher precedence
than alternation; thus
A+ | B+
is identical to
(A+) | (B+)
.
matches zero or more occurrences of
A
. Concatenation has higher precedence
than alternation; thus
A* | B*
is identical to
(A*) | (B*)
This section contains constraints on the EBNF productions,
which are required to parse syntactically valid sentences. The notes below
are referenced from the right side of the production, with
the notation:
A single slash may appear either as a complete path
expression or as the first part of a path expression in
which it is followed by a
*
token and keywords like
union
could be either an operator or a
/ * 5
is easily taken to be a complete
expression,
/ *
, which has a very different interpretation
(the child nodes of
/
).
Therefore to reduce the need for lookahead, if the token
immediately following a slash can form the start of a
A single slash may be used as the left-hand argument of
an operator by parenthesizing it:
(/) * 5
. The expression
5 * /
, on the other hand, is syntactically valid without
parentheses.
The version of XML and XML Names (e.g. prefix :
localname
is not a syntactically valid
XPath expressions allow any legal XML Unicode character, subject only to constraints imposed by the host language.
Unprefixed function names spelled the same way as
language keywords could make the language harder to
recognize. For instance,
if(foo)
could be taken either as a
A function named "if" can be called by binding its namespace to a prefix and using the prefixed form: "library:if(foo)" instead of "if(foo)".
As written, the grammar
in
Thus, 4 treat as item() + -
5
must be interpreted as (4
treat as item()+) - 5
, taking the '+' as an
OccurrenceIndicator and the '-' as a subtraction operator. To
force the interpretation of "+" as an addition operator (and
the corresponding interpretation of the "-" as a unary minus),
parentheses may be used: the form (4
treat as item()) + -5
surrounds the
function () as xs:string *
is interpreted as function () as
(xs:string *)
, not as (function
() as xs:string) *
. Parentheses can be used as shown
to force the latter interpretation.
This rule has as a consequence that certain forms which
would otherwise be syntactically valid and unambiguous are not
recognized: in "4 treat as item() + 5", the "+" is taken as
an
This section contains general notes on the EBNF
productions, which may be helpful in understanding how to
interpret and implement the EBNF. These notes are not
normative. The notes below are referenced from the right side
of the production, with the notation:
Look-ahead is required to distinguish
address (: this may be empty
:)
may be mistaken for a call to a function
named "address" unless this lookahead is employed.
Another example is
for (: whom the bell :)
$tolls in 3 return $tolls
, where the keyword
"for" must not be mistaken for a function name.
Comments are allowed everywhere that
A comment can contain nested comments, as long as all "(:" and ":)" patterns are balanced, no matter where they occur within the outer comment.
Lexical analysis may typically handle nested comments by incrementing a counter for each "(:" pattern, and decrementing the counter for each ":)" pattern. The comment does not terminate until the counter is back to zero.
Some illustrative examples:
(: commenting out a (: comment :) may be
confusing, but often helpful :)
is a syntactically valid
Comment, since balanced nesting of comments is
allowed.
"this is just a string
:)"
is a syntactically valid expression. However,
(: "this is just a string :)" :)
will
cause a syntax error. Likewise,
"this is another string
(:"
is a syntactically valid expression, but
(: "this is another string (:"
:)
will cause a syntax error. It is a
limitation of nested comments that literal
content can cause unbalanced nesting of
comments.
for (: set up loop :) $i
in $x return $i
is syntactically valid,
ignoring the comment.
5 instance (: strange
place for a comment :) of xs:integer
is
also syntactically valid.
The terminal symbols assumed by the grammar above are described in this section.
Quoted strings appearing in production rules are terminal symbols.
Other terminal symbols are defined in
Some productions are defined by reference to the XML and XML Names
specifications (e.g.
A
When tokenizing, the longest possible match that is
All keywords are case sensitive. Keywords are not
reserved—that is, any
The following symbols are used only in the definition of
terminal symbols; they are not terminal symbols in the
grammar of
XPath 3.0 expressions consist of
Terminal symbols that are not used exclusively in
It is customary to separate consecutive terminal symbols
by
The host language must specify whether the
XPath 3.0 processor normalizes all line breaks on input, before
parsing, and if it does so, whether it uses the rules of
For
the two-character sequence #xD #xA
any #xD character that is not immediately followed by #xA.
For
the two-character sequence #xD #xA
the two-character sequence #xD #x85
the single character #x85
the single character #x2028
any #xD character that is not immediately followed by #xA or #x85.
foo- foo
results in a syntax error. "foo-"
would be recognized as a QName.
foo -foo
is syntactically
equivalent to
foo - foo
, two QNames
separated by a subtraction operator.
foo(: This is a comment :)-
foo
is syntactically equivalent to
foo - foo
. This is because the comment
prevents the two adjacent terminals from being
recognized as one.
foo-foo
is syntactically equivalent to
single QName. This is because "-" is a valid character
in a QName. When used as an operator after the
characters of a name, the "-" must be separated from
the name, e.g. by using whitespace or parentheses.
10div 3
results in a syntax error.
10 div3
also results in a syntax error.
10div3
also results in a syntax error.
Explicit whitespace notation is specified with the EBNF productions, when it is different from the default rules, using the notation shown below. This notation is not inherited. In other words, if an EBNF rule is marked as /* ws: explicit */, the notation does not automatically apply to all the 'child' EBNF productions of that rule.
/* ws: explicit */ means that the EBNF notation
explicitly notates, with
S
or otherwise, where
The following names are not allowed as function names in an unprefixed form because expression syntax takes precedence.
attribute
comment
document-node
element
empty-sequence
function
if
item
namespace-node
node
processing-instruction
schema-attribute
schema-element
switch
text
typeswitch
Although the keywords
switch
and
typeswitch
are not used in XPath,
they are considered reserved function names
for compatibility with XQuery.
The grammar in
# | Operator | Associativity |
---|---|---|
1 |
| either |
2 |
| NA |
3 |
| either |
4 |
| either |
5 |
| NA |
6 |
| left-to-right |
7 |
| NA |
8 |
| left-to-right |
9 |
| left-to-right |
10 |
| either |
11 |
| left-to-right |
12 |
| NA |
13 |
| NA |
14 |
| NA |
15 |
| NA |
16 |
| right-to-left |
17 |
| left-to-right |
18 |
| left-to-right |
19 |
| left-to-right |
In the "Associativity" column,
"either"
indicates that all the operators at that level have the associative property
(i.e., (A op B) op C
is equivalent to A op (B op C)
),
so their associativity is inconsequential.
"NA" (not applicable)
indicates that the EBNF does not allow
an expression that directly contains
multiple operators from that precedence level,
so the question of their associativity does not arise.
Parentheses can be used to override the operator precedence in the usual way. Square brackets in an expression such as A[B] serve two roles: they act as an operator causing B to be evaluated once for each item in the value of A, and they act as parentheses enclosing the expression B.
Numeric type promotion:
A value of type xs:float
(or any type
derived by restriction from xs:float
) can be promoted to
the type xs:double
. The result is the
xs:double
value that is the same as the original
value.
A value of type xs:decimal
(or any type derived
by restriction from xs:decimal
) can be promoted to either
of the types xs:float
or xs:double
. The
result of this promotion is created by casting the original value to
the required type. This kind of promotion may cause loss of
precision.
URI type promotion: A value of type xs:anyURI
(or any type derived by restriction from xs:anyURI
) can be promoted to the type xs:string
. The result of this promotion is created by casting the original value to the type xs:string
.
Since xs:anyURI
values can be promoted to xs:string
, functions and operators that compare strings using the xs:anyURI
values using the xs:anyURI
values, or any combination of the two types are consistent and well-defined.
Note that
A function that expects a parameter $p
of type xs:float
can be invoked with a value of type xs:decimal
. This is an example of $p instance of xs:decimal
returns false
.
A function that expects a parameter $p
of type xs:decimal
can be invoked with a value of type xs:integer
. This is an example of $p instance of xs:integer
returns true
.
The operator mapping tables in this section list the
combinations of types for which the various operators of XPath 3.0
are defined.
The and
and
or
operators are defined directly in the main body of
this document, and do not occur in the operator mapping tables.
If an operator in the operator mapping tables expects an operand of type
gt
operator may
be applied to two xs:date
operands, returning
xs:boolean
. Therefore, the gt
operator may
also be applied to two (possibly different) subtypes of
xs:date
, also returning xs:boolean
.
xs:integer
, xs:decimal
,
xs:float
, and xs:double
.+
operator might be
thought of as representing the following four operators:
Operator | First operand type | Second operand type | Result type |
+
|
xs:integer
|
xs:integer
|
xs:integer
|
+
|
xs:decimal
|
xs:decimal
|
xs:decimal
|
+
|
xs:float
|
xs:float
|
xs:float
|
+
|
xs:double
|
xs:double
|
xs:double
|
A numeric operator may be validly applied to an operand of type (xs:integer, xs:decimal, xs:float, xs:double)
into which all operands can be converted by hatsize
is derived from xs:integer
and the type shoesize
is derived from xs:float
. Then if the +
operator is invoked with operands of type hatsize
and shoesize
, it returns a result of type xs:float
. Similarly, if +
is invoked with two operands of type hatsize
it returns a result of type xs:integer
.
xs:gYearMonth
, xs:gYear
,
xs:gMonthDay
, xs:gDay
, and
xs:gMonth
.xs:gDay
, the other
operand must be of type xs:gDay
.)
Operator | Type(A) | Type(B) | Function | Result type |
---|---|---|---|---|
A + B | numeric | numeric | op:numeric-add(A, B) | numeric |
A + B | xs:date | xs:yearMonthDuration | op:add-yearMonthDuration-to-date(A, B) | xs:date |
A + B | xs:yearMonthDuration | xs:date | op:add-yearMonthDuration-to-date(B, A) | xs:date |
A + B | xs:date | xs:dayTimeDuration | op:add-dayTimeDuration-to-date(A, B) | xs:date |
A + B | xs:dayTimeDuration | xs:date | op:add-dayTimeDuration-to-date(B, A) | xs:date |
A + B | xs:time | xs:dayTimeDuration | op:add-dayTimeDuration-to-time(A, B) | xs:time |
A + B | xs:dayTimeDuration | xs:time | op:add-dayTimeDuration-to-time(B, A) | xs:time |
A + B | xs:dateTime | xs:yearMonthDuration | op:add-yearMonthDuration-to-dateTime(A, B) | xs:dateTime |
A + B | xs:yearMonthDuration | xs:dateTime | op:add-yearMonthDuration-to-dateTime(B, A) | xs:dateTime |
A + B | xs:dateTime | xs:dayTimeDuration | op:add-dayTimeDuration-to-dateTime(A, B) | xs:dateTime |
A + B | xs:dayTimeDuration | xs:dateTime | op:add-dayTimeDuration-to-dateTime(B, A) | xs:dateTime |
A + B | xs:yearMonthDuration | xs:yearMonthDuration | op:add-yearMonthDurations(A, B) | xs:yearMonthDuration |
A + B | xs:dayTimeDuration | xs:dayTimeDuration | op:add-dayTimeDurations(A, B) | xs:dayTimeDuration |
A - B | numeric | numeric | op:numeric-subtract(A, B) | numeric |
A - B | xs:date | xs:date | op:subtract-dates(A, B) | xs:dayTimeDuration |
A - B | xs:date | xs:yearMonthDuration | op:subtract-yearMonthDuration-from-date(A, B) | xs:date |
A - B | xs:date | xs:dayTimeDuration | op:subtract-dayTimeDuration-from-date(A, B) | xs:date |
A - B | xs:time | xs:time | op:subtract-times(A, B) | xs:dayTimeDuration |
A - B | xs:time | xs:dayTimeDuration | op:subtract-dayTimeDuration-from-time(A, B) | xs:time |
A - B | xs:dateTime | xs:dateTime | op:subtract-dateTimes(A, B) | xs:dayTimeDuration |
A - B | xs:dateTime | xs:yearMonthDuration | op:subtract-yearMonthDuration-from-dateTime(A, B) | xs:dateTime |
A - B | xs:dateTime | xs:dayTimeDuration | op:subtract-dayTimeDuration-from-dateTime(A, B) | xs:dateTime |
A - B | xs:yearMonthDuration | xs:yearMonthDuration | op:subtract-yearMonthDurations(A, B) | xs:yearMonthDuration |
A - B | xs:dayTimeDuration | xs:dayTimeDuration | op:subtract-dayTimeDurations(A, B) | xs:dayTimeDuration |
A * B | numeric | numeric | op:numeric-multiply(A, B) | numeric |
A * B | xs:yearMonthDuration | numeric | op:multiply-yearMonthDuration(A, B) | xs:yearMonthDuration |
A * B | numeric | xs:yearMonthDuration | op:multiply-yearMonthDuration(B, A) | xs:yearMonthDuration |
A * B | xs:dayTimeDuration | numeric | op:multiply-dayTimeDuration(A, B) | xs:dayTimeDuration |
A * B | numeric | xs:dayTimeDuration | op:multiply-dayTimeDuration(B, A) | xs:dayTimeDuration |
A idiv B | numeric | numeric | op:numeric-integer-divide(A, B) | xs:integer |
A div B | numeric | numeric | op:numeric-divide(A, B) | numeric; but xs:decimal if both operands are xs:integer |
A div B | xs:yearMonthDuration | numeric | op:divide-yearMonthDuration(A, B) | xs:yearMonthDuration |
A div B | xs:dayTimeDuration | numeric | op:divide-dayTimeDuration(A, B) | xs:dayTimeDuration |
A div B | xs:yearMonthDuration | xs:yearMonthDuration | op:divide-yearMonthDuration-by-yearMonthDuration (A, B) | xs:decimal |
A div B | xs:dayTimeDuration | xs:dayTimeDuration | op:divide-dayTimeDuration-by-dayTimeDuration (A, B) | xs:decimal |
A mod B | numeric | numeric | op:numeric-mod(A, B) | numeric |
A eq B | numeric | numeric | op:numeric-equal(A, B) | xs:boolean |
A eq B | xs:boolean | xs:boolean | op:boolean-equal(A, B) | xs:boolean |
A eq B | xs:string | xs:string | op:numeric-equal(fn:compare(A, B), 0) | xs:boolean |
A eq B | xs:date | xs:date | op:date-equal(A, B) | xs:boolean |
A eq B | xs:time | xs:time | op:time-equal(A, B) | xs:boolean |
A eq B | xs:dateTime | xs:dateTime | op:dateTime-equal(A, B) | xs:boolean |
A eq B | xs:duration | xs:duration | op:duration-equal(A, B) | xs:boolean |
A eq B | Gregorian | Gregorian | op:gYear-equal(A, B) etc. | xs:boolean |
A eq B | xs:hexBinary | xs:hexBinary | op:hexBinary-equal(A, B) | xs:boolean |
A eq B | xs:base64Binary | xs:base64Binary | op:base64Binary-equal(A, B) | xs:boolean |
A eq B | xs:anyURI | xs:anyURI | op:numeric-equal(fn:compare(A, B), 0) | xs:boolean |
A eq B | xs:QName | xs:QName | op:QName-equal(A, B) | xs:boolean |
A eq B | xs:NOTATION | xs:NOTATION | op:NOTATION-equal(A, B) | xs:boolean |
A ne B | numeric | numeric | fn:not(op:numeric-equal(A, B)) | xs:boolean |
A ne B | xs:boolean | xs:boolean | fn:not(op:boolean-equal(A, B)) | xs:boolean |
A ne B | xs:string | xs:string | fn:not(op:numeric-equal(fn:compare(A, B), 0)) | xs:boolean |
A ne B | xs:date | xs:date | fn:not(op:date-equal(A, B)) | xs:boolean |
A ne B | xs:time | xs:time | fn:not(op:time-equal(A, B)) | xs:boolean |
A ne B | xs:dateTime | xs:dateTime | fn:not(op:dateTime-equal(A, B)) | xs:boolean |
A ne B | xs:duration | xs:duration | fn:not(op:duration-equal(A, B)) | xs:boolean |
A ne B | Gregorian | Gregorian | fn:not(op:gYear-equal(A, B)) etc. | xs:boolean |
A ne B | xs:hexBinary | xs:hexBinary | fn:not(op:hexBinary-equal(A, B)) | xs:boolean |
A ne B | xs:base64Binary | xs:base64Binary | fn:not(op:base64Binary-equal(A, B)) | xs:boolean |
A ne B | xs:anyURI | xs:anyURI | fn:not(op:numeric-equal(fn:compare(A, B), 0)) | xs:boolean |
A ne B | xs:QName | xs:QName | fn:not(op:QName-equal(A, B)) | xs:boolean |
A ne B | xs:NOTATION | xs:NOTATION | fn:not(op:NOTATION-equal(A, B)) | xs:boolean |
A gt B | numeric | numeric | op:numeric-greater-than(A, B) | xs:boolean |
A gt B | xs:boolean | xs:boolean | op:boolean-greater-than(A, B) | xs:boolean |
A gt B | xs:string | xs:string | op:numeric-greater-than(fn:compare(A, B), 0) | xs:boolean |
A gt B | xs:date | xs:date | op:date-greater-than(A, B) | xs:boolean |
A gt B | xs:time | xs:time | op:time-greater-than(A, B) | xs:boolean |
A gt B | xs:dateTime | xs:dateTime | op:dateTime-greater-than(A, B) | xs:boolean |
A gt B | xs:yearMonthDuration | xs:yearMonthDuration | op:yearMonthDuration-greater-than(A, B) | xs:boolean |
A gt B | xs:dayTimeDuration | xs:dayTimeDuration | op:dayTimeDuration-greater-than(A, B) | xs:boolean |
A gt B | xs:anyURI | xs:anyURI | op:numeric-greater-than(fn:compare(A, B), 0) | xs:boolean |
A lt B | numeric | numeric | op:numeric-less-than(A, B) | xs:boolean |
A lt B | xs:boolean | xs:boolean | op:boolean-less-than(A, B) | xs:boolean |
A lt B | xs:string | xs:string | op:numeric-less-than(fn:compare(A, B), 0) | xs:boolean |
A lt B | xs:date | xs:date | op:date-less-than(A, B) | xs:boolean |
A lt B | xs:time | xs:time | op:time-less-than(A, B) | xs:boolean |
A lt B | xs:dateTime | xs:dateTime | op:dateTime-less-than(A, B) | xs:boolean |
A lt B | xs:yearMonthDuration | xs:yearMonthDuration | op:yearMonthDuration-less-than(A, B) | xs:boolean |
A lt B | xs:dayTimeDuration | xs:dayTimeDuration | op:dayTimeDuration-less-than(A, B) | xs:boolean |
A lt B | xs:anyURI | xs:anyURI | op:numeric-less-than(fn:compare(A, B), 0) | xs:boolean |
A ge B | numeric | numeric | op:numeric-greater-than(A, B) or op:numeric-equal(A, B) | xs:boolean |
A ge B | xs:boolean | xs:boolean | fn:not(op:boolean-less-than(A, B)) | xs:boolean |
A ge B | xs:string | xs:string | op:numeric-greater-than(fn:compare(A, B), -1) | xs:boolean |
A ge B | xs:date | xs:date | fn:not(op:date-less-than(A, B)) | xs:boolean |
A ge B | xs:time | xs:time | fn:not(op:time-less-than(A, B)) | xs:boolean |
A ge B | xs:dateTime | xs:dateTime | fn:not(op:dateTime-less-than(A, B)) | xs:boolean |
A ge B | xs:yearMonthDuration | xs:yearMonthDuration | fn:not(op:yearMonthDuration-less-than(A, B)) | xs:boolean |
A ge B | xs:dayTimeDuration | xs:dayTimeDuration | fn:not(op:dayTimeDuration-less-than(A, B)) | xs:boolean |
A ge B | xs:anyURI | xs:anyURI | op:numeric-greater-than(fn:compare(A, B), -1) | xs:boolean |
A le B | numeric | numeric | op:numeric-less-than(A, B) or op:numeric-equal(A, B) | xs:boolean |
A le B | xs:boolean | xs:boolean | fn:not(op:boolean-greater-than(A, B)) | xs:boolean |
A le B | xs:string | xs:string | op:numeric-less-than(fn:compare(A, B), 1) | xs:boolean |
A le B | xs:date | xs:date | fn:not(op:date-greater-than(A, B)) | xs:boolean |
A le B | xs:time | xs:time | fn:not(op:time-greater-than(A, B)) | xs:boolean |
A le B | xs:dateTime | xs:dateTime | fn:not(op:dateTime-greater-than(A, B)) | xs:boolean |
A le B | xs:yearMonthDuration | xs:yearMonthDuration | fn:not(op:yearMonthDuration-greater-than(A, B)) | xs:boolean |
A le B | xs:dayTimeDuration | xs:dayTimeDuration | fn:not(op:dayTimeDuration-greater-than(A, B)) | xs:boolean |
A le B | xs:anyURI | xs:anyURI | op:numeric-less-than(fn:compare(A, B), 1) | xs:boolean |
A is B | node() | node() | op:is-same-node(A, B) | xs:boolean |
A << B | node() | node() | op:node-before(A, B) | xs:boolean |
A >> B | node() | node() | op:node-after(A, B) | xs:boolean |
A union B | node()* | node()* | op:union(A, B) | node()* |
A | B | node()* | node()* | op:union(A, B) | node()* |
A intersect B | node()* | node()* | op:intersect(A, B) | node()* |
A except B | node()* | node()* | op:except(A, B) | node()* |
A to B | xs:integer | xs:integer | op:to(A, B) | xs:integer* |
A , B | item()* | item()* | op:concatenate(A, B) | item()* |
A || B | xs:anyAtomicType | xs:anyAtomicType | fn:concat(A, B) | xs:string |
Operator | Operand type | Function | Result type |
---|---|---|---|
+ A | numeric | op:numeric-unary-plus(A) | numeric |
- A | numeric | op:numeric-unary-minus(A) | numeric |
The tables in this
section describe the scope (range of applicability) of the various
components in
The following table describes the components of
the
Component | Scope |
---|---|
XPath 1.0 Compatibility Mode | global |
Statically known namespaces | global |
Default element/type namespace | global |
Default function namespace | global |
In-scope schema types | global |
In-scope element declarations | global |
In-scope attribute declarations | global |
In-scope variables | lexical; for-expressions, let-expressions, and quantified expressions can bind new variables |
Context item static type | lexical |
| global |
Statically known collations | global |
Default collation | global |
Base URI | global |
Statically known documents | global |
Statically known collections | global |
Statically known default collection type | global |
The following table describes how values are assigned to the various components of the
Component | Scope |
---|---|
Context item | dynamic; changes during evaluation of path expressions and predicates |
Context position | dynamic; changes during evaluation of path expressions and predicates |
Context size | dynamic; changes during evaluation of path expressions and predicates |
Variable values | dynamic; for-expressions, let-expressions, and quantified expressions can bind new variables |
Current date and time | global; must be initialized |
Implicit timezone | global; must be initialized |
Available documents | global; must be initialized |
Available node collections | global; must be initialized |
Default node collection | global; overwriteable by implementation |
Available resource collections | global; must be initialized |
Default resource collection | global; overwriteable by implementation |
The following items in this specification are
The version of Unicode that is used to construct expressions.
The
The
The circumstances in which
The method by which errors are reported to the external processing environment.
Which version of XML and XML Names (e.g.
How XDM instances are created from sources other than an Infoset or PSVI.
Whether the implementation supports the namespace axis.
Whether the type system is based on
The signatures of functions provided by the implementation or via an implementation-defined API (see
Any
Any rules used for static typing (see
Any serialization parameters provided by the implementationn
What error, if any, is returned if an external function's implementation does not return the declared result type (see
Additional
XPath is
intended primarily as a component that can be used by other
specifications. Therefore, XPath relies on specifications that use it
(such as
The specification of such a language may describe it as an extension of XPath provided that every expression that conforms to the XPath grammar behaves as described in this specification.
If an implementation does not support the
It is a
It is a
It is a
It is a
During the analysis phase,
it is a ()
or data(())
is empty-sequence()
.
It is a
An implementation that does not support the namespace axis must raise a
It is a
It is a
It is a E1
in a path expression E1/E2
does not evaluate to a sequence of nodes.
It is a
It is a
An implementation xs:anyURI
It is a treat
expression does not match the treat
expression. This error might also be raised by a path expression beginning with "/
" or "//
" if the context node is not in a tree that is rooted at a document node. This is because a leading "/
" or "//
" in a path expression is an abbreviation for an initial step that includes the clause treat as document-node()
.
It is a
The type must be the name of a type defined in the {variety}
of the type must be simple
.
A xml
or xmlns
appears in a namespace declaration
The prefix xml
is bound to some namespace URI
other than http://www.w3.org/XML/1998/namespace
.
A prefix other than xml
is bound to the
namespace URI http://www.w3.org/XML/1998/namespace
.
The prefix xmlns
is bound to any namespace URI.
A prefix other than xmlns
is bound to the
namespace URI http://www.w3.org/2000/xmlns/
.
It is a
cast
or castable
expression is xs:NOTATION
xs:anySimpleType
,xs:anyAtomicType
.
It is a
In a cast expression, if an item is of type xs:untypedAtomic
and the expected type is
An implementation-defined limit has been exceeded.
It is a http://www.w3.org/2000/xmlns/
.
XQuery 3.0 does not support the namespace axis.
This appendix provides a summary of the areas of incompatibility
between XPath 3.0 and
Three separate cases are considered:
Incompatibilities that exist when source documents have no schema, and when running with XPath 1.0 compatibility mode set to true. This specification has been designed to reduce the number of incompatibilities in this situation to an absolute minimum, but some differences remain and are listed individually.
Incompatibilities that arise when XPath 1.0 compatibility mode is set to false. In this case, the number of expressions where compatibility is lost is rather greater.
Incompatibilities that arise when the source document is processed using a schema (whether or not XPath 1.0 compatibility mode is set to true). Processing the document with a schema changes the way that the values of nodes are interpreted, and this can cause an XPath expression to return different results.
The list below contains all known areas, within the scope of this specification, where
an XPath 3.0 processor running with compatibility mode set to true will produce different
results from an XPath 1.0 processor evaluating the same expression, assuming that the expression
was valid in XPath 1.0, and that the nodes in the source document have no type annotations other than
xs:untyped
and xs:untypedAtomic
.
Incompatibilities in the behavior of individual functions are not listed here, but are included
in an appendix of
Since both XPath 1.0 and XPath 3.0 leave some aspects of the specification implementation-defined, there may be incompatibilities in the behavior of a particular implementation that are outside the scope of this specification. Equally, some aspects of the behavior of XPath are defined by the host language.
Consecutive comparison operators such as A < B < C
were
supported in XPath 1.0, but are not permitted by the XPath 3.0 grammar. In most cases such
comparisons in XPath 1.0 did not have the intuitive meaning, so it is unlikely that
they have been widely used in practice. If such a construct is found, an XPath 3.0 processor
will report a syntax error, and the construct can be rewritten as (A < B) < C
When converting strings to numbers (either explicitly when using the number
function,
or implicitly say on a function call), certain strings that converted to the special value NaN
under XPath 1.0 will convert to values other than NaN
under XPath 3.0. These include
any number written with a leading +
sign, any number in exponential floating point
notation (for example 1.0e+9
), and the strings INF
and -INF
.
Furthermore, the strings Infinity
and -Infinity
, which were accepted by XPath 1.0 as
representations of the floating-point values positive and negative
infinity, are no longer recognized. They are converted
to NaN
when running under XPath 3.0 with compatibility
mode set to true, and cause a dynamic error when compatibility mode is
set to false.
XPath 3.0 does not allow a token starting with a letter to follow immediately after a numeric
literal, without intervening whitespace. For example, 10div 3
was permitted in XPath 1.0,
but in XPath 3.0 must be written as 10 div 3
.
The namespace axis is deprecated
In XPath 1.0, the expression -x|y
parsed
as -(x|y)
, and returned the negation of the numeric value
of the first node in the union of x
and y
. In XPath 3.0, this expression parses
as (-x)|y
. When XPath 1.0 Compatibility Mode is true,
this will always cause a type error.
The rules for converting numbers to strings have
changed. These may affect the way numbers are displayed in the output
of a stylesheet. For numbers whose absolute value is in the
range 1E-6
to 1E+6
, the result should be the
same, but outside this range, scientific format is used for
non-integral xs:float
and xs:double
values.
If one operand in a general comparison is a single atomic
value of type xs:boolean
, the other operand is converted
to xs:boolean
when XPath 1.0 compatibility mode is set to
true. In XPath 1.0, if neither operand of a comparison operation
using the <, <=, > or >= operator was a node set, both
operands were converted to numbers. The result of the expression
true() > number('0.5')
is therefore true in XPath 1.0,
but is false in XPath 3.0 even when compatibility mode is set to
true.
In XPath 3.0, a type error is raised if the PITarget specified in a SequenceType of form processing-instruction(PITarget)
is not a valid NCName. In XPath 1.0, this condition was not treated as an error.
Even when the setting of the XPath 1.0 compatibility mode is false, many XPath expressions will still produce the same results under XPath 3.0 as under XPath 1.0. The exceptions are described in this section.
In all cases it is assumed that the expression
in question was valid under XPath 1.0, that XPath 1.0 compatibility mode is false, and that all elements
and attributes are annotated with the types xs:untyped
and xs:untypedAtomic
respectively.
In the description below, the terms
When a node-set containing more than one node is supplied as an argument to a
function or operator that expects a single node or value, the XPath 1.0 rule was that all nodes after the first were
discarded. Under XPath 3.0, a type error occurs if there is more than one node.
The XPath 1.0 behavior can always be restored by using the predicate [1]
to
explicitly select the first node in the node-set.
In XPath 1.0, the <
and >
operators, when applied
to two strings, attempted to convert both the strings to numbers and then made a numeric
comparison between the results. In XPath 3.0, these operators perform a string comparison using the
default collating sequence. (If either value is numeric, however, the results are compatible
with XPath 1.0)
When an empty node-set is supplied as an argument to a
function or operator that expects a number, the value is no longer converted
implicitly to NaN.
The XPath 1.0 behavior can always be restored by using the number
function to perform an explicit conversion.
More generally, the supplied arguments to a function or operator are no longer implicitly converted
to the required type, except in the case where the supplied argument is of type xs:untypedAtomic
(which will commonly be the case when a node in a schemaless document is supplied as the argument).
For example, the function call substring-before(10 div 3, ".")
raises a type error under XPath 3.0, because the arguments
to the substring-before
function must be strings rather than numbers. The XPath 1.0 behavior can be
restored by performing an explicit conversion to the required type using a constructor function
or cast.
The rules for comparing a node-set to a boolean have changed. In XPath 1.0,
an expression such as $node-set = true()
was evaluated by converting the
node-set to a boolean and then performing a boolean comparison: so this expression would return true
if $node-set
was non-empty. In XPath 3.0, this expression is handled in
the same way as other comparisons between a sequence and a singleton: it is true
if
$node-set
contains at least one node whose value, after atomization and conversion
to a boolean using the casting rules, is true
.
This means that if $node-set
is empty, the result under XPath 3.0
will be false
regardless of
the value of the boolean operand, and regardless of which operator is used.
If $node-set
is non-empty, then in most cases the comparison with a boolean is
likely to fail, giving a dynamic error. But if a node has the value "0",
"1", "true", or "false", evaluation of the expression may succeed.
Comparisons of a number to a boolean, a number to a string, or a string to a boolean
are not allowed in XPath 3.0: they result in a type error. In XPath 1.0 such comparisons were
allowed, and were handled by converting one of the operands to the type of the other. So for
example in XPath 1.0 4 = true()
was true; 4 = "+4"
was false (because
the string +4
converts to NaN
), and false = "false"
was
false (because the string "false"
converts to the boolean true
).
In XPath 3.0 all these comparisons are type errors.
Additional numeric types have been introduced, with the effect that arithmetic
may now be done as an integer, decimal, or single- or double-precision floating point calculation
where previously it was always performed as double-precision floating point.
The result of the div
operator when dividing two integers is now a value
of type decimal rather than double. The expression 10 div 0
raises an
error rather than returning positive infinity.
The rules for converting strings to numbers have changed. The implicit
conversion that occurs when passing an xs:untypedAtomic
value as an argument to a function
that expects a number no longer converts unrecognized strings to the value NaN
;
instead, it reports a dynamic error. This is in addition to the differences that apply
when backwards compatibility mode is set to true.
Many operations in XPath 3.0 produce an empty sequence as their result
when one of the arguments or operands is an empty sequence. Where the operation
expects a string, an empty sequence is usually considered equivalent to a zero-length string, which
is compatible with the XPath 1.0 behavior. Where the operation expects a number, however, the
result is not the same. For example, if @width
returns an empty sequence, then
in XPath 1.0 the result of @width+1
was NaN
, while with XPath 3.0
it is ()
. This has the effect that a filter expression such as item[@width+1 != 2]
will select items having no width
attribute under XPath 1.0, and will not select them
under XPath 3.0.
The typed value of a comment node, processing instruction node, or namespace node under
XPath 3.0 is of type xs:string
, not xs:untypedAtomic
. This means that no implicit conversions
are applied if the value is used in a context where a number is expected. If a processing-instruction node is used as an operand of
an arithmetic operator, for example, XPath 1.0 would attempt to convert the string value of the node to a number (and deliver
NaN
if unsuccessful), while XPath 3.0 will report a type error.
In XPath 1.0, it was defined that with an expression of the form A and
B
,
B would not be evaluated if A was false. Similarly in the case of A or
B
, B would not be evaluated if A was true. This is no longer
guaranteed with XPath 3.0: the implementation is free to evaluate the two
operands in either order or in parallel. This change has been made to give
more scope for optimization in situations where XPath expressions are
evaluated against large data collections supported by indexes. Implementations
may choose to retain backwards compatibility in this area, but they are not
obliged to do so.
In XPath 1.0, the expression -x|y
parsed
as -(x|y)
, and returned the negation of the numeric value
of the first node in the union of x
and y
. In XPath 3.0, this expression parses
as (-x)|y
. When XPath 1.0 Compatibility Mode is false,
this will cause a type error, except in the situation
where x
evaluates to an empty sequence. In that
situation, XPath 3.0 will return the value of y
, whereas
XPath 1.0 returned the negation of the numeric value
of y
.
An XPath expression applied to a document that has been processed against a schema will not always give the same results as the same expression applied to the same document in the absence of a schema. Since schema processing had no effect on the result of an XPath 1.0 expression, this may give rise to further incompatibilities. This section gives a few examples of the differences that can arise.
Suppose that the context node is an element node derived from
the following markup: <background color="red green blue"/>
.
In XPath 1.0, the predicate [@color="blue"]
would return false
.
In XPath 3.0, if the color
attribute is defined in a schema
to be of type xs:NMTOKENS
, the same predicate will return true
.
Similarly, consider the expression @birth < @death
applied to the
element <person birth="1901-06-06" death="1991-05-09"/>
. With XPath 1.0, this
expression would return false, because both attributes are converted to numbers, which returns
NaN
in each case. With XPath 3.0, in the presence of a schema that annotates these
attributes as dates, the expression returns true
.
Once schema validation is applied, elements and attributes cannot be used as operands and arguments
of expressions that expect a different data type. For example, it is no longer possible to apply the substring
function to a date to extract the year component, or to a number to extract the integer part. Similarly, if an attribute is
annotated as a boolean then it is not possible to compare it with the strings "true"
or "false"
.
All such operations lead to type errors. The remedy when such errors occur is to introduce an explicit conversion, or
to do the computation in a different way. For example, substring-after(@temperature, "-")
might be
rewritten as abs(@temperature)
.
In the case of an XPath 3.0 implementation that provides the static typing feature, many further type errors will
be reported in respect of expressions that worked under XPath 1.0. For example, an expression such as
round(../@price)
might lead to a static type error because the processor cannot infer statically that
../@price
is guaranteed to be numeric.
Schema validation will in many cases perform whitespace normalization on the contents of elements (depending on their type).
This will change the result of operations such as the string-length
function.
Schema validation augments the data model by adding default values for omitted attributes and empty elements.
This appendix lists the changes that have been made to this
specification since the
The following names are now reserved, and cannot appear as function names (see
function
namespace-node
switch
Code written for XQuery 1.0 processors may assume that every item
is either a node or an atomic value. This is no longer true, since
XQuery 3.0 introduces function items. Thus, an XQuery 1.0 function
that declares a parameter as an item()
can now have a
function item passed as a parameter, which might not have been
anticipated by the author of the function.
The following substantive changes have been made.
Removed require-feature()
/prohibit-feature()
due to implementation experience.
Added entry to function
,
namespace-node
, and switch
are all reserved. Resolves
Added entry to
Fixed text for castable. Resolves
Added error code
Changed fn:map
to fn:for-each
, changed fn:map-pairs
to fn:for-each-pair
.
See
Adopted new definition of derives-from(AT, ET).
Resolves
If the NodeTest in an axis step is a NamespaceNodeTest then a static error is raised.
Resolves
A try/catch expression catches dynamic errors and type errors raised by the evaluation of the target expression of the try clause. Previously, the text referred to expressions lexically contained within the try clause. Resolves
The host language must specify whether or not the XPath 3.0 processor normalizes all
line breaks before parsing, and if it does so, whether it uses the rules of XML 1.0 or 1.1.
Resolves
Added support for xs:error
.
Resolves
If any component in the focus is defined, all components of the focus are defined.
Resolves
XPath expressions allow any legal XML Unicode character, subject only to constraints imposed by the host language.
Changed XPTY0117 to FONS0004 in section 2.5.2, changed text of
Explicitly stated that no catch clause "matches" the error value, a the try/catch expression raises the error that was raised by the target expression.
Resolves
Changed "When tokenizing, the longest possible match that is valid in the current context is used." to "When tokenizing, the longest possible match consistent with the EBNF is used." Decided in Teleconference #541 2013-05-21.
Added an exception for subtype(Ai*, Bi?) when Ai is a pure union type with no member types, as in xs:error. Resolves
Modified definition of statically known decimal formats in context. Resolves
A processor must not raise errors for serialization parameters that it does not support. "A processor that is performing serialization must raise a serialization error if the values of any serialization parameters
Changed the second rule of
Removed the paragraph that said no published version of XML Schema references the XML 1.1 specifications, since this is no longer true.
Modified xs:error
. Resolves
Improved Step 5.b.ii.A in
The following are some of the editorial changes that have been made.
Deleted unused error, checked for consistency of errors.
Resolves
Added an example to show how to copy "unused" namespaces from one node to another using in-scope-prefixes($e) ! namespace {namespace-uri-for-prefix($e,.)} {.}
.
Resolves
Restored normative status of FunctionTest semantics - see
Added entry for
Deleted note on the converse relationship from
Removed statement that implied the XQuery 3.0 requirements include a requirement for an XML-based representation.
The following are changes that have been decided, but are no longer relevant because of our decision to remove require-feature
/prohibit-feature
.
Resolution of the following bugs, all related to require/prohibit feature, has not yet been implemented in this document:
The following substantive changes have been made.
Pure union types (formerly known as restricted union types) are now permitted in AtomicOrUnionTypes. Resolves
Adopted the XML restriction that control characters #x1 to #x1F and 0x7F to 0x9F cannot appear in unescaped form in an XQuery. Resolves
Function conversion rules depend on the setting of XPath 1.0 compatibility mode only for static functions. Resolves
Added available text resources to the static context, as part of the resolution of
Changed error XQST0046 for URI literals so that it is no longer dependent on the lexical space of xs:anyURI - the error is now raised if the value of a URILiteral or a BracedURILiteral is of nonzero length and is neither an absolute URI nor a relative URI. Resolves
Clarified and extended rules for casting. Resolves
Abandoned the special casting rule that prevented atomization for namespace sensitive types. Resolves
The split of base URI into static base URI and dynamic
base URI has been reverted. Resolves
Changed the syntax of EQName to avoid conflicts with potential JSON syntax extensions in future versions. Resolves
Relaxed rules that required inputs, outputs, and query modules to all use the same versions of XML, XML Names, and XML Schemas for names, characters, attribute value normalization, line-breaks, etc. Resolves
Function items are now supported for context-dependent functions if they depend only on the static context. Resolves
Removed error XPDY0229. Resolves
Changed precedence of simple map operator, reorganized text accordingly. Resolves
Integrated proposals on static and dynamic context
from
If there is a Comment before the end of a Version Declaration, an implementation must either raise an implementation-defined static error or ignore the commment. Decided in Montreal Face-to-Face, see
Changed rules for whitespace in URI Literals and Braced URI Literals in
Updated the appendix of implementation-defined items.
In E castable as T
, if E
raises a dyanmic error, castable
returns false
, it does not "fail". See
Adopted rewording of
Corrected rule #17 of
Added error http://www.w3.org/2000/xmlns/
, in the early section on names. Removed duplicate material in the section on node tests. Resolves
Updated function
, namespace-node
, and switch
). Fulfils Action A-523-06.
Ai is a subtype of Bi if Ai and Bi are both pure union types, and every type t in the transitive membership of Ai is also in the transitive membership of Bi. Resolves
Added html-version
and item-separator
to Appendix C.1. Resolves
Implementations must raise an error if limits are exceeded. Resolves
The following are some of the editorial changes that have been made.
Introduced the concept of singleton focus, borrowed from XSLT, and used it to clarify context declaration. Resolves
Reworked much of the prose re functions, to increase clarity and better accommodate dynamic function calls and partial function applications.
Reworked abstract and introductory text for XPath.
Consistently use "absent" for properties with no value in both static and dynamic context.
Removed erroneous references to modules in XPath.
Removed erroneous reference to XQST0034 codes in XPath.
More consistent use of terminology for raising an error, eliminating other terms (signal, report, raise, throw) that have been used in various versions of this specification over the years.
Eliminated Serialization section, which has no place in the XPath specification.
Improved the definition of
Added a reference to XQuery try/catch expressions as a possible implementation-defined way to catch errors.
Editorial rewrite of the description of document order.
Corrected erroneous inclusion of XQuery text on function assertions in XPath.
Corrected several places where EQNames, QNames, and expanded QNames were conflated.
Simplified
Improved the definition of
Removed change log entries that apply only to XQuery.
Removed a dangling note describing an obsolete error for context-sensitive functions in
Fixed headings in Appendix C that implied that it describes static and dynamic contexts only for modules. Resolves
The following substantive changes have been made in prior Working Drafts.
Applied all
Added
Added inline function
Added dynamic function
Added
Added
Clarified type information available to
Modified
Added
Removed section on static typing extensions.
Added support for literal URLs in names, using
Added support for XML Schema 1.1.
Added support for union types in function arguments.
Clarified wording on conflicts between function signatures and constructor functions in
Added definition for closure of a function item. Resolves
Added missing consistency constraints for statically known namespaces to xmlns
is not bound to any namespace URI, no prefix is bound to the namespace URI http://www.w3.org/2000/xmlns/
). Resolves
Adopted rules for abstract elements in substitution groups: abstract elements do not appear in substitution groups, block attributes must be taken into account when building the substitution groups. Resolves
Added missing semantics for EQNames with URILiterals. Resolves
Added support for casting to union types. Resolves
Allowed a URILiteral
in Wildcard
. (This change appeared in an earlier draft, but was not mentioned in the corresponding change log.)
How XDM instances are created from sources other than an Infoset or PSVI is implementation-defined. Resolves
Clarified use of Static Base URI, Dynamic Base URI per
Adds errors for casts to namepace sensitive types in cast and function conversion rules. Resolves
Specified use of "unknown" types, including types from documents and types from other modules. Eliminated err:XQST0036. Resolves
Introduced
Added string concatenation operator "con" || "cat" || "enate"
Implemented simple mapping operator proposal using "!" operator. Resolves
Changed rules for matching substitution groups. Resolves
For a partial function application, a failure in the function conversion rules MUST raise a type error.
Function item coercion is required to raise a type error if there's a mismatch in the number of parameters (expected vs actual). Resolves
In the triggers for err:XPST0112, broaden the class of functions that can't be referenced by partial function applications and named function references, from "focus-dependent" to "context-dependent built-in".
Added default language, calendar, and place to the dynamic context. Resolves
Removed function annotations from XPath. Resolves
Whether end-of-line handling is done before parsing is defined by the host language. Resolves
Expanded definition of XPST0080 so that casting to xs:anySimpleType is also an error. Resolves