This document is also available in these non-normative formats: XML and Recent revisions.
Copyright © 2005 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark and document use rules apply.
This document defines constructor functions, operators and functions on the datatypes defined in [XML Schema Part 2: Datatypes Second Edition] and the datatypes defined in [XQuery 1.0 and XPath 2.0 Data Model] and in this document. It also discusses functions and operators on nodes and node sequences as defined in the [XQuery 1.0 and XPath 2.0 Data Model]. These functions and operators are defined for use in [XML Path Language (XPath) 2.0], [XQuery 1.0: An XML Query Language] and [XSL Transformations (XSLT) Version 2.0] and other related XML standards. The signatures and summaries of functions defined in this document are available at: http://www.w3.org/2005/xpath-functions/.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
This is a Candidate Recommendation as described in the Process Document. This document is intended for review by W3C members and other interested parties. The publication of this document constitutes a call for implementations of this specification. This specification will remain a Candidate Recommendation until at least 28 February 2006.
This document has been jointly produced by the XML Query Working Group (WG) and the XSL Working Group, both of which are part of the XML Activity. Publication as a Candidate 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 draft includes corrections and changes based on public comments recorded in the W3C public Bugzilla repository (http://www.w3.org/Bugs/Public/) used for Last Call issues tracking. A list of substantive changes since the Last Call Working Draft of 04 April 2005 can be found in B Change Log for this Version of the Document.
Comments on this document should be made in W3C's public Bugzilla system (instructions can be found at http://www.w3.org/XML/2005/04/qt-bugzilla). If access to that system is not feasible, you may send your comments to the W3C XSLT/XPath/XQuery mailing list, public-qt-comments@w3.org. It will be very helpful if you include the string [F&O] in the subject line of your comment, whether made in Bugzilla or in email. Each Bugzilla entry and email message should contain only one comment. Archives of the comments and responses are available at http://lists.w3.org/Archives/Public/public-qt-comments/ .
The XML Query and XSL WGs plan to submit this specification for consideration as a W3C Proposed Recommendation as soon as both the XQuery 1.0 specification and the XSLT 2.0 specification have been submitted for consideration as a W3C Proposed Recommendation.
The XML Query and XPath Test Suite is under development. Implementors are encouraged to run this test suite and report their results.
The patent policy for this document is the 5 February 2004 W3C Patent Policy. Patent disclosures relevant to this specification may be found on the XML Query Working Group's patent disclosure page and the XSL Working Group's patent disclosure page. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) with respect to this specification should disclose the information in accordance with section 6 of the W3C Patent Policy.
1 Introduction
1.1 Conformance
1.2 Namespaces and Prefixes
1.3 Function Overloading
1.4 Function Signatures and Descriptions
1.5 Namespace Terminology
1.6 Type Hierarchy
1.7 Terminology
2 Accessors
2.1 fn:node-name
2.2 fn:nilled
2.3 fn:string
2.4 fn:data
2.5 fn:base-uri
2.6 fn:document-uri
3 The Error Function
3.1 Examples
4 The Trace Function
4.1 Examples
5 Constructor Functions
5.1 Constructor Functions for XML Schema Built-in Types
5.2 A Special Constructor Function for xs:dateTime
5.2.1 Examples
5.3 Constructor Functions for User-Defined Types
6 Functions and Operators on Numerics
6.1 Numeric Types
6.2 Operators on Numeric Values
6.2.1 op:numeric-add
6.2.2 op:numeric-subtract
6.2.3 op:numeric-multiply
6.2.4 op:numeric-divide
6.2.5 op:numeric-integer-divide
6.2.6 op:numeric-mod
6.2.7 op:numeric-unary-plus
6.2.8 op:numeric-unary-minus
6.3 Comparison of Numeric Values
6.3.1 op:numeric-equal
6.3.2 op:numeric-less-than
6.3.3 op:numeric-greater-than
6.4 Functions on Numeric Values
6.4.1 fn:abs
6.4.2 fn:ceiling
6.4.3 fn:floor
6.4.4 fn:round
6.4.5 fn:round-half-to-even
7 Functions on Strings
7.1 String Types
7.2 Functions to Assemble and Disassemble Strings
7.2.1 fn:codepoints-to-string
7.2.2 fn:string-to-codepoints
7.3 Equality and Comparison of Strings
7.3.1 Collations
7.3.2 fn:compare
7.3.3 fn:codepoint-equal
7.4 Functions on String Values
7.4.1 fn:concat
7.4.2 fn:string-join
7.4.3 fn:substring
7.4.4 fn:string-length
7.4.5 fn:normalize-space
7.4.6 fn:normalize-unicode
7.4.7 fn:upper-case
7.4.8 fn:lower-case
7.4.9 fn:translate
7.4.10 fn:encode-for-uri
7.4.11 fn:iri-to-uri
7.4.12 fn:escape-html-uri
7.5 Functions Based on Substring Matching
7.5.1 fn:contains
7.5.2 fn:starts-with
7.5.3 fn:ends-with
7.5.4 fn:substring-before
7.5.5 fn:substring-after
7.6 String Functions that Use Pattern Matching
7.6.1 Regular Expression Syntax
7.6.2 fn:matches
7.6.3 fn:replace
7.6.4 fn:tokenize
8 Functions and Operators for anyURI
8.1 fn:resolve-uri
9 Functions and Operators on Boolean Values
9.1 Additional Boolean Constructor Functions
9.1.1 fn:true
9.1.2 fn:false
9.2 Operators on Boolean Values
9.2.1 op:boolean-equal
9.2.2 op:boolean-less-than
9.2.3 op:boolean-greater-than
9.3 Functions on Boolean Values
9.3.1 fn:not
10 Functions and Operators on Durations, Dates and Times
10.1 Duration, Date and Time Types
10.1.1 Limits and Precision
10.2 Date/time datatype values
10.2.1 Examples
10.3 Two Totally Ordered Subtypes of Duration
10.3.1 xdt:yearMonthDuration
10.3.2 xdt:dayTimeDuration
10.4 Comparisons of Duration, Date and Time Values
10.4.1 op:yearMonthDuration-equal
10.4.2 op:yearMonthDuration-less-than
10.4.3 op:yearMonthDuration-greater-than
10.4.4 op:dayTimeDuration-equal
10.4.5 op:dayTimeDuration-less-than
10.4.6 op:dayTimeDuration-greater-than
10.4.7 op:duration-equal
10.4.8 op:dateTime-equal
10.4.9 op:dateTime-less-than
10.4.10 op:dateTime-greater-than
10.4.11 op:date-equal
10.4.12 op:date-less-than
10.4.13 op:date-greater-than
10.4.14 op:time-equal
10.4.15 op:time-less-than
10.4.16 op:time-greater-than
10.4.17 op:gYearMonth-equal
10.4.18 op:gYear-equal
10.4.19 op:gMonthDay-equal
10.4.20 op:gMonth-equal
10.4.21 op:gDay-equal
10.5 Component Extraction Functions on Durations, Dates and Times
10.5.1 fn:years-from-duration
10.5.2 fn:months-from-duration
10.5.3 fn:days-from-duration
10.5.4 fn:hours-from-duration
10.5.5 fn:minutes-from-duration
10.5.6 fn:seconds-from-duration
10.5.7 fn:year-from-dateTime
10.5.8 fn:month-from-dateTime
10.5.9 fn:day-from-dateTime
10.5.10 fn:hours-from-dateTime
10.5.11 fn:minutes-from-dateTime
10.5.12 fn:seconds-from-dateTime
10.5.13 fn:timezone-from-dateTime
10.5.14 fn:year-from-date
10.5.15 fn:month-from-date
10.5.16 fn:day-from-date
10.5.17 fn:timezone-from-date
10.5.18 fn:hours-from-time
10.5.19 fn:minutes-from-time
10.5.20 fn:seconds-from-time
10.5.21 fn:timezone-from-time
10.6 Arithmetic Functions on Durations
10.6.1 op:add-yearMonthDurations
10.6.2 op:subtract-yearMonthDurations
10.6.3 op:multiply-yearMonthDuration
10.6.4 op:divide-yearMonthDuration
10.6.5 op:divide-yearMonthDuration-by-yearMonthDuration
10.6.6 op:add-dayTimeDurations
10.6.7 op:subtract-dayTimeDurations
10.6.8 op:multiply-dayTimeDuration
10.6.9 op:divide-dayTimeDuration
10.6.10 op:divide-dayTimeDuration-by-dayTimeDuration
10.7 Timezone Adjustment on Dates and Time Values
10.7.1 fn:adjust-dateTime-to-timezone
10.7.2 fn:adjust-date-to-timezone
10.7.3 fn:adjust-time-to-timezone
10.8 Arithmetic Functions on Durations, Dates and Times
10.8.1 op:subtract-dateTimes
10.8.2 op:subtract-dates
10.8.3 op:subtract-times
10.8.4 op:add-yearMonthDuration-to-dateTime
10.8.5 op:add-dayTimeDuration-to-dateTime
10.8.6 op:subtract-yearMonthDuration-from-dateTime
10.8.7 op:subtract-dayTimeDuration-from-dateTime
10.8.8 op:add-yearMonthDuration-to-date
10.8.9 op:add-dayTimeDuration-to-date
10.8.10 op:subtract-yearMonthDuration-from-date
10.8.11 op:subtract-dayTimeDuration-from-date
10.8.12 op:add-dayTimeDuration-to-time
10.8.13 op:subtract-dayTimeDuration-from-time
11 Functions Related to QNames
11.1 Additional Constructor Functions for QNames
11.1.1 fn:resolve-QName
11.1.2 fn:QName
11.2 Operators and Functions Related to QNames
11.2.1 op:QName-equal
11.2.2 fn:prefix-from-QName
11.2.3 fn:local-name-from-QName
11.2.4 fn:namespace-uri-from-QName
11.2.5 fn:namespace-uri-for-prefix
11.2.6 fn:in-scope-prefixes
12 Functions and Operators on base64Binary and hexBinary
12.1 Comparisons of base64Binary and hexBinary Values
12.1.1 op:hexBinary-equal
12.1.2 op:base64Binary-equal
13 Functions and Operators on NOTATION
13.1 Operators on NOTATION
13.1.1 op:NOTATION-equal
14 Functions and Operators on Nodes
14.1 fn:name
14.2 fn:local-name
14.3 fn:namespace-uri
14.4 fn:number
14.4.1 Examples
14.5 fn:lang
14.5.1 Examples
14.6 op:is-same-node
14.6.1 Examples
14.7 op:node-before
14.7.1 Examples
14.8 op:node-after
14.8.1 Examples
14.9 fn:root
14.9.1 Examples
15 Functions and Operators on Sequences
15.1 General Functions and Operators on Sequences
15.1.1 fn:boolean
15.1.2 op:concatenate
15.1.3 fn:index-of
15.1.4 fn:empty
15.1.5 fn:exists
15.1.6 fn:distinct-values
15.1.7 fn:insert-before
15.1.8 fn:remove
15.1.9 fn:reverse
15.1.10 fn:subsequence
15.1.11 fn:unordered
15.2 Functions That Test the Cardinality of Sequences
15.2.1 fn:zero-or-one
15.2.2 fn:one-or-more
15.2.3 fn:exactly-one
15.3 Equals, Union, Intersection and Except
15.3.1 fn:deep-equal
15.3.2 op:union
15.3.3 op:intersect
15.3.4 op:except
15.4 Aggregate Functions
15.4.1 fn:count
15.4.2 fn:avg
15.4.3 fn:max
15.4.4 fn:min
15.4.5 fn:sum
15.5 Functions and Operators that Generate Sequences
15.5.1 op:to
15.5.2 fn:id
15.5.3 fn:idref
15.5.4 fn:doc
15.5.5 fn:doc-available
15.5.6 fn:collection
16 Context Functions
16.1 fn:position
16.2 fn:last
16.3 fn:current-dateTime
16.3.1 Examples
16.4 fn:current-date
16.4.1 Examples
16.5 fn:current-time
16.5.1 Examples
16.6 fn:implicit-timezone
16.7 fn:default-collation
16.8 fn:static-base-uri
17 Casting
17.1 Casting from primitive types to primitive types
17.1.1 Casting from xs:string and xdt:untypedAtomic
17.1.2 Casting to xs:string and xdt:untypedAtomic
17.1.3 Casting to numeric types
17.1.4 Casting to duration types
17.1.5 Casting to date and time types
17.1.6 Casting to xs:boolean
17.1.7 Casting to xs:base64Binary and xs:hexBinary
17.1.8 Casting to xs:anyURI
17.2 Casting to derived types
17.3 Casting from derived types to parent types
17.4 Casting within a branch of the type hierarchy
17.4.1 Casting to xs:ENTITY
17.5 Casting across the type hierarchy
A References
A.1 Normative References
A.2 Non-normative References
B Change Log for this Version of the Document
C Error Summary
D Compatibility with XPath 1.0 (Non-Normative)
E Illustrative User-written Functions (Non-Normative)
E.1 eg:if-empty and eg:if-absent
E.1.1 eg:if-empty
E.1.2 eg:if-absent
E.2 union, intersect and except on sequences of values
E.2.1 eg:value-union
E.2.2 eg:value-intersect
E.2.3 eg:value-except
E.3 eg:index-of-node
E.4 eg:string-pad
E.5 eg:distinct-nodes-stable
F Schema for the XDT Namespace (Non-Normative)
G Checklist of Implementation-Defined Features (Non-Normative)
H Function and Operator Quick Reference (Non-Normative)
H.1 Functions and Operators by Section
H.2 Functions and Operators Alphabetically
The purpose of this document is to catalog the functions and operators required for XPath 2.0, XML Query 1.0 and XSLT 2.0. The exact syntax used to invoke these functions and operators is specified in [XML Path Language (XPath) 2.0], [XQuery 1.0: An XML Query Language] and [XSL Transformations (XSLT) Version 2.0].
This document defines constructor functions and functions that take typed values as arguments. Some of the functions define the semantics of operators discussed in [XQuery 1.0: An XML Query Language].
[XML Schema Part 2: Datatypes Second Edition] defines a number of primitive and derived datatypes, collectively known as built-in datatypes. This document defines functions and operations on these datatypes as well as the three datatypes defined in Section 2.6 TypesDM and the two totally ordered subtypes of the duration datatype from [XML Schema Part 2: Datatypes Second Edition] defined in 10.3 Two Totally Ordered Subtypes of Duration. These functions and operations are defined for use in [XML Path Language (XPath) 2.0], [XQuery 1.0: An XML Query Language] and [XSL Transformations (XSLT) Version 2.0] and related XML standards. This document also discusses functions and operators on nodes and node sequences as defined in the [XQuery 1.0 and XPath 2.0 Data Model] for use in [XML Path Language (XPath) 2.0], [XQuery 1.0: An XML Query Language] and [XSL Transformations (XSLT) Version 2.0] and other related XML standards.
References to specific sections of some of the above documents are indicated by cross-document links in this document. Each such link consists of a pointer to a specific section followed a superscript specifying the linked document. The superscripts have the following meanings: 'XQ' [XQuery 1.0: An XML Query Language], 'XT' [XSL Transformations (XSLT) Version 2.0], 'XP' [XML Path Language (XPath) 2.0], 'DM' [XQuery 1.0 and XPath 2.0 Data Model] and 'FS' [XQuery 1.0 and XPath 2.0 Formal Semantics].
The Functions and Operators specification is intended primarily as a component that can be used by other specifications. Therefore, Functions and Operators relies on specifications that use it (such as [XML Path Language (XPath) 2.0], [XSL Transformations (XSLT) Version 2.0] and [XQuery 1.0: An XML Query Language]) to specify conformance criteria for their respective environments.
Authors of conformance criteria for the use of the Functions and Operators should pay particular attention to the following features:
Support for XML 1.0 and XML 1.1 by the datatypes used in Functions and Operators.
It is ·implementation-defined· which version of Unicode is supported, but it is recommended that the most recent version of Unicode be used.
The functions and operators discussed in this document are contained in one of four namespaces (see [Namespaces in XML]) and referenced using a xs:QName
. Constructor functions for the built-in datatypes defined in [XML Schema Part 2: Datatypes Second Edition] discussed in 5 Constructor Functions are in the XML Schema namespace, http://www.w3.org/2001/XMLSchema
, and named in this
document using the xs
prefix. The namespace prefix used in this document for functions that are available to users is fn
. Operator functions are named with the prefix op
.
The datatypes defined in [XQuery 1.0 and XPath 2.0 Data Model] Section 2.6 TypesDM and 10.3 Two Totally Ordered Subtypes of Duration in this document are contained in a separate namespace and are named using the prefix xdt
.
This document uses the prefix err
to represent the namespace URI http://www.w3.org/2005/xqt-errors
, which is the namespace for all XPath and XQuery error codes and messages. This namespace prefix is not predeclared and its use in this document is not normative.
The namespace prefix used for the functions, datatypes and errors can vary, as long as the prefix is bound to the correct URI.
The URIs of the namespaces and the default prefixes associated with them are:
http://www.w3.org/2001/XMLSchema
for constructors -- associated with xs
.
http://www.w3.org/2005/xpath-functions
for functions -- associated with fn
.
http://www.w3.org/2005/xpath-datatypes
for the datatypes -- associated with xdt
.
http://www.w3.org/2005/xqt-errors
-- associated with err
.
Note:
The namespace URI associated with the err
prefix is not expected to change from one version of this document to another. The contents of this namespace may be extended to allow additional errors to be returned.
The functions defined with an fn
prefix are callable by the user. Functions defined with the op
prefix are described here to underpin the definitions of the operators in [XML Path Language (XPath) 2.0], [XQuery 1.0: An XML Query Language] and [XSL Transformations (XSLT) Version 2.0]. These functions are not available directly to users, and there is no requirement that implementations should actually provide
these functions. For this reason, no namespace is associated with the op
prefix. For example, multiplication is generally associated with the *
operator, but it is described as a function in this document:
op:multiply
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
In general, the specifications named above do not support function overloading in the sense that functions that have multiple signatures with the same name and the same number of parameters are not supported. Consequently, there are no such overloaded functions in this document except for legacy [XML Path Language (XPath) Version 1.0] functions such as fn:string()
, which accepts a single parameter of a variety of types. In addition, it should
be noted that the functions defined in 6 Functions and Operators on Numerics that accept numeric
parameters accept arguments of type xs:integer
, xs:decimal
, xs:float
or xs:double
. See 1.4 Function Signatures and Descriptions. Operators such as "+" may be overloaded. This document does define some functions with more than one signature with the same name and
different number of parameters. User-defined functions with more than one signature with the same name and different number of parameters are also supported.
Each function is defined by specifying its signature, a description of the return type and each of the parameters and its semantics. For many functions, examples are included to illustrate their use.
Each function's signature is presented in a form like this:
fn:function-name
($parameter-name
as
parameter-type
, ...) as
return-type
In this notation, function-name, in bold-face, is the name of the function whose signature is being specified. If the function takes no parameters, then the name is followed by an empty parameter list: "()
"; otherwise, the name is followed by a parenthesized list of parameter declarations, each declaration specifies the static type of the parameter, in italics, and a descriptive, but non-normative, name. If there are two or more parameter declarations, they are separated by a comma.
The return-type
, also in italics, specifies the static type of the value returned by the function. The dynamic type returned by the function is the same as its static type or derived from the static type. All parameter types and return types are specified using the SequenceType notation defined in Section 2.5.3 SequenceType SyntaxXP.
In some cases the word " numeric
" is used in function signatures as a shorthand to indicate the four numeric types: xs:integer
, xs:decimal
, xs:float
and xs:double
. For example, a function with the signature
fn:numeric-function
($arg
as
numeric
) as
...
fn:numeric-function
($arg
as
xs:integer
) as
...
fn:numeric-function
($arg
as
xs:decimal
) as
...
fn:numeric-function
($arg
as
xs:float
) as
...
fn:numeric-function
($arg
as
xs:double
) as
...
For most functions there is an initial paragraph describing what the function does followed by semantic rules. These rules are meant to be followed in the order that they appear in this document.
In some cases, the static type returned by a function depends on the type(s) of its argument(s). These special functions are indicated by using bold italics for the return type. The semantic rules specifying the type of the value returned are documented in the function definition. The rules are described more formally in Section 7.2 Standard functions with specific typing rulesFS.
The function name is a QName
as defined in [XML Schema Part 2: Datatypes Second Edition] and must adhere to its syntactic conventions. Following [XML Path Language (XPath) Version 1.0], function names are composed of English words separated by hyphens,"-". If a function name contains a [XML Schema Part 2: Datatypes Second Edition] datatype name, it may have intercapitalized spelling and is used in the function name
as such. For example, fn:timezone-from-dateTime
.
Rules for passing parameters to operators are described in the relevant sections of [XQuery 1.0: An XML Query Language] and [XML Path Language (XPath) 2.0]. For example, the rules for passing parameters to arithmetic operators are described in Section 3.4 Arithmetic ExpressionsXP. Specifically, rules for parameters of type xdt:untypedAtomic
and the empty sequence
are specified in this section.
As is customary, the parameter type name indicates that the function or operator accepts arguments of that type, or types derived from it, in that position. This is called subtype substitution (See Section 2.5.4 SequenceType MatchingXP). In addition, numeric type instances and instances of type xs:anyURI
can be promoted to produce an argument of the required type. (See Section B.1 Type PromotionXP).
Subtype Substitution: A derived type may substitute for its base type. In particular, xs:integer
may be used where xs:decimal
is expected.
Numeric Type Promotion: xs:decimal
may be promoted to xs:float
or xs:double
. Promotion to xs:double
should be done directly, not via xs:float
, to avoid loss of precision.
anyURI Type Promotion: A value of type xs:anyURI
can be promoted to the type xs:string
.
Some functions accept a single value or the empty sequence as an argument and some may return a single value or the empty sequence. This is indicated in the function signature by following the parameter or return type name with a question mark: "?
", indicating that either a single value or the empty sequence must appear. See below.
fn:function-name
($parameter-name
as
parameter-type?
) as
return-type?
Note that this function signature is different from a signature in which the parameter is omitted. See, for example, the two signatures for fn:string()
. In the first signature, the parameter is omitted and the argument defaults to the context item, referred to as ".". In the second signature, the argument must be present but may be the empty sequence, referred to as "()."
Some functions accept a sequence of zero or more values as an argument. This is indicated by following the name of type of the items in the sequence with *
. The sequence may contain zero or more items of the named type. For example, the function below accepts a sequence of xs:double
and returns a xs:double
or the empty sequence.
fn:median
($arg
as
xs:double*
) as
xs:double?
This document uses the phrase "namespace URI" to identify the concept identified in [Namespaces in XML] as "namespace name", and the phrase "local name" to identify the concept identified in [Namespaces in XML] as "local part".
It also uses the term "expanded-QName" defined below.
An expanded-QName is a pair of values consisting of a namespace URI and a local name. They belong to the value space of the [XML Schema Part 2: Datatypes Second Edition] datatype xs:QName
. When this document refers to xs:QName
we always mean the value space, i.e. a namespace URI, local name pair (and not the lexical space referring to constructs of the form prefix:local-name).
The diagram below shows the types for which functions are defined in this document. These include the built-in types defined by [XML Schema Part 2: Datatypes Second Edition] (shown on the right) as well as types defined in [XQuery 1.0 and XPath 2.0 Data Model] (shown on the left). Solid lines connect a base datatype above to a derived datatype.xs:IDREFS
, xs:NMTOKENS
, xs:ENTITIES
and user-defined list
and union types
are special types in that these types are lists or unions rather than true subtypes. Dashed lines connect a union type above with its component types below.
The information in the above diagram is reproduced below in tabular form. For ease of presentation the information is divided into three tables. The first table shows the top three layers of the hierarchy starting at xs:anyType
. The second table shows the types derived from xdt:anyAtomicType
. The third table shows the types defined in [XQuery 1.0 and XPath 2.0 Data Model]
Each type whose name is indented is derived from the type whose name appears nearest above it with one less level of indentation.
xs:anyType | ||
user-defined complex types | ||
xdt:untyped | ||
xs:anySimpleType | ||
user-defined list and union types | ||
xs:IDREFS | ||
xs:NMTOKENS | ||
xs:ENTITIES | ||
xdt:anyAtomicType |
The table below shows the datatypes derived from xdt:anyAtomicType
. This includes all the [XML Schema Part 2: Datatypes Second Edition] built-in datatypes as well as the two totally ordered subtypes of duration defined 10.3 Two Totally Ordered Subtypes of Duration.
Each type whose name is indented is derived from the type whose name appears nearest above it with one less level of indentation.
xdt:untypedAtomic | ||||||
xs:dateTime | ||||||
xs:date | ||||||
xs:time | ||||||
xs:duration | ||||||
xdt:yearMonthDuration | ||||||
xdt:dayTimeDuration | ||||||
xs:float | ||||||
xs:double | ||||||
xs:decimal | ||||||
xs:integer | ||||||
xs:nonPositiveInteger | ||||||
xs:negativeInteger | ||||||
xs:long | ||||||
xs:int | ||||||
xs:short | ||||||
xs:byte | ||||||
xs:nonNegativeInteger | ||||||
xs:unsignedLong | ||||||
xs:unsignedInt | ||||||
xs:unsignedShort | ||||||
xs:unsignedByte | ||||||
xs:positiveInteger | ||||||
xs:gYearMonth | ||||||
xs:gYear | ||||||
xs:gMonthDay | ||||||
xs:gDay | ||||||
xs:gMonth | ||||||
xs:string | ||||||
xs:normalizedString | ||||||
xs:token | ||||||
xs:language | ||||||
xs:NMTOKEN | ||||||
xs:Name | ||||||
xs:NCName | ||||||
xs:ID | ||||||
xs:IDREF | ||||||
xs:ENTITY | ||||||
xs:boolean | ||||||
xs:base64Binary | ||||||
xs:hexBinary | ||||||
xs:anyURI | ||||||
xs:QName | ||||||
xs:NOTATION |
The table below shows the type hierarchy for the types introduced in [XQuery 1.0 and XPath 2.0 Data Model]. For these types, each type whose name is indented is a component of the union type whose name appears nearest above with one less level of indentation.
item | |||
xdt:anyAtomicType | |||
node | |||
attribute | |||
user-defined attribute types | |||
comment | |||
document | |||
user-defined document types | |||
element | |||
user-defined element types | |||
processing-instruction | |||
text |
The terminology used to describe the functions and operators on [XML Schema Part 2: Datatypes Second Edition] is defined in the body of this specification. The terms defined in the following list are used in building those definitions:
A feature of this specification included to ensure that implementations that use this feature remain compatible with [XML Path Language (XPath) Version 1.0]
Conforming documents and processors are permitted to, but need not, behave as described.
Conforming documents and processors are required to behave as described; otherwise, they are either non-conformant or else in error.
Possibly differing between implementations, but specified and documented by the implementor for each particular implementation.
Possibly differing between implementations, but not specified by this or other W3C specification, and not required to be specified by the implementor for any particular implementation.
The scope over which any two calls on a function would be executed. In XSLT, it applies to any two calls on the function executed during the same transformation. In XQuery, it applies to any two calls executed during the evaluation of a top-level expression i.e. an expression not contained in any other expression. In other contexts, the scope is specified by the host environment that invokes the function library.
Most of the functions in the core library have the property that calling the same function twice within an ·execution scope· with the same arguments returns the same result: these functions are said to be stable. This category includes a number of functions such as fn:doc()
, fn:collection()
,
fn:current-dateTime()
, fn:current-date
and fn:current-time()
whose result depends on the external environment. Where the function returns nodes, stability means that the returned nodes are identical, not merely equal and are returned in the same order.. Some other functions, for example fn:position() and fn:last(), depend on the dynamic context and may, therefore,
produce different results each time they are called. These functions are said to be contextual.
Some other functions, for example fn:position()
and fn:last()
, depend on the dynamic context and may, therefore, produce different results each time they are called. These functions are said to be contextual.
Within this specification, the term "URI" refers to Universal Resource Identifiers as defined in [RFC 3986] and extended in [RFC 3987] with a new name "IRI". The term "URI Reference", unless otherwise stated, refers to a string in the lexical space of the xs:anyURI
datatype as defined in [XML Schema Part 2: Datatypes Second Edition]. Note that this means, in practice, that where this specification requires a "URI
Reference", an IRI as defined in [RFC 3987] will be accepted, provided that other relevant specifications also permit an IRI. The term URI has been retained in preference to IRI to avoid introducing new names for concepts such as "Base URI" that are defined or referenced across the whole family of XML specifications. Note also that the definition of xs:anyURI
is a wider definition than the definition in [RFC 3987]; for example it does not require
non-ASCII characters to be escaped.
Accessors and their semantics are described in [XQuery 1.0 and XPath 2.0 Data Model]. Some of these accessors are exposed to the user through the functions described below.
Function | Accessor | Accepts | Returns |
---|---|---|---|
fn:node-name |
node-name |
an optional node | zero or one xs:QName |
fn:nilled |
nilled |
a node | an optional xs:boolean |
fn:string |
string-value |
an optional item or no argument | xs:string |
fn:data |
typed-value |
zero or more items | a sequence of atomic values |
fn:base-uri |
base-uri |
an optional node or no argument | zero or one xs:anyURI |
fn:document-uri |
document-uri |
an optional node | zero or one xs:anyURI |
fn:node-name
($arg
as
node()?
) as
xs:QName?
Summary: Returns an expanded-QName for node kinds that can have names. For other kinds of nodes it returns the empty sequence. If $arg
is the empty sequence, the empty sequence is returned.
fn:nilled
($arg
as
node()?
) as
xs:boolean?
Summary: Returns an xs:boolean
indicating whether the argument node is "nilled". If the argument is not an element node, returns the empty sequence. If the argument is the empty sequence, returns the empty sequence.
fn:string
() as
xs:string
fn:string
($arg
as
item()?
) as
xs:string
Summary: Returns the value of $arg
represented as a xs:string
. If no argument is supplied, this function returns the string value of the context item (.
).
If no argument is supplied and the context item is undefined, an error is raised: [err:FONC0001].
If $arg
is the empty sequence, the zero-length string is returned.
If $arg
is a node, the function returns the string-value of the node, as obtained using the dm:string-value
accessor defined in the Section 5.13 string-value AccessorDM.
If $arg
is an atomic value, then the function returns the same string as is returned by the expression " $arg
cast as xs:string
" (see 17 Casting).
fn:data
($arg
as
item()*
) as
xdt:anyAtomicType*
Summary: fn:data
takes a sequence of items and returns a sequence of atomic values.
The result of fn:data
is the sequence of atomic values produced by applying the following rules to each item in $arg
:
If the item is an atomic value, it is returned.
If the item is a node:
If the node does not have a typed value an error is raised [err:FOTY0012].
Otherwise, fn:data()
returns the typed value of the node as defined by the accessor function dm:typed-value
in Section 5.15 typed-value AccessorDM.
fn:base-uri
() as
xs:anyURI?
fn:base-uri
($arg
as
node()?
) as
xs:anyURI?
Summary: Returns the value of the base-uri property for $arg
as defined by the accessor function dm:base-uri()
for that kind of node in Section 5.2 base-uri AccessorDM. If $arg
is not specified, returns the value of the base-uri property of the context item (.
) with the above semantics. If the context item is not a node, an error is raised: [err:FOTY0011]. If the context item is undefined, an error is raised: [err:FONC0001].
If $arg
is the empty sequence, the empty sequence is returned.
Document, element and processing-instruction nodes have a base-uri property which may be empty. The base-uri property of all other node types is the empty sequence. The value of the base-uri property is returned if it exists and is not empty. Otherwise, if the node has a parent, the value of dm:base-uri()
applied to its parent is returned, recursively. If the node does not have a parent, or if the recursive ascent up the ancestor chain encounters a node whose base-uri property is empty and
it does not have a parent, the empty sequence is returned.
See also fn:static-base-uri
.
fn:document-uri
($arg
as
node()?
) as
xs:anyURI?
Summary: Returns the value of the document-uri property for $arg
as defined by the dm:document-uri
accessor function defined in Section 6.1.2 AccessorsDM.
If $arg
is the empty sequence, the empty sequence is returned.
Returns the empty sequence if the node is not a document node. Otherwise, returns the value of the dm:document-uri
accessor of the document node.
If fn:document-uri($arg)
does not return the empty sequence, then the following expression always holds:
fn:doc(fn:document-uri($arg)) is $arg
In this document, as well as in [XQuery 1.0: An XML Query Language], [XML Path Language (XPath) 2.0], and [XQuery 1.0 and XPath 2.0 Formal Semantics], the phrase "an error is raised" is used. Raising an error is equivalent to invoking the fn:error
function defined in this section with the provided error code.
The above phrase is normally accompanied by specification of a specific error, to wit: "an error is raised [error code]". Each error defined in this document is identified by an xs:QName
that is in the http://www.w3.org/2005/xqt-errors
namespace, represented in this document by the err
prefix. It is this xs:QName
that is actually passed as an argument to the fn:error
function invocation. Invocation of this function raises an
error. For a more detailed treatment of error handing, see Section 2.3.3 Handling Dynamic ErrorsXP and Section 7.2.9 The fn:error functionFS.
The fn:error
function is a general function that may be invoked as above but may also be invoked from [XQuery 1.0: An XML Query Language] or [XML Path Language (XPath) 2.0] applications with, for example, an xs:QName
argument.
fn:error
() as
none
fn:error
($error
as
xs:QName
) as
none
fn:error
($error
as
xs:QName?
, $description
as
xs:string
) as
none
fn:error ( |
$error |
as xs:QName? , |
$description |
as xs:string , |
|
$error-object |
as item()* ) as none |
Summary: The fn:error
function raises an error. While this function never returns a value, an error is returned to the external processing environment as an xs:anyURI
or an xs:QName
. The error xs:anyURI
is derived from the error xs:QName
. An error xs:QName
with namespace URI NS and local part LP will be returned as the xs:anyURI
NS#LP. The method by which the xs:anyURI
or xs:QName
is
returned to the external processing environment is ·implementation dependent·.
If an invocation provides $description
and $error-object
, then these values may also be returned to the external processing environment. The method by which these values are provided to the external environment is ·implementation dependent·.
Note:
The value of the $description
parameter may need to be localized.
Note that "none" is a special type defined in [XQuery 1.0 and XPath 2.0 Formal Semantics] and is not available to the user. It indicates that the function never returns and ensures that it has the correct static type.
If fn:error
is invoked with no arguments, then its behavior is the same as the invocation of the following expression:
fn:error(fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000'))
If the first argument in the third or fourth signature is the empty sequence it is assumed to be the xs:QName
constructed by:
fn:QName('http://www.w3.org/2005/xqt-errors', 'err:FOER0000')
fn:error()
returns http://www.w3.org/2005/xqt-errors#FOER0000
to the external processing environment.
fn:error(fn:QName('http://www.example.com/HR', 'myerr:toohighsal'), 'Does not apply because salary is too high')
returns http://www.example.com/HR#toohighsal
and the xs:string
"Does not apply because salary is too high"
to the external processing environment.
This function is intended to be used in debugging queries by providing a trace of their execution.
fn:trace
($value
as
item()*
, $label
as
xs:string
) as
item()*
The input $value
is returned, unchanged, as the result of the function. In addition, the inputs $value
, converted to an xs:string
, and $label
may be directed to a trace data set. The destination of the trace output is ·implementation-defined·. The format of the trace output is ·implementation dependent·. The ordering of output from invocations of the fn:trace()
function is ·implementation dependent·.
Consider a situation in which a user wants to investigate the actual value passed to a function. Assume that in a particular execution, $v
is an xs:decimal
with value 124.84
. Writing fn:trace($v, 'the value of $v is:')
will put the strings "124.84"
and "the value of $v is:"
in the trace data set in implementation dependent order.
Every built-in atomic type that is defined in [XML Schema Part 2: Datatypes Second Edition], except xs:NOTATION
, has an associated constructor function; as do xdt:untypedAtomic
, defined in Section 2.6 TypesDM and the two derived types xdt:yearMonthDuration
and xdt:dayTimeDuration
defined in 10.3 Two Totally
Ordered Subtypes of Duration. A constructor function is not defined for xs:NOTATION
since it is defined as an abstract type in [XML Schema Part 2: Datatypes Second Edition]. If the static context (See Section 2.1.1 Static ContextXP) contains a type derived from xs:NOTATION
then a constructor function is defined for it. See 5.3 Constructor Functions for User-Defined Types.
The form of the constructor function for a type prefix:TYPE is:
prefix:TYPE
($arg
as
xdt:anyAtomicType?
) as
prefix:TYPE?
If $arg
is the empty sequence, the empty sequence is returned. For example, the signature of the constructor function corresponding to the xs:unsignedInt
type defined in [XML Schema Part 2: Datatypes Second Edition] is:
xs:unsignedInt
($arg
as
xdt:anyAtomicType?
) as
xs:unsignedInt?
Invoking the constructor function xs:unsignedInt(12)
returns the xs:unsignedInt
value 12. Another invocation of that constructor function that returns the same xs:unsignedInt
value is xs:unsignedInt("12")
. The same result would also be returned if the constructor function were to be invoked with a node that had a typed value equal to the xs:unsignedInt
12. The standard features described in Section 2.4.2 AtomizationXP would 'atomize' the node to extract its typed value and then call the constructor with that value. If the value passed to a constructor is illegal for the datatype to be constructed, an error is raised [err:FORG0001].
The semantics of the constructor function " xs:TYPE(arg)
" are identical to the semantics of " arg
cast as xs:TYPE?
", except for constructors for xs:QName
and types derived from xs:NOTATION
which are identical to "cast as xs:TYPE
". See 17 Casting.
If the argument to a constructor function is a literal, the result of the function may be evaluated statically; if an error is found during such evaluation, it may be reported as a static error.
Constructor functions for xs:QName
and types derived from xs:QName
and xs:NOTATION
, are constrained to take a xs:string
literal as their argument. (This means that they are actually pseudo-functions: they can always be evaluated statically). A static error is raised [err:XPST0083]XP if the argument to a constructor function for xs:QName
or a type derived from xs:QName
or xs:NOTATION
is not an xs:string
literal.
The prefix within the lexical xs:QName
supplied as the argument is resolved to a namespace URI using the statically known namespaces from the static context. If the lexical xs:QName
has no prefix, the namespace URI of the resulting expanded-QName is the default element/type namespace from the static context. Components of the static context are discussed in Section C.1 Static Context
ComponentsXP. A static error is raised [err:FONS0004] if the prefix is not bound in the static context. As described in Section 2.1 TerminologyDM, the supplied prefix is retained as part of the expanded-QName value.
The following constructor functions for the built-in types are supported:
xs:string
($arg
as
xdt:anyAtomicType?
) as
xs:string?
xs:boolean
($arg
as
xdt:anyAtomicType?
) as
xs:boolean?
xs:decimal
($arg
as
xdt:anyAtomicType?
) as
xs:decimal?
xs:float
($arg
as
xdt:anyAtomicType?
) as
xs:float?
Implementations ·may· return negative zero for xs:float("-0.0E0")
. [XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero.
xs:double
($arg
as
xdt:anyAtomicType?
) as
xs:double?
Implementations ·may· return negative zero for xs:double("-0.0E0").
[XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero.
xs:duration
($arg
as
xdt:anyAtomicType?
) as
xs:duration?
xs:dateTime
($arg
as
xdt:anyAtomicType?
) as
xs:dateTime?
xs:time
($arg
as
xdt:anyAtomicType?
) as
xs:time?
xs:date
($arg
as
xdt:anyAtomicType?
) as
xs:date?
xs:gYearMonth
($arg
as
xdt:anyAtomicType?
) as
xs:gYearMonth?
xs:gYear
($arg
as
xdt:anyAtomicType?
) as
xs:gYear?
xs:gMonthDay
($arg
as
xdt:anyAtomicType?
) as
xs:gMonthDay?
xs:gDay
($arg
as
xdt:anyAtomicType?
) as
xs:gDay?
xs:gMonth
($arg
as
xdt:anyAtomicType?
) as
xs:gMonth?
xs:hexBinary
($arg
as
xdt:anyAtomicType?
) as
xs:hexBinary?
xs:base64Binary
($arg
as
xdt:anyAtomicType?
) as
xs:base64Binary?
xs:anyURI
($arg
as
xdt:anyAtomicType?
) as
xs:anyURI?
xs:QName
($arg
as
xs:string
) as
xs:QName
$arg
must be a xs:string
literal.
xs:normalizedString
($arg
as
xdt:anyAtomicType?
) as
xs:normalizedString?
xs:token
($arg
as
xdt:anyAtomicType?
) as
xs:token?
xs:language
($arg
as
xdt:anyAtomicType?
) as
xs:language?
xs:NMTOKEN
($arg
as
xdt:anyAtomicType?
) as
xs:NMTOKEN?
xs:Name
($arg
as
xdt:anyAtomicType?
) as
xs:Name?
xs:NCName
($arg
as
xdt:anyAtomicType?
) as
xs:NCName?
xs:ID
($arg
as
xdt:anyAtomicType?
) as
xs:ID?
xs:IDREF
($arg
as
xdt:anyAtomicType?
) as
xs:IDREF?
xs:ENTITY
($arg
as
xdt:anyAtomicType?
) as
xs:ENTITY?
See 17.4.1 Casting to xs:ENTITY for rules related to constructing values of type xs:ENTITY
and types derived from it.
xs:integer
($arg
as
xdt:anyAtomicType?
) as
xs:integer?
xs:nonPositiveInteger
($arg
as
xdt:anyAtomicType?
) as
xs:nonPositiveInteger?
xs:negativeInteger
($arg
as
xdt:anyAtomicType?
) as
xs:negativeInteger?
xs:long
($arg
as
xdt:anyAtomicType?
) as
xs:long?
xs:int
($arg
as
xdt:anyAtomicType?
) as
xs:int?
xs:short
($arg
as
xdt:anyAtomicType?
) as
xs:short?
xs:byte
($arg
as
xdt:anyAtomicType?
) as
xs:byte?
xs:nonNegativeInteger
($arg
as
xdt:anyAtomicType?
) as
xs:nonNegativeInteger?
xs:unsignedLong
($arg
as
xdt:anyAtomicType?
) as
xs:unsignedLong?
xs:unsignedInt
($arg
as
xdt:anyAtomicType?
) as
xs:unsignedInt?
xs:unsignedShort
($arg
as
xdt:anyAtomicType?
) as
xs:unsignedShort?
xs:unsignedByte
($arg
as
xdt:anyAtomicType?
) as
xs:unsignedByte?
xs:positiveInteger
($arg
as
xdt:anyAtomicType?
) as
xs:positiveInteger?
xdt:yearMonthDuration
($arg
as
xdt:anyAtomicType?
) as
xdt:yearMonthDuration?
xdt:dayTimeDuration
($arg
as
xdt:anyAtomicType?
) as
xdt:dayTimeDuration?
xdt:untypedAtomic
($arg
as
xdt:anyAtomicType?
) as
xdt:untypedAtomic?
A special constructor function is provided for constructing a xs:dateTime
value from a xs:date
value and a xs:time
value.
fn:dateTime
($arg1
as
xs:date
, $arg2
as
xs:time
) as
xs:dateTime
The result xs:dateTime
has a date component whose value is equal to $arg1
and a time component whose value is equal to $arg2
. The timezone of the result is computed as follows:
If neither argument has a timezone, the result has no timezone.
If exactly one of the arguments has a timezone, or if both arguments have the same timezone, the result has this timezone.
If the two arguments have different timezones, an error is raised:[err:FORG0008]
For every atomic type in the static context (See Section 2.1.1 Static ContextXP) that is derived from a primitive type, there is a constructor function (whose name is the same as the name of the type) whose effect is to create a value of that type from the supplied argument. The rules for constructing user-defined types are defined in the same way as the rules for constructing built-in derived types discussed in 5.1 Constructor Functions for XML Schema Built-in Types.
Consider a situation where the static context contains a type called hatSize
defined in a schema whose target namespace is bound to the prefix my
. In such a case the constructor function:
my:hatSize
($arg
as
xdt:anyAtomicType?
) as
my:hatSize?
is available to users.
To construct an instance of an atomic type that is not in a namespace, it is necessary to use a cast expression or undeclare the default function namespace. For example, if the user-defined type apple
is derived from xs:integer
but is not in a namespace, an instance of this type can be constructed as follows using a cast expression (this requires that the default element/type namespace is no namespace):
17 cast as apple
The following shows the use of the constructor function:
declare default function namespace ""; apple(17)
This section discusses arithmetic operators on the numeric datatypes defined in [XML Schema Part 2: Datatypes Second Edition]. It uses an approach that permits lightweight implementation whenever possible.
The operators described in this section are defined on the following numeric types. Each type whose name is indented is derived from the type whose name appears nearest above with one less level of indentation.
xs:decimal | |
xs:integer | |
xs:float | |
xs:double |
They also apply to types derived by restriction from the above types.
Note:
This specification uses [IEEE 754-1985] arithmetic for xs:float
and xs:double
values. This differs from [XML Schema Part 2: Datatypes Second Edition] which defines NaN
as being equal to itself and defines only a single zero in the value space while [IEEE 754-1985] arithmetic treats NaN
as unequal to all other values including itself and can produce distinct results of positive
zero and negative zero. (These are two different machine representations for the same [XML Schema Part 2: Datatypes Second Edition] value.) The text accompanying several functions discusses behaviour for both positive and negative zero inputs and outputs in the interest of alignment with [IEEE 754-1985].
The following functions define the semantics of operators defined in [XQuery 1.0: An XML Query Language] and [XML Path Language (XPath) 2.0] on these numeric types.
Operators | Meaning |
---|---|
op:numeric-add |
Addition |
op:numeric-subtract |
Subtraction |
op:numeric-multiply |
Multiplication |
op:numeric-divide |
Division |
op:numeric-integer-divide |
Integer division |
op:numeric-mod |
Modulus |
op:numeric-unary-plus |
Unary plus |
op:numeric-unary-minus |
Unary minus (negation) |
The parameters and return types for the above operators are the basic numeric types: xs:integer
, xs:decimal
, xs:float
and xs:double
, and types derived from them. The word "numeric
" in function signatures signifies these four types. For simplicity, each operator is defined to operate on operands of the same type and return the same type. The exceptions are op:numeric-divide
, which returns an
xs:decimal
if called with two xs:integer
operands and op:numeric-integer-divide
which always returns an xs:integer
.
If the two operands are not of the same type, subtype substitution and numeric type promotion are used to obtain two operands of the same type. Section B.1 Type PromotionXP and Section B.2 Operator MappingXP describe the semantics of these operations in detail.
The result type of operations depends on their argument datatypes and is defined in the following table:
Operator | Returns |
---|---|
op:operation(xs:integer, xs:integer) |
xs:integer (except for op:numeric-divide(integer, integer) , which returns xs:decimal ) |
op:operation(xs:decimal, xs:decimal) |
xs:decimal |
op:operation(xs:float, xs:float) |
xs:float |
op:operation(xs:double, xs:double) |
xs:double |
op:operation(xs:integer) |
xs:integer |
op:operation(xs:decimal) |
xs:decimal |
op:operation(xs:float) |
xs:float |
op:operation(xs:double) |
xs:double |
These rules define any operation on any pair of arithmetic types. Consider the following example:
op:operation(xs:int, xs:double) => op:operation(xs:double, xs:double)
For this operation, xs:int
must be converted to xs:double
. This can be done, since by the rules above: xs:int
can be substituted for xs:integer
, xs:integer
can be substituted for xs:decimal
, xs:decimal
can be promoted to xs:double
. As far as possible, the promotions should be done in a single step. Specifically, when an xs:decimal
is promoted to an xs:double
, it should not be
converted to an xs:float
and then to xs:double
, as this risks loss of precision.
As another example, a user may define height
as a derived type of xs:integer
with a minimum value of 20 and a maximum value of 100. He may then derive fenceHeight
using an enumeration to restrict the permitted set of values to, say, 36, 48 and 60.
op:operation(fenceHeight, xs:integer) => op:operation(xs:integer, xs:integer)
fenceHeight
can be substituted for its base type height
and height
can be substituted for its base type xs:integer
.
On overflow and underflow situations during arithmetic operations conforming implementations ·must· behave as follows:
For xs:float
and xs:double
operations, overflow behavior ·must· be conformant with [IEEE 754-1985]. This specification allows the following options:
Raising an error [err:FOAR0002] via an overflow trap.
Returning INF
or -INF
.
Returning the largest (positive or negative) non-infinite number.
For xs:float
and xs:double
operations, underflow behavior ·must· be conformant with [IEEE 754-1985]. This specification allows the following options:
Raising an error [err:FOAR0002] via an underflow trap.
Returning 0.0E0
or +/- 2**Emin
or a denormalized value; where Emin
is the smallest possible xs:float
or xs:double
exponent.
For xs:decimal
operations, overflow behavior ·must· raise an error [err:FOAR0002]. On underflow, 0.0
must be returned.
For xs:integer
operations, implementations that support limited-precision integer operations ·must· select from the following options:
They ·may· choose to always raise an error [err:FOAR0002].
They ·may· provide an ·implementation-defined· mechanism that allows users to choose between raising an error and returning a result that is modulo the largest representable integer value. See [ISO 10967].
The functions op:numeric-add
, op:numeric-subtract
, op:numeric-multiply
, op:numeric-divide
, op:numeric-integer-divide
and op:numeric-mod
are each defined for pairs of numeric operands, each of which has the same
type:xs:integer
, xs:decimal
, xs:float
, or xs:double
. The functions op:numeric-unary-plus
and op:numeric-unary-minus
are defined for a single operand whose type is one of those same numeric types.
For xs:float
and xs:double
arguments, if either argument is NaN
, the result is NaN
.
For xs:decimal
values the number of digits of precision returned by the numeric operators is ·implementation-defined·. If the number of digits in the result exceeds the number of digits that the implementation supports, the result is truncated or rounded in an ·implementation-defined· manner.
op:numeric-add
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
Summary: Backs up the "+" operator and returns the arithmetic sum of its operands: ($arg1 + $arg2
).
Note:
For xs:float
or xs:double
values, if one of the operands is a zero or a finite number and the other is INF
or -INF
, INF
or -INF
is returned. If both operands are INF
, INF
is returned. If both operands are -INF
, -INF
is returned. If one of the operands is INF
and the other is -INF
, NaN
is returned.
op:numeric-subtract
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
Summary: Backs up the "-" operator and returns the arithmetic difference of its operands: ($arg1 - $arg2
).
Note:
For xs:float
or xs:double
values, if one of the operands is a zero or a finite number and the other is INF
or -INF
, an infinity of the appropriate sign is returned. If both operands are INF
or -INF
, NaN
is returned. If one of the operands is INF
and the other is -INF
, an infinity of the appropriate sign is returned.
op:numeric-multiply
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
Summary: Backs up the "*" operator and returns the arithmetic product of its operands: ($arg1 * $arg2
).
Note:
For xs:float
or xs:double
values, if one of the operands is a zero and the other is an infinity, NaN
is returned. If one of the operands is a non-zero number and the other is an infinity, an infinity with the appropriate sign is returned.
op:numeric-divide
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
Summary: Backs up the "div" operator and returns the arithmetic quotient of its operands: ($arg1 div $arg2
).
As a special case, if the types of both $arg1
and $arg2
are xs:integer
, then the return type is xs:decimal
.
Notes:
For xs:decimal
and xs:integer
operands, if the divisor is (positive or negative) zero, an error is raised [err:FOAR0001]. For xs:float
and xs:double
operands, floating point division is performed as specified in [IEEE 754-1985].
For xs:float
or xs:double
values, a positive number divided by positive zero returns INF
. A negative number divided by positive zero returns -INF
. Division by negative zero returns -INF
and INF
, respectively. Positive or negative zero divided by positive or negative zero returns NaN
. Also, INF
or -INF
divided by INF
or -INF
returns NaN
.
op:numeric-integer-divide
($arg1
as
numeric
, $arg2
as
numeric
) as
xs:integer
Summary: This function backs up the "idiv" operator and performs an integer division: that is, it divides the first argument by the second, and returns the integer obtained by truncating the fractional part of the result. The division is performed so that the sign of the fractional part is the same as the sign of the dividend.
If the dividend, $arg1
, is not evenly divided by the divisor, $arg2
, then the quotient is the xs:integer
value obtained, ignoring (truncating) any remainder that results from the division (that is, no rounding is performed). Thus, the semantics " $a idiv $b
" are equivalent to " ($a div $b) cast as xs:integer
" except for error situations.
If the divisor is (positive or negative) zero, then an error is raised [err:FOAR0001]. If either operand is NaN
or if $arg1
is INF
or -INF
then an error is raised [err:FOAR0002].
Note:
The semantics of this function are different from integer division as defined in programming languages such as Java and C++.
op:numeric-integer-divide(10,3)
returns 3
op:numeric-integer-divide(3,-2)
returns -1
op:numeric-integer-divide(-3,2)
returns -1
op:numeric-integer-divide(-3,-2)
returns 1
op:numeric-integer-divide(9.0,3)
returns 3
op:numeric-integer-divide(-3.5,3)
returns -1
op:numeric-integer-divide(3.0,4)
returns 0
op:numeric-integer-divide(3.1E1,6)
returns 5
op:numeric-integer-divide(3.1E1,7)
returns 4
op:numeric-mod
($arg1
as
numeric
, $arg2
as
numeric
) as
numeric
Summary: Backs up the "mod" operator. Informally, this function returns the remainder resulting from dividing $arg1
, the dividend, by $arg2
, the divisor. The operation a mod b
for operands that are xs:integer
or xs:decimal
, or types derived from them, produces a result such that (a idiv b)*b+(a mod b)
is equal to a
and the magnitude of the result is always less than the magnitude of b
. This identity
holds even in the special case that the dividend is the negative integer of largest possible magnitude for its type and the divisor is -1 (the remainder is 0). It follows from this rule that the sign of the result is the sign of the dividend.
For xs:integer
and xs:decimal
operands, if $arg2
is zero, then an error is raised [err:FOAR0001].
For xs:float
and xs:double
operands the following rules apply:
If either operand is NaN
, the result is NaN
.
If the dividend is positive or negative infinity, or the divisor is positive or negative zero (0), or both, the result is NaN
.
If the dividend is finite and the divisor is an infinity, the result equals the dividend.
If the dividend is positive or negative zero and the divisor is finite, the result is the same as the dividend.
In the remaining cases, where neither positive or negative infinity, nor positive or negative zero, nor NaN
is involved, the result obeys (a idiv b)*b+(a mod b)
= a
. Division is truncating division, analogous to integer division, not [IEEE 754-1985] rounding division i.e. additional digits are truncated, not rounded to the required precision.
op:numeric-unary-plus
($arg
as
numeric
) as
numeric
Summary: Backs up the unary "+" operator and returns its operand with the sign unchanged: (+ $arg
). Semantically, this operation performs no operation.
op:numeric-unary-minus
($arg
as
numeric
) as
numeric
Summary: Backs up the unary "-" operator and returns its operand with the sign reversed: (- $arg
). If $arg
is positive, its negative is returned; if it is negative, its positive is returned.
For xs:integer
and xs:decimal
arguments, 0
and 0.0
return 0
and 0.0
, respectively. For xs:float
and xs:double
arguments, NaN
returns NaN
, 0.0E0
returns -0.0E0
and vice versa. INF
returns -INF
. -INF
returns INF
.
This specification defines the following comparison operators on numeric values. Comparisons take two arguments of the same type. If the arguments are of different types, one argument is promoted to the type of the other as described above in 6.2 Operators on Numeric Values. Each comparison operator returns a boolean value. If either, or both, operands are NaN
, false
is returned.
Operator | Meaning |
---|---|
op:numeric-equal |
Equality comparison |
op:numeric-less-than |
Less-than comparison |
op:numeric-greater-than |
Greater-than comparison |
op:numeric-equal
($arg1
as
numeric
, $arg2
as
numeric
) as
xs:boolean
Summary: Returns true if and only if the value of $arg1
is equal to the value of $arg2
. For xs:float
and xs:double
values, positive zero and negative zero compare equal. INF
equals INF
and -INF
equals -INF
. NaN
does not equal itself.
This function backs up the "eq", "ne", "le" and "ge" operators on numeric values.
op:numeric-less-than
($arg1
as
numeric
, $arg2
as
numeric
) as
xs:boolean
Summary: Returns true
if and only if $arg1
is less than $arg2
. For xs:float
and xs:double
values, positive infinity is greater than all other non-NaN
values; negative infinity is less than all other non-NaN
values. If $arg1
or $arg2
is NaN
, the function returns false
.
This function backs up the "lt" and "le" operators on numeric values.
op:numeric-greater-than
($arg1
as
numeric
, $arg2
as
numeric
) as
xs:boolean
Summary: Returns true
if and only if $arg1
is greater than $arg2
. For xs:float
and xs:double
values, positive infinity is greater than all other non-NaN
values; negative infinity is less than all other non-NaN
values. If $arg1
or $arg2
is NaN
, the function returns false
.
This function backs up the "gt" and "ge" operators on numeric values.
The following functions are defined on numeric types. Each function returns a value of the same type as the type of its argument.
If the argument is the empty sequence, the empty sequence is returned.
For xs:float
and xs:double
arguments, if the argument is "NaN", "NaN" is returned.
Except for fn:abs()
, for xs:float
and xs:double
arguments, if the argument is positive or negative infinity, positive or negative infinity is returned.
Function | Meaning |
---|---|
fn:abs |
Returns the absolute value of the argument. |
fn:ceiling |
Returns the smallest number with no fractional part that is greater than or equal to the argument. |
fn:floor |
Returns the largest number with no fractional part that is less than or equal to the argument. |
fn:round |
Rounds to the nearest number with no fractional part. |
fn:round-half-to-even |
Takes a number and a precision and returns a number rounded to the given precision. If the fractional part is exactly half, the result is the number whose least significant digit is even. |
fn:abs
($arg
as
numeric?
) as
numeric?
Summary: Returns the absolute value of $arg
. If $arg
is negative returns -$arg
otherwise returns $arg
. If type of $arg
is one of the four numeric types xs:float
, xs:double
, xs:decimal
or xs:integer
the type of the result is the same as the type of $arg
. If the type of $arg
is a type derived from one of the numeric types, the result is an instance of the base
numeric type.
For xs:float
and xs:double
arguments, if the argument is positive zero or negative zero, then positive zero is returned. If the argument is positive or negative infinity, positive infinity is returned.
For detailed type semantics, see Section 7.2.3 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS
fn:ceiling
($arg
as
numeric?
) as
numeric?
Summary: Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of $arg
. If type of $arg
is one of the four numeric types xs:float
, xs:double
, xs:decimal
or xs:integer
the type of the result is the same as the type of $arg
. If the type of $arg
is a type derived from one of the numeric types, the result is an instance of the base numeric
type.
For xs:float
and xs:double
arguments, if the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned. If the argument is less than zero and greater than -1, negative zero is returned.
For detailed type semantics, see Section 7.2.3 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS
fn:floor
($arg
as
numeric?
) as
numeric?
Summary: Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg
. If type of $arg
is one of the four numeric types xs:float
, xs:double
, xs:decimal
or xs:integer
the type of the result is the same as the type of $arg
. If the type of $arg
is a type derived from one of the numeric types, the result is an instance of the base numeric
type.
For float
and double
arguments, if the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned.
For detailed type semantics, see Section 7.2.3 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS
fn:round
($arg
as
numeric?
) as
numeric?
Summary: Returns the number with no fractional part that is closest to the argument. If there are two such numbers, then the one that is closest to positive infinity is returned. If type of $arg
is one of the four numeric types xs:float
, xs:double
, xs:decimal
or xs:integer
the type of the result is the same as the type of $arg
. If the type of $arg
is a type derived from one of the numeric types, the result is an
instance of the base numeric type.
For xs:float
and xs:double
arguments, if the argument is positive infinity, then positive infinity is returned. If the argument is negative infinity, then negative infinity is returned. If the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned. If the argument is less than zero, but greater than or equal to -0.5, then negative zero is returned. In the cases where positive zero or negative zero is returned,
negative zero or positive zero may be returned as [XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero.
For the last two cases, note that the result is not the same as fn:floor(x+0.5)
.
For detailed type semantics, see Section 7.2.3 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS
fn:round-half-to-even
($arg
as
numeric?
) as
numeric?
fn:round-half-to-even
($arg
as
numeric?
, $precision
as
xs:integer
) as
numeric?
Summary: The value returned is the nearest (that is, numerically closest) numeric to $arg
that is a multiple of ten to the power of minus $precision
. If two such values are equally near (e.g. if the fractional part in $arg
is exactly .500...), returns the one whose least significant digit is even. If type of $arg
is one of the four numeric types xs:float
, xs:double
, xs:decimal
or xs:integer
the type
of the result is the same as the type of $arg
. If the type of $arg
is a type derived from one of the numeric types, the result is an instance of the base numeric type.
The first signature of this function produces the same result as the second signature with $precision=0
.
For arguments of type xs:float
and xs:double
, if the argument is positive zero, then positive zero is returned. If the argument is negative zero, then negative zero is returned. If the argument is less than zero, but greater than or equal to -0.5, then negative zero is returned.
If $arg
is of type xs:float
or xs:double
, rounding occurs on the value of the mantissa computed with exponent = 0.
For detailed type semantics, see Section 7.2.3 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS
This section discusses functions and operators on the [XML Schema Part 2: Datatypes Second Edition] xs:string
datatype and the datatypes derived from it.
The operators described in this section are defined on the following types. Each type whose name is indented is derived from the type whose name appears nearest above with one less level of indentation.
xs:string | |||||
xs:normalizedString | |||||
xs:token | |||||
xs:language | |||||
xs:NMTOKEN | |||||
xs:Name | |||||
xs:NCName | |||||
xs:ID | |||||
xs:IDREF | |||||
xs:ENTITY |
They also apply to user-defined types derived by restriction from the above types.
It is ·implementation-defined· which version of [The Unicode Standard] is supported, but it is recommended that the most recent version of Unicode be used.
Unless explicitly stated, the xs:string
values returned by the functions in this document are not normalized in the sense of [Character Model for the World Wide Web 1.0: Fundamentals].
Notes:
This document uses the term "code point", sometimes spelt "codepoint" (also known as "character number" or "code position") to mean a non-negative integer that represents a character in some encoding. See [Character Model for the World Wide Web 1.0: Fundamentals]. The use of the word "character" in this document is in the sense of production [2] of [Extensible Markup Language (XML) 1.0 Recommendation (Third Edition)]. [The Unicode Standard], defines code points that range from #x0000 to #x10FFFF inclusive and may include code points that have not yet been assigned to characters.
In functions that involve character counting such as fn:substring
, fn:string-length
and fn:translate
, what is counted is the number of XML characters in the string (or equivalently, the number of Unicode code points). Some implementations may represent a code point above xFFFF using two 16-bit values known as a surrogate. A surrogate counts as one character, not two.
Function | Meaning |
---|---|
fn:codepoints-to-string |
Creates an xs:string from a sequence of Unicode code points. |
fn:string-to-codepoints |
Returns the sequence of Unicode code points that constitute an xs:string . |
fn:codepoints-to-string
($arg
as
xs:integer*
) as
xs:string
Summary: Creates an xs:string
from a sequence of [The Unicode Standard] code points. Returns the zero-length string if $arg
is the empty sequence. If any of the code points in $arg
is not a legal XML character, an error is raised [err:FOCH0001].
fn:string-to-codepoints
($arg
as
xs:string?
) as
xs:integer*
Summary: Returns the sequence of [The Unicode Standard] code points that constitute an xs:string
. If $arg
is a zero-length string or the empty sequence, the empty sequence is returned.
A collation is a specification of the manner in which character strings are compared and, by extension, ordered. When values whose type is xs:string
or a type derived from xs:string
are compared (or, equivalently, sorted), the comparisons are inherently performed according to some collation (even if that collation is defined entirely on code point values). The [Character Model for the World Wide Web 1.0: Fundamentals] observes that some applications may
require different comparison and ordering behaviors than other applications. Similarly, some users having particular linguistic expectations may require different behaviors than other users. Consequently, the collation must be taken into account when comparing strings in any context. Several functions in this and the following section make use of a collation.
Collations can indicate that two different code points are, in fact, equal for comparison purposes (e.g., "v" and "w" are considered equivalent in Swedish). Strings can be compared codepoint-by-codepoint or in a linguistically appropriate manner, as defined by the collation.
Some collations, especially those based on the [Unicode Collation Algorithm] can be "tailored" for various purposes. This document does not discuss such tailoring, nor does it provide a mechanism to perform tailoring. Instead, it assumes that the collation argument to the various functions below is a tailored and named collation. A specific collation with a distinguished name, http://www.w3.org/2005/xpath-functions/collation/codepoint
, provides the ability
to compare strings based on code point values. Every implementation of XQuery/XPath must support the collation based on code point values.
In the ideal case, a collation should treat two strings as equal if the two strings are identical after Unicode normalization. Thus, the [Character Model for the World Wide Web 1.0: Normalization] recommends that all strings be subjected to early Unicode normalization and some collations will raise runtime errors if they encounter strings that are not properly normalized. However, it is not possible to guarantee that all strings in all XML documents are, in fact, normalized, or that they are normalized in the same manner. In order to maximize interoperability of operations on XML documents in general, there may be collations that operate on unnormalized strings and other collations that implicitly normalize strings before comparing them. Applications may choose the kind of collation best suited for their needs. Note that collations based on the Unicode collation algorithm implicitly normalize strings before comparison and produce equivalent results regardless of a string's normalization.
This specification assumes that collations are named and that the collation name may be provided as an argument to string functions. Functions that allow specification of a collation do so with an argument whose type is xs:string
but whose lexical form must conform to an xs:anyURI
. If the collation is specified using a relative URI, it is assumed to be relative to the value of the base-uri property in the static context. This specification also defines the manner in which a
default collation is determined if the collation argument is not specified in invocations of functions that use a collation but allow it to be omitted.
This specification does not define whether or not the collation URI is dereferenced. The collation URI may be an abstract identifier, or it may refer to an actual resource describing the collation. If it refers to a resource, this specification does not define the nature of that resource. One possible candidate is that the resource is a locale description expressed using the Locale Data Markup Language: see [Locale Data Markup Language].
Functions such as fn:compare
and fn:max
that compare xs:string
values use a single collation URI to identify all aspects of the collation rules. This means that any parameters such as the strength of the collation must be specified as part of the collation URI. For example, suppose there is a collation " http://www.example.com/collations/French
" that refers to a French collation that compares on the
basis of base characters. Collations that use the same basic rules, but with higher strengths, for example, base characters and accents, or base characters, accents and case, would need to be given different names, say " http://www.example.com/collations/French1
" and " http://www.example.com/collations/French2
". Note that some specifications use the term collation to refer to an algorithm that can be parameterized, but in this specification, each possible parameterization is
considered to be a distinct collation.
The XQuery/XPath static context includes a provision for a default collation that can be used for string comparisons and ordering operations. See the description of the static context in Section 2.1.1 Static ContextXP. If the default collation is not specified by the user or the system, the default collation is the Unicode code point collation
(http://www.w3.org/2005/xpath-functions/collation/codepoint
).
The decision of which collation to use for a given comparison or ordering function is determined by the following algorithm:
If the function specifies an explicit collation, CollationA (e.g., if the optional collation argument is specified in an invocation of the fn:compare()
function), then:
If CollationA is supported by the implementation, then CollationA is used.
Otherwise, an error is raised [err:FOCH0002].
If no collation is explicitly specified for the function and the default collation in the XQuery/XPath static context is CollationB, then:
If CollationB is supported by the implementation, then CollationB is used.
Otherwise, an error is raised [err:FOCH0002].
Note:
XML allows elements to specify the xml:lang
attribute to indicate the language associated with the content of such an element. This specification does not use xml:lang
to identify the default collation because using xml:lang
does not produce desired effects when the two strings to be compared have different xml:lang
values or when a string is multilingual.
Function | Meaning | |
---|---|---|
fn:compare |
Returns -1, 0, or 1, depending on whether the value of the first argument is respectively less than, equal to, or greater than the value of the second argument, according to the rules of the collation that is used. | |
fn:codepoint-equal |
Returns true if the two arguments are equal using the Unicode code point collation. |
fn:compare
($comparand1
as
xs:string?
, $comparand2
as
xs:string?
) as
xs:integer?
fn:compare ( |
$comparand1 |
as xs:string? , |
$comparand2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:integer? |
Summary: Returns -1, 0, or 1, depending on whether the value of the $comparand1
is respectively less than, equal to, or greater than the value of $comparand2
, according to the rules of the collation that is used.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations.
If either argument is the empty sequence, the result is the empty sequence.
This function, invoked with the first signature, backs up the "eq", "ne", "gt", "lt", "le" and "ge" operators on string values.
fn:compare('abc', 'abc')
returns 0.
fn:compare('Strasse', 'Straße')
returns 0 if and only if the default collation includes provisions that equate "ss" and the (German) character "ß" ("sharp-s"). (Otherwise, the returned value depends on the semantics of the default collation.)
fn:compare('Strasse', 'Straße', 'deutsch')
returns 0 if the collation identified by the relative URI constructed from the string
value "deutsch" includes provisions that equate "ss" and the (German) character "ß" ("sharp-s"). (Otherwise, the returned value depends on the semantics of that collation.)
fn:compare('Strassen', 'Straße')
returns 1 if the default collation includes provisions that treat differences between "ss" and the (German) character "ß" ("sharp-s") with less strength than the differences between the base characters, such as the final "n".
fn:codepoint-equal ( |
$comparand1 |
as xs:string? , |
$comparand2 |
as xs:string? ) as xs:boolean? |
Summary: Returns true
or false
depending on whether the value of $comparand1
is equal to the value of $comparand2
, according to the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
).
If either argument is the empty sequence, the result is the empty sequence.
Note:
This function allows xs:anyURI
values to be compared without having to specify the Unicode code point collation.
The following functions are defined on values of type xs:string
and types derived from it.
Function | Meaning |
---|---|
fn:concat |
Concatenates two or more xdt:anyAtomicType arguments cast to xs:string . |
fn:string-join |
Returns the xs:string produced by concatenating a sequence of xs:string s using an optional separator. |
fn:substring |
Returns the xs:string located at a specified place within an argument xs:string . |
fn:string-length |
Returns the length of the argument. |
fn:normalize-space |
Returns the whitespace-normalized value of the argument. |
fn:normalize-unicode |
Returns the normalized value of the first argument in the normalization form specified by the second argument. |
fn:upper-case |
Returns the upper-cased value of the argument. |
fn:lower-case |
Returns the lower-cased value of the argument. |
fn:translate |
Returns the first xs:string argument with occurrences of characters contained in the second argument replaced by the character at the corresponding position in the third argument. |
fn:encode-for-uri |
Returns the xs:string argument with certain characters escaped to enable the resulting string to be used as a path segment in a URI. |
fn:iri-to-uri |
Returns the xs:string argument with certain characters escaped to enable the resulting string to be used as (part of) a URI. |
fn:escape-html-uri |
Returns the xs:string argument with certain characters escaped in the manner that html user agents handle attribute values that expect URIs. |
Notes:
When the above operators and functions are applied to datatypes derived from xs:string
, they are guaranteed to return legal xs:string
s, but they might not return a legal value for the particular subtype to which they were applied.
The strings returned by fn:concat
and fn:string-join
are not guaranteed to be normalized. But see note in fn:concat
.
fn:concat ( |
$arg1 |
as xdt:anyAtomicType? , |
$arg2 |
as xdt:anyAtomicType? , |
|
... | ) as xs:string |
Summary: Accepts two or more xdt:anyAtomicType
arguments and casts them to xs:string
. Returns the xs:string
that is the concatenation of the values of its arguments after conversion. If any of the arguments is the empty sequence, the argument is treated as the zero-length string.
The fn:concat
function is specified to allow an two or more arguments that are concatenated together. This is the only function specified in this document that allows a variable number of arguments. This capability is retained for compatibility with [XML Path Language (XPath) Version 1.0].
Note:
As mentioned in the note above, the result of fn:concat
may not be normalized. If a normalized result is required, fn:normalize-unicode
can be applied to the xs:string
returned by fn:concat
. The following XQuery:
let $v1 := "I plan to go to Mu" let $v2 := "?nchen in September" return concat($v1, $v2)
where the "?" represents either the actual Unicode character COMBINING DIARESIS (Unicode codepoint U+0308) or "̈", will return:
"I plan to go to Mu?nchen in September"
where the "?" represents either the actual Unicode character COMBINING DIARESIS (Unicode codepoint U+0308) or "̈". It is worth noting that the returned value is not normalized in NFC; however, it is normalized in NFD. .
However, the following XQuery:
let $v1 := "I plan to go to Mu" let $v2 := "?nchen in September" return normalize-unicode(concat($v1, $v2))
where the "?" represents either the actual Unicode character COMBINING DIARESIS (Unicode codepoint U+0308) or "̈", will return:
"I plan to go to München in September"
This returned result is normalized in NFC.
fn:concat('un', 'grateful')
returns " ungrateful
".
fn:concat('Thy ', (), 'old ', "groans", "", ' ring', ' yet', ' in', ' my', ' ancient',' ears.')
returns " Thy old groans ring yet in my ancient ears.
".
fn:concat('Ciao!',())
returns " Ciao!
".
fn:concat('Ingratitude, ', 'thou ', 'marble-hearted', ' fiend!')
returns " Ingratitude, thou marble-hearted fiend!
".
fn:string-join
($arg1
as
xs:string*
, $arg2
as
xs:string
) as
xs:string
Summary: Returns a xs:string
created by concatenating the members of the $arg1
sequence using $arg2
as a separator. If the value of $arg2
is the zero-length string, then the members of $arg1
are concatenated without a separator.
If the value of $arg1
is the empty sequence, the zero-length string is returned.
fn:string-join(('Now', 'is', 'the', 'time', '...'), ' ')
returns " Now is the time ...
".
fn:string-join(('Blow, ', 'blow, ', 'thou ', 'winter ', 'wind!'), '')
returns " Blow, blow, thou winter wind!
".
fn:string-join((), 'separator')
returns "".
Assume a document:
<doc> <chap> <section> </section> </chap> </doc>
with the <section>
as the context node, the [XML Path Language (XPath) 2.0] expression:
fn:string-join(for $n in ancestor-or-self::* return name($n), '/')
returns " doc/chap/section
"
fn:substring ( |
$sourceString |
as xs:string? , |
$startingLoc |
as xs:double ) as xs:string |
fn:substring ( |
$sourceString |
as xs:string? , |
$startingLoc |
as xs:double , |
|
$length |
as xs:double ) as xs:string |
Summary: Returns the portion of the value of $sourceString
beginning at the position indicated by the value of $startingLoc
and continuing for the number of characters indicated by the value of $length
. The characters returned do not extend beyond $sourceString
. If $startingLoc
is zero or negative, only those characters in positions greater than zero are returned.
More specifically, the three argument version of the function returns the characters in $sourceString
whose position $p
obeys:
fn:round($startingLoc) <= $p < fn:round($startingLoc) + fn:round($length)
The two argument version of the function assumes that $length
is infinite and returns the characters in $sourceString
whose position $p
obeys:
fn:round($startingLoc) <= $p < fn:round(INF)
In the above computations, the rules for op:numeric-less-than()
and op:numeric-greater-than()
apply.
If the value of $sourceString
is the empty sequence, the zero-length string is returned.
Note:
The first character of a string is located at position 1, not position 0.
fn:substring("motor car", 6)
returns " car"
.
Characters starting at position 6 to the end of $sourceString
are selected.
fn:substring("metadata", 4, 3)
returns "ada"
.
Characters at positions greater than or equal to 4 and less than 7 are selected.
fn:substring("12345", 1.5, 2.6)
returns "234"
.
Characters at positions greater than or equal to 2 and less than 5 are selected.
fn:substring("12345", 0, 3)
returns "12"
.
Characters at positions greater than or equal to 0 and less than 3 are selected. Since the first position is 1, these are the characters at positions 1 and 2.
fn:substring("12345", 5, -3)
returns ""
.
Characters at positions greater than or equal to 5 and less than 2 are selected.
fn:substring("12345", -3, 5)
returns "1"
.
Characters at positions greater than or equal to -3 and less than 2 are selected. Since the first position is 1, this is the character at position 1.
fn:substring("12345", 0 div 0E0, 3)
returns ""
.
Since 0 div 0E0
returns NaN
, and NaN
compared to any other number returns false
, no characters are selected.
fn:substring("12345", 1, 0 div 0E0)
returns ""
.
As above.
fn:substring((), 1, 3)
returns ""
.
fn:substring("12345", -42, 1 div 0E0)
returns "12345"
.
Characters at positions greater than or equal to -42 and less than INF are selected.
fn:substring("12345", -1 div 0E0, 1 div 0E0)
returns ""
.
Since -INF + INF
returns NaN
, no characters are selected.
fn:string-length
() as
xs:integer
fn:string-length
($arg
as
xs:string?
) as
xs:integer
Summary: Returns an xs:integer
equal to the length in characters of the value of $arg
.
If the value of $arg
is the empty sequence, the xs:integer
0 is returned.
If no argument is supplied, $arg
defaults to the string value (calculated using fn:string()
) of the context item (.
). If no argument is supplied and the context item is undefined an error is raised: [err:FONC0001].
fn:normalize-space
() as
xs:string
fn:normalize-space
($arg
as
xs:string?
) as
xs:string
Summary: Returns the value of $arg
with whitespace normalized by stripping leading and trailing whitespace and replacing sequences of one or more than one whitespace character with a single space, #x20
.
The whitespace characters are defined in the metasymbol S (Production 3) of [Extensible Markup Language (XML) 1.0 Recommendation (Third Edition)].
Note:
The definition of the metasymbol S (Production 3), is unchanged in [Extensible Markup Language (XML) 1.1 Recommendation].
If the value of $arg
is the empty sequence, returns the zero-length string.
If no argument is supplied, $arg
defaults to the string value (calculated using fn:string()
) of the context item (.
). If no argument is supplied and the context item is undefined an error is raised: [err:FONC0001]
fn:normalize-unicode
($arg
as
xs:string?
) as
xs:string
fn:normalize-unicode ( |
$arg |
as xs:string? , |
$normalizationForm |
as xs:string ) as xs:string |
Summary: Returns the value of $arg
normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm
. The effective value of the $normalizationForm
is computed by removing leading and trailing blanks, if present, and converting to upper case.
If the value of $arg
is the empty sequence, returns the zero-length string.
See [Character Model for the World Wide Web 1.0: Normalization] for a description of the normalization forms.
If the $normalizationForm
is absent, as in the first format above, it shall be assumed to be "NFC"
If the effective value of $normalizationForm
is "NFC", then the value returned by the function is the value of $arg
in Unicode Normalization Form C (NFC).
If the effective value of $normalizationForm
is "NFD", then the value returned by the function is the value of $arg
in Unicode Normalization Form D (NFD).
If the effective value of $normalizationForm
is "NFKC", then the value returned by the function is the value of $arg
in Unicode Normalization Form KC (NFKC).
If the effective value of $normalizationForm
is "NFKD", then the value returned by the function is the value of $arg
in Unicode Normalization Form KD (NFKD).
If the effective value of $normalizationForm
is "FULLY-NORMALIZED", then the value returned by the function is the value of $arg
in the fully normalized form.
If the effective value of $normalizationForm
is the zero-length string, no normalization is performed and $arg
is returned.
Conforming implementations ·must· support normalization form "NFC" and ·may· support normalization forms "NFD", "NFKC", "NFKD", "FULLY-NORMALIZED". They ·may· also support other normalization forms with
·implementation-defined· semantics. If the effective value of the $normalizationForm
is other than one of the values supported by the implementation, then an error is raised [err:FOCH0003].
fn:upper-case
($arg
as
xs:string?
) as
xs:string
Summary: Returns the value of $arg
after translating every character to its upper-case correspondent as defined in the Unicode standard [The Unicode Standard]. Every character that does not have an upper-case correspondent is included in the returned value in its original form..
If the value of $arg
is the empty sequence, the zero-length string is returned.
Note:
Case mappings may change the length of a string. In general, the two functions are not inverses of each other fn:lower-case(fn:upper-case($arg))
is not guaranteed to return $arg
, nor is fn:upper-case(fn:lower-case($arg))
. The Latin small letter dotless i (as used in Turkish) is perhaps the most prominent lower-case letter which will not round-trip. The Latin capital letter i with dot above is the most prominent upper-case letter which
will not round trip; there are others.
These functions may not always be linguistically appropriate (e.g. Turkish i without dot) or appropriate for the application (e.g. titlecase). In cases such as Turkish, a simple translation should be used first.
Results may violate user expectations (in Quebec, for example, the standard uppercase equivalent of "è" is "È", while in metropolitan France it is more commonly "E"; only one of these is supported by the functions as defined).
Many characters of class Ll lack uppercase equivalents in the Unicode case mapping tables; many characters of class Lu lack lowercase equivalents.
fn:lower-case
($arg
as
xs:string?
) as
xs:string
Summary: returns the value of $arg
after translating every character to its lower-case correspondent as defined in the Unicode standard [The Unicode Standard]. Every character that does not have an lower-case correspondent is included in the returned value in its original form.
If the value of $arg
is the empty sequence, the zero-length string is returned.
Note:
Case mappings may change the length of a string. In general, the two functions are not inverses of each other fn:lower-case(fn:upper-case($arg))
is not guaranteed to return $arg
, nor is fn:upper-case(fn:lower-case($arg))
. The Latin small letter dotless i (as used in Turkish) is perhaps the most prominent lower-case letter which will not round-trip. The Latin capital letter i with dot above is the most prominent upper-case letter which
will not round trip; there are others.
These functions may not always be linguistically appropriate (e.g. Turkish i without dot) or appropriate for the application (e.g. titlecase). In cases such as Turkish, a simple translation should be used first.
Results may violate user expectations (in Quebec, for example, the standard uppercase equivalent of "è" is "È", while in metropolitan France it is more commonly "E"; only one of these is supported by the functions as defined).
Many characters of class Ll lack uppercase equivalents in the Unicode case mapping tables; many characters of class Lu lack lowercase equivalents.
fn:translate ( |
$arg |
as xs:string? , |
$mapString |
as xs:string , |
|
$transString |
as xs:string ) as xs:string |
Summary: Returns the value of $arg
modified so that every character in the value of $arg
that occurs at some position N in the value of $mapString
has been replaced by the character that occurs at position N in the value of $transString
.
If the value of $arg
is the empty sequence, the zero-length string is returned.
Every character in the value of $arg
that does not appear in the value of $mapString
is unchanged.
Every character in the value of $arg
that appears at some position M in the value of $mapString
, where the value of $transString
is less than M characters in length, is omitted from the returned value. If $mapString
is the zero-length string $arg
is returned.
If a character occurs more than once in $mapString
, then the first occurrence determines the replacement character. If $transString
is longer than $mapString
, the excess characters are ignored.
fn:encode-for-uri
($uri-part
as
xs:string?
) as
xs:string
Summary: This function should be used to process an xs:string
to be used as a path segment in a URI. It is invertible but not idempotent. This function applies the URI escaping rules defined in section 2 of [RFC 3986] to the string supplied as $uri-part
. The effect of the function is to escape a set of identified characters in the string. Each such character is replaced in the string by an escape sequence, which is formed by encoding the character as a
sequence of octets in UTF-8, and then representing each of these octets in the form %HH, where HH is the hexadecimal representation of the octet.
If $uri-part
is the empty sequence, returns the zero-length string.
All characters are escaped other than the lower case letters a-z, the upper case letters A-Z, the digits 0-9, the NUMBER SIGN "#" and HYPHEN-MINUS ("-"), LOW LINE ("_"), FULL STOP ".", EXCLAMATION MARK "!", TILDE "~", ASTERISK "*", APOSTROPHE "'", LEFT PARENTHESIS "(", and RIGHT PARENTHESIS ")".
Since [RFC 3986] recommends that, for consistency, URI producers and normalizers should use uppercase hexadecimal digits for all percent-encodings, this function must always generate hexadecimal values using the upper-case letters A-F.
fn:encode-for-uri ("http://www.example.com/00/Weather/CA/Los%20Angeles#ocean")
returns "http%3A%2F%2Fwww.example.com%2F00%2FWeather%2FCA%2FLos%2520Angeles#ocean"
. This is probably not what the user wants as the '%' sign in the percent-encoded space character is escaped.
concat("http://www.example.com/", encode-for-uri("~bébé")) returns "http://www.example.com/~b%C3%A9b%C3%A9"
.
concat("http://www.example.com/", encode-for-uri("100% organic")) returns "http://www.example.com/100%25%20organic"
.
fn:iri-to-uri
($uri-part
as
xs:string?
) as
xs:string
Summary: This function should be used to process an xs:string
to be used as a URI or part of a URI. It is idempotent but not invertible. This function applies the URI escaping rules defined in section 2 of [RFC 3986] to the string supplied as $uri-part
, which typically represents all or part of a URI. The effect of the function is to escape a set of identified characters in the string. Each such character is replaced in the string by an escape sequence,
which is formed by encoding the character as a sequence of octets in UTF-8, and then representing each of these octets in the form %HH, where HH is the hexadecimal representation of the octet.
If $uri-part
is the empty sequence, returns the zero-length string.
All characters are escaped other than the lower case letters a-z, the upper case letters A-Z, the digits 0-9, the NUMBER SIGN "#" and HYPHEN-MINUS ("-"), LOW LINE ("_"), FULL STOP ".", EXCLAMATION MARK "!", TILDE "~", ASTERISK "*", APOSTROPHE "'", LEFT PARENTHESIS "(", and RIGHT PARENTHESIS ")", SEMICOLON ";", SOLIDUS "/", QUESTION MARK "?", COLON ":", COMMERCIAL AT "@", AMPERSAND "&", EQUALS SIGN "=", PLUS SIGN "+", DOLLAR SIGN "$", COMMA ",", LEFT SQUARE BRACKET "[", RIGHT SQUARE BRACKET "]", and the PERCENT SIGN "%".
Since [RFC 3986] recommends that, for consistency, URI producers and normalizers should use uppercase hexadecimal digits for all percent-encodings, this function must always generate hexadecimal values using the upper-case letters A-F.
Note:
Since this function does not escape the PERCENT SIGN "%" and this character is not allowed in data within a URI, users wishing to convert character strings, such as file names, that include "%" to a URI should manually escape "%" by replacing it with "%25".
fn:escape-html-uri
($uri
as
xs:string?
) as
xs:string
Summary: This function escapes all characters except printable characters of the US-ASCII coded character set, specifically the octets ranging from 32 to 126 (decimal). The effect of the function is to escape a URI in the manner html user agents handle attribute values that expect URIs. Each character in $uri
to be escaped is replaced by an escape sequence, which is formed by encoding the character as a sequence of octets in UTF-8, and then representing each of these octets in the form %HH,
where HH is the hexadecimal representation of the octet. This function must always generate hexadecimal values using the upper-case letters A-F.
If $uri
is the empty sequence, returns the zero-length string.
Note:
The behavior of this function corresponds to the recommended handling of non-ASCII characters in URI attribute values as described in [HTML 4.0] Appendix B.2.1.
fn:escape-html-uri ("http://www.example.com/00/Weather/CA/Los Angeles#ocean")
returns "http://www.example.com/00/Weather/CA/Los Angeles#ocean"
.
fn:escape-html-uri ("javascript:if (navigator.browserLanguage == 'fr') window.open('http://www.example.com/~bébé');") returns "javascript:if (navigator.browserLanguage == 'fr') window.open('http://www.example.com/~b%C3%A9b%C3%A9');"
.
The functions described in the section examine a string $arg1
to see whether it contains another string $arg2
as a substring. The result depends on whether $arg2
is a substring of $arg1
, and if so, on the range of characters in $arg1
which $arg2
matches.
When the Unicode code point collation is used, this simply involves determining whether $arg1
contains a contiguous sequence of characters whose code points are the same, one for one, with the code points of the characters in $arg2
.
When a collation is specified, the rules are more complex.
All collations support the capability of deciding whether two strings are considered equal, and if not, which of the strings should be regarded as preceding the other. For functions such as fn:compare()
, this is all that is required. For other functions, such as fn:contains()
, the collation needs to support an additional property: it must be able to decompose the string into a sequence of collation units, each unit
consisting of one or more characters, such that two strings can be compared by pairwise comparison of these units. ("collation unit" is equivalent to "collation element" as defined in [Unicode Collation Algorithm].) The string $arg1
is then considered to contain $arg2
as a substring if the sequence of collation units corresponding to $arg2
is a subsequence of the sequence of the collation units corresponding to $arg1
. The
characters in $arg1
that match are the characters corresponding to these collation units.
This rule may occasionally lead to surprises. For example, consider a collation that treats "Jaeger" and "Jäger" as equal. It might do this by treating "ä" as representing two collation units, in which case the expression fn:contains("Jäger", "eg")
will return true
. Alternatively, a collation might treat "ae" as a single collation unit, in which case the expression fn:contains("Jaeger", "eg")
will return
false
. The results of these functions thus depend strongly on the properties of the collation that is used. In addition, collations may specify that some collation units should be ignored during matching.
In the definitions below, we say that $arg1
contains $arg2
at positions m
through n
if the collation units corresponding to characters in positions m
to n
of $arg1
are the same as the collation units corresponding to all the characters of $arg2
modulo ignorable collation units. In the simple case of the Unicode code point collation, the collation units are the same as the characters of the string. See
[Unicode Collation Algorithm] for a detailed discussion of substring matching.
It is possible to define collations that do not have the ability to decompose a string into units suitable for substring matching. An argument to a function defined in this section may be a URI that identifies a collation that is able to compare two strings, but that does not have the capability to split the string into collation units. Such a collation may cause the function to fail, or to give unexpected results or it may be rejected as an unsuitable argument. The ability to decompose strings into collation units is an ·implementation-defined· property of the collation.
Function | Meaning |
---|---|
fn:contains |
Indicates whether one xs:string contains another xs:string . A collation may be specified. |
fn:starts-with |
Indicates whether the value of one xs:string begins with the collation units of another xs:string . A collation may be specified. |
fn:ends-with |
Indicates whether the value of one xs:string ends with the collation units of another xs:string . A collation may be specified. |
fn:substring-before |
Returns the collation units of one xs:string that precede in that xs:string the collation units of another xs:string . A collation may be specified. |
fn:substring-after |
Returns the collation units of xs:string that follow in that xs:string the collation units of another xs:string . A collation may be specified. |
fn:contains
($arg1
as
xs:string?
, $arg2
as
xs:string?
) as
xs:boolean
fn:contains ( |
$arg1 |
as xs:string? , |
$arg2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:boolean |
Summary: Returns an xs:boolean
indicating whether or not the value of $arg1
contains (at the beginning, at the end, or anywhere within) at least one sequence of collation units that provides a minimal match to the collation units in the value of $arg2
, according to the collation that is used.
Note:
"Minimal match" is defined in [Unicode Collation Algorithm].
If the value of $arg1
or $arg2
is the empty sequence, or contains only ignorable collation units, it is interpreted as the zero-length string.
If the value of $arg2
is the zero-length string, then the function returns true
.
If the value of $arg1
is the zero-length string, the function returns false
.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations. If the specified collation does not support collation units an error ·may· be raised [err:FOCH0004].
CollationA used in these examples is a collation in which both "-" and "*" are ignorable collation units.
Note:
"Ignorable collation unit" is equivalent to "ignorable collation element" in [Unicode Collation Algorithm].
fn:contains ( "tattoo", "t")
returns true
.
fn:contains ( "tattoo", "ttt")
returns false
.
fn:contains ( "", ())
returns true
. The first rule is applied, followed by the second rule.
fn:contains ( "abcdefghi", "-d-e-f-", "CollationA")
returns true
.
fn:contains ( "a*b*c*d*e*f*g*h*i*", "d-ef-", "CollationA")
returns true
.
fn:contains ( "abcd***e---f*--*ghi", "def", "CollationA")
returns true
.
fn:contains ( (), "--***-*---", "CollationA")
returns true
. The second argument contains only ignorable collation units and is equivalent to the zero-length string.
fn:starts-with
($arg1
as
xs:string?
, $arg2
as
xs:string?
) as
xs:boolean
fn:starts-with ( |
$arg1 |
as xs:string? , |
$arg2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:boolean |
Summary: Returns an xs:boolean
indicating whether or not the value of $arg1
starts with a sequence of collation units that provides a minimal match to the collation units of $arg2
according to the collation that is used.
Note:
"Minimal match" is defined in [Unicode Collation Algorithm].
If the value of $arg1
or $arg2
is the empty sequence, or contains only ignorable collation units, it is interpreted as the zero-length string.
If the value of $arg2
is the zero-length string, then the function returns true
. If the value of $arg1
is the zero-length string and the value of $arg2
is not the zero-length string, then the function returns false
.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations. If the specified collation does not support collation units an error ·may· be raised [err:FOCH0004].
CollationA used in these examples is a collation in which both "-" and "*" are ignorable collation units.
Note:
"Ignorable collation unit" is equivalent to "ignorable collation element" in [Unicode Collation Algorithm].
fn:starts-with("tattoo", "tat")
returns true
.
fn:starts-with ( "tattoo", "att")
returns false
.
fn:starts-with ((), ())
returns true
.
fn:starts-with ( "abcdefghi", "-a-b-c-", "CollationA")
returns true
.
fn:starts-with ( "a*b*c*d*e*f*g*h*i*", "a-bc-", "CollationA")
returns true
.
fn:starts-with ( "abcd***e---f*--*ghi", "abcdef", "CollationA")
returns true
.
fn:starts-with ( (), "--***-*---", "CollationA")
returns true
. The second argument contains only ignorable collation units and is equivalent to the zero-length string.
fn:ends-with
($arg1
as
xs:string?
, $arg2
as
xs:string?
) as
xs:boolean
fn:ends-with ( |
$arg1 |
as xs:string? , |
$arg2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:boolean |
Summary: Returns an xs:boolean
indicating whether or not the value of $arg1
ends with a sequence of collation units that provides a minimal match to the collation units of $arg2
according to the collation that is used.
Note:
"Minimal match" is defined in [Unicode Collation Algorithm].
If the value of $arg1
or $arg2
is the empty sequence, or contains only ignorable collation units, it is interpreted as the zero-length string.
If the value of $arg2
is the zero-length string, then the function returns true
. If the value of $arg1
is the zero-length string and the value of $arg2
is not the zero-length string, then the function returns false
.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations. If the specified collation does not support collation units an error ·may· be raised [err:FOCH0004].
CollationA used in these examples is a collation in which both "-" and "*" are ignorable collation units.
Note:
"Ignorable collation unit" is equivalent to "ignorable collation element" in [Unicode Collation Algorithm].
fn:ends-with ( "tattoo", "tattoo")
returns true
.
fn:ends-with ( "tattoo", "atto")
returns false
.
fn:ends-with ((), ())
returns true
.
fn:ends-with ( "abcdefghi", "-g-h-i-", "CollationA")
returns true
.
fn:ends-with ( "abcd***e---f*--*ghi", "defghi", "CollationA")
returns true
.
fn:ends-with ( "abcd***e---f*--*ghi", "defghi", "CollationA")
returns true
.
fn:ends-with ( (), "--***-*---", "CollationA")
returns true
. The second argument contains only ignorable collation units and is equivalent to the zero-length string.
fn:substring-before
($arg1
as
xs:string?
, $arg2
as
xs:string?
) as
xs:string
fn:substring-before ( |
$arg1 |
as xs:string? , |
$arg2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:string |
Summary: Returns the substring of the value of $arg1
that precedes in the value of $arg1
the first occurrence of a sequence of collation units that provides a minimal match to the collation units of $arg2
according to the collation that is used.
Note:
"Minimal match" is defined in [Unicode Collation Algorithm].
If the value of $arg1
or $arg2
is the empty sequence, or contains only ignorable collation units, it is interpreted as the zero-length string.
If the value of $arg2
is the zero-length string, then the function returns the zero-length string.
If the value of $arg1
does not contain a string that is equal to the value of $arg2
, then the function returns the zero-length string.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations If the specified collation does not support collation units an error ·may· be raised [err:FOCH0004].
CollationA used in these examples is a collation in which both "-" and "*" are ignorable collation units.
Note:
"Ignorable collation unit" is equivalent to "ignorable collation element" in [Unicode Collation Algorithm].
fn:substring-before ( "tattoo", "attoo")
returns "t
".
fn:substring-before ( "tattoo", "tatto")
returns "".
fn:substring-before ((), ())
returns "".
fn:substring-before ( "abcdefghi", "--d-e-", "CollationA")
returns "abc
".
fn:substring-before ( "abc--d-e-fghi", "--d-e-", "CollationA")
returns "abc--
".
fn:substring-before ( "a*b*c*d*e*f*g*h*i*", "***cde", "CollationA")
returns "a*b*
".
fn:substring-before ( "Eureka!", "--***-*---", "CollationA")
returns "". The second argument contains only ignorable collation units and is equivalent to the zero-length string.
fn:substring-after
($arg1
as
xs:string?
, $arg2
as
xs:string?
) as
xs:string
fn:substring-after ( |
$arg1 |
as xs:string? , |
$arg2 |
as xs:string? , |
|
$collation |
as xs:string ) as xs:string |
Summary: Returns the substring of the value of $arg1
that follows in the value of $arg1
the first occurrence of a sequence of collation units that provides a minimal match to the collation units of $arg2
according to the collation that is used.
Note:
"Minimal match" is defined in [Unicode Collation Algorithm].
If the value of $arg1
or $arg2
is the empty sequence, or contains only ignorable collation units, it is interpreted as the zero-length string.
If the value of $arg2
is the zero-length string, then the function returns the value of $arg1
.
If the value of $arg1
does not contain a string that is equal to the value of $arg2
, then the function returns the zero-length string.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations If the specified collation does not support collation units an error ·may· be raised [err:FOCH0004].
CollationA used in these examples is a collation in which both "-" and "*" are ignorable collation units.
Note:
"Ignorable collation unit" is equivalent to "ignorable collation element" in [Unicode Collation Algorithm].
fn:substring-after("tattoo", "tat")
returns "too
".
fn:substring-after ( "tattoo", "tattoo")
returns "".
fn:substring-after ((), ())
returns "".
fn:substring-after ( "abcdefghi", "--d-e-", "CollationA")
returns "fghi
".
fn:substring-after ( "abc--d-e-fghi", "--d-e-", "CollationA")
returns "-fghi
".
fn:substring-after ( "a*b*c*d*e*f*g*h*i*", "***cde***", "CollationA")
returns "*f*g*h*i*
".
fn:substring-after ( "Eureka!", "--***-*---", "CollationA")
returns "Eureka!
". The second argument contains only ignorable collation units and is equivalent to the zero-length string.
The three functions described in this section make use of a regular expression syntax for pattern matching. This is described below.
Function | Meaning |
---|---|
fn:matches |
Returns an xs:boolean value that indicates whether the value of the first argument is matched by the regular expression that is the value of the second argument. |
fn:replace |
Returns the value of the first argument with every substring matched by the regular expression that is the value of the second argument replaced by the replacement string that is the value of the third argument. |
fn:tokenize |
Returns a sequence of one or more xs:string s whose values are substrings of the value of the first argument separated by substrings that match the regular expression that is the value of the second argument. |
The regular expression syntax used by these functions is defined in terms of the regular expression syntax specified in XML Schema (see [XML Schema Part 2: Datatypes Second Edition]), which in turn is based on the established conventions of languages such as Perl. However, because XML Schema uses regular expressions only for validity checking, it omits some facilities that are widely-used with languages such as Perl. This section, therefore, describes extensions to the XML Schema regular expressions syntax that reinstate these capabilities.
Note:
It is recommended that implementers consult [Unicode Regular Expressions] for information on using regular expression processing on Unicode characters.
The regular expression syntax and semantics are identical to those defined in [XML Schema Part 2: Datatypes Second Edition] with the following additions:
Two meta-characters, ^
and $
are added. By default, the meta-character ^
matches the start of the entire string, while $
matches the end of the entire string. In multi-line mode, ^
matches the start of any line (that is, the start of the entire string, and the position immediately after a newline character), while $
matches the end of any line (that is, the end of the entire string, and the position immediately before a
newline character). Newline here means the character #x0A
only.
This means that the production in [XML Schema Part 2: Datatypes Second Edition]:
[10] Char ::= [^.\?*+{}()|#x5B#x5D]
is modified to read:
[10] Char ::= [^.\?*+{}()|^$#x5B#x5D]
The characters #x5B
and #x5D
correspond to "[
" and "]
" respectively.
The following production:
[11] charClass ::= charClassEsc | charClassExpr | WildCardEsc
is modified to read:
[11] charClass ::= charClassEsc | charClassExpr | WildCardEsc | "^" | "$"
Reluctant quantifiers are supported. They are indicated by a " ?
" following a quantifier. Specifically:
X??
matches X, once or not at all
X*?
matches X, zero or more times
X+?
matches X, one or more times
X{n}?
matches X, exactly n times
X{n,}?
matches X, at least n times
X{n,m}?
matches X, at least n times, but not more than m times
The effect of these quantifiers is that the regular expression matches the shortest possible substring consistent with the match as a whole succeeding. Without the " ?
", the regular expression matches the longest possible substring.
To achieve this, the production in [XML Schema Part 2: Datatypes Second Edition]:
[4] quantifier ::= [?*+] | ( '{' quantity '}' )
is changed to:
[4] quantifier ::= ( [?*+] | ( '{' quantity '}' ) ) '?'?
Note:
Reluctant quantifiers have no effect on the results of the boolean fn:matches
function, since this function is only interested in discovering whether a match exists, and not where it exists.
Sub-expressions (groups) within the regular expression are recognized. The regular expression syntax defined by [XML Schema Part 2: Datatypes Second Edition] allows a regular expression to contain parenthesized sub-expressions, but attaches no special significance to them. The fn:replace()
function described below allows access to the parts of the input string that matched a sub-expression (called captured substrings). The
sub-expressions are numbered according to the position of the opening parenthesis in left-to-right order within the top-level regular expression: the first opening parenthesis identifies captured substring 1, the second identifies captured substring 2, and so on. 0 identifies the substring captured by the entire regular expression. If a sub-expression matches more than one substring (because it is within a construct that allows repetition), then only the last substring that it matched will be
captured.
Back-references are allowed. The construct \n
where n
is a single digit is always recognized as a back-reference; if this is followed by further digits, these digits are taken to be part of the back-reference if and only if the back-reference is preceded by sufficiently many capturing subexpressions. A back-reference matches the string that was matched by the n
th capturing subexpression within the regular expression, that is, the parenthesized subexpression whose
opening left parenthesis is the n
th unescaped left parenthesis within the regular expression. The closing right parenthesis of this subexpression must occur before the back-reference. For example, the regular expression ('|").*\1
matches a sequence of characters delimited either by an apostrophe at the start and end, or by a quotation mark at the start and end.
If no string is matched by the n
th capturing subexpression, the back-reference is interpreted as matching a zero-length string.
Back-references change the following production:
[23] charClassEsc ::= ( SingleCharEsc | MultiCharEsc | catEsc | complEsc )
to
[23] charClassEsc ::= ( SingleCharEsc | MultiCharEsc | catEsc | complEsc | backReference )
[23a] backReference ::= "\" [1-9][0-9]*
Single character escapes are extended to allow the $
character to be escaped. The following production is changed:
[24]SingleCharEsc ::= '\' [nrt\|.?*+(){}#x2D#x5B#x5D#x5E]
to
[24]SingleCharEsc ::= '\' [nrt\|.?*+(){}$#x2D#x5B#x5D#x5E]
All these functions provide an optional parameter, $flags
, to set options for the interpretation of the regular expression. The parameter accepts a xs:string
, in which individual letters are used to set options. The presence of a letter within the string indicates that the option is on; its absence indicates that the option is off. Letters may appear in any order and may be repeated. If there are characters present that are not defined here as flags, then an error is raised
[err:FORX0001].
The following options are defined:
s
: If present, the match operates in "dot-all" mode. (Perl calls this the single-line mode.) If the s
flag is not specified, the meta-character .
matches any character except a newline (#x0A
) character. In dot-all mode, the meta-character .
matches any character whatsoever. Suppose the input contains "hello" and "world" on two lines. This will not be matched by the regular expression "hello.*world" unless dot-all mode is enabled.
m
: If present, the match operates in multi-line mode. By default, the meta-character ^
matches the start of the entire string, while $ matches the end of the entire string. In multi-line mode, ^
matches the start of any line (that is, the start of the entire string, and the position immediately after a newline character), while $
matches the end of any line (that is, the end of the entire string, and the position immediately before a newline
character). Newline here means the character #x0A
only.
i
: If present, the match operates in case-insensitive mode. The detailed rules are as follows. In these rules, a character C2 is considered to be a *case-variant* of another character C1 if the following XPath expression returns true
when the two characters are considered as strings of length one, and the Unicode codepoint collation is used:
fn:lower-case(C1) eq fn:lower-case(C2)
or
fn:upper-case(C1) eq fn:upper-case(C2)
Note that the case-variants of a character under this definition are always single characters.
When a normal character (Char
) is used as an atom, it represents the set containing that character and all its case-variants. For example, the regular expression "z" will match both "z" and "Z".
A character range (charRange
) represents the set containing all the characters that it would match in the absence of the "i
" flag, together with their case-variants. For example, the regular expression "[A-Z]" will match all the letters A-Z and all the letters a-z. It will also match certain other characters such as #x212A
(KELVIN SIGN), since fn:lower-case("#x212A")
is "k".
This rule applies also to a character range used in a character class subtraction (charClassSub
): thus [A-Z-[IO]] will match characters such as "A", "B", "a", and "b", but will not match "I", "O", "i", or "o".
The rule also applies to a character range used as part of a negative character group: thus [^Q] will match every character except "Q" and "q" (these being the only case-variants of "Q" in Unicode).
A back-reference is compared using case-blind comparison: that is, each character must either be the same as the corresponding character of the previously matched string, or must be a case-variant of that character. For example, the strings "Mum", "mom", "Dad", and "DUD" all match the regular expression "([md])[aeiou]\1" when the "i
" flag is used.
All other constructs are unaffected by the "i
" flag. For example, "\p{Lu}" continues to match upper-case letters only.
x
: If present, whitespace characters (#x9, #xA, #xD and #x20) in the regular expression are removed prior to matching with one exception: whitespace characters within character class expressions (charClassExpr
) are not removed. This flag can be used, for example, to break up long regular expressions into readable lines.
Examples:
fn:matches("helloworld", "hello world", "x")
returns true
fn:matches("helloworld", "hello[ ]world", "x")
returns false
fn:matches("hello world", "hello\ sworld", "x")
returns true
fn:matches("hello world", "hello world", "x")
returns false
fn:matches
($input
as
xs:string?
, $pattern
as
xs:string
) as
xs:boolean
fn:matches ( |
$input |
as xs:string? , |
$pattern |
as xs:string , |
|
$flags |
as xs:string ) as xs:boolean |
Summary: The function returns true
if $input
matches the regular expression supplied as $pattern
as influenced by the value of $flags
, if present; otherwise, it returns false
.
The effect of calling the first version of this function (omitting the argument $flags
) is the same as the effect of calling the second version with the $flags
argument set to a zero-length string. Flags are defined in 7.6.1.1 Flags.
If $input
is the empty sequence, it is interpreted as the zero-length string.
Unless the metacharacters ^
and $
are used as anchors, the string is considered to match the pattern if any substring matches the pattern. But if anchors are used, the anchors must match the start/end of the string (in string mode), or the start/end of a line (in multiline mode).
Note:
This is different from the behavior of patterns in [XML Schema Part 2: Datatypes Second Edition], where regular expressions are implicitly anchored.
An error is raised [err:FORX0002] if the value of $pattern
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
An error is raised [err:FORX0001] if the value of $flags
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
fn:matches("abracadabra", "bra")
returns true
fn:matches("abracadabra", "^a.*a$")
returns true
fn:matches("abracadabra", "^bra")
returns false
Given the source document:
<poem author="Wilhelm Busch"> Kaum hat dies der Hahn gesehen, Fängt er auch schon an zu krähen: «Kikeriki! Kikikerikih!!» Tak, tak, tak! - da kommen sie. </poem>
the following function calls produce the following results, with the poem
element as the context node:
fn:matches(., "Kaum.*krähen")
returns false
fn:matches(., "Kaum.*krähen", "s")
returns true
fn:matches(., "^Kaum.*gesehen,$", "m")
returns true
fn:matches(., "^Kaum.*gesehen,$")
returns false
fn:matches(., "kiki", "i")
returns true
Note:
Regular expression matching is defined on the basis of Unicode code points; it takes no account of collations.
fn:replace ( |
$input |
as xs:string? , |
$pattern |
as xs:string , |
|
$replacement |
as xs:string ) as xs:string |
fn:replace ( |
$input |
as xs:string? , |
$pattern |
as xs:string , |
|
$replacement |
as xs:string , |
|
$flags |
as xs:string ) as xs:string |
Summary: The function returns the xs:string
that is obtained by replacing each non-overlapping substring of $input
that matches the given $pattern
with an occurrence of the $replacement
string.
The effect of calling the first version of this function (omitting the argument $flags
) is the same as the effect of calling the second version with the $flags
argument set to a zero-length string. Flags are defined in 7.6.1.1 Flags.
The $flags
argument is interpreted in the same manner as for the fn:matches()
function.
If $input
is the empty sequence, it is interpreted as the zero-length string.
If two overlapping substrings of $input
both match the $pattern
, then only the first one (that is, the one whose first character comes first in the $input
string) is replaced.
Within the $replacement
string, a variable $N
may be used to refer to the substring captured by the Nth parenthesized sub-expression in the regular expression. For each match of the pattern, these variables are assigned the value of the content matched by the relevant sub-expression, and the modified replacement string is then substituted for the characters in $input
that matched the pattern. $0
refers to the substring captured by the regular
expression as a whole.
More specifically, the rules are as follows, where S
is the number of parenthesized sub-expressions in the regular expression, and N
is the decimal number formed by taking all the digits that consecutively follow the $
character:
If N
=0
, then the variable is replaced by the substring matched by the regular expression as a whole.
If 1
<=N
<=S
, then the variable is replaced by the substring captured by the Nth parenthesized sub-expression. If the Nth
parenthesized sub-expression was not matched, then the variable is replaced by the zero-length string.
If S
<N
<=9
, then the variable is replaced by the zero-length string.
Otherwise (if N
>S
and N
>9
), the last digit of N
is taken to be a literal character to be included "as is" in the replacement string, and the rules are reapplied using the number N
formed by stripping off this last digit.
For example, if the replacement string is "$23
" and there are 5 substrings, the result contains the value of the substring that matches the second sub-expression, followed by the digit "3
".
A literal "$
" symbol must be written as "\$
".
A literal "\
" symbol must be written as "\\
".
If two alternatives within the pattern both match at the same position in the $input
, then the match that is chosen is the one matched by the first alternative. For example:
fn:replace("abcd", "(ab)|(a)", "[1=$1][2=$2]") returns "[1=ab][2=]cd"
An error is raised [err:FORX0002] if the value of $pattern
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
An error is raised [err:FORX0001] if the value of $flags
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
An error is raised [err:FORX0003] if the pattern matches a zero-length string, that is, if the expression fn:matches("", $pattern, $flags)
returns true
. It is not an error, however, if a captured substring is zero-length.
An error is raised [err:FORX0004] if the value of $replacement
contains a "$
" character that is not immediately followed by a digit 0-9
and not immediately preceded by a "\".
An error is raised [err:FORX0004] if the value of $replacement
contains a "\
" character that is not part of a "\\
" pair, unless it is immediately followed by a "$
" character.
replace("abracadabra", "bra", "*")
returns "a*cada*"
replace("abracadabra", "a.*a", "*")
returns "*"
replace("abracadabra", "a.*?a", "*")
returns "*c*bra"
replace("abracadabra", "a", "")
returns "brcdbr"
replace("abracadabra", "a(.)", "a$1$1")
returns "abbraccaddabbra"
replace("abracadabra", ".*?", "$1")
raises an error, because the pattern matches the zero-length string
replace("AAAA", "A+", "b")
returns " b
"
replace("AAAA", "A+?", "b")
returns " bbbb
"
replace("darted", "^(.*?)d(.*)$", "$1c$2")
returns " carted
". The first " d
" is replaced.
fn:tokenize
($input
as
xs:string?
, $pattern
as
xs:string
) as
xs:string*
fn:tokenize ( |
$input |
as xs:string? , |
$pattern |
as xs:string , |
|
$flags |
as xs:string ) as xs:string* |
Summary: This function breaks the $input
string into a sequence of strings, treating any substring that matches $pattern
as a separator. The separators themselves are not returned.
The effect of calling the first version of this function (omitting the argument $flags
) is the same as the effect of calling the second version with the $flags
argument set to a zero-length string. Flags are defined in 7.6.1.1 Flags.
The $flags
argument is interpreted in the same way as for the fn:matches()
function.
If $input
is the empty sequence, or if $input
is the zero-length string, the result is the empty sequence.
If the supplied $pattern
matches a zero-length string, that is, if fn:matches("", $pattern, $flags)
returns true
, then an error is raised: [err:FORX0003].
If a separator occurs at the start of the $input
string, the result sequence will start with a zero-length string. Zero-length strings will also occur in the result sequence if a separator occurs at the end of the $input
string, or if two adjacent substrings match the supplied $pattern
.
If two alternatives within the supplied $pattern
both match at the same position in the $input
string, then the match that is chosen is the first. For example:
fn:tokenize("abracadabra", "(ab)|(a)") returns ("", "r", "c", "d", "r", "")
An error is raised [err:FORX0002] if the value of $pattern
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
An error is raised [err:FORX0001] if the value of $flags
is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.
fn:tokenize("The cat sat on the mat", "\s+")
returns ("The", "cat", "sat", "on", "the", "mat")
fn:tokenize("1, 15, 24, 50", ",\s*")
returns ("1", "15", "24", "50")
fn:tokenize("1,15,,24,50,", ",")
returns ("1", "15", "", "24", "50", "")
fn:tokenize("abba", ".?")
raises the error [err:FORX0003].
fn:tokenize("Some unparsed <br> HTML <BR> text", "\s*<br>\s*", "i")
returns ("Some unparsed", "HTML", "text")
This section specifies functions that take anyURI as arguments.
Function | Meaning |
---|---|
fn:resolve-uri |
Returns an xs:anyURI representing an absolute xs:anyURI given a base URI and a relative URI. |
fn:resolve-uri
($relative
as
xs:string?
) as
xs:anyURI?
fn:resolve-uri
($relative
as
xs:string?
, $base
as
xs:string
) as
xs:anyURI?
Summary: The purpose of this function is to enable a relative URI to be resolved against an absolute URI.
The first form of this function resolves $relative
against the value of the base-uri property from the static context. If the base-uri property is not initialized in the static context an error is raised [err:FONS0005].
If $relative
is a relative URI reference, it is resolved against $base
, or the base-uri property from the static context, using an algorithm such as the ones described in [RFC 2396] or [RFC 3986], and the resulting absolute URI reference is returned. An error may be raised [err:FORG0009] in the resolution process.
If $relative
is an absolute URI reference, it is returned unchanged.
If $relative
or $base
is not a valid xs:anyURI
an error is raised [err:FORG0002].
If $relative
is the empty sequence, the empty sequence is returned.
Notes:
If $relative
is the zero-length string, returns the value of the base-uri property from the static context in the first form (if the base-uri property is not initialized in the static context an error is raised [err:FONS0005]) and $base
in the second form.
Resolving a URI does not dereference it. This is merely a syntactic operation on two character strings.
This section defines functions and operators on the [XML Schema Part 2: Datatypes Second Edition] boolean datatype.
The following additional constructor functions are defined on the boolean type.
Function | Meaning |
---|---|
fn:true |
Constructs the xs:boolean value 'true'. |
fn:false |
Constructs the xs:boolean value 'false'. |
The following functions define the semantics of operators on boolean values in [XQuery 1.0: An XML Query Language] and [XML Path Language (XPath) 2.0]:
Operator | Meaning |
---|---|
op:boolean-equal |
Equality of xs:boolean values |
op:boolean-less-than |
A less-than operator on xs:boolean values: false is less than true . |
op:boolean-greater-than |
A greater-than operator on xs:boolean values: true is greater than false . |
The ordering operators op:boolean-less-than
and op:boolean-greater-than
are provided for application purposes and for compatibility with [XML Path Language (XPath) Version 1.0]. The [XML Schema Part 2: Datatypes Second Edition] datatype xs:boolean
is not ordered.
op:boolean-equal
($value1
as
xs:boolean
, $value2
as
xs:boolean
) as
xs:boolean
Summary: Returns true
if both arguments are true
or if both arguments are false
. Returns false
if one of the arguments is true
and the other argument is false
.
This function backs up the "eq" operator on xs:boolean
values.
The following functions are defined on boolean values:
Function | Meaning |
---|---|
fn:not |
Inverts the xs:boolean value of the argument. |
fn:not
($arg
as
item()*
) as
xs:boolean
Summary: $arg
is first reduced to an effective boolean value by applying the fn:boolean()
function. Returns true
if the effective boolean value is false
, and false
if the effective boolean value is true
.
This section discusses operations on the [XML Schema Part 2: Datatypes Second Edition] date and time types. It also discusses operations on two subtypes of xs:duration
that are defined in this document. See 10.3 Two Totally Ordered Subtypes of Duration.
See [Working With Timezones] for a disquisition on working with date and time values with and without timezones.
The operators described in this section are defined on the following date and time types:
xs:dateTime
xs:date
xs:time
xs:gYearMonth
xs:gYear
xs:gMonthDay
xs:gMonth
xs:gDay
Note that only equality is defined on xs:gYearMonth
, xs:gYear
, xs:gMonthDay
, xs:gMonth
and xs:gDay
values.
In addition, operators are defined on:
xs:duration
and on the 10.3 Two Totally Ordered Subtypes of Duration:
xdt:yearMonthDuration
xdt:dayTimeDuration
Note that only equality is defined on xs:duration
values.
For a number of the above datatypes [XML Schema Part 2: Datatypes Second Edition] extends the basic [ISO 8601] lexical representations, such as YYYY-MM-DDThh:mm:ss.s for dateTime, by allowing a preceding minus sign, more than four digits to represent the year field — no maximum is specified — and an unlimited number of digits for fractional seconds. Leap seconds are not supported.
All minimally conforming processors ·must· support positive year values with a minimum of 4 digits (i.e., YYYY) and a minimum fractional second precision of 1 millisecond or three digits (i.e., s.sss). However, conforming processors ·may· set larger ·implementation-defined· limits on the maximum number of digits they support in these two situations. Processors ·may· also choose to support the year 0000 and years with negative values. The results of operations on dates that cross the year 0000 are ·implementation-defined·.
A processor that limits the number of digits in date and time datatype representations may encounter overflow and underflow conditions when it tries to execute the functions in 10.8 Arithmetic Functions on Durations, Dates and Times. In these situations, the processor ·must· return P0M or PT0S in case of duration underflow and 00:00:00 in case of time underflow. It ·must· raise an error [err:FODT0001] in case of overflow.
The value spaces of the two totally ordered subtypes of xs:duration
described in 10.3 Two Totally Ordered Subtypes of Duration are xs:integer
months for xdt:yearMonthDuration
and xs:decimal
seconds for xdt:dayTimeDuration
. If a processor limits the number of digits allowed in the representation of xs:integer
and xs:decimal
then overflow and underflow situations can arise
when it tries to execute the functions in 10.6 Arithmetic Functions on Durations. In these situations the processor ·must· return zero in case of numeric underflow and P0M or PT0S in case of duration underflow. It ·must· raise an error [err:FODT0002] in case of overflow.
As defined in Section 3.3.2 Dates and TimesDM, xs:dateTime
, xs:date
, xs:time
, xs:gYearMonth
, xs:gYear
, xs:gMonthDay
, xs:gMonth
, xs:gDay
values, referred to collectively as date/time values, are represented as seven components or properties: year
, month
, day
,
hour
, minute
, second
and timezone
. The value of the first five components are xs:integer
s. The value of the second
component is an xs:decimal
and the value of the timezone
component is an xdt:dayTimeDuration
. For all the date/time datatypes, the timezone
property is optional and may or may not be present. Depending on the datatype, some of the remaining six properties must be
present and some must be absent. Absent, or missing, properties are represented by the empty sequence. This value is referred to as the local value in that the value is in the given timezone. Before comparing or subtracting xs:dateTime
values, this local value ·must· be translated or normalized to UTC.
For xs:time
, "00:00:00"
and "24:00:00"
are alternate lexical forms for the same value. For xs:dateTime
, a time component "24:00:00"
translates to "00:00:00"
of the following day.
An xs:dateTime
with lexical representation 1999-05-31T05:00:00
is represented in the datamodel by {1999, 5, 31, 5, 0, 0.0, ()}
.
An xs:dateTime
with lexical representation 1999-05-31T13:20:00-05:00
is represented by {1999, 5, 31, 13, 20, 0.0, -PT5H}
.
An xs:dateTime
with lexical representation 1999-12-31T24:00:00
is represented by {2000, 1, 1, 0, 0, 0.0, ()}
.
An xs:date
with lexical representation 2005-02-28+8:00
is represented by {2005, 2, 28, (), (), (), PT8H}
.
An xs:time
with lexical representation 24:00:00
is represented by {(), (), (), 0, 0, 0, ()}
.
Two totally ordered subtypes of xs:duration
are defined in Section 2.6 TypesDM specification using the mechanisms described in [XML Schema Part 2: Datatypes Second Edition] for defining user-defined types. They are available in the namespace http://www.w3.org/2005/xpath-datatypes
. The XML Schema for these two derived datatypes is shown in [schema-for-duration-subtypes]. Additional details about these types is given below.
[Definition] xdt:yearMonthDuration
is derived from xs:duration
by restricting its lexical representation to contain only the year and month components. The value space of xdt:yearMonthDuration
is the set of xs:integer
month values. The year and month components of xdt:yearMonthDuration
correspond to the Gregorian year and month components defined in section 5.5.3.2 of [ISO 8601], respectively.
The lexical representation for xdt:yearMonthDuration
is the [ISO 8601] reduced format PnYnM, where nY represents the number of years and nM the number of months. The values of the years and months components are not restricted but allow an arbitrary unsigned xs:integer
.
An optional preceding minus sign ('-') is allowed to indicate a negative duration. If the sign is omitted a positive duration is indicated. To indicate a xdt:yearMonthDuration
of 1 year, 2 months, one would write: P1Y2M. One could also indicate a xdt:yearMonthDuration
of minus 13 months as: -P13M.
Reduced precision and truncated representations of this format are allowed provided they conform to the following:
If the number of years or months in any expression equals zero (0), the number and its corresponding designator ·may· be omitted. However, at least one number and its designator ·must· be present. For example, P1347Y and P1347M are allowed; P-1347M is not allowed, although -P1347M is allowed. P1Y2MT is not allowed. Also, P24YM is not allowed, nor is PY43M since Y must have at least one preceding digit and M must have one preceding digit.
The value of a xdt:yearMonthDuration
lexical form is obtained by multiplying the value of the years component by 12 and adding the value of the months component. The value is positive or negative depending on the preceding sign.
The canonical representation of xdt:yearMonthDuration
restricts the value of the months component to xs:integer
values between 0 and 11, both inclusive. To convert from a non-canonical representation to the canonical representation, the lexical representation is first converted to a value in xs:integer
months as defined above. This value is then divided by 12 to obtain the value of the years component of the canonical representation. The remaining number of months
is the value of the months component of the canonical representation. For negative durations, the canonical form is calculated using the absolute value of the duration and a negative sign is prepended to it. If a component has the value zero (0), then the number and the designator for that component ·must· be omitted. However, if the value is zero (0) months, the canonical form is "P0M".
Let the function that calculates the value of an xdt:yearMonthDuration
in the manner described above be called V(d). Then for two xdt:yearMonthDuration
values x and y, x > y if and only if V(x) > V(y). The order relation on yearMonthDuration
is a total order.
[Definition] xdt:dayTimeDuration
is derived from xs:duration
by restricting its lexical representation to contain only the days, hours, minutes and seconds components. The value space of xdt:dayTimeDuration
is the set of fractional second values. The components of xdt:dayTimeDuration
correspond to the day, hour, minute and second components defined in Section 5.5.3.2 of [ISO 8601], respectively.
The lexical representation for xdt:dayTimeDuration
is the [ISO 8601] truncated format PnDTnHnMnS, where nD represents the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes and nS the number of seconds.
The values of the days, hours and minutes components are not restricted, but allow an arbitrary unsigned xs:integer
. Similarly, the value of the seconds component allows an arbitrary unsigned xs:decimal
. An optional minus sign ('-') is allowed to precede the 'P', indicating a negative duration. If the sign is omitted, the duration is positive. See also [ISO 8601] Date and Time Formats.
For example, to indicate a duration of 3 days, 10 hours and 30 minutes, one would write: P3DT10H30M. One could also indicate a duration of minus 120 days as: -P120D. Reduced precision and truncated representations of this format are allowed, provided they conform to the following:
If the number of days, hours, minutes, or seconds in any expression equals zero (0), the number and its corresponding designator ·may· be omitted. However, at least one number and its designator ·must· be present.
The seconds part ·may· have a decimal fraction.
The designator 'T' ·must· be absent if and only if all of the time items are absent. The designator 'P' ·must· always be present.
For example, P13D, PT47H, P3DT2H, -PT35.89S and P4D251M are all allowed. P-134D is not allowed (invalid location of minus sign), although -P134D is allowed.
The value of a xdt:dayTimeDuration
lexical form in fractional seconds is obtained by converting the days, hours, minutes and seconds value to fractional seconds using the conversion rules: 24 hours = 1 day, 60 minutes = 1 hour and 60 seconds = 1 minute.
The canonical representation of xdt:dayTimeDuration
restricts the value of the hours component to xs:integer
values between 0 and 23, both inclusive; the value of the minutes component to xs:integer
values between 0 and 59; both inclusive; and the value of the seconds component to xs:decimal
valued from 0.0 to 59.999... (see [XML Schema Part 2: Datatypes Second Edition], Appendix D).
To convert from a non-canonical representation to the canonical representation, the value of the lexical form in fractional seconds is first calculated in the manner described above. The value of the days component in the canonical form is then calculated by dividing the value by 86,400 (24*60*60). The remainder is in fractional seconds. The value of the hours component in the canonical form is calculated by dividing this remainder by 3,600 (60*60). The remainder is again in fractional seconds. The value of the minutes component in the canonical form is calculated by dividing this remainder by 60. The remainder in fractional seconds is the value of the seconds component in the canonical form. For negative durations, the canonical form is calculated using the absolute value of the duration and a negative sign is prepended to it. If a component has the value zero (0) then the number and the designator for that component must be omitted. However, if all the components of the lexical form are zero (0), the canonical form is "PT0S".
Let the function that calculates the value of a xdt:dayTimeDuration
in the manner described above be called V(d). Then for two xdt:dayTimeDuration
values x and y, x > y if and only if V(x) > V(y). The order relation on xdt:dayTimeDuration
is a total order.
Operator | Meaning |
---|---|
op:yearMonthDuration-equal |
Equality comparison on xdt:yearMonthDuration values |
op:yearMonthDuration-less-than |
Less-than comparison on xdt:yearMonthDuration values |
op:yearMonthDuration-greater-than |
Greater-than comparison on xdt:yearMonthDuration values |
op:dayTimeDuration-equal |
Equality comparison on xdt:dayTimeDuration values |
op:dayTimeDuration-less-than |
Less-than comparison on xdt:dayTimeDuration values |
op:dayTimeDuration-greater-than |
Greater-than comparison on xdt:dayTimeDuration values |
op:duration-equal |
Equality comparison on xs:duration values |
op:dateTime-equal |
Equality comparison on xs:dateTime values |
op:dateTime-less-than |
Less-than comparison on xs:dateTime values |
op:dateTime-greater-than |
Greater-than comparison on xs:dateTime values |
op:date-equal |
Equality comparison on xs:date values |
op:date-less-than |
Less-than comparison on xs:date values |
op:date-greater-than |
Greater-than comparison on xs:date values |
op:time-equal |
Equality comparison on xs:time values |
op:time-less-than |
Less-than comparison on xs:time values |
op:time-greater-than |
Greater-than comparison on xs:time values |
op:gYearMonth-equal |
Equality comparison on xs:gYearMonth values |
op:gYear-equal |
Equality comparison on xs:gYear values |
op:gMonthDay-equal |
Equality comparison on xs:gMonthDay values |
op:gMonth-equal |
Equality comparison on xs:gMonth values |
op:gDay-equal |
Equality comparison on xs:gDay values |
The following comparison operators are defined on the [XML Schema Part 2: Datatypes Second Edition] date, time and duration datatypes. Each operator takes two operands of the same type and returns an xs:boolean
result. As discussed in [XML Schema Part 2: Datatypes Second Edition], the order relation on xs:duration
is not a total order but, rather, a partial order. For this reason, only equality is defined on
xs:duration
. A full complement of comparison and arithmetic functions are defined on the two subtypes of duration described in 10.3 Two Totally Ordered Subtypes of Duration which do have a total order.
[XML Schema Part 2: Datatypes Second Edition] also states that the order relation on date and time datatypes is not a total order but a partial order because these datatypes may or may not have a timezone. This is handled as follows. If either operand to a comparison function on date or time values does not have an (explicit) timezone then, for the purpose of the operation, an implicit timezone, provided by the dynamic context Section C.2 Dynamic Context ComponentsXP, is assumed to be present as part of the value. This creates a total order for all date and time values.
An xs:dateTime
can be considered to consist of seven components: year
, month
, day
, hour
, minute
, second
and timezone
. For xs:dateTime
six components: year
, month
, day
, hour
, minute
and second
are required and timezone
is optional. For other date/time values, of the first six components, some are
required and others must be absent or missing. Timezone
is always optional. For example, for xs:date
, the year
, month
and day
components are required and hour
, minute
and second
components must be absent; for xs:time
the hour
, minute
and second
components are required and year
, month
and day
are missing; for
xs:gDay
, day
is required and year
, month
, hour
, minute
and second
are missing.
Values of the date/time datatypes xs:time
, xs:gMonthDay
, xs:gMonth
, and xs:gDay
, can be considered to represent a sequence of recurring time instants or time periods. An xs:time
occurs every day. An xs:gMonth
occurs every year. Comparison operators on these datatypes compare the starting instants of equivalent occurrences in the recurring series. These xs:dateTime
values are calculated as described below.
Comparison operators on xs:date
, xs:gYearMonth
and xs:gYear
compare their starting instants. These xs:dateTime
values are calculated as described below.
The starting instant of an occurrence of a date/time value is an xs:dateTime
calculated by filling in the missing components of the local value from a reference xs:dateTime
. If the value filled in for a missing day component exceeds the maximum day value for the month, the last day of the month is used. Suppose, for example, that the reference xs:dateTime
is 1972-12-31T00:00:00
and the xs:date
value to be compared is
1993-03-31
. Filling in the time components from the reference xs:dateTime
we get 1993-03-31T00:00:00
which is the starting instant of that day. Similarly, if the xs:time
value 12:30:00
is to be compared, we fill in the missing components from the reference xs:dateTime
and we get 1972-12-31T12:30:00
which is the time on that day. For an xs:gYearMonth
value of 1976-02
we fill in the missing
components, adjust for the last day in the month and get 1976-02-29T00:00:00
.
If the xs:time
value written as 24:00:00
is to be compared, filling in the missing components gives 1972-12-31T00:00:00
, because 24:00:00
is an alternative representation of 00:00:00
(the lexical value "24:00:00"
is converted to the time components {0,0,0} before the missing components are filled in). This has the consequence that when ordering xs:time
values, 24:00:00
is considered to be earlier than
23:59:59
. However, when ordering xs:dateTime
values, a time component of 24:00:00
is considered equivalent to 00:00:00
on the following day.
Note that the reference xs:dateTime
does not have a timezone. The timezone
component is never filled in from the reference xs:dateTime
. In some cases, if the date/time value does not have a timezone, the implicit timezone from the dynamic context is used as the timezone.
Note:
This proposal uses the reference xs:dateTime 1972-12-31T00:00:00
in the description of the comparison operators. Implementations are allowed to use other reference xs:dateTime
values as long as they yield the same results. The reference xs:dateTime
used must meet the following constraints: when it is used to supply components into xs:gMonthDay
values, the year must allow for February 29 and so must be a leap year; when it is used to supply missing
components into xs:gDay
values, the month must allow for 31 days. Different reference xs:dateTime
values may be used for different operators.
op:yearMonthDuration-equal ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xs:boolean |
Summary: Returns true
if and only if $arg1
is equal to $arg2
. Returns false
otherwise.
This function backs up the "eq", "ne", "le" and "ge" operators on xdt:yearMonthDuration
values.
op:yearMonthDuration-less-than ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xs:boolean |
Summary: Returns true
if and only if $arg1
is less than $arg2
. Returns false
otherwise.
This function backs up the "lt" and "le" operators on xdt:yearMonthDuration
values.
op:yearMonthDuration-greater-than ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xs:boolean |
Summary: Returns true
if and only if $arg1
is greater than $arg2
. Returns false
otherwise.
This function backs up the "gt" and "ge" operators on xdt:yearMonthDuration
values.
op:dayTimeDuration-equal ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xs:boolean |
Summary: Returns true
if and only if the value of $arg1
is equal to the value of $arg2
. Returns false
otherwise.
This function backs up the "eq", "ne", "le" and "ge" operators on xdt:dayTimeDuration
values.
op:dayTimeDuration-less-than ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xs:boolean |
Summary: Returns true
if and only if $arg1
is less than $arg2
. Returns false
otherwise.
This function backs up the "lt" and "le" operators on xdt:dayTimeDuration
values.
op:dayTimeDuration-greater-than ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xs:boolean |
Summary: Returns true
if and only if $arg1
is greater than $arg2
. Returns false
otherwise.
This function backs up the "gt" and "ge" operators on xdt:dayTimeDuration
values.
op:duration-equal
($arg1
as
xs:duration
, $arg2
as
xs:duration
) as
xs:boolean
Summary: Returns true
if and only if the xdt:yearMonthDuration
and the xdt:dayTimeDuration
components of $arg1
and $arg2
compare equal respectively. Returns false
otherwise.
This function backs up the "eq" and "ne" operators on xs:duration
values.
The semantics of this function are:
if (cast as xdt:yearMonthDuration ($arg1) eq cast as xdt:yearMonthDuration($arg2) and cast as xdt:dayTimeDuration($arg1) eq cast as xdt:dayTimeDuration ($arg2)) return fn:true() else return fn:false()
op:dateTime-equal
($arg1
as
xs:dateTime
, $arg2
as
xs:dateTime
) as
xs:boolean
Summary: Returns true
if and only if the value of $arg1
is equal to the value of $arg2
according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime
values with timezones. Returns false
otherwise.
This function backs up the "eq", "ne", "le" and "ge" operators on xs:dateTime
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
.
op:dateTime-equal(xs:dateTime("2002-04-02T12:00:00-01:00"), xs:dateTime("2002-04-02T17:00:00+04:00"))
returns true
.
op:dateTime-equal(xs:dateTime("2002-04-02T12:00:00"), xs:dateTime("2002-04-02T23:00:00+06:00"))
returns true
.
op:dateTime-equal(xs:dateTime("2002-04-02T12:00:00"), xs:dateTime("2002-04-02T17:00:00"))
returns false
.
op:dateTime-equal(xs:dateTime("2002-04-02T12:00:00"), xs:dateTime("2002-04-02T12:00:00"))
returns true
.
op:dateTime-equal(xs:dateTime("2002-04-02T23:00:00-04:00"), xs:dateTime("2002-04-03T02:00:00-01:00"))
returns true
.
op:dateTime-equal(xs:dateTime("1999-12-31T24:00:00"), xs:dateTime("2000-01-01T00:00:00"))
returns true
.
op:dateTime-equal(xs:dateTime("2005-04-04T24:00:00"), xs:dateTime("2005-04-04T00:00:00"))
returns false
.
op:dateTime-less-than
($arg1
as
xs:dateTime
, $arg2
as
xs:dateTime
) as
xs:boolean
Summary: Returns true
if and only if the value of $arg1
is less than the value of $arg2
according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime
values with timezones. Returns false
otherwise.
This function backs up the "lt" and "le" operators on xs:dateTime
values.
op:dateTime-greater-than ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xs:dateTime ) as xs:boolean |
Summary: Returns true
if and only if the value of $arg1
is greater than the value of $arg2
according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime
values with timezones. Returns false
otherwise.
This function backs up the "gt" and "ge" operators on xs:dateTime
values.
op:date-equal
($arg1
as
xs:date
, $arg2
as
xs:date
) as
xs:boolean
Summary: Returns true
if and only if the starting instant of $arg1
is equal to starting instant of $arg2
. Returns false
otherwise.
The starting instant of an xs:date
is the xs:dateTime
at time 00:00:00
on that date.
The two starting instants are compared using op:dateTime-equal
.
This function backs up the "eq", "ne", "le" and "ge" operators on xs:date
values.
op:date-equal(xs:date("2004-12-25Z"), xs:date("2004-12-25+07:00"))
returns false
. The starting instants are xs:dateTime("2004-12-25T00:00:00Z")
and xs:dateTime("2004-12-25T00:00:00+07:00")
. These are normalized to xs:dateTime("2004-12-25T00:00:00Z")
and xs:dateTime("2004-12-24T17:00:00Z")
.
op:date-equal(xs:date("2004-12-25-12:00"), xs:date("2004-12-26+12:00"))
returns true
.
op:date-less-than
($arg1
as
xs:date
, $arg2
as
xs:date
) as
xs:boolean
Summary: Returns true
if and only if the starting instant of $arg1
is less than the starting instant of $arg2
. Returns false
otherwise.
The starting instant of an xs:date
is the xs:dateTime
at time 00:00:00
on that date.
The two starting instants are compared using op:dateTime-less-than
.
This function backs up the "lt" and "le" operators on xs:date
values.
op:date-greater-than
($arg1
as
xs:date
, $arg2
as
xs:date
) as
xs:boolean
Summary: Returns true
if and only if the starting instant of $arg1
is greater than the starting instant of $arg2
. Returns false
otherwise.
The starting instant of an xs:date
is the xs:dateTime
at time 00:00:00
on that date.
The two starting instants are compared using op:dateTime-greater-than
.
This function backs up the "gt" and "ge" operators on xs:date
values.
op:time-equal
($arg1
as
xs:time
, $arg2
as
xs:time
) as
xs:boolean
Summary: Returns true
if and only if the value of $arg1
converted to an xs:dateTime
using the date components from the reference xs:dateTime
is equal to the value of $arg2
converted to an xs:dateTime
using the date components from the same reference xs:dateTime
. Returns false
otherwise.
The two xs:dateTime
values are compared using op:dateTime-equal
.
This function backs up the "eq", "ne", "le" and "ge" operators on xs:time
values.
Assume that the date components from the reference xs:dateTime
correspond to 1972-12-31
.
op:time-equal(xs:time("08:00:00+09:00"), xs:time("17:00:00-06:00"))
returns false
. The xs:dateTime>
s calculated using the reference date components are 1972-12-31T08:00:00+09:00
and 1972-12-31T17:00:00-06:00
. These normalize to 1972-12-30T23:00:00Z
and 1972-12-31T23:00:00
.
op:time-equal(xs:time("21:30:00+10:30"), xs:time("06:00:00-05:00"))
returns true
.
op:time-equal(xs:time("24:00:00+01:00"), xs:time("00:00:00+01:00"))
returns true
.
op:time-less-than
($arg1
as
xs:time
, $arg2
as
xs:time
) as
xs:boolean
Summary: Returns true
if and only if the value of $arg1
converted to an xs:dateTime
using the date components from the reference xs:dateTime
is less than the normalized value of $arg2
converted to an xs:dateTime
using the date components from the same reference xs:dateTime
. Returns false
otherwise.
The two xs:dateTime
values are compared using op:dateTime-less-than
.
This function backs up the "lt" and "le" operators on xs:time
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
.
op:time-less-than(xs:time("12:00:00"), xs:time("23:00:00+06:00"))
returns false
.
op:time-less-than(xs:time("11:00:00"), xs:time("17:00:00Z"))
returns true
.
op:time-less-than(xs:time("23:59:59"), xs:time("24:00:00"))
returns false
.
op:time-greater-than
($arg1
as
xs:time
, $arg2
as
xs:time
) as
xs:boolean
Summary: Returns true
if and only if the value of $arg1
converted to an xs:dateTime
using the date components from the reference xs:dateTime
is greater than the value of $arg2
converted to an xs:dateTime
using the date components from the same reference xs:dateTime
. Returns false
otherwise.
The two xs:dateTime
values are compared using op:dateTime-greater-than
.
This function backs up the "gt" and "ge" operators on xs:time
values.
op:gYearMonth-equal ( |
$arg1 |
as xs:gYearMonth , |
$arg2 |
as xs:gYearMonth ) as xs:boolean |
Summary: Returns true
if and only if the xs:dateTime
s representing the starting instants of $arg1
and $arg2
compare equal. The starting instants of $arg1
and $arg2
are calculated by adding the missing components of $arg1
and $arg2
from the xs:dateTime
template xxxx-xx-ddT00:00:00
where dd
represents the last day of the month
component in
$arg1
or $arg2
. Returns false
otherwise.
The two xs:dateTime
values representing the starting instants of $arg1
and $arg2
are compared using op:dateTime-equal
.
This function backs up the "eq" and "ne" operators on xs:gYearMonth
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
.
op:gYearMonth-equal(xs:gYearMonth("1976-02"), xs:gYearMonth("1976-03Z"))
returns false
. The starting instants are 1972-02-29T00:00:00-05:00
and 1972-03-31T00:00:00Z
, respectively.
op:gYearMonth-equal(xs:gYearMonth("1976-03"), xs:gYearMonth("1976-03Z"))
returns false
.
op:gYear-equal
($arg1
as
xs:gYear
, $arg2
as
xs:gYear
) as
xs:boolean
Summary: Returns true
if and only if the xs:dateTime
s representing the starting instants of $arg1
and $arg2
compare equal. The starting instants of $arg1
and $arg2
are calculated by adding the missing components of $arg1
and $arg2
from a xs:dateTime
template such as xxxx-01-01T00:00:00
. Returns false
otherwise.
The two xs:dateTime
values representing the starting instants of $arg1
and $arg2
are compared using op:dateTime-equal
.
This function backs up the "eq" and "ne" operators on xs:gYear
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
. Assume, also, that the xs:dateTime
template is xxxx-01-01T00:00:00
.
op:gYear-equal(xs:gYear("2005-12:00"), xs:gYear("2005+12:00"))
returns false
. The starting instants are 2005-01-01T00:00:00-12:00
and 2005-01-01T00:00:00+12:00
, respectively, and normalize to 2005-01-015T12:00:00Z
and 2004-12-31T12:00:00Z
.
op:gYear-equal(xs:gYear("1976-05:00"), xs:gYear("1976"))
returns true
.
op:gMonthDay-equal
($arg1
as
xs:gMonthDay
, $arg2
as
xs:gMonthDay
) as
xs:boolean
Summary: Summary: Returns true
if and only if the xs:dateTime
s representing the starting instants of equivalent occurrences of $arg1
and $arg2
compare equal. The starting instants of equivalent occurrences of $arg1
and $arg2
are calculated by adding the missing components of $arg1
and $arg2
from an xs:dateTime
template such as 1972-xx-xxT00:00:00
. Returns false
otherwise.
The two xs:dateTime
values representing the starting instants of equivalent occurrences of $arg1
and $arg2
are compared using op:dateTime-equal
.
This function backs up the "eq" and "ne" operators on xs:gMonthDay
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
. Assume, also, that the xs:dateTime
template is 1976-xx-xxT00:00:00
.
op:gMonthDay-equal(xs:gMonthDay("--12-25-14:00"), xs:gMonthDay("--12-26+10:00"))
returns true
. The starting instants are 1976-12-25T00:00:00-14:00
and 1976-12-26T00:00:00+10:00
, respectively, and normalize to 1976-12-25T14:00:00Z
and 1976-12-25T14:00:00Z
.
op:gMonthDay-equal(xs:gMonthDay("--12-25"), xs:gMonthDay("--12-26Z"))
returns false
.
op:gMonth-equal
($arg1
as
xs:gMonth
, $arg2
as
xs:gMonth
) as
xs:boolean
Summary: Returns true
if and only if the xs:dateTime
s representing the starting instants of equivalent occurrences of $arg1
and $arg2
compare equal. The starting instants of equivalent occurrences of $arg1
and $arg2
are calculated by adding the missing components of $arg1
and $arg2
from an xs:dateTime
template such as 1972-xx-ddT00:00:00
where dd
represents the
last day of the month component in $arg1
or $arg2
. Returns false
otherwise.
The two xs:dateTime
values representing the starting instants of equivalent occurrences of $arg1
and $arg2
are compared using op:dateTime-equal
.
This function backs up the "eq" and "ne" operators on xs:gMonth
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
. Assume, also, that the xs:dateTime
template is 1972-xx-ddT00:00:00
.
op:gMonth-equal(xs:gMonth("--12-14:00"), xs:gMonth("--12+10:00")
returns false
. The starting instants are 1972-12-31T00:00:00-14:00
and 1972-12-31T00:00:00+10:00
, respectively, and normalize to 1972-01-01T14:00:00Z
and 1972-12-30T14:00:00Z
.
op:gMonth-equal(xs:gMonth("--12"), xs:gMonth("--12Z"))
returns false
.
op:gDay-equal
($arg1
as
xs:gDay
, $arg2
as
xs:gDay
) as
xs:boolean
Summary: Returns true
if and only if the xs:dateTime
s representing the starting instants of equivalent occurrences of $arg1
and $arg2
compare equal. The starting instants of equivalent occurrences of $arg1
and $arg2
are calculated by adding the missing components of $arg1
and $arg2
from an xs:dateTime
template such as 1972-12-xxT00:00:00
. Returns false
otherwise.
The two xs:dateTime
values representing the starting instants of equivalent occurrences of $arg1
and $arg2
are compared using op:dateTime-equal
.
This function backs up the "eq" and "ne" operators on xs:gDay
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
. Assume, also, that the xs:dateTime
template is 1976-xx-xxT00:00:00
.
op:gDay-equal(xs:gDay("---25-14:00"), xs:gDay("---25+10:00"))
returns false
. The starting instants are 1972-12-25T00:00:00-14:00
and 1972-12-25T00:00:00+10:00
, respectively, and normalize to 1972-12-25T14:00:00Z
and 1972-12-24T14:00:00Z
.
op:gDay-equal(xs:gDay("---12"), xs:gDay("---12Z"))
returns false
.
The duration, date and time datatypes may be considered to be composite datatypes in that they contain distinct properties or components. The extraction functions specified below extract a single component from a duration, date or time value. For the date/time datatypes the local value is used.
Function | Meaning |
---|---|
fn:years-from-duration |
Returns the year component of an xdt:yearMonthDuration value. |
fn:months-from-duration |
Returns the months component of an xdt:yearMonthDuration value. |
fn:days-from-duration |
Returns the days component of an xdt:dayTimeDuration value. |
fn:hours-from-duration |
Returns the hours component of an xdt:dayTimeDuration value. |
fn:minutes-from-duration |
Returns the minutes component of an xdt:dayTimeDuration value. |
fn:seconds-from-duration |
Returns the seconds component of an xdt:dayTimeDuration value. |
fn:year-from-dateTime |
Returns the year from an xs:dateTime value. |
fn:month-from-dateTime |
Returns the month from an xs:dateTime value. |
fn:day-from-dateTime |
Returns the day from an xs:dateTime value. |
fn:hours-from-dateTime |
Returns the hours from an xs:dateTime value. |
fn:minutes-from-dateTime |
Returns the minutes from an xs:dateTime value. |
fn:seconds-from-dateTime |
Returns the seconds from an xs:dateTime value. |
fn:timezone-from-dateTime |
Returns the timezone from an xs:dateTime value. |
fn:year-from-date |
Returns the year from an xs:date value. |
fn:month-from-date |
Returns the month from an xs:date value. |
fn:day-from-date |
Returns the day from an xs:date value. |
fn:timezone-from-date |
Returns the timezone from an xs:date value. |
fn:hours-from-time |
Returns the hours from an xs:time value. |
fn:minutes-from-time |
Returns the minutes from an xs:time value. |
fn:seconds-from-time |
Returns the seconds from an xs:time value. |
fn:timezone-from-time |
Returns the timezone from an xs:time value. |
fn:years-from-duration
($arg
as
xdt:yearMonthDuration?
) as
xs:integer?
Summary: Returns an xs:integer
representing the years component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:months-from-duration
($arg
as
xdt:yearMonthDuration?
) as
xs:integer?
Summary: Returns an xs:integer
representing the months component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:days-from-duration
($arg
as
xdt:dayTimeDuration?
) as
xs:integer?
Summary: Returns an xs:integer
representing the days component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:hours-from-duration
($arg
as
xdt:dayTimeDuration?
) as
xs:integer?
Summary: Returns an xs:integer
representing the hours component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:minutes-from-duration
($arg
as
xdt:dayTimeDuration?
) as
xs:integer?
Summary: Returns an xs:integer
representing the minutes component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:seconds-from-duration
($arg
as
xdt:dayTimeDuration?
) as
xs:decimal?
Summary: Returns an xs:decimal
representing the seconds component in the canonical lexical representation of the value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:year-from-dateTime
($arg
as
xs:dateTime?
) as
xs:integer?
Summary: Returns an xs:integer
representing the year component in the localized value of $arg
. The result may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:year-from-dateTime(xs:dateTime("1999-05-31T13:20:00-05:00"))
returns 1999
.
fn:year-from-dateTime(xs:dateTime("1999-05-31T21:30:00-05:00"))
returns 1999
.
fn:year-from-dateTime(xs:dateTime("1999-12-31T19:20:00"))
returns 1999
.
fn:year-from-dateTime(xs:dateTime("1999-12-31T24:00:00"))
returns 2000
.
fn:month-from-dateTime
($arg
as
xs:dateTime?
) as
xs:integer?
Summary: Returns an xs:integer
between 1 and 12, both inclusive, representing the month component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:month-from-dateTime(xs:dateTime("1999-05-31T13:20:00-05:00"))
returns 5
.
fn:month-from-dateTime(xs:dateTime("1999-12-31T19:20:00-05:00"))
returns 12
.
fn:month-from-dateTime(fn:adjust-dateTime-to-timezone(xs:dateTime("1999-12-31T19:20:00-05:00"), xdt:dayTimeDuration("PT0S")))
returns 1
.
fn:day-from-dateTime
($arg
as
xs:dateTime?
) as
xs:integer?
Summary: Returns an xs:integer
between 1 and 31, both inclusive, representing the day component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:day-from-dateTime(xs:dateTime("1999-05-31T13:20:00-05:00"))
returns 31
.
fn:day-from-dateTime(xs:dateTime("1999-12-31T20:00:00-05:00"))
returns 31
.
fn:day-from-dateTime(fn:adjust-dateTime-to-timezone(xs:dateTime("1999-12-31T19:20:00-05:00"), xdt:dayTimeDuration("PT0S")))
returns 1
.
fn:hours-from-dateTime
($arg
as
xs:dateTime?
) as
xs:integer?
Summary: Returns an xs:integer
between 0 and 23, both inclusive, representing the hours component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:hours-from-dateTime(xs:dateTime("1999-05-31T08:20:00-05:00"))
returns 8
.
fn:hours-from-dateTime(xs:dateTime("1999-12-31T21:20:00-05:00"))
returns 21
.
fn:hours-from-dateTime(fn:adjust-dateTime-to-timezone(xs:dateTime("1999-12-31T21:20:00-05:00"), xdt:dayTimeDuration("PT0S")))
returns 2
.
fn:hours-from-dateTime(xs:dateTime("1999-12-31T12:00:00"))
returns 12
.
fn:hours-from-dateTime(xs:dateTime("1999-12-31T24:00:00"))
returns 0
.
fn:minutes-from-dateTime
($arg
as
xs:dateTime?
) as
xs:integer?
Summary: Returns an xs:integer
value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:seconds-from-dateTime
($arg
as
xs:dateTime?
) as
xs:decimal?
Summary: Returns an xs:decimal
value greater than or equal to zero and less than 60, representing the seconds and fractional seconds in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:timezone-from-dateTime
($arg
as
xs:dateTime?
) as
xdt:dayTimeDuration?
Summary: Returns the timezone component of $arg
if any. If $arg
has a timezone component, then the result is an xdt:dayTimeDuration
that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
If $arg
is the empty sequence, returns the empty sequence.
fn:timezone-from-dateTime(xs:dateTime("1999-05-31T13:20:00-05:00"))
returns the xdt:dayTimeDuration
whose value is -PT5H
.
fn:timezone-from-dateTime(xs:dateTime("2000-06-12T13:20:00Z"))
returns the xdt:dayTimeDuration
whose value is PT0S
.
fn:timezone-from-dateTime(xs:dateTime("2004-08-27T00:00:00"))
returns ()
.
fn:year-from-date
($arg
as
xs:date?
) as
xs:integer?
Summary: Returns an xs:integer
representing the year in the localized value of $arg
. The value may be negative.
If $arg
is the empty sequence, returns the empty sequence.
fn:month-from-date
($arg
as
xs:date?
) as
xs:integer?
Summary: Returns an xs:integer
between 1 and 12, both inclusive, representing the month component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:day-from-date
($arg
as
xs:date?
) as
xs:integer?
Summary: Returns an xs:integer
between 1 and 31, both inclusive, representing the day component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:timezone-from-date
($arg
as
xs:date?
) as
xdt:dayTimeDuration?
Summary: Returns the timezone component of $arg
if any. If $arg
has a timezone component, then the result is an xdt:dayTimeDuration
that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
If $arg
is the empty sequence, returns the empty sequence.
fn:hours-from-time
($arg
as
xs:time?
) as
xs:integer?
Summary: Returns an xs:integer
between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
Assume that the dynamic context provides an implicit timezone value of -05:00
.
fn:hours-from-time(xs:time("11:23:00"))
returns 11
.
fn:hours-from-time(xs:time("21:23:00"))
returns 21
.
fn:hours-from-time(xs:time("01:23:00+05:00"))
returns 1
.
fn:hours-from-time(fn:adjust-time-to-timezone(xs:time("01:23:00+05:00"), xdt:dayTimeDuration("PT0S")))
returns 20
.
fn:hours-from-time(xs:time("24:00:00"))
returns 0
.
fn:minutes-from-time
($arg
as
xs:time?
) as
xs:integer?
Summary: Returns an xs:integer
value between 0 and 59, both inclusive, representing the value of the minutes component in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:seconds-from-time
($arg
as
xs:time?
) as
xs:decimal?
Summary: Returns an xs:decimal
value greater than or equal to zero and less than 60, representing the seconds and fractional seconds in the localized value of $arg
.
If $arg
is the empty sequence, returns the empty sequence.
fn:timezone-from-time
($arg
as
xs:time?
) as
xdt:dayTimeDuration?
Summary: Returns the timezone component of $arg
if any. If $arg
has a timezone component, then the result is an xdt:dayTimeDuration
that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
If $arg
is the empty sequence, returns the empty sequence.
Function | Meaning |
---|---|
op:add-yearMonthDurations |
Adds two xdt:yearMonthDuration s. Returns an xdt:yearMonthDuration . |
op:subtract-yearMonthDurations |
Subtracts one xdt:yearMonthDuration from another. Returns an xdt:yearMonthDuration . |
op:multiply-yearMonthDuration |
Multiplies a xdt:yearMonthDuration by an xs:double . Returns an xdt:yearMonthDuration . |
op:divide-yearMonthDuration |
Divides an xdt:yearMonthDuration by an xs:double . Returns an xdt:yearMonthDuration . |
op:divide-yearMonthDuration-by-yearMonthDuration |
Divides an xdt:yearMonthDuration by an xdt:yearMonthDuration . Returns an xs:decimal . |
op:add-dayTimeDurations |
Adds two xdt:dayTimeDurations . Returns an xdt:dayTimeDuration . |
op:subtract-dayTimeDurations |
Subtracts one xdt:dayTimeDuration from another. Returns an xdt:dayTimeDuration . |
op:multiply-dayTimeDuration |
Multiplies an xdt:dayTimeDuration by a xs:double . Returns an xdt:dayTimeDuration . |
op:divide-dayTimeDuration |
Divides an xdt:dayTimeDuration by an xs:double . Returns an xdt:dayTimeDuration . |
op:divide-dayTimeDuration-by-dayTimeDuration |
Divides an xdt:dayTimeDuration by an xdt:dayTimeDuration . Returns an xs:decimal . |
op:add-yearMonthDurations ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xdt:yearMonthDuration |
Summary: Returns the result of adding the value of $arg1
to the value of $arg2
. Backs up the "+" operator on xdt:yearMonthDuration
values.
op:subtract-yearMonthDurations ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xdt:yearMonthDuration |
Summary: Returns the result of subtracting the value of $arg2
from the value of $arg1
. Backs up the "-" operator on xdt:yearMonthDuration
values.
op:multiply-yearMonthDuration ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xs:double ) as xdt:yearMonthDuration |
Summary: Returns the result of multiplying the value of $arg1
by $arg2
. The result is rounded to the nearest month. For a value v, 0 <= v < 0.5 rounds to 0; 0.5 <= v < 1.0 rounds to 1.
If $arg2
is positive or negative zero, the result is a zero-length duration. If $arg2
is positive or negative infinity, the result overflows and is handled as discussed in 10.1.1 Limits and Precision. If $arg2
is NaN
an error is raised [err:FOCA0005]
Backs up the "*" operator on xdt:yearMonthDuration
values.
op:divide-yearMonthDuration ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xs:double ) as xdt:yearMonthDuration |
Summary: Returns the result of dividing the value of $arg1
by $arg2
. The result is rounded to the nearest month. For a value v, 0 <= v < 0.5 rounds to 0; 0.5 <= v < 1.0 rounds to 1.
If $arg2
is positive or negative infinity, the result is a zero-length duration. If $arg2
is positive or negative zero, the result overflows and is handled as discussed in 10.1.1 Limits and Precision. If $arg2
is NaN
an error is raised [err:FOCA0005]
Backs up the "div" operator on xdt:yearMonthDuration
and numeric values.
op:divide-yearMonthDuration-by-yearMonthDuration ( |
$arg1 |
as xdt:yearMonthDuration , |
$arg2 |
as xdt:yearMonthDuration ) as xs:decimal |
Summary: Returns the result of dividing the value of $arg1
by $arg2
. Since the values of both operands are integers, the semantics of the division is identical to op:numeric-divide
with xs:integer
operands.
Backs up the "div" operator on xdt:yearMonthDuration
values.
op:add-dayTimeDurations ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xdt:dayTimeDuration |
Summary: Returns the result of adding the value of $arg1
to the value of $arg2
. Backs up the "+" operator on xdt:dayTimeDuration
values.
op:subtract-dayTimeDurations ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xdt:dayTimeDuration |
Summary: Returns the result of subtracting the value of $arg2
from the value of $arg1
. Backs up the "-" operator on xdt:dayTimeDuration
values.
op:multiply-dayTimeDuration ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xs:double ) as xdt:dayTimeDuration |
Summary: Returns the result of multiplying the value of $arg1
by $arg2
.
If $arg2
is positive or negative zero, the result is a zero-length duration. If $arg2
is positive or negative infinity, the result overflows and is handled as discussed in 10.1.1 Limits and Precision. If $arg2
is NaN
an error is raised [err:FOCA0005]
Backs up the "*" operator on xdt:dayTimeDuration
values.
op:divide-dayTimeDuration ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xs:double ) as xdt:dayTimeDuration |
Summary: Returns the result of dividing the value of $arg1
by $arg2
.
If $arg2
is positive or negative infinity, the result is a zero-length duration. If $arg2
is positive or negative zero, the result overflows and is handled as discussed in 10.1.1 Limits and Precision. If $arg2
is NaN
an error is raised [err:FOCA0005]
Backs up the "div" operator on xdt:dayTimeDuration
values.
op:divide-dayTimeDuration-by-dayTimeDuration ( |
$arg1 |
as xdt:dayTimeDuration , |
$arg2 |
as xdt:dayTimeDuration ) as xs:decimal |
Summary: Returns the result of dividing the value of $arg1
by $arg2
. Since the values of both operands are decimals, the semantics of the division is identical to op:numeric-divide
with xs:decimal
operands.
Backs up the "div" operator on xdt:dayTimeDuration
values.
Function | Meaning |
---|---|
fn:adjust-dateTime-to-timezone |
Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all. |
fn:adjust-date-to-timezone |
Adjusts an xs:date value to a specific timezone, or to no timezone at all. |
fn:adjust-time-to-timezone |
Adjusts an xs:time value to a specific timezone, or to no timezone at all. |
These functions adjust the timezone component of an xs:dateTime
, xs:date
or xs:time
value. The $timezone
argument to these functions is defined as an xdt:dayTimeDuration
but must be a valid timezone value.
fn:adjust-dateTime-to-timezone
($arg
as
xs:dateTime?
) as
xs:dateTime?
fn:adjust-dateTime-to-timezone ( |
$arg |
as xs:dateTime? , |
$timezone |
as xdt:dayTimeDuration? ) as xs:dateTime? |
Summary: Adjusts an xs:dateTime
value to a specific timezone, or to no timezone at all. If $timezone
is the empty sequence, returns an xs:dateTime
without a timezone. Otherwise, returns an xs:dateTime
with a timezone.
If $timezone
is not specified, then $timezone
is the value of the implicit timezone in the dynamic context.
If $arg
is the empty sequence, then the result is the empty sequence.
A dynamic error is raised [err:FODT0003] if $timezone
is less than -PT14H
or greater than PT14H
or if does not contain an integral number of minutes.
If $arg
does not have a timezone component and $timezone
is the empty sequence, then the result is $arg
.
If $arg
does not have a timezone component and $timezone
is not the empty sequence, then the result is $arg
with $timezone
as the timezone component.
If $arg
has a timezone component and $timezone
is the empty sequence, then the result is the localized value of $arg
without its timezone component.
If $arg
has a timezone component and $timezone
is not the empty sequence, then the result is an xs:dateTime
value with a timezone component of $timezone
that is equal to $arg
.
Assume the dynamic context provides an implicit timezone of -05:00 (-PT5H0M)
.
let $tz := xdt:dayTimeDuration("-PT10H")
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00"))
returns 2002-03-07T10:00:00-05:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00-07:00"))
returns 2002-03-07T12:00:00-05:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00"), $tz)
returns 2002-03-07T10:00:00-10:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00-07:00"), $tz)
returns 2002-03-07T07:00:00-10:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00-07:00"), xdt:dayTimeDuration("PT10H"))
returns 2002-03-08T03:00:00+10:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T00:00:00+01:00"), xdt:dayTimeDuration("-PT8H"))
returns 2002-03-06T15:00:00-08:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00"), ())
returns 2002-03-07T10:00:00
fn:adjust-dateTime-to-timezone(xs:dateTime("2002-03-07T10:00:00-07:00"), ())
returns 2002-03-07T10:00:00
fn:adjust-date-to-timezone
($arg
as
xs:date?
) as
xs:date?
fn:adjust-date-to-timezone ( |
$arg |
as xs:date? , |
$timezone |
as xdt:dayTimeDuration? ) as xs:date? |
Summary: Adjusts an xs:date
value to a specific timezone, or to no timezone at all. If $timezone
is the empty sequence, returns an xs:date
without a timezone. Otherwise, returns an xs:date
with a timezone. For purposes of timezone adjustment, an xs:date
is treated as an xs:dateTime
with time 00:00:00
.
If $timezone
is not specified, then $timezone
is the value of the implicit timezone in the dynamic context.
If $arg
is the empty sequence, then the result is the empty sequence.
A dynamic error is raised [err:FODT0003] if $timezone
is less than -PT14H
or greater than PT14H
or if does not contain an integral number of minutes.
If $arg
does not have a timezone component and $timezone
is the empty sequence, then the result is the value of $arg
.
If $arg
does not have a timezone component and $timezone
is not the empty sequence, then the result is $arg
with $timezone
as the timezone component.
If $arg
has a timezone component and $timezone
is the empty sequence, then the result is the localized value of $arg
without its timezone component.
If $arg
has a timezone component and $timezone
is not the empty sequence, then:
Let $srcdt
be an xs:dateTime
value, with 00:00:00
for the time component and date and timezone components that are the same as the date and timezone components of $arg
.
Let $r
be the result of evaluating fn:adjust-dateTime-to-timezone($srcdt, $timezone)
The result of this function will be a date value that has date and timezone components that are the same as the date and timezone components of $r
.
Assume the dynamic context provides an implicit timezone of -05:00 (-PT5H0M)
.
let $tz := xdt:dayTimeDuration("-PT10H")
fn:adjust-date-to-timezone(xs:date("2002-03-07"))
returns 2002-03-07-05:00.
fn:adjust-date-to-timezone(xs:date("2002-03-07-07:00"))
returns 2002-03-07-05:00
.$arg
is converted to the xs:dateTime "2002-03-07T00:00:00-07:00"
. This is adjusted to the implicit timezone, giving "2002-03-07T02:00:00-05:00".
fn:adjust-date-to-timezone(xs:date("2002-03-07"), $tz)
returns 2002-03-07-10:00
.
fn:adjust-date-to-timezone(xs:date("2002-03-07-07:00"), $tz)
returns 2002-03-06-10:00
. $arg
is converted to the xs:dateTime "2002-03-07T00:00:00-07:00"
. This is adjusted to the given timezone, giving "2002-03-06T21:00:00-10:00"
.
fn:adjust-date-to-timezone(xs:date("2002-03-07"), ())
returns 2002-03-07.
fn:adjust-date-to-timezone(xs:date("2002-03-07-07:00"), ())
returns 2002-03-07.
fn:adjust-time-to-timezone
($arg
as
xs:time?
) as
xs:time?
fn:adjust-time-to-timezone ( |
$arg |
as xs:time? , |
$timezone |
as xdt:dayTimeDuration? ) as xs:time? |
Summary: Adjusts an xs:time
value to a specific timezone, or to no timezone at all. If $timezone
is the empty sequence, returns an xs:time
without a timezone. Otherwise, returns an xs:time
with a timezone.
If $timezone
is not specified, then $timezone
is the value of the implicit timezone in the dynamic context.
If $arg
is the empty sequence, then the result is the empty sequence.
A dynamic error is raised [err:FODT0003] if $timezone
is less than -PT14H
or greater than PT14H
or if does not contain an integral number of minutes.
If $arg
does not have a timezone component and $timezone
is the empty sequence, then the result is $arg
.
If $arg
does not have a timezone component and $timezone
is not the empty sequence, then the result is $arg
with $timezone
as the timezone component.
If $arg
has a timezone component and $timezone
is the empty sequence, then the result is the localized value of $arg
without its timezone component.
If $arg
has a timezone component and $timezone
is not the empty sequence, then:
Let $srcdt
be an xs:dateTime
value, with an arbitrary date for the date component and time and timezone components that are the same as the time and timezone components of $arg
.
Let $r
be the result of evaluating
The result of this function will be a time value that has time and timezone components that are the same as the time and timezone components of $r
.
Assume the dynamic context provides an implicit timezone of -05:00 (-PT5H0M)
.
let $tz := xdt:dayTimeDuration("-PT10H")
fn:adjust-time-to-timezone(xs:time("10:00:00"))
returns 10:00:00-05:00
fn:adjust-time-to-timezone(xs:time("10:00:00-07:00"))
returns 12:00:00-05:00
fn:adjust-time-to-timezone(xs:time("10:00:00"), $tz)
returns 10:00:00-10:00
fn:adjust-time-to-timezone(xs:time("10:00:00-07:00"), $tz)
returns 07:00:00-10:00
fn:adjust-time-to-timezone(xs:time("10:00:00"), ())
returns 10:00:00
fn:adjust-time-to-timezone(xs:time("10:00:00-07:00"), ())
returns 10:00:00
fn:adjust-time-to-timezone(xs:time("10:00:00-07:00"), xdt:dayTimeDuration("PT10H"))
returns 03:00:00+10:00
These functions support adding or subtracting a duration value to or from an xs:dateTime
, an xs:date
or an xs:time
value. Appendix E of [XML Schema Part 2: Datatypes Second Edition] describes an algorithm for performing such operations.
Function | Meaning |
---|---|
op:subtract-dateTimes |
Returns the difference between two xs:dateTimes as an xdt:dayTimeDuration . |
op:subtract-dates |
Returns the difference between two xs:dateTimes as an xdt:dayTimeDuration . |
op:subtract-times |
Returns the difference between two xs:time s as an xdt:dayTimeDuration . |
op:add-yearMonthDuration-to-dateTime |
Returns the end of a time period by adding an xdt:yearMonthDuration to the xs:dateTime that starts the period. |
op:add-dayTimeDuration-to-dateTime |
Returns the end of a time period by adding an xdt:dayTimeDuration to the xs:dateTime that starts the period. |
op:subtract-yearMonthDuration-from-dateTime |
Returns the beginning of a time period by subtracting an xdt:yearMonthDuration from the xs:dateTime that ends the period. |
op:subtract-dayTimeDuration-from-dateTime |
Returns the beginning of a time period by subtracting an xdt:dayTimeDuration from the xs:dateTime that ends the period. |
op:add-yearMonthDuration-to-date |
Returns the end of a time period by adding an xdt:yearMonthDuration to the xs:date that starts the period. |
op:add-dayTimeDuration-to-date |
Returns the end of a time period by adding an xdt:dayTimeDuration to the xs:date that starts the period. |
op:subtract-yearMonthDuration-from-date |
Returns the beginning of a time period by subtracting an xdt:yearMonthDuration from the xs:date that ends the period. |
op:subtract-dayTimeDuration-from-date |
Returns the beginning of a time period by subtracting an xdt:dayTimeDuration from the xs:date that ends the period. |
op:add-dayTimeDuration-to-time |
Adds the value of the hours, minutes and seconds components of an xdt:dayTimeDuration to an xs:time value. |
op:subtract-dayTimeDuration-from-time |
Subtracts the value of the hours, minutes and seconds components of an xdt:dayTimeDuration to an xs:time value. |
op:subtract-dateTimes ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xs:dateTime ) as xdt:dayTimeDuration? |
Summary: Returns the xdt:dayTimeDuration
that corresponds to the difference between the normalized value of $arg1
and the normalized value of $arg2
. If either $arg1
or $arg2
do not contain an explicit timezone then, for the purpose of the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context
ComponentsXP.) is assumed to be present as part of the value.
If the normalized value of $arg1
precedes in time the normalized value of $arg2
, then the returned value is a negative duration.
Backs up the subtract, "-", operator on xs:dateTime
values.
op:subtract-dates
($arg1
as
xs:date
, $arg2
as
xs:date
) as
xdt:dayTimeDuration?
Summary: Returns the xdt:dayTimeDuration
that corresponds to the difference between the starting instant of $arg1
and the the starting instant of $arg2
. If either $arg1
or $arg2
do not contain an explicit timezone then, for the purpose of the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context
ComponentsXP.) is assumed to be present as part of the value.
The starting instant of an xs:date
is the xs:dateTime
at 00:00:00
on that date.
The result is the result of subtracting the two starting instants using op:subtract-dateTimes
.
If the starting instant of $arg1
precedes in time the starting instant of $arg2
, then the returned value is a negative duration.
Backs up the subtract, "-", operator on xs:date
values.
Assume that the dynamic context provides an implicit timezone value of Z
. op:subtract-dates(xs:date("2000-10-30"), xs:date("1999-11-28"))
returns an xdt:dayTimeDuration
value corresponding to 337 days. The normalized values of the two starting instants are {2000, 10, 30, 0, 0, 0, PT0S}
and {1999, 11, 28, 0, 0, 0, PT0S}
.
If the dynamic context provides an implicit timezone value of +05:00
, op:subtract-dates(xs:date("2000-10-30"), xs:date("1999-11-28Z"))
returns an xdt:dayTimeDuration
value corresponding to 336 days and 19 hours. The normalized values of the two starting instants are {2000, 10, 29, 19, 0, 0, PT0S}
and {1999, 11, 28, 0, 0, 0, PT0S}
.
op:subtract-dates(xs:date("2000-10-15-05:00"), xs:date("2000-10-10+02:00"))
returns an xdt:dayTimeDuration
value corresponding to lexical form "P5DT7H
".
op:subtract-times
($arg1
as
xs:time
, $arg2
as
xs:time
) as
xdt:dayTimeDuration
Summary: Returns the xdt:dayTimeDuration
that corresponds to the difference between the value of $arg1
converted to an xs:dateTime
using the date components from the reference xs:dateTime
and the value of $arg2
converted to an xs:dateTime
using the date components from the same reference xs:dateTime
. If either $arg1
or $arg2
do not contain an explicit timezone then, for the purpose of
the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context ComponentsXP.) is assumed to be present as part of the value.
The result is the result of subtracting the two xs:dateTime
s using op:subtract-dateTimes
.
If the value of $arg1
converted to an xs:dateTime
using the date components from the reference xs:dateTime
precedes in time the value of $arg2
converted to an xs:dateTime
using the date components from the same reference xs:dateTime
, then the returned value is a negative duration.
Backs up the subtract, "-", operator on xs:time
values.
Assume that the dynamic context provides an implicit timezone value of -05:00
. Assume, also, that the date components of the reference xs:dateTime
correspond to "1972-12-31"
.
op:subtract-times(xs:time("11:12:00Z"), xs:time("04:00:00"))
returns an xdt:dayTimeDuration
value corresponding to 2 hours and 12 minutes. This is obtained by subtracting from the xs:dateTime
value {1972, 12, 31, 11, 12, 0, PT0S}
the xs:dateTime
value {1972, 12, 31, 9, 0, 0, PT0S}
.
op:subtract-times(xs:time("11:00:00-05:00"), xs:time("21:30:00+05:30"))
returns a zero xdt:dayTimeDuration
value corresponding to the lexical representation "PT0S"
. The two xs:dateTime
values are {1972, 12, 31, 11, 0, 0, -PT5H}
and {1972, 12, 31, 21, 30, 0, PT5H30M}
. These normalize to {1972, 12, 31, 16, 0, 0, PT0S}
and {1972, 12, 31, 16, 0, 0, PT0S}
.
op:subtract-times(xs:time("17:00:00-06:00"), xs:time("08:00:00+09:00"))
returns an xdt:dayTimeDuration
value corresponding to one day or 24 hours. The two normalized xs:dateTime
values are {1972, 12, 31, 23, 0, 0, PT0S}
and {1972, 12, 30, 23, 0, 0, PT0S}
.
op:subtract-times(xs:time("24:00:00"), xs:time("23:59:59"))
returns an xdt:dayTimeDuration
value corresponding to "-PT23H59M59S"
. The two normalized xs:dateTime
values are {1972, 12, 31, 0, 0, 0, ()}
and {1972, 12, 31, 23, 59, 59.0, ()}
.
op:add-yearMonthDuration-to-dateTime ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xdt:yearMonthDuration ) as xs:dateTime |
Summary: Returns the xs:dateTime
computed by adding $arg2
to the value of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2
is negative, then the result xs:dateTime
precedes $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "+" operator on xs:dateTime
and xdt:yearMonthDuration
values.
op:add-dayTimeDuration-to-dateTime ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xdt:dayTimeDuration ) as xs:dateTime |
Summary: Returns the xs:dateTime
computed by adding $arg2
to the value of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2
is negative, then the result xs:dateTime
precedes $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "+" operator on xs:dateTime
and xdt:dayTimeDuration
values.
op:subtract-yearMonthDuration-from-dateTime ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xdt:yearMonthDuration ) as xs:dateTime |
Summary: Returns the xs:dateTime
computed by negating $arg2
and adding the result to the value of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2
is negative, then the xs:dateTime
returned follows $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "-" operator on xs:dateTime
and xdt:yearMonthDuration
values.
op:subtract-dayTimeDuration-from-dateTime ( |
$arg1 |
as xs:dateTime , |
$arg2 |
as xdt:dayTimeDuration ) as xs:dateTime |
Summary: Returns the xs:dateTime
computed by negating $arg2
and adding the result to the value of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2
is negative, then the xs:dateTime
returned follows $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "-" operator on xs:dateTime
and xdt:dayTimeDuration
values.
op:add-yearMonthDuration-to-date ( |
$arg1 |
as xs:date , |
$arg2 |
as xdt:yearMonthDuration ) as xs:date |
Summary: Returns the xs:date
computed by adding $arg2
to the starting instant of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime
. If $arg2
is negative, then the xs:date
returned precedes $arg1
.
The starting instant of an xs:date
is the xs:dateTime
at time 00:00:00
on that date.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "+" operator on xs:date
and xdt:yearMonthDuration
values.
op:add-dayTimeDuration-to-date ( |
$arg1 |
as xs:date , |
$arg2 |
as xdt:dayTimeDuration ) as xs:date |
Summary: Returns the xs:date
computed by adding $arg2
to the starting instant of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime
. If $arg2
is negative, then the xs:date
returned precedes $arg1
.
The starting instant of an xs:date
is the xs:dateTime
at time 00:00:00
on that date.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "+" operator on xs:date
and xdt:dayTimeDuration
values.
op:add-dayTimeDuration-to-date(xs:date("2004-10-30Z"), xdt:dayTimeDuration("P2DT2H30M0S"))
returns the xs:date
November 1, 2004. The starting instant of the first argument is the xs:dateTime
value {2004, 10, 30, 0, 0, 0, PT0S}
. Adding the second argument to this, gives the xs:dateTime
value {2004, 11, 1, 2, 30, 0, PT0S}
. The time components are then discarded.
op:subtract-yearMonthDuration-from-date ( |
$arg1 |
as xs:date , |
$arg2 |
as xdt:yearMonthDuration ) as xs:date |
Summary: Returns the xs:date
computed by negating $arg2
and adding the result to the starting instant of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime
. If $arg2
is positive, then the xs:date
returned precedes $arg1
.
The starting instant of an xs:date
is the xs:dateTime
at 00:00:00
on that date.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "-" operator on xs:date
and xdt:yearMonthDuration
values.
op:subtract-yearMonthDuration-from-date(xs:date("2000-10-30"), xdt:yearMonthDuration("P1Y2M"))
returns the xs:date
August 30, 1999.
op:subtract-yearMonthDuration-from-date(xs:date("2000-02-29Z"), xdt:yearMonthDuration("P1Y"))
returns the xs:date
February 28, 1999 in timezone Z
.
op:subtract-yearMonthDuration-from-date(xs:date("2000-10-31-05:00"), xdt:yearMonthDuration("P1Y1M"))
returns the xs:date
September 30, 1999 in timezone -05:00
.
op:subtract-dayTimeDuration-from-date ( |
$arg1 |
as xs:date , |
$arg2 |
as xdt:dayTimeDuration ) as xs:date |
Summary: Returns the xs:date
computed by negating $arg2
and adding the result to the starting instant of $arg1
using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime
. If $arg2
is positive, then the xs:date
returned precedes $arg1
.
The starting instant of an xs:date
is the xs:dateTime
at 00:00:00
on that date.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "-" operator on xs:date
and xdt:dayTimeDuration
values.
op:add-dayTimeDuration-to-time ( |
$arg1 |
as xs:time , |
$arg2 |
as xdt:dayTimeDuration ) as xs:time |
Summary: First, the days component in the canonical lexical representation of $arg2
is set to zero (0) and the value of the resulting xdt:dayTimeDuration
is calculated. Alternatively, the value of $arg2
modulus 86,400 is used as the second argument. This value is added to the value of $arg1
converted to an xs:dateTime
using a reference date such as 1972-12-31
and the time components of the result returned. Note that the
xs:time
returned may occur in a following or preceding day and may be less than $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "+" operator on xs:time
and xdt:dayTimeDuration
values.
op:add-dayTimeDuration-to-time(xs:time("11:12:00"), xdt:dayTimeDuration("P3DT1H15M"))
returns the xs:time
value corresponding to the lexical representation "12:27:00
".
op:add-dayTimeDuration-to-time(xs:time("23:12:00+03:00"), xdt:dayTimeDuration("P1DT3H15M"))
returns the xs:time
value corresponding to the lexical representation "02:27:00+03:00
", i.e. {0, 0, 0, 2, 27, 0, PT3H}
.
op:subtract-dayTimeDuration-from-time ( |
$arg1 |
as xs:time , |
$arg2 |
as xdt:dayTimeDuration ) as xs:time |
Summary: The result is calculated by first setting the day component in the canonical lexical representation of $arg2
to zero (0) and calculating the value of the resulting xdt:dayTimeDuration
. Alternatively, the value of $arg2
modulus 86,400 is used as the second argument. This value is subtracted from the value of $arg1
converted to an xs:dateTime
using a reference date such as 1972-12-31
and the time components of the
result are returned. Note that the xs:time
returned may occur in a preceding or following day and may be greater than $arg1
.
The result has the same timezone as $arg1
. If $arg1
has no timezone, the result has no timezone.
This functions backs up the "-" operator on xs:time
and xdt:dayTimeDuration
values.
op:subtract-dayTimeDuration-from-time(xs:time("11:12:00"), xdt:dayTimeDuration("P3DT1H15M"))
returns an xs:time
value corresponding to the lexical representation "09:57:00"
.
op:subtract-dayTimeDuration-from-time(xs:time("08:20:00-05:00"), xdt:dayTimeDuration("P23DT10H10M"))
returns the xs:time
value corresponding to the lexical representation "22:10:00-05:00"
i.e. {0, 0, 0, 22, 10, 0, -PT5H}
This section defines additional constructor functions for QName as defined in [XML Schema Part 2: Datatypes Second Edition]. Leading and trailing whitespace, if present, is stripped from string arguments before the result is constructed.
Function | Meaning | |
---|---|---|
fn:resolve-QName |
Returns an xs:QName with the lexical form given in the first argument. The prefix is resolved using the in-scope namespaces for a given element. |
|
fn:QName |
Returns an xs:QName with the namespace URI given in the first argument and the local name and prefix in the second argument. |
fn:resolve-QName
($qname
as
xs:string?
, $element
as
element()
) as
xs:QName?
Summary: Returns an xs:QName
value (that is, an expanded-QName) by taking an xs:string
that has the lexical form of an xs:QName
(a string in the form "prefix:local-name" or "local-name") and resolving it using the in-scope namespaces for a given element.
If $qname
does not have the correct lexical form for xs:QName
an error is raised [err:FOCA0002].
If $qname
is the empty sequence, returns the empty sequence.
More specifically, the function searches the namespace bindings of $element
for a binding whose name matches the prefix of $qname
, or the zero-length string if it has no prefix, and constructs an expanded-QName whose local name is taken from the supplied $qname
, and whose namespace URI is taken from the string value of the namespace binding.
If the $qname
has a prefix and if there is no namespace binding for $element
that matches this prefix, then an error is raised [err:FONS0004].
If the $qname
has no prefix, and there is no namespace binding for $element
corresponding to the default (unnamed) namespace, then the resulting expanded-QName has no namespace part.
The prefix (or absence of a prefix) in the supplied $qname
argument is retained in the returned expanded-QName, as discussed in Section 2.1 TerminologyDM.
Sometimes the requirement is to construct an xs:QName
without using the default namespace. This can be achieved by writing:
if (contains($qname, ":")) then fn:resolve-QName($qname, $element) else fn:QName("", $qname)
If the requirement is to construct an xs:QName
using the namespaces in the static context, then the xs:QName
constructor should be used.
Assume that the element bound to $element
has a single namespace binding bound to the prefix eg
.
fn:resolve-QName("hello", $element)
returns a QName with local name "hello" that is in no namespace.
fn:resolve-QName("eg:myFunc", $element)
returns an xs:QName
whose namespace URI is specified by the namespace binding corresponding to the prefix "eg" and whose local name is "myFunc".
fn:QName
($paramURI
as
xs:string?
, $paramQName
as
xs:string
) as
xs:QName
Summary: Returns an xs:QName
with the namespace URI given in $paramURI
. If $paramURI
is the zero-length string or the empty sequence, it represents "no namespace"; in this case, if the value of $paramQName
contains a colon (:
), an error is raised [err:FOCA0002]. The prefix (or absence of a prefix) in $paramQName
is retained in the returned xs:QName
value. The local
name in the result is taken from the local part of $paramQName
.
If $paramQName
does not have the correct lexical form for xs:QName
an error is raised [err:FOCA0002].
Note that unlike xs:QName
this function does not require a xs:string
literal as the argument.
fn:QName("http://www.example.com/example", "person")
returns an xs:QName
with namespace URI = "http://www.example.com/example", local name = "person" and prefix = "".
fn:QName("http://www.example.com/example", "ht:person")
returns an xs:QName
with namespace URI = "http://www.example.com/example", local name = "person" and prefix = "ht".
This section discusses functions on QNames as defined in [XML Schema Part 2: Datatypes Second Edition].
Function | Meaning |
---|---|
op:QName-equal |
Returns true if the local names and namespace URIs of the two arguments are equal. |
fn:prefix-from-QName |
Returns an xs:NCName representing the prefix of the xs:QName argument. |
fn:local-name-from-QName |
Returns an xs:NCName representing the local name of the xs:QName argument. |
fn:namespace-uri-from-QName |
Returns the namespace URI for the xs:QName argument. If the xs:QName is in no namespace, the zero-length string is returned. |
fn:namespace-uri-for-prefix |
Returns the namespace URI of one of the in-scope namespaces for the given element, identified by its namespace prefix. |
fn:in-scope-prefixes |
Returns the prefixes of the in-scope namespaces for the given element. |
op:QName-equal
($arg1
as
xs:QName
, $arg2
as
xs:QName
) as
xs:boolean
Summary: Returns true
if the namespace URIs of $arg1
and $arg2
are equal and the local names of $arg1
and $arg2
are identical based on the default collation. Otherwise, returns false
. Two namespace URIs are considered equal if they are either both absent or both present and identical based on the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
). The prefix parts of
$arg1
and $arg2
, if any, are ignored.
Backs up the "eq" and "ne" operators on values of type xs:QName
.
fn:prefix-from-QName
($arg
as
xs:QName?
) as
xs:NCName?
Summary: Returns an xs:NCName
representing the prefix of $arg
. The empty sequence is returned if $arg
is the empty sequence or if the value of $arg
contains no prefix.
fn:local-name-from-QName
($arg
as
xs:QName?
) as
xs:NCName?
Summary: Returns an xs:NCName
representing the local part of $arg
. If $arg
is the empty sequence, returns the empty sequence.
fn:namespace-uri-from-QName
($arg
as
xs:QName?
) as
xs:anyURI?
Summary: Returns the namespace URI for $arg
as an xs:string
. If $arg
is the empty sequence, the empty sequence is returned. If $arg
is in no namespace, the zero-length string is returned.
fn:namespace-uri-for-prefix ( |
$prefix |
as xs:string? , |
$element |
as element() ) as xs:anyURI? |
Summary: Returns the namespace URI of one of the in-scope namespaces for $element
, identified by its namespace prefix.
If $element
has an in-scope namespace whose namespace prefix is equal to $prefix
, it returns the namespace URI of that namespace. If $prefix
is the zero-length string or the empty sequence, it returns the namespace URI of the default (unnamed) namespace. Otherwise, it returns the empty sequence.
Prefixes are equal only if their Unicode code points match exactly.
fn:in-scope-prefixes
($element
as
element()
) as
xs:string*
Summary: Returns the prefixes of the in-scope namespaces for $element
. For namespaces that have a prefix, it returns the prefix as an xs:NCName
. For the default namespace, which has no prefix, it returns the zero-length string.
The following comparison operators on xs:base64Binary
and xs:hexBinary
values are defined. Comparisons take two operands of the same type; that is, both operands must be xs:base64Binary
or both operands may be xs:hexBinary
. Each returns a boolean value.
A value of type xs:hexBinary
can be compared with a value of type xs:base64Binary
by casting one value to the other type. See 17.1.7 Casting to xs:base64Binary and xs:hexBinary.
Function | Meaning |
---|---|
op:hexBinary-equal |
Returns true if the two arguments are equal. |
op:base64Binary-equal |
Returns true if the two arguments are equal. |
op:hexBinary-equal ( |
$value1 |
as xs:hexBinary , |
$value2 |
as xs:hexBinary ) as xs:boolean |
Summary: Returns true
if $value1
and $value2
are of the same length, measured in binary octets, and contain the same octets in the same order. Otherwise, returns false
.
This function backs up the "eq" and "ne" operators on xs:hexBinary
values.
op:base64Binary-equal ( |
$value1 |
as xs:base64Binary , |
$value2 |
as xs:base64Binary ) as xs:boolean |
Summary: Returns true
if $value1
and $value2
are of the same length, measured in binary octets, and contain the same octets in the same order. Otherwise, returns false
.
This function backs up the "eq" and "ne" operators on xs:base64Binary
values.
This section discusses functions that take NOTATION as arguments.
Function | Meaning |
---|---|
op:NOTATION-equal |
Returns true if the two arguments are equal. |
This section discusses functions and operators on nodes. Nodes are formally defined in Section 6 NodesDM.
Function | Meaning | |
---|---|---|
fn:name |
Returns the name of the context node or the specified node as an xs:string . |
|
fn:local-name |
Returns the local name of the context node or the specified node as an xs:NCName . |
|
fn:namespace-uri |
Returns the namespace URI as an xs:anyURI for the xs:QName of the argument node or the context node if the argument is omitted. This may be the URI corresponding to the zero-length string if the xs:QName is in no namespace. |
|
fn:number |
Returns the value of the context item after atomization or the specified argument converted to an xs:double . |
|
fn:lang |
Returns true or false , depending on whether the language of the given node or the context node, as defined using the xml:lang attribute, is the same as, or a sublanguage of, the language specified by the argument. |
|
op:is-same-node |
Returns true if the two arguments have the same identity. |
|
op:node-before |
Indicates whether one node appears before another node in document order. | |
op:node-after |
Indicates whether one node appears after another node in document order. | |
fn:root |
Returns the root of the tree to which the node argument belongs. |
For the illustrative examples below assume an XQuery or transformation operating on a PurchaseOrder document containing a number of line-item elements. Each line-item has child elements called description, price, quantity, etc. whose content is different for each line-item. Quantity has simple content of type xs:decimal
. Further assume that variables $item1
, $item2
, etc. are each bound to single line-item element nodes in the document in sequence and that the value
of the quantity child of the first line-item is 5.0
.
<PurchaseOrder> <line-item> <description> ... </description> <price> ... </price> <quantity>5.0</quantity> ... </line-item> <line-item> ... </line-item> ... </PurchaseOrder>
fn:name
() as
xs:string
fn:name
($arg
as
node()?
) as
xs:string
Summary: Returns the name of a node, as an xs:string
that is either the zero-length string, or has the lexical form of an xs:QName
.
If the argument is omitted, it defaults to the context node. If the context item is undefined an error is raised: [err:FONC0001]. If the context item is not a node an error is raised: [err:FOTY0011].
If the argument is supplied and is the empty sequence, the function returns the zero-length string.
If the target node has no name (that is, if it is a document node, a comment, a text node, or a namespace binding having no name), the function returns the zero-length string.
Otherwise, the value returned is fn:string(fn:node-name($arg))
.
fn:local-name
() as
xs:string
fn:local-name
($arg
as
node()?
) as
xs:string
Summary: Returns the local part of the name of $arg
as an xs:string
that will either be the zero-length string or will have the lexical form of an xs:NCName
.
If the argument is omitted, it defaults to the context node. If the context item is undefined an error is raised: [err:FONC0001]. If the context item is not a node an error is raised [err:FOTY0011].
If the argument is supplied and is the empty sequence, the function returns the zero-length string.
If the target node has no name (that is, if it is a document node, a comment, or a text node), the function returns the zero-length string.
Otherwise, the value returned will be the local part of the expanded-QName of the target node (as determined by the dm:node-name
accessor in Section 5.11 node-name AccessorDM. This will be an xs:string
whose lexical form is an xs:NCName
.
fn:namespace-uri
() as
xs:anyURI
fn:namespace-uri
($arg
as
node()?
) as
xs:anyURI
Summary: Returns the namespace URI of the xs:QName
of $arg
.
If the argument is omitted, it defaults to the context node. If the context item is undefined an error is raised: [err:FONC0001]. If the context item is not a node an error is raised [err:FOTY0011].
If $arg
is the empty sequence, the xs:anyURI
corresponding to the zero-length string is returned.
If $arg
is neither an element nor an attribute node, or if it is an element or attribute node whose expanded-QName (as determined by the dm:node-name
accessor in the Section 5.11 node-name AccessorDM) is in no namespace, then the function returns the xs:anyURI
corresponding to the zero-length string.
fn:number
() as
xs:double
fn:number
($arg
as
xdt:anyAtomicType?
) as
xs:double
Summary: Returns the value indicated by $arg
or, if $arg
is not specified, the context item after atomization, converted to an xs:double
. If $arg
is the empty sequence or if $arg
or the context item cannot be converted to an xs:double
, the xs:double
value NaN
is returned. If the context item is undefined an error is raised: [err:FONC0001].
Calling the zero-argument version of the function is defined to give the same result as calling the single-argument version with an argument of ".". That is, fn:number()
is equivalent to fn:number(.)
.
If $arg
is the empty sequence, NaN
is returned. Otherwise, $arg
, or the context item after atomization, is converted to an xs:double
following the rules of 17.1.3.2 Casting to xs:double. If the conversion to xs:double
fails, the xs:double
value NaN
is returned.
fn:lang
($testlang
as
xs:string?
) as
xs:boolean
fn:lang
($testlang
as
xs:string?
, $node
as
node()
) as
xs:boolean
Summary: This function tests whether the language of $node
, or the context node if the second argument is omitted, as specified by xml:lang
attributes is the same as, or is a sublanguage of, the language specified by $testlang
. The language of the argument node, or the context node if the second argument is omitted, is determined by the value of the xml:lang
attribute on the node, or, if the node has no such attribute, by the value of the
xml:lang
attribute on the nearest ancestor of the node that has an xml:lang
attribute. If there is no such ancestor, then the function returns false
If the second argument is omitted and the context item is undefined an error is raised: [err:FONC0001]. If the context item is not a node an error is raised [err:FOTY0011].
If $testlang
is the empty sequence it is interpreted as the zero-length string.
The relevant xml:lang
attribute is determined by the value of the XPath expression:
(ancestor-or-self::*/@xml:lang)[last()]
If this expression returns an empty sequence, the function returns false
.
Otherwise, the function returns true
if and only if the string-value of the relevant xml:lang
attribute is equal to $testlang
based on a caseless default match as specified in section 3.13 of [The Unicode Standard], or if the string-value of the relevant testlang
attribute contains a hyphen, "-" (The character "-" is HYPHEN-MINUS, #x002D) such that the part of the string-value preceding that hyphen is equal to
$testlang
, using caseless matching.
The expression fn:lang("en")
would return true
if the context node were any of the following four elements:
<para xml:lang="en"/>
<div xml:lang="en"><para>And now, and forever!</para></div>
<para xml:lang="EN"/>
<para xml:lang="en-us"/>
The expression fn:lang("fr")
would return false
if the context node were <para xml:lang="EN"/>
op:is-same-node
($parameter1
as
node()
, $parameter2
as
node()
) as
xs:boolean
Summary: If the node identified by the value of $parameter1
is the same node as the node identified by the value of $parameter2
(that is, the two nodes have the same identity), then the function returns true
; otherwise, the function returns false
. This function backs up the "is" operator on nodes.
op:node-before
($parameter1
as
node()
, $parameter2
as
node()
) as
xs:boolean
Summary: If the node identified by the value of $parameter1
occurs in document order before the node identified by the value of $parameter2
, this function returns true
; otherwise, it returns false
. The rules determining the order of nodes within a single document and in different documents can be found in Section 2.4 Document OrderDM. This function backs up the
"<<" operator.
op:node-after
($parameter1
as
node()
, $parameter2
as
node()
) as
xs:boolean
Summary: If the node identified by the value of $parameter1
occurs in document order after the node identified by the value of $parameter2
, this function returns true
; otherwise, it returns false
. The rules determining the order of nodes within a single document and in different documents can be found in Section 2.4 Document OrderDM. This function backs up the
">>" operator.
fn:root
() as
node()
fn:root
($arg
as
node()?
) as
node()?
Summary: Returns the root of the tree to which $arg
belongs. This will usually, but not necessarily, be a document node.
If $arg
is the empty sequence, the empty sequence is returned.
If $arg
is a document node, $arg
is returned.
If the function is called without an argument, the context item is used as the default argument. If the context item is undefined an error is raised: [err:FONC0001]. If the context item is not a node an error is raised: [err:FOTY0011].
These examples use some variables which could be defined in [XQuery 1.0: An XML Query Language] as:
let $i := <tool>wrench</tool> let $o := <order> {$i} <quantity>5</quantity> </order> let $odoc := document {$o} let $newi := $o/tool
Or they could be defined in [XSL Transformations (XSLT) Version 2.0] as:
<xsl:variable name="i" as="element()"> <tool>wrench</tool> </xsl:variable> <xsl:variable name="o" as="element()"> <order> <xsl:copy-of select="$i"/> <quantity>5</quantity> </order> </xsl:variable> <xsl:variable name="odoc"> <xsl:copy-of select="$o"/> </xsl:variable> <xsl:variable name="newi" select="$o/tool"/>
fn:root($i)
returns $i
fn:root($o/quantity)
returns $o
fn:root($odoc//quantity)
returns $odoc
fn:root($newi)
returns $o
Note:
The final three examples could be made type-safe by wrapping their operands with fn:exactly-one().
A sequence
is an ordered collection of zero or more items
. An item
is either a node or an atomic value. The terms sequence
and item
are defined formally in [XQuery 1.0: An XML Query Language] and [XML Path Language (XPath) 2.0].
The following functions are defined on sequences.
Function | Meaning |
---|---|
fn:boolean |
Computes the effective boolean value of the argument sequence. |
op:concatenate |
Concatenates two sequences. |
fn:index-of |
Returns a sequence of xs:integer s, each of which is the index of a member of the sequence specified as the first argument that is equal to the value of the second argument. If no members of the specified sequence are equal to the value of the second argument, the empty sequence is returned. |
fn:empty |
Indicates whether or not the provided sequence is empty. |
fn:exists |
Indicates whether or not the provided sequence is not empty. |
fn:distinct-values |
Returns a sequence in which all but one of a set of duplicate values, based on value equality, have been deleted. The order in which the distinct values are returned is ·implementation dependent·. |
fn:insert-before |
Inserts an item or sequence of items at a specified position in a sequence. |
fn:remove |
Removes an item from a specified position in a sequence. |
fn:reverse |
Reverses the order of items in a sequence. |
fn:subsequence |
Returns the subsequence of a given sequence, identified by location. |
fn:unordered |
Returns the items in the given sequence in a non-deterministic order. |
As in the previous section, for the illustrative examples below, assume an XQuery or transformation operating on a non-empty Purchase Order document containing a number of line-item elements. The variable $seq
is bound to the sequence of line-item nodes in document order. The variables $item1
, $item2
, etc. are bound to separate, individual line-item nodes in the sequence.
fn:boolean
($arg
as
item()*
) as
xs:boolean
Summary: Computes the effective boolean value of the sequence $arg
. See Section 2.4.3 Effective Boolean ValueXP
If $arg
is the empty sequence, fn:boolean
returns false
.
If $arg
is a sequence whose first item is a node, fn:boolean
returns true
.
If $arg
is a singleton value of type xs:boolean
or a derived from xs:boolean
, fn:boolean
returns $arg
.
If $arg
is a singleton value of type xs:string
or a type derived from xs:string
or xdt:untypedAtomic
, fn:boolean
returns false
if the operand value has zero length; otherwise it returns true
.
If $arg
is a singleton value of any numeric type or a type derived from a numeric type, 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 static semantics of this function are described in Section 7.2.4 The fn:boolean functionFS.
Note:
The result of this function is not necessarily the same as " $arg cast as xs:boolean
". For example, fn:boolean("false")
returns the value "true"
whereas "false
" cast as xs:boolean
returns false
.
let $x := ("a", "b", "c")
fn:boolean($x)
raises a type error [err:FORG0006].
fn:boolean($x[1])
returns true
.
fn:boolean($x[0])
returns false
.
op:concatenate
($seq1
as
item()*
, $seq2
as
item()*
) as
item()*
Summary: Returns a sequence consisting of the items in $seq1
followed by the items in $seq2
. This function backs up the infix operator ",". If either sequence is the empty sequence, the other operand is returned.
For detailed type semantics, see Section 4.3.1 Constructing SequencesFS
fn:index-of ( |
$seqParam |
as xdt:anyAtomicType* , |
$srchParam |
as xdt:anyAtomicType ) as xs:integer* |
fn:index-of ( |
$seqParam |
as xdt:anyAtomicType* , |
$srchParam |
as xdt:anyAtomicType , |
|
$collation |
as xs:string ) as xs:integer* |
Summary: Returns a sequence of positive integers giving the positions within the sequence $seqParam
of items that are equal to $srchParam
.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations. The collation is used when string comparison is required.
The items in the sequence $seqParam
are compared with $srchParam
under the rules for the eq
operator. Values that cannot be compared, i.e. the eq
operator is not defined for their types, are considered to be distinct. If an item compares equal, then the position of that item in the sequence $srchParam
is included in the result.
If the value of $seqParam
is the empty sequence, or if no item in $seqParam
matches $srchParam
, then the empty sequence is returned.
The first item in a sequence is at position 1, not position 0.
The result sequence is in ascending numeric order.
fn:index-of ((10, 20, 30, 40), 35)
returns ().
fn:index-of ((10, 20, 30, 30, 20, 10), 20)
returns (2, 5).
fn:index-of (("a", "sport", "and", "a", "pastime"), "a")
returns (1, 4).
If @a is an attribute of type xs:NMTOKENS
whose typed value is " red green blue
", then: fn:index-of (@a, "blue")
returns 3
.
This is because the function calling mechanism atomizes the attribute node to produce a sequence of three xs:NMTOKEN
s.
fn:empty
($arg
as
item()*
) as
xs:boolean
Summary: If the value of $arg
is the empty sequence, the function returns true
; otherwise, the function returns false
.
fn:exists
($arg
as
item()*
) as
xs:boolean
Summary: If the value of $arg
is not the empty sequence, the function returns true
; otherwise, the function returns false
.
fn:distinct-values
($arg
as
xdt:anyAtomicType*
) as
xdt:anyAtomicType*
fn:distinct-values ( |
$arg |
as xdt:anyAtomicType* , |
$collation |
as xs:string ) as xdt:anyAtomicType* |
Summary: Returns the sequence that results from removing from $arg
all but one of a set of values that are eq
to one other. Values that cannot be compared, i.e. the eq
operator is not defined for their types, are considered to be distinct. Values of type xdt:untypedAtomic
are compared as if they were of type xs:string
. The order in which the sequence of values is returned is ·implementation dependent·.
The static type of the result is a sequence of prime types as defined in Section 7.2.7 The fn:distinct-values functionFS.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations. The collation is used when string comparison is required.
If $arg
is the empty sequence, the empty sequence is returned.
For xs:float
and xs:double
values, positive zero is equal to negative zero and, although NaN
does not equal itself, if $arg
contains multiple NaN
values a single NaN
is returned.
If xs:dateTime
, xs:date
or xs:time
values do not have a timezone, they are considered to have the implicit timezone provided by the dynamic context for the purpose of comparison. Note that xs:dateTime
, xs:date
or xs:time
values can compare equal even if their timezones are different.
Which value of a set of values that compare equal is returned is ·implementation dependent·.
fn:distinct-values((1, 2.0, 3, 2))
might return (1, 3, 2.0)
.
The following query:
let $x as xdt:untypedAtomic* := (xdt:untypedAtomic("cherry"), xdt:untypedAtomic("bar"), xdt:untypedAtomic("bar")) return fn:distinct-values ($x)
xdt:untypedAtomic
.fn:insert-before ( |
$target |
as item()* , |
$position |
as xs:integer , |
|
$inserts |
as item()* ) as item()* |
Summary: Returns a new sequence constructed from the value of $target
with the value of $inserts
inserted at the position specified by the value of $position
. (The value of $target
is not affected by the sequence construction.)
If $target
is the empty sequence, $inserts
is returned. If $inserts
is the empty sequence, $target
is returned.
The value returned by the function consists of all items of $target
whose index is less than $position
, followed by all items of $inserts
, followed by the remaining elements of $target
, in that sequence.
If $position
is less than one (1), the first position, the effective value of $position
is one (1). If $position
is greater than the number of items in $target
, then the effective value of $position
is equal to the number of items in $target
plus 1.
For detailed semantics see, Section 7.2.15 The fn:insert-before functionFS.
let $x
:= ("a", "b", "c")
fn:insert-before($x, 0, "z")
returns ("z", "a", "b", "c")
fn:insert-before($x, 1, "z")
returns ("z", "a", "b", "c")
fn:insert-before($x, 2, "z")
returns ("a", "z", "b", "c")
fn:insert-before($x, 3, "z")
returns ("a", "b", "z", "c")
fn:insert-before($x, 4, "z")
returns ("a", "b", "c", "z")
fn:remove
($target
as
item()*
, $position
as
xs:integer
) as
item()*
Summary: Returns a new sequence constructed from the value of $target
with the item at the position specified by the value of $position
removed.
If $position
is less than 1 or greater than the number of items in $target
, $target
is returned. Otherwise, the value returned by the function consists of all items of $target
whose index is less than $position
, followed by all items of $target
whose index is greater than $position
. If $target
is the empty sequence, the empty sequence is returned.
For detailed type semantics, see Section 7.2.11 The fn:remove functionFS
fn:reverse
($arg
as
item()*
) as
item()*
Summary: Reverses the order of items in a sequence. If $arg
is the empty sequence, the empty sequence is returned.
For detailed type semantics, see Section 7.2.12 The fn:reverse functionFS
fn:subsequence
($sourceSeq
as
item()*
, $startingLoc
as
xs:double
) as
item()*
fn:subsequence ( |
$sourceSeq |
as item()* , |
$startingLoc |
as xs:double , |
|
$length |
as xs:double ) as item()* |
Summary: Returns the contiguous sequence of items in the value of $sourceSeq
beginning at the position indicated by the value of $startingLoc
and continuing for the number of items indicated by the value of $length
.
In the two-argument case, returns:
$sourceSeq[fn:round($startingLoc) le $p]
In the three-argument case, returns:
$sourceSeq[fn:round($startingLoc) le $p and $p lt fn:round($startingLoc) + fn:round($length)]
Notes:
If $sourceSeq
is the empty sequence, the empty sequence is returned.
If $startingLoc
is zero or negative, the subsequence includes items from the beginning of the $sourceSeq
.
If $length
is not specified, the subsequence includes items to the end of $sourceSeq
.
If $length
is greater than the number of items in the value of $sourceSeq
following $startingLoc
, the subsequence includes items to the end of $sourceSeq
.
The first item of a sequence is located at position 1, not position 0.
For detailed type semantics, see Section 7.2.13 The fn:subsequence functionFS.
The reason the function accepts arguments of type xs:double
is that many computations on untyped data return an xs:double
result; and the reason for the rounding rules is to compensate for any imprecision in these floating-point computations.
fn:unordered
($sourceSeq
as
item()*
) as
item()*
Summary: Returns the items of $sourceSeq
in an ·implementation dependent· order.
Note:
Query optimizers may be able to do a better job if the order of the output sequence is not specified. For example, when retrieving prices from a purchase order, if an index exists on prices, it may be more efficient to return the prices in index order rather than in document order.
The following functions test the cardinality of their sequence arguments.
Function | Meaning |
---|---|
fn:zero-or-one |
Returns the input sequence if it contains zero or one items. Raises an error otherwise. |
fn:one-or-more |
Returns the input sequence if it contains one or more items. Raises an error otherwise. |
fn:exactly-one |
Returns the input sequence if it contains exactly one item. Raises an error otherwise. |
The functions fn:zero-or-one
, fn:one-or-more
, and fn:exactly-one
defined in this section, check that the cardinality of a sequence is in the expected range. They are particularly useful with regard to static typing. For example, the XML Schema [XML Schema Part 1: Structures Second Edition] describing the output of a query may require a sequence
of length one-or-more in some position, but the static type system may not be able to infer this; inserting a call to fn:one-or-more
at the appropriate place will provide a suitable static type at query analysis time, and confirm that the length is correct with a dynamic check at query execution time.
fn:zero-or-one
($arg
as
item()*
) as
item()?
Summary: Returns $arg
if it contains zero or one items. Otherwise, raises an error [err:FORG0003].
For detailed type semantics, see Section 7.2.16 The fn:zero-or-one, fn:one-or-more, and fn:exactly-one functionsFS
fn:one-or-more
($arg
as
item()*
) as
item()+
Summary: Returns $arg
if it contains one or more items. Otherwise, raises an error [err:FORG0004].
For detailed type semantics, see Section 7.2.16 The fn:zero-or-one, fn:one-or-more, and fn:exactly-one functionsFS
fn:exactly-one
($arg
as
item()*
) as
item()
Summary: Returns $arg
if it contains exactly one item. Otherwise, raises an error [err:FORG0005].
For detailed type semantics, see Section 7.2.16 The fn:zero-or-one, fn:one-or-more, and fn:exactly-one functionsFS
Function | Meaning |
---|---|
fn:deep-equal |
Returns true if the two arguments have items that compare equal in corresponding positions. |
op:union |
Returns the union of the two sequence arguments, eliminating duplicates. |
op:intersect |
Returns the intersection of the two sequence arguments, eliminating duplicates. |
op:except |
Returns the difference of the two sequence arguments, eliminating duplicates. |
As in the previous sections, for the illustrative examples below, assume an XQuery or transformation operating on a Purchase Order document containing a number of line-item elements. The variables $item1
, $item2
, etc. are bound to individual line-item nodes in the sequence. We use sequences of these nodes in some of the examples below.
fn:deep-equal
($parameter1
as
item()*
, $parameter2
as
item()*
) as
xs:boolean
fn:deep-equal ( |
$parameter1 |
as item()* , |
$parameter2 |
as item()* , |
|
$collation |
as string ) as xs:boolean |
Summary: This function assesses whether two sequences are deep-equal to each other. To be deep-equal, they must contain items that are pairwise deep-equal; and for two items to be deep-equal, they must either be atomic values that compare equal, or nodes of the same kind, with the same name, whose children are deep-equal. This is defined in more detail below. The $collation
argument identifies a collation which is used at all levels of recursion when strings are compared (but not when names
are compared), according to the rules in 7.3.1 Collations.
If the two sequences are both empty, the function returns true
.
If the two sequences are of different lengths, the function returns false
.
If the two sequences are of the same length, the function returns true
if and only if every item in the sequence $parameter1
is deep-equal to the item at the same position in the sequence $parameter2
. The rules for deciding whether two items are deep-equal follow.
Call the two items $i1
and $i2
respectively.
If $i1
and $i2
are both atomic values, they are deep-equal if and only if ($i1 eq $i2)
is true
. Or if both values are NaN
. If the eq
operator is not defined for $i1
and $i2
, the function returns false
.
If one of the pair $i1
or $i2
is an atomic value and the other is a node, the function returns false
.
If $i1
and $i2
are both nodes, they are compared as described below:
If the two nodes are of different kinds, the result is false
.
If the two nodes are both document nodes then they are deep-equal if and only if the sequence $i1/(*|text())
is deep-equal to the sequence $i2/(*|text())
.
If the two nodes are both element nodes then they are deep-equal if and only if all of the following conditions are satisfied:
the two nodes have the same name, that is (node-name($i1) eq node-name($i2))
.
the two nodes are both annotated as having simple content or both nodes are annotated as having complex content.
the two nodes have the same number of attributes, and for every attribute $a1
in $i1/@*
there exists an attribute $a2
in $i2/@*
such that $a1
and $a2
are deep-equal.
One of the following conditions holds:
Both element nodes have a type annotation that is simple content, and the typed value of $i1
is deep-equal to the typed value of $i2
.
Both element nodes have a type annotation that is complex content with elementOnly content, and each child element of $i1
is deep-equal to the corresponding child element of $i2
.
Both element nodes have a type annotation that is complex content with mixed content, and the sequence $i1/(*|text())
is deep-equal to the sequence $i2/(*|text())
.
Both element nodes have a type annotation that is complex content with empty content.
If the two nodes are both attribute nodes then they are deep-equal if and only if both the following conditions are satisfied:
the two nodes have the same name, that is (node-name($i1) eq node-name($i2))
.
the typed value of $i1
is deep-equal to the typed value of $i2
.
If the two nodes are both processing instruction nodes or namespace bindings, then they are deep-equal if and only if both the following conditions are satisfied:
the two nodes have the same name, that is (node-name($i1) eq node-name($i2))
.
the string value of $i1
is equal to the string value of $i2
.
If the two nodes are both text nodes or comment nodes, then they are deep-equal if and only if their string-values are equal.
Notes:
The two nodes are not required to have the same type annotation, and they are not required to have the same in-scope namespaces. They may also differ in their parent, their base URI, and the values returned by the is-id
and is-idrefs
accessors (see Section 5.5 is-id AccessorDM and Section 5.6 is-idrefs
AccessorDM). The order of children is significant, but the order of attributes is insignificant.
The contents of comments and processing instructions are significant only if these nodes appear directly as items in the two sequences being compared. The content of a comment or processing instruction that appears as a descendant of an item in one of the sequences being compared does not affect the result. However, the presence of a comment or processing instruction, if it causes a text node to be split into two text nodes, may affect the result.
The result of fn:deep-equal(1, current-dateTime())
is false
; it does not raise an error.
let $at := <attendees> <name last='Parker' first='Peter'/> <name last='Barker' first='Bob'/> <name last='Parker' first='Peter'/> </attendees>
fn:deep-equal($at, $at/*)
returns false
.
fn:deep-equal($at/name[1], $at/name[2])
returns false
.
fn:deep-equal($at/name[1], $at/name[3])
returns true
.
fn:deep-equal($at/name[1], 'Peter Parker')
returns false
.
op:union
($parameter1
as
node()*
, $parameter2
as
node()*
) as
node()*
Summary: Constructs a sequence containing every node that occurs in the values of either $parameter1
or $parameter2
, eliminating duplicate nodes. Nodes are returned in document order. Two nodes are duplicates if they are op:is-same-node()
.
If either operand is the empty sequence, a sequence is returned containing the nodes in the other operand in document order after eliminating duplicates.
For detailed type semantics, see Section 7.2.14 The op:union, op:intersect, and op:except operatorsFS
This function backs up the "union" or "|" operator.
op:intersect
($parameter1
as
node()*
, $parameter2
as
node()*
) as
node()*
Summary: Constructs a sequence containing every node that occurs in the values of both $parameter1
and $parameter2
, eliminating duplicate nodes. Nodes are returned in document order.
If either operand is the empty sequence, the empty sequence is returned.
Two nodes are duplicates if they are op:is-same-node()
.
For detailed type semantics, see Section 7.2.14 The op:union, op:intersect, and op:except operatorsFS.
This function backs up the "intersect" operator.
op:except
($parameter1
as
node()*
, $parameter2
as
node()*
) as
node()*
Summary: Constructs a sequence containing every node that occurs in the value of $parameter1
, but not in the value of $parameter2
, eliminating duplicate nodes. Nodes are returned in document order.
If $parameter1
is the empty sequence, the empty sequence is returned. If $parameter2
is the empty sequence, a sequence is returned containing the nodes in $parameter1
in document order after eliminating duplicates.
Two nodes are duplicates if they are op:is-same-node()
.
For detailed type semantics, see Section 7.2.14 The op:union, op:intersect, and op:except operatorsFS.
This function backs up the "except" operator.
Aggregate functions take a sequence as argument and return a single value computed from values in the sequence. Except for fn:count
, the sequence must consist of values of a single type or one if its subtypes, or they must be numeric. xdt:untypedAtomic
values are permitted in the input sequence and handled by special conversion rules. The type of the items in the sequence must also support certain operations.
Function | Meaning |
---|---|
fn:count |
Returns the number of items in a sequence. |
fn:avg |
Returns the average of a sequence of values. |
fn:max |
Returns the maximum value from a sequence of comparable values. |
fn:min |
Returns the minimum value from a sequence of comparable values. |
fn:sum |
Returns the sum of a sequence of values. |
fn:count
($arg
as
item()*
) as
xs:integer
Summary: Returns the number of items in the value of $arg
.
Returns 0 if $arg
is the empty sequence.
fn:avg
($arg
as
xdt:anyAtomicType*
) as
xdt:anyAtomicType?
Summary: Returns the average of the values in the input sequence $arg
, that is, the sum of the values divided by the number of values.
If $arg
is the empty sequence, the empty sequence is returned.
If $arg
contains values of type xdt:untypedAtomic
they are cast to xs:double
.
Duration values must either all be xdt:yearMonthDuration
values or must all be xdt:dayTimeDuration
values. For numeric values, the numeric promotion rules defined in 6.2 Operators on Numeric Values are used to promote all values to a single common type. After these operations, $arg
must contain items of a single type, which must be one of the four numeric types, xdt:yearMonthDuration
or xdt:dayTimeDuration
or one if its subtypes.
If the above conditions are not met, then a type error is raised [err:FORG0006].
Otherwise, returns the average of the values computed as sum($arg) div count($arg)
.
For detailed type semantics, see Section 7.2.10 The fn:min, fn:max, fn:avg, and fn:sum functionsFS.
Assume $d1 = xdt:yearMonthDuration("P20Y")
and $d2 = xdt:yearMonthDuration("P10M")
and $seq3 = (3, 4, 5)
.
fn:avg($seq3)
returns 4.0
.
fn:avg(($d1, $d2))
returns a yearMonthDuration
with value 125
months.
fn:avg(($d1, $seq3))
raises a type error [err:FORG0006].
fn:avg(())
returns ()
.
fn:avg((xs:float('INF')), xs:float('-INF'))
returns NaN
.
fn:avg(($seq3, xs:float('NaN'))
returns NaN
.
fn:max
($arg
as
xdt:anyAtomicType*
) as
xdt:anyAtomicType?
fn:max
($arg
as
xdt:anyAtomicType*
, $collation
as
string
) as
xdt:anyAtomicType?
Summary: Selects an item from the input sequence $arg
whose value is greater than or equal to the value of every other item in the input sequence. If there are two or more such items, then the specific item whose value is returned is ·implementation dependent·.
The following rules are applied to the input sequence:
Values of type xdt:untypedAtomic
in $arg
are cast to xs:double
.
For numeric values, the numeric promotion rules defined in 6.2 Operators on Numeric Values are used to promote all values to a single common type.
The items in the resulting sequence may be reordered in an arbitrary order. The resulting sequence is referred to below as the converted sequence. This function returns an item from the converted sequence rather than the input sequence.
If the converted sequence is empty, the empty sequence is returned.
All items in $arg
must be numeric or derived from a single base type for which the ge
operator is defined. In addition, the values in the sequence must have a total order. If date/time values do not have a timezone, they are considered to have the implicit timezone provided by the dynamic context for purposes of comparison. Duration values must either all be xdt:yearMonthDuration
values or must all be xdt:dayTimeDuration
values.
If any of these conditions is not met, then a type error is raised [err:FORG0006].
If the converted sequence contains the value NaN
, the value NaN
is returned.
If the items in the value of $arg
are of type xs:string
or types derived by restriction from xs:string
, then the determination of the item with the largest value is made according to the collation that is used. If the type of the items in $arg
is not xs:string
and $collation
is specified, the collation is ignored.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations.
Otherwise, the result of the function is the result of the expression:
if (every $v in $c satisfies $c[1] ge $v) then $c[1] else fn:max(fn:subsequence($c, 2))
evaluated with $collation
as the default collation if specified, and with $c
as the converted sequence.
For detailed type semantics, see Section 7.2.10 The fn:min, fn:max, fn:avg, and fn:sum functionsFS.
Notes:
If the converted sequence contains exactly one value then that value is returned.
The default type when the fn:max
function is applied to xdt:untypedAtomic
values is xs:double
. This differs from the default type for operators such as gt
, and for sorting in XQuery and XSLT, which is xs:string
.
fn:max((3,4,5))
returns 5
.
fn:max((5, 5.0e0))
returns 5.0e0
.
fn:max((3,4,"Zero"))
raises a type error [err:FORG0006].
fn:max((fn:current-date(), xs:date("2001-01-01")))
typically returns the current date.
fn:max(("a", "b", "c"))
returns "c" under a typical default collation.
fn:min
($arg
as
xdt:anyAtomicType*
) as
xdt:anyAtomicType?
fn:min
($arg
as
xdt:anyAtomicType*
, $collation
as
string
) as
xdt:anyAtomicType?
Summary: selects an item from the input sequence $arg
whose value is less than or equal to the value of every other item in the input sequence. If there are two or more such items, then the specific item whose value is returned is ·implementation dependent·.
The following rules are applied to the input sequence:
Values of type xdt:untypedAtomic
in $arg
are cast to xs:double
.
For numeric values, the numeric promotion rules defined in 6.2 Operators on Numeric Values are used to promote all values to a single common type.
The items in the resulting sequence may be reordered in an arbitrary order. The resulting sequence is referred to below as the converted sequence. This function returns an item from the converted sequence rather than the input sequence.
If the converted sequence is empty, the empty sequence is returned.
All items in $arg
must be numeric or derived from a single base type for which the le
operator is defined. In addition, the values in the sequence must have a total order. If date/time values do not have a timezone, they are considered to have the implicit timezone provided by the dynamic context for the purpose of comparison. Duration values must either all be xdt:yearMonthDuration
values or must all be xdt:dayTimeDuration
values.
If any of these conditions is not met, a type error is raised [err:FORG0006].
If the converted sequence contains the value NaN
, the value NaN
is returned.
If the items in the value of $arg
are of type xs:string
or types derived by restriction from xs:string
, then the determination of the item with the smallest value is made according to the collation that is used. If the type of the items in $arg
is not xs:string
and $collation
is specified, the collation is ignored.
The collation used by the invocation of this function is determined according to the rules in 7.3.1 Collations.
Otherwise, the result of the function is the result of the expression:
if (every $v in $c satisfies $c[1] le $v) then $c[1] else fn:min(fn:subsequence($c, 2))
evaluated with $collation
as the default collation if specified, and with $c
as the converted sequence.
For detailed type semantics, see Section 7.2.10 The fn:min, fn:max, fn:avg, and fn:sum functionsFS.
Notes:
If the converted sequence contains exactly one value then that value is returned.
The default type when the fn:min
function is applied to xdt:untypedAtomic
values is xs:double
. This differs from the default type for operators such as lt
, and for sorting in XQuery and XSLT, which is xs:string
.
fn:min((3,4,5))
returns 3
.
fn:min((5, 5.0e0))
returns 5.0e0
.
fn:min((3,4,"Zero"))
raises a type error [err:FORG0006].
fn:min(xs:float(0.0E0), xs:float(-0.0E0)
can return either positive or negative zero. [XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero. The result is ·implementation dependent·.
fn:min((fn:current-date(), xs:date("2001-01-01")))
typically returns xs:date("2001-01-01")
.
fn:min(("a", "b", "c"))
returns "a" under a typical default collation.
fn:sum
($arg
as
xdt:anyAtomicType*
) as
xdt:anyAtomicType
fn:sum ( |
$arg |
as xdt:anyAtomicType* , |
$zero |
as xdt:anyAtomicType? ) as xdt:anyAtomicType? |
Summary: Returns a value obtained by adding together the values in $arg
. If $zero
is not specified, then the value returned for an empty sequence is the xs:integer
value 0. If $zero
is specified, then the value returned for an empty sequence is $zero.
.
Any values of type xdt:untypedAtomic
in $arg
are cast to xs:double
. The items in the resulting sequence may be reordered in an arbitrary order. The resulting sequence is referred to below as the converted sequence.
If the converted sequence is empty, then the single-argument form of the function returns the xs:integer
value 0
; the two-argument form returns the value of the argument $zero
.
If the converted sequence contains the value NaN
, NaN
is returned.
All items in $arg
must be numeric or derived from a single base type. In addition, the type must support addition. Duration values must either all be xdt:yearMonthDuration
values or must all be xdt:dayTimeDuration
values. For numeric values, the numeric promotion rules defined in 6.2 Operators on Numeric Values are used to promote all values to a single common type. The sum of a sequence of integers will therefore be an integer,
while the sum of a numeric sequence that includes at least one xs:double will be an xs:double.
If the above conditions are not met, a type error is raised [err:FORG0006].
Otherwise, the result of the function, using the second signature, is the result of the expression:
if (fn:count($c) eq 0) then $zero else if (fn:count($c) eq 1) then $c[1] else $c[1] + fn:sum(subsequence($c, 2))
where $c
is the converted sequence.
The result of the function, using the first signature, is the result of the expression: fn:sum($arg, 0)
.
For detailed type semantics, see Section 7.2.10 The fn:min, fn:max, fn:avg, and fn:sum functionsFS.
Notes:
The second argument allows an appropriate value to be defined to represent the sum of an empty sequence. For example, when summing a sequence of durations it would be appropriate to return a zero-length duration of the appropriate type. This argument is necessary because a system that does dynamic typing cannot distinguish "an empty sequence of integers", for example, from "an empty sequence of durations".
If the converted sequence contains exactly one value then that value is returned.
Assume:
$d1 = xdt:yearMonthDuration("P20Y") $d2 = xdt:yearMonthDuration("P10M") $seq1 = ($d1, $d2)</code> $seq3 = (3, 4, 5)</code>
fn:sum(($d1, $d2))
returns an xdt:yearMonthDuration
with a value of 250
months.
fn:sum($seq1[. < xdt:yearMonthDuration('P3M')], xdt:yearMonthDuration('P0M'))
returns an xdt:yearMonthDuration
with a value of 0
months.
fn:sum($seq3)
returns 12
.
fn:sum(())
returns 0
.
fn:sum((),())
returns ()
.
fn:sum((1 to 100)[.<0], 0)
returns 0
.
fn:sum(($d1, 9E1))
raises an error [err:FORG0006].
Function | Meaning |
---|---|
op:to |
Returns the sequence containing every xs:integer between the values of the operands. |
fn:id |
Returns the sequence of element nodes having an ID value matching the one or more of the supplied IDREF values. |
fn:idref |
Returns the sequence of element or attribute nodes with an IDREF value matching one or more of the supplied ID values. |
fn:doc |
Returns a document node retrieved using the specified URI. |
fn:doc-available |
Returns true if a document node can be retrieved using the specified URI. |
fn:collection |
Returns a sequence of nodes retrieved using the specified URI or the nodes in the default collection. |
op:to
($firstval
as
xs:integer
, $lastval
as
xs:integer
) as
xs:integer*
Summary: Returns the sequence containing every xs:integer
whose value is between the value of $firstval
(inclusive) and the value of $lastval
(inclusive), in monotonic order. If the value of the first operand is greater than the value of the second, the empty sequence is returned. If the values of the two operands are equal, a sequence containing a single xs:integer
equal to the value is returned.
This function backs up the "to" operator.
fn:id
($arg
as
xs:string*
) as
element()*
fn:id
($arg
as
xs:string*
, $node
as
node()
) as
element()*
Summary: Returns the sequence of element nodes that have an ID
value matching the value of one or more of the IDREF
values supplied in $arg
.
The function returns a sequence, in document order with duplicates eliminated, containing every element node E
that satisfies all the following conditions:
E
is in the target document. The target document is the document containing $node
, or the document containing the context node if the second argument is omitted. An error is raised [err:FODC0001] if $node
, or the context item if the second argument is omitted, is a node in a tree whose root is not a document node or if the second argument is omitted and there is no context item [err:FONC0001], or if the context item is not a node [err:FOTY0011].
E
has an ID
value equal to one of the candidate IDREF
values, where:
An element has an ID
value equal to V
if either or both of the following conditions are true:
The is-id
property (See Section 5.5 is-id AccessorDM.) of the element node is true, and the typed value of the element node is equal to V under the rules of the eq
operator using the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
).
The element has an attribute node whose is-id
property (See Section 5.5 is-id AccessorDM.) is true and whose typed value is equal to V
under the rules of the eq
operator using the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
).
Each xs:string
in $arg
is parsed as if it were of type IDREFS
, that is, each xs:string
in $arg
is treated as a space-separated sequence of tokens, each acting as an IDREF
. These tokens are then included in the list of candidate IDREF
s. If any of the tokens is not a lexically valid IDREF
(that is, if it is not lexically an xs:NCName
), it is ignored. Formally, The candidate
IDREF
values are the strings in the sequence given by the expression:
for $s in $arg return fn:tokenize(fn:normalize-space($s), ' ') [. castable as xs:IDREF]
If several elements have the same ID
value, then E
is the one that is first in document order.
Notes:
If the data model is constructed from an Infoset, an attribute will have the is-id
property if the corresponding attribute in the Infoset had an attribute type of ID
: typically this means the attribute was declared as an ID
in a DTD.
If the data model is constructed from a PSVI, an element or attribute will have the is-id
property if its schema-defined type is xs:ID
or a type derived by restriction from xs:ID
.
No error is raised in respect of a candidate IDREF
value that does not match the ID
of any element in the document. If no candidate IDREF
value matches the ID
value of any element, the function returns the empty sequence.
It is not necessary that the supplied argument should have type xs:IDREF
or xs:IDREFS
, or that it should be derived from a node with the is-idrefs
property.
An element may have more than one ID
value. This can occur with synthetic data models or with data models constructed from a PSVI where an the element and one of its attributes are both typed as xs:ID
.
If the source document is well-formed but not valid, it is possible for two or more elements to have the same ID
value. In this situation, the function will select the first such element.
It is also possible in a well-formed but invalid document to have an element or attribute that has the is-id property but whose value does not conform to the lexical rules for the xs:ID
type. Such a node will never be selected by this function.
fn:idref
($arg
as
xs:string*
) as
node()*
fn:idref
($arg
as
xs:string*
, $node
as
node()
) as
node()*
Summary: Returns the sequence of element or attribute nodes with an IDREF
value matching the value of one or more of the ID
values supplied in $arg
.
The function returns a sequence, in document order with duplicates eliminated, containing every element or attribute node $N
that satisfies all the following conditions:
$N
is in the target document. The target document is the document containing $node
, or the document containing the context node if the second argument is omitted. An error is raised [err:FODC0001] if $node
, or the context item if the second argument is omitted, is a node in a tree whose root is not a document node or if the second argument is omitted and there is no context item [err:FONC0001], or if the context item is not a node [err:FOTY0011].
$N
has an IDREF
value equal to one of the candidate ID
values, where:
A node $N
has an IDREF
value equal to V
if both of the following conditions are true:
The is-idrefs
property (See Section 5.6 is-idrefs AccessorDM.)of $N
is true
The sequence
fn:tokenize(fn:normalize-space($N), ' ')
V
under the rules of the eq
operator using the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
).Each xs:string
in $arg
is parsed as if it were of lexically of type xs:ID
. These xs:string
s are then included in the list of candidate xs:ID
s. If any of the strings in $arg
is not a lexically valid xs:ID
(that is, if it is not lexically an xs:NCName
), it is ignored. More formally, the candidate ID
values are the strings in the sequence
$arg[. castable as xs:NCName]
Notes:
An element or attribute typically acquires the is-idrefs
property by being validated against the schema type xs:IDREF
or xs:IDREFS
, or (for attributes only) by being described as of type IDREF
or IDREFS
in a DTD.
No error is raised in respect of a candidate ID
value that does not match the IDREF
value of any element or attribute in the document. If no candidate ID
value matches the IDREF
value of any element or attribute, the function returns the empty sequence.
It is possible for two or more nodes to have an IDREF
value that matches a given candidate ID
value. In this situation, the function will return all such nodes. However, each matching node will be returned at most once, regardless how many candidate ID
values it matches.
It is possible in a well-formed but invalid document to have a node whose is-idrefs
property is true but that does not conform to the lexical rules for the xs:IDREF
type. The effect of the above rules is that ill-formed candidate ID
values and ill-formed IDREF
values are ignored.
fn:doc
($uri
as
xs:string?
) as
document-node()?
Summary: Retrieves a document using an xs:anyURI
, which may include a fragment identifier, supplied as an xs:string
. If $uri
is not a valid xs:anyURI
, an error is raised [err:FODC0005]. If it is a relative URI Reference, it is resolved relative to the value of the base URI property from the static context. The resulting absolute URI Reference is promoted to an xs:string
. If the Available
documents discussed in Section 2.1.2 Dynamic ContextXP provides a mapping from this string to a document node, the function returns that document node. If the Available documents maps the string to an empty sequence, then the function returns an empty sequence. If the Available documents provides no mapping for the string, an error is raised [err:FODC0005].
If $uri
is the empty sequence, the result is an empty sequence.
This function is ·stable·. Two calls on this function return the same document node if the same URI Reference (after resolution to an absolute URI Reference) is supplied to both calls. Thus, the following expression (if it does not raise an error) will always be true:
doc("foo.xml") is doc("foo.xml")
For detailed type semantics, see Section 7.2.5 The fn:collection and fn:doc functionsFS.
Note:
If $uri
is read from a source document, it is generally appropriate to resolve it relative to the base URI property of the relevant node in the source document. This can be achieved by calling the fn:resolve-uri
function, and passing the resulting absolute URI as an argument to the fn:doc
function.
If two calls to this function supply different absolute URI References as arguments, the same document node may be returned if the implementation can determine that the two arguments refer to the same resource.
By defining the semantics of this function in terms of a string-to-document-node mapping in the dynamic context, the specification is acknowledging that the results of this function are outside the purview of the language specification itself, and depend entirely on the run-time environment in which the expression is evaluated. This run-time environment includes not only an unpredictable collection of resources ("the web"), but configurable machinery for locating resources and turning their contents into document nodes within the XPath data model. Both the set of resources that are reachable, and the mechanisms by which those resources are parsed and validated, are ·implementation dependent·.
One possible processing model for this function is as follows. The resource identified by the URI Reference is retrieved. If the resource cannot be retrieved, an error is raised [err:FODC0002]. The data resulting from the retrieval action is then parsed as an XML document and a tree is constructed in accordance with the [XQuery 1.0 and XPath 2.0 Data Model]. If the top-level media type is known and is "text", the content is parsed in the same way as if the media type were text/xml; otherwise, it is parsed in the same way as if the media type were application/xml. If the contents cannot be parsed successfully, an error is raised. Otherwise, the result of the function is the document node at the root of the resulting tree. This tree is then optionally validated against a schema.
Various aspects of this processing are ·implementation-defined·. Implementations may provide external configuration options that allow any aspect of the processing to be controlled by the user. In particular:
The set of URI schemes that the implementation recognizes is implementation-defined. Implementations may allow the mapping of URIs to resources to be configured by the user, using mechanisms such as catalogs or user-written URI handlers.
The handling of non-XML media types is implementation-defined. Implementations may allow instances of the data model to be constructed from non-XML resources, under user control.
It is ·implementation-defined· whether DTD validation and/or schema validation is applied to the source document.
Implementations may provide user-defined error handling options that allow processing to continue following an error in retrieving a resource, or in parsing and validating its content. When errors have been handled in this way, the function may return either an empty sequence, or a fallback document provided by the error handler.
fn:doc-available
($uri
as
xs:string?
) as
xs:boolean
Summary: If fn:doc($uri)
returns a document node, this function returns true
. If $uri
is not a valid xs:anyURI
, an error is raised [err:FODC0005]. Otherwise, this function returns false
.
If this function returns true
, then calling fn:doc($uri)
within the same ·execution scope· must return a document node.
fn:collection
() as
node()*
fn:collection
($arg
as
xs:string?
) as
node()*
Summary: This function takes an xs:string
as argument and returns a sequence of nodes obtained by interpreting $arg
as an xs:anyURI
and resolving it according to the mapping specified in Available collections described in Section C.2 Dynamic Context ComponentsXP. If Available collections provides a mapping from this string to a sequence of nodes,
the function returns that sequence. If Available collections maps the string to an empty sequence, then the function returns an empty sequence. If Available collections provides no mapping for the string, an error is raised [err:FODC0004]. If $arg
is not specified, the function returns the sequence of the nodes in the default collection in the dynamic context. See Section C.2 Dynamic Context ComponentsXP. If the value of the default collection is undefined an error is raised [err:FODC0002].
If the $arg
is a relative xs:anyURI
, it is resolved against the value of the base-URI property from the static context. If $arg
is not a valid xs:anyURI
, an error is raised [err:FODC0002].
If $arg
is the empty sequence, the function behaves as if it had been called without an argument. See above.
This function is ·stable·. For detailed type semantics, see Section 7.2.5 The fn:collection and fn:doc functionsFS.
Note:
This function provides a facility for users to work with a collection of documents which may be contained in a directory or rows of a Relational table or other implementation-specific construct. An implementation may also use external variables to identify external resources, but fn:collection()
provides functionality not provided by external variables. Specifying resources using URIs is useful because URIs are dynamic, can be parameterized, and do not rely on an external environment.
The following functions are defined to obtain information from the dynamic context.
Function | Meaning |
---|---|
fn:position |
Returns the position of the context item within the sequence of items currently being processed. |
fn:last |
Returns the number of items in the sequence of items currently being processed. |
fn:current-dateTime |
Returns the current xs:dateTime . |
fn:current-date |
Returns the current xs:date . |
fn:current-time |
Returns the current xs:time . |
fn:implicit-timezone |
Returns the value of the implicit timezone property from the dynamic context. |
fn:default-collation |
Returns the value of the default collation property from the static context. |
fn:static-base-uri |
Returns the value of the base-uri property from the static context. |
fn:position
() as
xs:integer
Summary: Returns the context position from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) If the context item is undefined, an error is raised [err:FONC0001].
fn:last
() as
xs:integer
Summary: Returns the context size from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) If the context item is undefined, an error is raised [err:FONC0001].
fn:current-dateTime
() as
xs:dateTime
Summary: Returns the current dateTime (with timezone) from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) This is an xs:dateTime
that is current at some time during the evaluation of a query or transformation in which fn:current-dateTime()
is executed. This function is ·stable·. The precise instant during the query or transformation represented by the value of fn:current-dateTime()
is ·implementation dependent·.
fn:current-date
() as
xs:date
Summary: Returns xs:date(fn:current-dateTime())
. This is an xs:date
(with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-date()
is executed. This function is ·stable·. The precise instant during the query or transformation represented by the value of fn:current-date()
is ·implementation dependent·.
fn:current-time
() as
xs:time
Summary: Returns xs:time(fn:current-dateTime())
. This is an xs:time
(with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-time()
is executed. This function is ·stable·. The precise instant during the query or transformation represented by the value of fn:current-time()
is ·implementation dependent·.
fn:implicit-timezone
() as
xdt:dayTimeDuration
Summary: Returns the value of the implicit timezone property from the dynamic context. Components of the dynamic context are discussed in Section C.2 Dynamic Context ComponentsXP.
fn:default-collation
() as
xs:string
Summary: Returns the value of the default collation property from the static context. Components of the static context are discussed in Section C.1 Static Context ComponentsXP.
Note:
The default collation property can never be undefined. If it is not explicitly defined, a system defined default can be invoked. If this is not provided, the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint
) is used.
fn:static-base-uri
() as
xs:anyURI?
Summary: Returns the value of the base-uri property from the static context. If the base-uri property is undefined, the empty sequence is returned. Components of the static context are discussed in Section C.1 Static Context ComponentsXP .
Constructor functions and cast expressions accept an expression and return a value of a given type. They both convert a source value, SV, of a source type, ST, to a target value, TV, of the given target type, TT, with identical semantics and different syntax. The name of a constructor function is the same as the name of the [XML Schema Part 2: Datatypes Second Edition] built-in type (see 5.1
Constructor Functions for XML Schema Built-in Types) or user-derived type (see 5.3 Constructor Functions for User-Defined Types) that is the target for the conversion, and the semantics are exactly the same as for a cast expression; for example," xs:date("2003-01-01")
" means exactly the same as " "2003-01-01"
cast as xs:date?
".
The cast expression takes a type name to indicate the target type of the conversion. See Section 3.10.2 CastXP. If the type name allows the empty sequence and the expression to be cast is the empty sequence, the empty sequence is returned. If the type name does not allow the empty sequence and the expression to be cast is the empty sequence, a type error is raised [err:FORG0006].
Where the argument to a cast is a literal, the result of the function may be evaluated statically; if an error is encountered during such evaluation, it may be reported as a static error.
This section defines casting between the 19 primitive types defined in [XML Schema Part 2: Datatypes Second Edition] as well as xdt:untypedAtomic
, xs:integer
and the two derived types of xs:duration
(xdt:yearMonthDuration
and xdt:dayTimeDuration
). These four types are not primitive types but they are treated as primitive types in this section. The type conversions that are supported are indicated in the table
below. In this table, there is a row for each primitive type with that type as the source of the conversion and there is a column for each primitive type as the target of the conversion. The intersections of rows and columns contain one of three characters: "Y" indicates that a conversion from values of the type to which the row applies to the type to which the column applies is supported; "N" indicates that there are no supported conversions from values of the type to which the row applies to the type to
which the column applies; and "M" indicates that a conversion from values of the type to which the row applies to the type to which the column applies may succeed for some values in the value space and fails for others.
[XML Schema Part 2: Datatypes Second Edition] defines xs:NOTATION
as an abstract type. Thus, casting to xs:NOTATION
from any other type including xs:NOTATION
is not permitted. However, casting from one subtype of xs:NOTATION
to another subtype of xs:NOTATION
is permitted.
Casting is not supported to or from xs:anySimpleType
. Thus, there is no row or column for this type in the table below. For any node that has not been validated or has been validated as xs:anySimpleType
, the typed value of the node is an atomic value of type xdt:untypedAtomic
. There are no atomic values with the type annotation xs:anySimpleType
at runtime.
Similarly, casting is not supported to or from xdt:anyAtomicType
. There are no atomic values with the type annotation xdt :anyAtomicType
at runtime, although this can be a statically inferred type.
An attempt to cast to any of the above three type raises a static error [err:XPST0080]XP
If casting is attempted from an ST to a TT for which casting is not supported, as defined in the table below, an error is raised [err:XPTY0004]XP.
In the following table, the columns and rows are identified by short codes that identify simple types as follows:
uA = xdt:untypedAtomic
aURI = xs:anyURI
b64 = xs:base64Binary
bool = xs:boolean
dat = xs:date
gDay = xs:gDay
dbl = xs:double
dec = xs:decimal
dT = xs:dateTime
dTD = xdt:dayTimeDuration
dur = xs:duration
flt = xs:float
hxB = xs:hexBinary
gMD = xs:gMonthDay
gMon = xs:gMonth
int = xs:integer
NOT = xs:NOTATION
QN = xs:QName
str = xs:string
tim = xs:time
gYM = xs:gYearMonth
yMD = xdt:yearMonthDuration
gYr = xs:gYear
In the following table, the notation "S\T" indicates that the source ("S") of the conversion is indicated in the column below the notation and that the target ("T") is indicated in the row to the right of the notation.
S\T | uA | str | flt | dbl | dec | int | dur | yMD | dTD | dT | tim | dat | gYM | gYr | gMD | gDay | gMon | bool | b64 | hxB | aURI | QN | NOT |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uA | Y | Y | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | N | N |
str | Y | Y | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M | M |
flt | Y | Y | Y | Y | M | M | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N |
dbl | Y | Y | Y | Y | M | M | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N |
dec | Y | Y | Y | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N |
int | Y | Y | Y | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N |
dur | Y | Y | N | N | N | N | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N |
yMD | Y | Y | N | N | N | N | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N |
dTD | Y | Y | N | N | N | N | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N |
dT | Y | Y | N | N | N | N | N | N | N | Y | Y | Y | Y | Y | Y | Y | Y | N | N | N | N | N | N |
tim | Y | Y | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N | N | N | N | N | N | N |
dat | Y | Y | N | N | N | N | N | N | N | Y | N | Y | Y | Y | Y | Y | Y | N | N | N | N | N | N |
gYM | Y | Y | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N | N | N | N | N |
gYr | Y | Y | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N | N | N | N |
gMD | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N | N | N |
gDay | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N | N |
gMon | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N | N |
bool | Y | Y | Y | Y | Y | Y | N | N | N | N | N | N | N | N | N | N | N | Y | N | N | N | N | N |
b64 | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | Y | N | N | N |
hxB | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | Y | N | N | N |
aURI | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | N | N |
QN | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Y | N |
NOT | Y | Y | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | M |
The following sub-sections define the semantics of casting from a primitive type to a primitive type. Semantics of casting to and from a derived type are defined in sections 17.2 Casting to derived types, 17.3 Casting from derived types to parent types, 17.4 Casting within a branch of the type hierarchy and 17.5 Casting across the type hierarchy.
When the supplied value is an instance of xs:string
or an instance of xdt:untypedAtomic
, it is treated as being a string value and mapped to a typed value of the target type as defined in [XML Schema Part 2: Datatypes Second Edition]. Whitespace normalization is applied as indicated by the whiteSpace facet for the datatype. The resulting whitespace-normalized string must be a valid lexical form for the datatype. The semantics of casting are identical
to XML Schema validation. For example, "13" cast as xs:unsignedInt
returns the xs:unsignedInt
typed value 13
. This could also be written xs:unsignedInt("13")
.
When casting from xs:string
or xdt:untypedAtomic
to a derived type where the derived type is restricted by a pattern facet, the lexical form is first checked against the pattern before further casting is attempted (See 17.2 Casting to derived types). If the lexical form does not conform to the pattern, error [err:FORG0001] is raised.
Consider a user-defined Schema whose target namespace is bound to the prefix mySchema
which defines a restriction of xs:boolean
called trueBool
which allows only the lexical forms "1
" and "0
". "true" cast as mySchema:trueBool
would fail with [err:FORG0001]. If the Schema also defines a datatype called height
as a restriction of xs:integer
with a maximum
value of 84
then "100" cast as mySchema:height
would also fail with [err:FORG0001].
Casting is permitted from xs:string
and xdt:untypedAtomic
to any primitive atomic type or any atomic type derived by restriction, except xs:QName
or xs:NOTATION
. Casting to xs:NOTATION
is not permitted because it is an abstract type.
Casting is permitted from xs:string
literals to xs:QName
and types derived from xs:NOTATION
. A static error is raised [err:XPST0083]XP if the argument to a cast for xs:QName
or a type derived from xs:QName
or xs:NOTATION
is not an xs:string
literal.
In casting to numerics, if the value is too large or too small to be accurately represented by the implementation, it is handled as an overflow or underflow as defined in 6.2 Operators on Numeric Values.
In casting to a date or time value, if the value is too large or too small to be represented by the implementation, error [err:FODT0001] is raised.
In casting to a duration value, if the value is too large or too small to be represented by the implementation, error [err:FODT0002] is raised.
For xs:anyURI
, the extent to which an implementation validates the lexical form of xs:anyURI
is ·implementation dependent·.
If the cast fails for any other reason, error [err:FORG0001] is raised.
Casting is permitted from any primitive type to the primitive types xs:string
and xdt:untypedAtomic
.
When a value of any simple type is cast as xs:string
, the derivation of the xs:string
value TV depends on the ST and on the SV, as follows.
If ST is xs:string
or a type derived from xs:string
, TV is SV.
If ST is xs:anyURI
, the type conversion is performed without escaping any characters.
If ST is xs:QName
, TV is fn:concat(fn:prefix-from-QName(
SV
), ":", fn:local-name-from-QName(
SV
))
.
If ST is a numeric type, the following rules apply:
If ST is xs:integer
, TV is the canonical lexical representation of SV as defined in [XML Schema Part 2: Datatypes Second Edition]. There is no decimal point.
If ST is xs:decimal
, then:
If SV is in the value space of xs:integer
, that is, if there are no significant digits after the decimal point, then the value is converted from an xs:decimal
to an xs:integer
and the resulting xs:integer
is converted to an xs:string
using the rule above.
Otherwise, the canonical lexical representation of SV is returned, as defined in [XML Schema Part 2: Datatypes Second Edition].
If ST is xs:float
or xs:double
, then:
If SV has an absolute value that is greater than or equal to 0.000001 (one millionth) and less than 1000000 (one million), then the value is converted to an xs:decimal
and the resulting xs:decimal
is converted to an xs:string
according to the rules above, as though using an implementation of xs:decimal
that imposes no limits on the totalDigits
or fractionDigits
facets.
If SV has the value positive or negative zero, TV is "0" or "-0" respectively.
Otherwise, the canonical lexical representation of SV value is returned. This is defined as follows: NaN has the canonical form "NaN". Infinity and negative infinity have the canonical forms "INF" and "-INF" respectively. Besides these special values, the general form of the canonical form for xs:float
and xs:double
is a mantissa, which is a xs:decimal
, followed by the letter "E", followed by an exponent which is an xs:integer
. Leading zeroes
and the preceding optional "+" sign are prohibited in the exponent. If the exponent is zero it must be indicated by "E0". For the mantissa, the preceding optional "+" sign is prohibited and the decimal point is required. Leading and trailing zeroes are prohibited subject to the following: number representations must be normalized such that there is a single digit which is non-zero to the left of the decimal point and at least a single digit to the right of the decimal point unless the value being
represented is zero. Beyond the one required digit after the decimal point in the mantissa, there must be as many, but only as many, additional digits as are needed to uniquely distinguish the value from all other values for the datatype after rounding the final digit.
Note:
The above wording has been accepted by the XML Schema Working Group for the canonical form of the xs:float
and xs:double
datatypes. When this wording appears in a publicly available document the paragraph above will be replaced by an appropriate reference.
If ST is xs:dateTime
, xs:date
or xs:time
, TV is the local value. The components of TV are individually cast to xs:string
using the functions described in [casting-to-datetimes] and the results are concatenated together. The year
component is cast to xs:string
using eg:convertYearToString
. The month
, day
, hour
and
minute
components are cast to xs:string
using eg:convertTo2CharString
. The second
component is cast to xs:string
using eg:convertSecondsToString
. The timezone component, if present, is cast to xs:string
using eg:convertTZtoString
.
Note that the hours component of the resulting string will never be "24"
. Midnight is always represented as "00:00:00"
.
If ST is xdt:yearMonthDuration
or xdt:dayTimeDuration
, TV is the canonical representation of SV as defined in 10.3.1 xdt:yearMonthDuration or 10.3.2 xdt:dayTimeDuration, respectively.
If ST is xs:duration
then let SYM be SV
cast as xdt:yearMonthDuration
, and let SDT be SV
cast as xdt:dayTimeDuration
; Now, let the next intermediate value, TYM, be SYM
cast as
TT
, and let TDT be SDT
cast as
TT
. If TYM is "P0M", then TV is
TDT. Otherwise, TYM and TDT are merged according to the following rules:
If TDT is "PT0S", then TV is TYM.
Otherwise, TV is the concatenation of all the characters in TYM and all the characters except the first "P" and the optional negative sign in TDT.
In all other cases, TV is the [XML Schema Part 2: Datatypes Second Edition] canonical representation of SV. For datatypes that do not have a canonical lexical representation defined an ·implementation dependent· canonical representation may be used.
To cast as xdt:untypedAtomic
the value is cast as xs:string
, as described above, and the type annotation changed to xdt:untypedAtomic
.
Note:
The string representations of numeric values are backwards compatible with XPath 1.0 except for the special values positive and negative infinity, negative zero and values outside the range 1.0e-6
to 1.0e+6
.
When a value of any simple type is cast as xs:float
, the xs:float
TV is derived from the ST and the SV as follows:
If ST is xs:float
, then TV is SV and the conversion is complete.
If ST is xs:double
, then TV is obtained as follows:
if SV is the xs:double
value INF
, -INF
, NaN
, positive zero, or negative zero, then TV is the xs:float
value INF
, -INF
, NaN
, positive zero, or negative zero respectively.
otherwise, SV can be expressed in the form m × 2^e
where the mantissa m
and exponent e
are signed xs:integer
s whose value range is defined in [XML Schema Part 2: Datatypes Second Edition], and the following rules apply:
if m
(the mantissa of SV) is outside the permitted range for the mantissa of an xs:float
value (-2^24+1 to +2^24-1)
, then it is divided by 2^N
where N
is the lowest positive xs:integer
that brings the result of the division within the permitted range, and the exponent e
is increased by N
. This is integer division (in effect, the binary value of the mantissa is truncated on the right). Let
M
be the mantissa and E
the exponent after this adjustment.
if E
exceeds 104
(the maximum exponent value in the value space of xs:float
) then TV is the xs:float
value INF
or -INF
depending on the sign of M
.
if E
is less than -149
(the minimum exponent value in the value space of xs:float
) then TV is the xs:float
value positive or negative zero depending on the sign of M
otherwise, TV is the xs:float
value M × 2^E
.
If ST is xs:decimal
, or xs:integer
, then TV is xs:float(
SV cast as xs:string)
and the conversion is complete.
If ST is xs:boolean
, SV is converted to 1.0E0
if SV is true
and to 0.0E0
if SV is false
and the conversion is complete.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Note:
Implementations ·may· return negative zero for "-0.0E0" cast as xs:float
. [XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero.
When a value of any simple type is cast as xs:double
, the xs:double
value TV is derived from the ST and the SV as follows:
If ST is xs:double
, then TV is SV and the conversion is complete.
If ST is xs:float
or a type derived from xs:float
, then TV is obtained as follows:
if SV is the xs:float
value INF
, -INF
, NaN
, positive zero, or negative zero, then TV is the xs:double
value INF
, -INF
, NaN
, positive zero, or negative zero respectively.
otherwise, SV can be expressed in the form m × 2^e
where the mantissa m
and exponent e
are signed xs:integer
values whose value range is defined in [XML Schema Part 2: Datatypes Second Edition], and TV is the xs:double
value m × 2^e
.
If ST is xs:decimal
or xs:integer
, then TV is xs:double(
SV cast as xs:string)
and the conversion is complete.
If ST is xs:boolean
, SV is converted to 1.0E0
if SV is true
and to 0.0E0
if SV is false
and the conversion is complete.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Note:
Implementations ·may· return negative zero for "-0.0E0" cast as xs:double
. [XML Schema Part 2: Datatypes Second Edition] does not distinguish between the values positive zero and negative zero.
When a value of any simple type is cast as xs:decimal
, the xs:decimal
value TV is derived from ST and SV as follows:
If ST is xs:decimal
, xs:integer
or a type derived from them, then TV is SV, converted to an xs:decimal
value if need be, and the conversion is complete.
If ST is xs:float
or xs:double
, then TV is the xs:decimal
value, within the set of xs:decimal
values that the implementation is capable of representing, that is numerically closest to SV. If two values are equally close, then the one that is closest to zero is chosen. If SV is too large to be accommodated as an xs:decimal
, (see [XML Schema Part 2: Datatypes Second Edition] for
·implementation-defined· limits on numeric values) an error is raised [err:FOCA0001]. If SV is one of the special xs:float
or xs:double
values NaN
, INF
, or -INF
, an error is raised [err:FOCA0002].
If ST is xs:boolean
, SV is converted to 1.0
if SV is 1
or true
and to 0.0
if SV is 0
or false
and the conversion is complete.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any simple type is cast as xs:integer
, the xs:integer
value TV is derived from ST and SV as follows:
If ST is xs:integer
, or a type derived from xs:integer
, then TV is SV, converted to an xs:integer
value if need be, and the conversion is complete.
If ST is xs:decimal
, xs:float
or xs:double
, then TV is SV with the fractional part discarded and the value converted to xs:integer
. Thus, casting 3.1456
returns 3
and -17.89
returns -17
. Casting 3.124E1
returns 31
. If SV is too large to be accommodated as an integer, (see [XML Schema Part 2: Datatypes Second
Edition] for ·implementation-defined· limits on numeric values) an error is raised [err:FOCA0003]. If SV is one of the special xs:float
or xs:double
values NaN
, INF
, or -INF
, an error is raised [err:FOCA0002].
If ST is xs:boolean
, SV is converted to 1
if SV is 1
or true
and to 0
if SV is 0
or false
and the conversion is complete.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of type xdt:untypedAtomic
, xs:string
, a type derived from xs:string
, xdt:yearMonthDuration
or xdt:dayTimeDuration
is cast as xs:duration
, xdt:yearMonthDuration
or xdt:dayTimeDuration
, TV is derived from ST and SV as follows:
If ST is the same as TT, then TV is SV.
If ST is xs:duration
, or a type derived from xs:duration
, but not xdt:dayTimeDuration
or a type derived from xdt:dayTimeDuration
, and TT is xdt:yearMonthDuration
, then TV is derived from SV by removing the day, hour, minute and second components from SV.
If ST is xs:duration
, or a type derived from duration
, but not xdt:yearMonthDuration
or a type derived from xdt:yearMonthDuration
, and TT is xdt:dayTimeDuration
, then TV is derived from SV by removing the year and month components from SV.
If ST is xdt:yearMonthDuration
or xdt:dayTimeDuration
, and TT is xs:duration
, then TV is derived from SV as discussed in 17.3 Casting from derived types to parent types.
If ST is xdt:yearMonthDuration
and TT is xdt:dayTimeDuration
, the cast is permitted and returns a xdt:dayTimeDuration
with value 0.0 seconds.
If ST is xdt:dayTimeDuration
and TT is xdt:yearMonthDuration
, the cast is permitted and returns a xdt:yearMonthDuration
with value 0 months.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Note that casting from xs:duration
to xdt:yearMonthDuration
or xdt:dayTimeDuration
loses information. To avoid this, users can cast the xs:duration
value to both an xdt:yearMonthDuration
and an xdt:dayTimeDuration
and work with both values.
In several situations, casting to date and time types requires the extraction of a component from SV or from the result of fn:current-dateTime
and converting it to an xs:string
. These conversions must follow certain rules. For example, converting an xs:integer
year value requires converting to an xs:string
with four or more characters, preceded by a minus sign if the value is negative.
This document defines four functions to perform these conversions. These functions are for illustrative purposes only and make no recommendations as to style or efficiency. References to these functions from the following text are not normative.
The arguments to these functions come from functions defined in this document. Thus, the functions below assume that they are correct and do no range checking on them.
declare function eg:convertYearToString($year as xs:integer) as xs:string { let $plusMinus := if ($year >= 0) then "" else "-" let $yearString := fn:abs($year) cast as xs:string let $length := fn:length($yearString) return if ($length = 1) then fn:concat($plusMinus, "000", $yearString) else if ($length = 2) then fn:concat($plusMinus, "00", $yearString) else if ($length = 3) then fn:concat($plusMinus, "0", $yearString) else fn:concat($plusMinus, $yearString) }
declare function eg:convertTo2CharString($value as xs:integer) as xs:string { let $string := $value cast as xs:string return if (fn:length($string) = 1) then fn:concat("0", $string) else $string }
declare function eg:convertSecondsToString($seconds as xs:decimal) as xs:string { let $string := $seconds cast as xs:string let $intLength := fn:length(($seconds cast as xs:integer) cast as xs:string) return if ($intLength = 1) then fn:concat("0", $string) else $string }
declare function eg:convertTZtoString($tz as xdt:dayTimeDuration?) as xs:string { if (empty($tz)) then "" else let $tzh := fn:hours-from-dayTimeDuration($tz) let $tzm := fn:minutes-from-dayTimeDuration($tz) let $plusMinus := if ($tzh >= 0) then "+" else "-" let $tzhString := eg:convertTo2CharString(fn:abs($tzh)) let $tzmString := eg:convertTo2CharString(fn:abs($tzm)) return fn:concat($plusMinus, $tzhString, ":", $tzmString) }
Conversion from primitive types to date and time types follows the rules below.
When a value of any primitive type is cast as xs:dateTime
, xs:time
, xs:date
, xs:gYearMonth
, xs:gYear
, xs:gMonthDay
, xs:gDay
, or xs:gMonth
,
let CYR be eg:convertYearToString( fn:year-from-dateTime( fn:current-dateTime() ))
,
let CMO be eg:convertTo2CharString( fn:month-from-dateTime( fn:current-dateTime() ))
,
let CDA be eg:convertTo2CharString( fn:day-from-dateTime( fn:current-dateTime() ))
.
When a value of any primitive type is cast as xs:dateTime
, the xs:dateTime
value TV is derived from ST and SV as follows:
If ST is xs:dateTime
, then TV is SV.
If ST is xs:date
, then let SYR be eg:convertYearToString( fn:year-from-date(
SV ))
, let SMO be eg:convertTo2CharString( fn:month-from-date(
SV ))
, let SDA be eg:convertTo2CharString( fn:day-from-date(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:dateTime(
fn:concat(
SYR , '-',
SMO , '-',
SDA , 'T00:00:00 '
, STZ ) )
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:time
, the xs:time
value TV is derived from ST and SV as follows:
If ST is xs:time
, then TV is SV.
If ST is xs:dateTime
, then TV is xs:time( fn:concat( eg:convertTo2CharString( fn:hours-from-dateTime(
SV )), ':', eg:convertTo2CharString( fn:minutes-from-dateTime(
SV )), ':', eg:convertSecondsToString( fn:seconds-from-dateTime(
SV )), eg:convertTZtoString( fn:timezone-from-dateTime(
SV )) ))
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:date
, the xs:date
value TV is derived from ST and SV as follows:
If ST is xs:date
, then TV is SV.
If ST is xs:dateTime
, then let SYR be eg:convertYearToString( fn:year-from-dateTime(
SV ))
, let SMO be eg:convertTo2CharString( fn:month-from-dateTime(
SV ))
, let SDA be eg:convertTo2CharString( fn:day-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString(fn:timezone-from-dateTime(
SV ))
; TV is
xs:date( fn:concat(
SYR , '-',
SMO , '-',
SDA, STZ ) )
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:gYearMonth
, the xs:gYearMonth
value TV is derived from ST and SV as follows:
If ST is xs:gYearMonth
, then TV is SV.
If ST is xs:dateTime
, then let SYR be eg:convertYearToString( fn:year-from-dateTime(
SV ))
, let SMO be eg:convertTo2CharString( fn:month-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-dateTime(
SV ))
; TV is xs:gYearMonth( fn:concat(
SYR , '-',
SMO, STZ )
)
.
If ST is xs:date
, then let SYR be eg:convertYearToString( fn:year-from-date(
SV ))
, let SMO be eg:convertTo2CharString( fn:month-from-date(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:gYearMonth( fn:concat(
SYR , '-',
SMO, STZ ) )
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:gYear
, the xs:gYear
value TV is derived from ST and SV as follows:
If ST is xs:gYear
, then TV is SV.
If ST is xs:dateTime
, let SYR be eg:convertYearToString( fn:year-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-dateTime(
SV ))
; TV is xs:gYear(fn:concat(
SYR, STZ ))
.
If ST is xs:date
, let SYR be eg:convertYearToString( fn:year-from-date(
SV ))
; and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:gYear(fn:concat(
SYR, STZ ))
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:gMonthDay
, the xs:gMonthDay
value TV is derived from ST and SV as follows:
If ST is xs:gMonthDay
, then TV is SV.
If ST is xs:dateTime
, then let SMO be eg:convertTo2CharString( fn:month-from-dateTime(
SV ))
, let SDA be eg:convertTo2CharString( fn:day-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-dateTime(
SV ))
; TV is xs:gYearMonth( fn:concat(
'--',
SMO '-',
SDA,
STZ ) )
.
If ST is xs:date
, then let SMO be eg:convertTo2CharString( fn:month-from-date(
SV ))
, let SDA be eg:convertTo2CharString( fn:day-from-date(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:gYearMonth( fn:concat(
'--',
SMO , '-',
SDA, STZ )
)
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:gDay
, the xs:gDay
value TV is derived from ST and SV as follows:
If ST is xs:gDay
, then TV is SV.
If ST is xs:dateTime
, then let SDA be eg:convertTo2CharString( fn:day-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-dateTime(
SV ))
; TV is xs:gDay( fn:concat( '---'
, SDA, STZ ))
.
If ST is xs:date
, then let SDA be eg:convertTo2CharString( fn:day-from-date(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:gDay( fn:concat( '---'
, SDA, STZ ))
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:gMonth
, the xs:gMonth
value TV is derived from ST and SV as follows:
If ST is xs:gMonth
, then TV is SV.
If ST is xs:dateTime
, then let SMO be eg:convertTo2CharString( fn:month-from-dateTime(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-dateTime(
SV ))
; TV is xs:gMonth( fn:concat( '--'
, SMO, STZ ))
.
If ST is xs:date
, then let SMO be eg:convertTo2CharString( fn:month-from-date(
SV ))
and let STZ be eg:convertTZtoString( fn:timezone-from-date(
SV ))
; TV is xs:gMonth( fn:concat( '--'
, SMO, STZ ))
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
When a value of any primitive type is cast as xs:boolean
, the xs:boolean
value TV is derived from ST and SV as follows:
If ST is xs:boolean
, then TV is SV.
If ST is xs:float
, xs:double
, xs:decimal
or xs:integer
and SV is 0
, +0
, -0
, 0.0
, 0.0E0
or NaN
, then TV is false
.
If ST is xs:float
, xs:double
, xs:decimal
or xs:integer
and SV is not one of the above values, then TV is true
.
If ST is xdt:untypedAtomic
or xs:string
, see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Values of type xs:base64Binary
can be cast as xs:hexBinary
and vice versa, since the two types have the same value space. Casting to xs:base64Binary
and xs:hexBinary
is also supported from the same type and from xdt:untypedAtomic
, xs:string
and subtypes of xs:string
using [XML Schema Part 2: Datatypes Second Edition] semantics.
Casting to xs:anyURI
is supported only from the same type, xdt:untypedAtomic
or xs:string
.
When a value of any primitive type is cast as xs:anyURI
, the xs:anyURI
value TV is derived from the ST and SV as follows:
If ST is xdt:untypedAtomic
or xs:string
see 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Casting a value to a derived type can be separated into four cases. Note that xdt:untypedAtomic
, xs:integer
and the two derived types of xs:duration
:xdt:yearMonthDuration
and xdt:dayTimeDuration
are treated as primitive types.
When SV is an instance of a type that is derived by restriction from TT. This is described in section 17.3 Casting from derived types to parent types.
When SV is an instance of a type derived by restriction from the same primitive type as TT. This is described in 17.4 Casting within a branch of the type hierarchy.
When the derived type is derived, directly or indirectly, from a different primitive type than the primitive type of ST. This is described in 17.5 Casting across the type hierarchy.
When SV is an instance of the TT, the cast always succeeds (Identity cast).
It is always possible to cast a value of any atomic type to an atomic type from which it is derived, directly or indirectly, by restriction. For example, it is possible to cast an xs:unsignedShort
to an xs:unsignedInt
, an xs:integer
, or an xs:decimal
. Since the value space of the original type is a subset of the value space of the target type, such a cast is always successful. The result will have the same value as the original, but will have a new
type annotation.
It is possible to cast an SV to a TT if the type of the SV and the TT type are both derived by restriction (directly or indirectly) from the same primitive type, provided that the supplied value conforms to the constraints implied by the facets of the target type. This includes the case where the target type is derived from the type of the supplied value, as well as the case where the type of the supplied value is derived from the target type. For example, an instance
of xs:byte
can be cast as xs:unsignedShort
, provided the value is not negative.
If the value does not conform to the facets defined for the target type, then an error is raised [err:FORG0001]. See [XML Schema Part 2: Datatypes Second Edition]. In the case of the pattern facet (which applies to the lexical space rather than the value space), the pattern is tested against the canonical lexical representation of the value, as defined for the source type (or the result of casting the value to an
xs:string
, in the case of types that have no canonical lexical representation defined for them).
Note that this will cause casts to fail if the pattern excludes the canonical lexical representation of the source type. For example, if the type my:distance
is defined as a restriction of xs:decimal
with a pattern that requires two digits after the decimal point, casting of an xs:integer
to my:distance
will always fail, because the canonical representation of an xs:integer
does not conform to this pattern.
In some cases, casting from a parent type to a derived type requires special rules. See 17.1.4 Casting to duration types for rules regarding casting to xdt:yearMonthDuration
and xdt:dayTimeDuration
. See 17.4.1 Casting to xs:ENTITY, below, for casting to xs:ENTITY
and types derived from it.
[XML Schema Part 2: Datatypes Second Edition] says that "The value space of ENTITY is the set of all strings that match the NCName production ... and have been declared as an unparsed entity in a document type definition." However, [XSL Transformations (XSLT) Version 2.0] and [XQuery 1.0: An XML Query Language] do not check that constructed values of type xs:ENTITY
match declared unparsed entities. Thus, this rule is
relaxed in this specification and, in casting to xs:ENTITY
and types derived from it, no check is made that the values correspond to declared unparsed entities.
When the ST and the TT are derived, directly or indirectly, from different primitive types, this is called casting across the type hierarchy. Casting across the type hierarchy is logically equivalent to three separate steps performed in order. Errors can occur in either of the latter two steps.
Cast the SV, up the hierarchy, to the primitive type of the source, as described in 17.3 Casting from derived types to parent types.
If SV is an instance of xs:string
or xdt:untypedAtomic
, check its value against the pattern facet of TT, and raise an error [err:FORG0001] if the check fails.
Cast the value to the primitive type of TT, as described in 17.1 Casting from primitive types to primitive types.
Cast the value down to the TT, as described in 17.4 Casting within a branch of the type hierarchy
Some of the more significant changes that appear in this version of the document with respect to the last call version http://www.w3.org/TR/2005/WD-xpath-functions-20050404/ are listed below. A complete list of comments against the last call version of the document can be found in the Bugzilla database for product "XPath/XQuery/XSLT" and component "Functions and Operators". A list of bugs that have been resolved or closed can be found at: resolved comments.
A reference has been added from the section entitled 10 Functions and Operators on Durations, Dates and Times to [Working With Timezones], a W3C Note prepared by the I18N WG that discusses problems, pitfalls and solutions for writing applications that work with date and time values with and without timezones.
The fn:escape-uri
function has been removed and replaced with 2 functions called fn:encode-for-uri
and fn:iri-to-uri
corresponding to the behaviour of fn:escape-uri
with the parameter escape-reserved
set to TRUE
and FALSE
respectively.
Values of type xs:duration
can now be compared for equality using the new function op:duration-equal
.
Values of type xs:duration
can now be cast to xs:string
.
The functions fn:subtract-dateTimes-yielding-dayTimeDuration
and fn:subtract-dates-yielding-dayTimeDuration
have been renamed fn:subtract-dateTimes
and fn:subtract-dates
, respectively.
The rules for functions returning positive zero or negative zero have been clarified. Since [XML Schema Part 2: Datatypes Second Edition] does not distinguish between these two values, functions that return positive zero or negative zero are free to return either value.
A new function fn:escape-html-uri
has been added to mimic the html 4.0 URI escaping behavior on attributes. The serialization specification escapes URIs in this manner and it was felt to be useful to make this functionality available as a function.
Casting from xs:string
and xdt:untypedAtomic
to derived types has been clarified. If the derived type is restricted by a pattern, the lexical form is first checked against the pattern. See 17.1.1 Casting from xs:string and xdt:untypedAtomic.
Section 17.1 Casting from primitive types to primitive types has been clarified to say that although casting is not permitted from xs:NOTATION
to xs:NOTATION
, since it is an abstract type, casting is permitted from one subtype of xs:NOTATION
to another. The entry in the table at the intersection of xs:NOTATION
and xs:NOTATION
has consequently been changed to "M".
This document now does support leap seconds. Wording has been changed in several places to reflect this decision.
We have been made aware of ongoing work to provide URI-based names for collations and collation algorithms and to create an IANA registry for such names. See member-only communication: http://lists.w3.org/Archives/Member/w3c-query-operators/2003Aug/0017.html. References to this work may also appear in future versions of this document.
The error text provided with these errors is non-normative.
Unidentified error.
This error is raised whenever an attempt is made to divide by zero.
This error is raised whenever numeric operations result in an overflow or underflow.
.
This appendix summarizes the relationship between certain functions defined in [XML Path Language (XPath) Version 1.0] and the corresponding functions defined in this document. The first column of the table provides the signature of functions defined in this document. The second column provides the signature of the corresponding function in [XML Path Language (XPath) Version 1.0]. The third column discusses the differences in the semantics of the corresponding functions. The functions appear in the order they appear in [XML Path Language (XPath) Version 1.0].
The evaluation of the arguments to the functions defined in this document depends on whether the XPath 1.0 compatibility mode is on or off. See [XML Path Language (XPath) 2.0]. If the mode is on, the following conversions are applied, in order, before the argument value is passed to the function:
If the expected type is a single item or an optional single item, (examples: xs:string, xs:string?, xdt:untypedAtomic, xdt:untypedAtomic?, node(), node()?, item(), item()?
), then the given value V
is effectively replaced by fn:subsequence(V, 1, 1)
.
If the expected type is xs:string
or xs:string?
, then the given value V
is effectively replaced by fn:string(V)
.
If the expected type is numeric or optional numeric, then the given value V
is effectively replaced by fn:number(V)
.
Otherwise, the given value is unchanged.
XQuery 1.0 and XPath 2.0 | XPath 1.0 | Notes | |||||||
---|---|---|---|---|---|---|---|---|---|
fn:last () as xs:integer |
last() => number |
Precision of numeric results may be different. | |||||||
fn:position () as xs:integer |
position() => number |
Precision of numeric results may be different. | |||||||
fn:count ($arg as item* ) as xs:integer |
count(node-set) => number |
Precision of numeric results may be different. | |||||||
fn:id ($arg as xs:string* ) as element()* |
id(object) => node-set |
XPath 2.0 behavior is different for boolean and numeric arguments. The recognition of a node as an id value is sensitive to the manner in which the datamodel is constructed. In XPath 1.0 the whole string is treated as a unit. In XPath 2.0 each string is treated as a list. | |||||||
fn:local-name () as xs:string |
local-name(node-set?) => string |
If compatibility mode is off, an error will occur if argument has more than one node. | |||||||
fn:local-name ($arg as node()? ) as xs:string |
|||||||||
fn:namespace-uri () as xs:string |
namespace-uri(node-set?) => string |
If compatibility mode is off, an error will occur if argument has more than one node. | |||||||
fn:namespace-uri ($arg as node? ) as xs:string |
|||||||||
fn:name ($arg as node()? ) as xs:string |
name(node-set?) => string |
If compatibility mode is off, an error will occur if argument has more than one node. The rules for determining the prefix are more precisely defined in [XML Path Language (XPath) 2.0]. Function is not "well-defined" for parentless attribute nodes. | |||||||
fn:string () as xs:string |
string(object) => string |
If compatibility mode is off, an error will occur if argument has more than one node. Representations of numeric values are XPath 1.0 compatible except for the special values positive and negative infinity, and for values outside the range 1.0e-6 to 1.0e+6. | |||||||
fn:string ($arg as item()? ) as xs:string |
|||||||||
fn:concat ($arg1 as xs:string? , $arg2 as xs:string? , ...) as xs:string |
concat(string, string, string*) => string |
If compatibility mode is off, an error will occur if argument has more than one node or if argument is a number or a boolean. If compatibility mode on, implicit conversion is performed. | |||||||
fn:starts-with ($arg1 as xs:string? , $arg2 as xs:string? ) as xs:boolean? |
starts-with(string, string) => boolean |
In 1.0, returns false if the first argument is an empty node-set. In 2.0, returns () . If compatibility mode is off, an error will occur if argument has more than one node or if argument is a number or a boolean. If compatibility mode is on, implicit conversion is performed. |
|||||||
|
|||||||||
fn:contains ($arg1 as xs:string? , $arg2 as xs:string? ) as xs:boolean? |
contains(string, string) => boolean |
In 1.0, returns false if the first argument is an empty node-set. In 2.0, returns () . If compatibility mode is off, an error will occur with more than one node and a non-string argument results in a type error. |
|||||||
|
|||||||||
fn:substring-before ($arg1 as xs:string? , $arg2 as xs:string? ) as xs:string? |
substring-before(string, string) => string |
In 1.0, returns "" if the first argument is an empty node-set. In 2.0, returns () . If compatibility mode is off, numbers and booleans will give errors. Multiple nodes and more than one value will also give error. |
|||||||
|
|||||||||
fn:substring-after ($arg1 as xs:string? , $arg2 as xs:string? ) as xs:string? |
substring-after(string, string) => string |
In 1.0, returns "" if the first argument is an empty node-set. In 2.0, returns () . If compatibility mode is off, numbers and booleans will give errors. Multiple nodes and more than one value will also give error. |
|||||||
|
|||||||||
|
substring(string, number, number?) => string |
In 1.0, returns "" if the first argument is an empty node-set. In 2.0, returns () . |
|||||||
|
|||||||||
fn:string-length ($arg as xs:string? ) as xs:integer? |
string-length(string?) => number |
If you apply fn:string-length(@a) == 0 ; In 1.0 returns true if @a does not exist. In 2.0 returns false. |
|||||||
fn:string-length () as xs:integer? |
|||||||||
fn:normalize-space ($arg as xs:string? ) as xs:string? |
normalize-space(string?) => string |
In 1.0, returns "" if the first argument is an empty node-set. In 2.0, returns () . If compatibility mode is off, numbers and booleans will give errors for first arg. Also, multiple nodes will give error. |
|||||||
fn:normalize-space () as xs:string? |
|||||||||
|
translate(string, string, string)=> string |
. | |||||||
fn:boolean ($arg as item()* ) as xs:boolean |
boolean(object) => boolean |
||||||||
fn:not ($arg as item()* ) as xs:boolean |
not(boolean) => boolean |
||||||||
fn:true () as xs:boolean |
true() => boolean |
||||||||
fn:false () as xs:boolean |
false() => boolean |
||||||||
fn:lang ($testlang as xs:string ) as xs:boolean |
lang(string) => boolean |
If compatibility mode is off, numbers and booleans will give errors. Also, multiple nodes will give error. If compatibility mode is on, implicit conversion is performed. | |||||||
fn:number () as xs:double |
number(object?) => number |
Error if argument has more than one node when not in compatibility node. | |||||||
fn:number ($arg as xdt:anyAtomicType? ) as xs:double |
|||||||||
fn:sum ($arg as xdt:anyAtomicType* ) as xdt:anyAtomicType |
sum(node-set) => number |
2.0 raises an error if sequence contains values that cannot be added together such as NMTOKENS and other subtypes of string. 1.0 returns NaN . |
|||||||
fn:floor ($arg as numeric? ) as numeric? |
floor(number)=> number |
In 2.0, if argument is () , the result is () . In 1.0, the result is NaN . If compatibility mode is off, an error will occur with more than one node. If compatibility mode is on, implicit conversion is performed. |
|||||||
fn:ceiling ($arg as numeric? ) as numeric? |
ceiling(number)=> number |
In 2.0, if argument is () , the result is () . In 1.0, the result is NaN . If compatibility mode is off, an error will occur with more than one node. If compatibility mode is on, implicit conversion is performed. |
|||||||
fn:round ($arg as numeric? ) as numeric? |
round(number)=> number |
In 2.0, if argument is () , the result is () . In 1.0, the result is NaN . If compatibility mode is off, an error will occur with more than one node. If compatibility mode is on, implicit conversion is performed. |
Certain functions that were proposed for inclusion in this function library have been excluded on the basis that it is straightforward for users to implement these functions themselves using XSLT 2.0 or XQuery 1.0.
This Appendix provides sample implementations of some of these functions.
To emphasize that these functions are examples of functions that vendors may write, their names carry the prefix 'eg'. Vendors are free to define such functions in any namespace. A group of vendors may also choose to create a collection of such useful functions and put them in a common namespace.
In some situations, users may want to provide default values for missing information that may be signaled by elements that are omitted, have no value or have the empty sequence as their value. For example, a missing middle initial may be indicated by omitting the element or a non-existent bonus signaled with an empty sequence. This section includes examples of functions that provide such defaults. These functions return xdt:anyAtomicType*
. Users may want to write functions that return more
specific types.
eg:if-empty ( |
$node |
as node()? , |
$value |
as xdt:anyAtomicType ) as xdt:anyAtomicType* |
If the first argument is the empty sequence or an element without simple or complex content, if-empty() returns the second argument; otherwise, it returns the content of the first argument.
XSLT implementation
<xsl:function name="eg:if-empty" as="xdt:anyAtomicType*"> <xsl:param name="node" as="node()?"/> <xsl:param name="value" as="xdt:anyAtomicType"/> <xsl:choose> <xsl:when test="$node and $node/child::node()"> <xsl:sequence select="fn:data($node)"/> </xsl:when> <xsl:otherwise> <xsl:sequence select="$value"/> </xsl:otherwise> </xsl:choose> </xsl:function>
XQuery implementation
declare function eg:if-empty ( $node as node()?, $value as xdt:anyAtomicType) as xdt:anyAtomicType* { if ($node and $node/child::node()) then fn:data($node) else $value }
eg:if-absent ( |
$node |
as node()? , |
$value |
as xdt:anyAtomicType ) as xdt:anyAtomicType* |
If the first argument is the empty sequence, if-absent() returns the second argument; otherwise, it returns the content of the first argument.
XSLT implementation
<xsl:function name="eg:if-absent"> <xsl:param name="node" as="node()?"/> <xsl:param name="value" as="xdt:anyAtomicType"/> <xsl:choose> <xsl:when test="$node"> <xsl:sequence select="fn:data($node)"/> </xsl:when> <xsl:otherwise> <xsl:sequence select="$value"/> </xsl:otherwise> </xsl:choose> </xsl:function>
XQuery implementation
declare function eg:if-absent ( $node as node()?, $value as xdt:anyAtomicType) as xdt:anyAtomicType* { if ($node) then fn:data($node) else $value }
eg:value-union ( |
$arg1 |
as xdt:anyAtomicType* , |
$arg2 |
as xdt:anyAtomicType* ) as xdt:anyAtomicType* |
This function returns a sequence containing all the distinct items in $arg1 and $arg2, in an undefined order.
XSLT implementation
xsl:function name="eg:value-union" as="xdt:anyAtomicType*"> <xsl:param name="arg1" as="xdt:anyAtomicType*"/> <xsl:param name="arg2" as="xdt:anyAtomicType*"/> <xsl:sequence select="fn:distinct-values(($arg1, $arg2))"/> </xsl:function>
XQuery implementation
declare function eg:value-union ( $arg1 as xdt:anyAtomicType*, $arg2 as xdt:anyAtomicType*) as xdt:anyAtomicType* { fn:distinct-values(($arg1, $arg2)) }
eg:value-intersect ( |
$arg1 |
as xdt:anyAtomicType* , |
$arg2 |
as xdt:anyAtomicType* ) as xdt:anyAtomicType* |
This function returns a sequence containing all the distinct items that appear in both $arg1 and $arg2, in an undefined order.
XSLT implementation>
<xsl:function name="eg:value-intersect" as="xdt:anyAtomicType*"> <xsl:param name="arg1" as="xdt:anyAtomicType*"/> <xsl:param name="arg2" as="xdt:anyAtomicType*"/> <xsl:sequence select="fn:distinct-values($arg1[.=$arg2])"/> </xsl:function>
XQuery implementation
declare function eg:value-intersect ( $arg1 as xdt:anyAtomicType*, $arg2 as xdt:anyAtomicType* ) as xdt:anyAtomicType* { fn:distinct-values($arg1[.=$arg2]) }
eg:value-except ( |
$arg1 |
as xdt:anyAtomicType* , |
$arg2 |
as xdt:anyAtomicType* ) as xdt:anyAtomicType* |
This function returns a sequence containing all the distinct items that appear in $arg1 but not in $arg2, in an undefined order.
XSLT implementation
<xsl:function name="eg:value-except" as="xdt:anyAtomicType*"> <xsl:param name="arg1" as="xdt:anyAtomicType*"/> <xsl:param name="arg2" as="xdt:anyAtomicType*"/> <xsl:sequence select="fn:distinct-values($arg1[not(.=$arg2)])"/> </xsl:function>
XQuery implementation
declare function eg:value-except ( $arg1 as xdt:anyAtomicType*, $arg2 as xdt:anyAtomicType*) as xdt:anyAtomicType* { fn:distinct-values($arg1[not(.=$arg2)]) }
eg:index-of-node
($seqParam
as
node()*
, $srchParam
as
node()
) as
xs:integer*
This function returns a sequence of positive integers giving the positions within the sequence $seqParam
of nodes that are identical to $srchParam
.
The nodes in the sequence $seqParam
are compared with $srchParam
under the rules for the is
operator. If a node compares identical, then the position of that node in the sequence $srchParam
is included in the result.
If the value of $seqParam
is the empty sequence, or if no node in $seqParam
matches $srchParam, then the empty sequence is returned.
The index is 1-based, not 0-based.
The result sequence is in ascending numeric order.
XSLT implementation
<xsl:function name="eg:index-of-node" as="xs:integer*"> <xsl:param name="sequence" as="node()*"/> <xsl:param name="srch" as="node()"/> <xsl:for-each select="$sequence"> <xsl:if test=". is $srch"> <xsl:sequence select="position()"/> </xsl:if> </xsl:for-each> </xsl:function>
XQuery implementation
declare function eg:index-of-node($sequence as node()*, $srch as node()) as xs:integer* { for $n at $i in $sequence where ($n is $srch) return $i }
eg:string-pad
($padString
as
xs:string?
, $padCount
as
xs:integer
) as
xs:string
Returns a xs:string
consisting of a given number of copies of an xs:string
argument concatenated together.
XSLT implementation
<xsl:function name="eg:string-pad" as="xs:string"> <xsl:param name="padString" as="xs:string?"/> <xsl:param name="padCount" as="xs:integer"/> <xsl:sequence select="fn:string-join((for $i in 1 to $padCount return $padString), '')"/> </xsl:function>
XQuery implementation
declare function eg:string-pad ( $padString as xs:string?, $padCount as xs:integer) as xs:string { fn:string-join((for $i in 1 to $padCount return $padString), "") }
This returns the zero-length string if $padString
is the empty sequence, which is consistent with the general principle that if an xs:string
argument is the empty sequence it is treated as if it were the zero-length string.
fn:eg:distinct-nodes-stable
($arg
as
node()*
) as
node()*
This function illustrates one possible implementation of a distinct-nodes function. It removes duplicate nodes by identity, preserving the first occurrence of each node.
XPath
$arg[empty(subsequence($arg, 1, position()-1) intersect .)]
XSLT implementation
<xsl:function name="eg:distinct-nodes-stable" as="node()*"> <xsl:param name="arg" as="node()*"/> <xsl:sequence select="$arg[empty(subsequence($arg, 1, position()-1) intersect .)]"/> </xsl:function>
XQuery implementation
declare function distinct-nodes-stable ($arg as node()*) as node()* { for $a at $apos in $arg let $before_a := fn:subsequence($arg, 1, $apos - 1) where every $ba in $before_a satisfies not($ba is $a) return $a }
The following schema defines the types in the xdt:
namespace identified by the namespace name http://www.w3.org/2005/xpath-datatypes
.
You can retrieve the normative schema for this namespace from http://www.w3.org/2005/xpath-datatypes.
<?xml version='1.0'?> <!-- This document provides an XML Schema for xdt:dayTimeDuration and xdt:yearMonthDuration. The other xdt: types are not described here because xdt:untyped and xdt:anyAtomicType are special types that cannot be properly defined using XML Schema itself and because xdt:untypedAtomic should not be used for validation, but only used for unvalidated elements and attributes. --> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.w3.org/2005/xpath-datatypes" xmlns:xdt="http://www.w3.org/2005/xpath-datatypes" elementFormDefault="qualified" blockDefault="#all" xml:lang="en"> <xs:simpleType name='dayTimeDuration'> <xs:annotation> <xs:documentation source="http://www.w3.org/TR/xpath-datamodel/#xdt-dayTimeDuration"/> </xs:annotation> <xs:restriction base='xs:duration'> <xs:pattern value="[^YM]*[DT].*"/> </xs:restriction> </xs:simpleType> <xs:simpleType name='yearMonthDuration'> <xs:annotation> <xs:documentation source="http://www.w3.org/TR/xpath-datamodel/#xdt-yearMonthDuration"/> </xs:annotation> <xs:restriction base='xs:duration'> <xs:pattern value="[^DT]*"/> </xs:restriction> </xs:simpleType> </xs:schema>
This appendix provides a summary of features defined in this specification whose effect is explicitly ·implementation-defined·. The conformance rules require vendors to provide documentation that explains how these choices have been exercised.
The destination of the trace output is ·implementation-defined·. See 4 The Trace Function.
For xs:integer
operations, implementations that support limited-precision integer operations ·must· either raise an error [err:FOAR0002] or provide an ·implementation-defined· mechanism that allows users
to choose between raising an error and returning a result that is modulo the largest representable integer value. See 6.2 Operators on Numeric Values.
For xs:decimal
values the number of digits of precision returned by the numeric operators is ·implementation-defined·. See 6.2 Operators on Numeric Values. See also 17.1.3.3 Casting to xs:decimal and 17.1.3.4 Casting to xs:integer
If the number of digits in the result of a numeric operation exceeds the number of digits that the implementation supports, the result is truncated or rounded in an ·implementation-defined· manner. See 6.2 Operators on Numeric Values. See also 17.1.3.3 Casting to xs:decimal and 17.1.3.4 Casting to xs:integer
It is ·implementation-defined· which version of Unicode is supported by the features defined in this specification, but it is recommended that the most recent version of Unicode be used. See 7.1 String Types.
For 7.4.6 fn:normalize-unicode, conforming implementations ·must· support normalization form "NFC" and ·may· support normalization forms "NFD", "NFKC", "NFKD", "FULLY-NORMALIZED". They ·may· also support other normalization forms with ·implementation-defined· semantics.
The ability to decompose strings into collation units suitable for substring matching is an ·implementation-defined· property of a collation. See 7.5 Functions Based on Substring Matching.
All minimally conforming processors ·must· support year values with a minimum of 4 digits (i.e., YYYY) and a minimum fractional second precision of 1 millisecond or three digits (i.e., s.sss). However, conforming processors ·may· set larger ·implementation-defined· limits on the maximum number of digits they support in these two situations. See 10.1.1 Limits and Precision.
Various aspects of the processing provided by 15.5.4 fn:doc are ·implementation-defined·. Implementations may provide external configuration options that allow any aspect of the processing to be controlled by the user.
fn:compare
($comparand1
as
xs:string?
, $comparand2
as
xs:string?
, $collation
as
xs:string
) as
xs:integer?
fn:substring
($sourceString
as
xs:string?
, $startingLoc
as
xs:double
, $length
as
xs:double
) as
xs:string
fn:replace
($input
as
xs:string?
, $pattern
as
xs:string
, $replacement
as
xs:string
, $flags
as
xs:string
) as
xs:string
op:yearMonthDuration-equal
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
op:yearMonthDuration-less-than
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
op:yearMonthDuration-greater-than
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
op:dayTimeDuration-less-than
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:boolean
op:dayTimeDuration-greater-than
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:boolean
op:add-yearMonthDurations
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xdt:yearMonthDuration
op:subtract-yearMonthDurations
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xdt:yearMonthDuration
op:multiply-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xs:double
) as
xdt:yearMonthDuration
op:divide-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xs:double
) as
xdt:yearMonthDuration
op:divide-yearMonthDuration-by-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:decimal
op:add-dayTimeDurations
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xdt:dayTimeDuration
op:subtract-dayTimeDurations
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xdt:dayTimeDuration
op:multiply-dayTimeDuration
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xs:double
) as
xdt:dayTimeDuration
op:divide-dayTimeDuration-by-dayTimeDuration
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:decimal
fn:adjust-dateTime-to-timezone
($arg
as
xs:dateTime?
, $timezone
as
xdt:dayTimeDuration?
) as
xs:dateTime?
op:add-yearMonthDuration-to-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:yearMonthDuration
) as
xs:dateTime
op:add-dayTimeDuration-to-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:dayTimeDuration
) as
xs:dateTime
op:subtract-yearMonthDuration-from-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:yearMonthDuration
) as
xs:dateTime
op:subtract-dayTimeDuration-from-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:dayTimeDuration
) as
xs:dateTime
op:subtract-yearMonthDuration-from-date
($arg1
as
xs:date
, $arg2
as
xdt:yearMonthDuration
) as
xs:date
fn:index-of
($seqParam
as
xdt:anyAtomicType*
, $srchParam
as
xdt:anyAtomicType
, $collation
as
xs:string
) as
xs:integer*
op:add-dayTimeDuration-to-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:dayTimeDuration
) as
xs:dateTime
(§10.8.5)op:add-dayTimeDuration-to-time
($arg1
as
xs:time
, $arg2
as
xdt:dayTimeDuration
) as
xs:time
(§10.8.12)op:add-dayTimeDurations
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xdt:dayTimeDuration
(§10.6.6)op:add-yearMonthDuration-to-date
($arg1
as
xs:date
, $arg2
as
xdt:yearMonthDuration
) as
xs:date
(§10.8.8)op:add-yearMonthDuration-to-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:yearMonthDuration
) as
xs:dateTime
(§10.8.4)op:add-yearMonthDurations
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xdt:yearMonthDuration
(§10.6.1)fn:adjust-date-to-timezone
($arg
as
xs:date?
, $timezone
as
xdt:dayTimeDuration?
) as
xs:date?
(§10.7.2)fn:adjust-dateTime-to-timezone
($arg
as
xs:dateTime?
, $timezone
as
xdt:dayTimeDuration?
) as
xs:dateTime?
(§10.7.1)fn:adjust-time-to-timezone
($arg
as
xs:time?
, $timezone
as
xdt:dayTimeDuration?
) as
xs:time?
(§10.7.3)op:base64Binary-equal
($value1
as
xs:base64Binary
, $value2
as
xs:base64Binary
) as
xs:boolean
(§12.1.2)fn:compare
($comparand1
as
xs:string?
, $comparand2
as
xs:string?
, $collation
as
xs:string
) as
xs:integer?
(§7.3.2)fn:contains
($arg1
as
xs:string?
, $arg2
as
xs:string?
, $collation
as
xs:string
) as
xs:boolean
(§7.5.1)op:dayTimeDuration-equal
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:boolean
(§10.4.4)op:dayTimeDuration-greater-than
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:boolean
(§10.4.6)op:dayTimeDuration-less-than
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:boolean
(§10.4.5)fn:deep-equal
($parameter1
as
item()*
, $parameter2
as
item()*
, $collation
as
string
) as
xs:boolean
(§15.3.1)fn:distinct-values
($arg
as
xdt:anyAtomicType*
, $collation
as
xs:string
) as
xdt:anyAtomicType*
(§15.1.6)op:divide-dayTimeDuration
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xs:double
) as
xdt:dayTimeDuration
(§10.6.9)op:divide-dayTimeDuration-by-dayTimeDuration
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xs:decimal
(§10.6.10)op:divide-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xs:double
) as
xdt:yearMonthDuration
(§10.6.4)op:divide-yearMonthDuration-by-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:decimal
(§10.6.5)fn:ends-with
($arg1
as
xs:string?
, $arg2
as
xs:string?
, $collation
as
xs:string
) as
xs:boolean
(§7.5.3)fn:index-of
($seqParam
as
xdt:anyAtomicType*
, $srchParam
as
xdt:anyAtomicType
) as
xs:integer*
(§15.1.3)fn:index-of
($seqParam
as
xdt:anyAtomicType*
, $srchParam
as
xdt:anyAtomicType
, $collation
as
xs:string
) as
xs:integer*
(§15.1.3)fn:insert-before
($target
as
item()*
, $position
as
xs:integer
, $inserts
as
item()*
) as
item()*
(§15.1.7)op:multiply-dayTimeDuration
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xs:double
) as
xdt:dayTimeDuration
(§10.6.8)op:multiply-yearMonthDuration
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xs:double
) as
xdt:yearMonthDuration
(§10.6.3)fn:replace
($input
as
xs:string?
, $pattern
as
xs:string
, $replacement
as
xs:string
) as
xs:string
(§7.6.3)fn:replace
($input
as
xs:string?
, $pattern
as
xs:string
, $replacement
as
xs:string
, $flags
as
xs:string
) as
xs:string
(§7.6.3)fn:starts-with
($arg1
as
xs:string?
, $arg2
as
xs:string?
, $collation
as
xs:string
) as
xs:boolean
(§7.5.2)fn:subsequence
($sourceSeq
as
item()*
, $startingLoc
as
xs:double
, $length
as
xs:double
) as
item()*
(§15.1.10)fn:substring
($sourceString
as
xs:string?
, $startingLoc
as
xs:double
, $length
as
xs:double
) as
xs:string
(§7.4.3)fn:substring-after
($arg1
as
xs:string?
, $arg2
as
xs:string?
, $collation
as
xs:string
) as
xs:string
(§7.5.5)fn:substring-before
($arg1
as
xs:string?
, $arg2
as
xs:string?
, $collation
as
xs:string
) as
xs:string
(§7.5.4)op:subtract-dayTimeDuration-from-date
($arg1
as
xs:date
, $arg2
as
xdt:dayTimeDuration
) as
xs:date
(§10.8.11)op:subtract-dayTimeDuration-from-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:dayTimeDuration
) as
xs:dateTime
(§10.8.7)op:subtract-dayTimeDuration-from-time
($arg1
as
xs:time
, $arg2
as
xdt:dayTimeDuration
) as
xs:time
(§10.8.13)op:subtract-dayTimeDurations
($arg1
as
xdt:dayTimeDuration
, $arg2
as
xdt:dayTimeDuration
) as
xdt:dayTimeDuration
(§10.6.7)op:subtract-yearMonthDuration-from-date
($arg1
as
xs:date
, $arg2
as
xdt:yearMonthDuration
) as
xs:date
(§10.8.10)op:subtract-yearMonthDuration-from-dateTime
($arg1
as
xs:dateTime
, $arg2
as
xdt:yearMonthDuration
) as
xs:dateTime
(§10.8.6)op:subtract-yearMonthDurations
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xdt:yearMonthDuration
(§10.6.2)fn:tokenize
($input
as
xs:string?
, $pattern
as
xs:string
, $flags
as
xs:string
) as
xs:string*
(§7.6.4)fn:translate
($arg
as
xs:string?
, $mapString
as
xs:string
, $transString
as
xs:string
) as
xs:string
(§7.4.9)op:yearMonthDuration-equal
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
(§10.4.1)op:yearMonthDuration-greater-than
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
(§10.4.3)op:yearMonthDuration-less-than
($arg1
as
xdt:yearMonthDuration
, $arg2
as
xdt:yearMonthDuration
) as
xs:boolean
(§10.4.2)