The presentation of this document has been augmented to identify changes from a previous version. Three kinds of changes are highlighted: new, added text, changed text, and deleted text.


W3C

XQuery 1.0 and XPath 2.0 Functions and Operators

W3C Working Draft 12 November 2003

This version:
Latest version:
http://www.w3.org/TR/xpath-functions/
Previous version:
Editors:
Ashok Malhotra (XML Query and XSL WGs), Microsoft <ashokma@microsoft.com>
Jim Melton (XML Query WG), Oracle Corp <jim.melton@acm.org>
Norman Walsh (XSL WG), Sun Microsystems <Norman.Walsh@Sun.COM>

Abstract

This document defines basic operators and functions on the datatypes defined in [XML Schema Part 2: Datatypes] and the datatypes defined in this document for use in [XPath 2.0],[XQuery 1.0: An XML Query Language]and [XSLT 2.0]and other related XML standards. It also discusses operators and functions on nodes and node sequences as defined in the [XQuery 1.0 and XPath 2.0 Data Model] for use in [XPath 2.0], [XQuery 1.0: An XML Query Language]and [XSLT 2.0]and other related XML standards.

Status of this Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of currentW3C publications and the latest revision of this technical report can be found in the W3C technical reports index athttp://www.w3.org/TR/.

This is a Last Call Working Draft. Comments on this document are due by 15 February, 2004. Comments should be sent to the W3C mailing list, public-qt-comments@w3.org (archived at http://lists.w3.org/Archives/Public/public-qt-comments/).

This is a Public Working Draft for review by W3C Members and other interested parties. Publication as a Working Draft does not imply endorsement bythe W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document describes constructor functions, operators and functions that are used in [XPath 2.0], [XQuery 1.0: An XML Query Language] and [XSLT 2.0] and possibly other W3C specifications.

A number of changes havebeen made to this document as aresult of"Last Call" comments on the previous version of the document. Feedbackis solicited on these changes. The more significant of these changes are listed below.

A proposal related tothe two totally ordered subtypesof xs:duration, xdt:yearMonthDuration and xs:dayTimeDuration has been received.See http://lists.w3.org/Archives/Public/public-qt-comments/2003Sep/0114.html.

This proposal argues that since the value space for these datatypes is integermonths and decimal seconds respectively, these datatypes shouldberemovedand functions that work with thesedatatypes should be removed and replaced by functions on numeric types. Analternative is to retain the datatypes but remove the functions and provide casting facilities for these datatypes to and from numbers.

This is a far-reaching proposal and the Working Groups felt that its consideration should be postponed until after this document was published. This note is to alert readersthat such a change may appear in future versionsof thisdocument.

We have also 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. Referencesto thiswork may also appear in futureversions of this document.

In addition, a number of editorial corrections and improvements havebeen made as the result of public and member-only comments. The editors wish to thank the people who have sent in commentsfor their close reading of the document.

XQuery1.0and XPath 2.0 Functions and Operators has beendefined through the efforts of a joint task force of the XML Query Working Group and the XSL Working Group (both part of the XML Activity). It is designed to be read in conjunction with the following documents: [XQuery 1.0 and XPath 2.0 Data Model], [XPath 2.0], [XQuery 1.0: An XML Query Language] and [XSLT 2.0].

This is a Last Call Working Draft which consolidates changes and editorial improvements undertaken in response to feedback received during the previous Last Call publication which began on 2 May 2003. A list of the first Last Call issues addressed by the Working Groups is also available at http://www.w3.org/XML/2003/05/xpath-functions-issues.

Comments on this document are due on 15 February 2004. Comments should be sent to the W3C mailing list public-qt-comments@w3.org (archived at http://lists.w3.org/Archives/Public/public-qt-comments/) with "[F&O]" as the beginning of the subject field.

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.

Table of Contents

1 Introduction
    1.1 Functionpermitted Overloading
    1.2 Function stable Most Signatures and Descriptions
    1.3 Namespacetimezone Terminology
    1.4 Type HierarchySyntax
    1.5 xdt:anyAtomicType and xdt:untypedAtomic
        1.5.1 xdt:anyAtomicType
        1.5.2 xdt:untypedAtomic
        1.5.3 xdt:untypedAny
    1.6 xs:dateTime,of xs:date andargument(s). These xs:time values
        1.6.1 Examples
    1.7 Namespaces andNamespace Prefixes
    1.8 Terminology
2 Accessors
    2.1 fn:node-name
    2.2 fn:string
    2.3 fn:data
    2.4 fn:base-uri
    2.5 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 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.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:escape-uri
    7.5 Functions Based on Substring Matchingfn:normalize-unicode
        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 on Boolean ValuesBooleans
    8.1 Additional Boolean Constructor Functions
        8.1.1 fn:true
        8.1.2 fn:false
    8.2 Operators on Boolean Values
        8.2.1 op:boolean-equal
        8.2.2 op:boolean-less-than
        8.2.3 op:boolean-greater-than
    8.3 Functions on Boolean Values
        8.3.1 fn:not
9 Functions and Operators on Durations, Dates and Times
    9.1 Duration, Date and Time Types
        9.1.1 Limits andCONFORMANCE Precision
    9.2 Two Totally Ordered Subtypes of Duration
        9.2.1 xdt:yearMonthDuration
        9.2.2 xdt:dayTimeDuration
    9.3 Comparisons of Duration, Date and Time Values
        9.3.1 op:yearMonthDuration-equal
        9.3.2 op:yearMonthDuration-less-than
        9.3.3 op:yearMonthDuration-greater-than
        9.3.4 op:dayTimeDuration-equal
        9.3.5 op:dayTimeDuration-less-than
        9.3.6 op:dayTimeDuration-greater-than
        9.3.7 op:dateTime-equal
        9.3.8 op:dateTime-less-than
        9.3.9 op:dateTime-greater-than
        9.3.10 op:date-equal
        9.3.11 op:date-less-than
        9.3.12 op:date-greater-than
        9.3.13 op:time-equal
        9.3.14 op:time-less-than
        9.3.15 op:time-greater-than
        9.3.16 op:gYearMonth-equal
        9.3.17 op:gYear-equal
        9.3.18 op:gMonthDay-equal
        9.3.19 op:gMonth-equal
        9.3.20 op:gDay-equal
    9.4 Component Extraction Functions on Duration, Date and Time Values
        9.4.1 fn:get-years-from-yearMonthDuration
        9.4.2 fn:get-months-from-yearMonthDuration
        9.4.3 fn:get-days-from-dayTimeDuration
        9.4.4 fn:get-hours-from-dayTimeDuration
        9.4.5 fn:get-minutes-from-dayTimeDuration
        9.4.6 fn:get-seconds-from-dayTimeDuration
        9.4.7 fn:get-year-from-dateTime
        9.4.8 fn:get-month-from-dateTime
        9.4.9 fn:get-day-from-dateTime
        9.4.10 fn:get-hours-from-dateTime
        9.4.11 fn:get-minutes-from-dateTime
        9.4.12 fn:get-seconds-from-dateTime
        9.4.13 fn:get-timezone-from-dateTime
        9.4.14 fn:get-year-from-date
        9.4.15 fn:get-month-from-date
        9.4.16 fn:get-day-from-date
        9.4.17 fn:get-timezone-from-date
        9.4.18 fn:get-hours-from-time
        9.4.19 fn:get-minutes-from-time
        9.4.20 fn:get-seconds-from-time
        9.4.21 fn:get-timezone-from-time
    9.5 Arithmetic Functions on xdt:yearMonthDuration and xdt:dayTimeDuration
        9.5.1 op:add-yearMonthDurations
        9.5.2 op:subtract-yearMonthDurations
        9.5.3 op:multiply-yearMonthDuration
        9.5.4 op:divide-yearMonthDuration
        9.5.5 op:add-dayTimeDurations
        9.5.6 op:subtract-dayTimeDurations
        9.5.7 op:multiply-dayTimeDuration
        9.5.8 op:divide-dayTimeDuration
    9.6 Timezone Adjustment on dateTime, date and time Values
        9.6.1 fn:adjust-dateTime-to-timezone
        9.6.2 fn:adjust-date-to-timezone
        9.6.3 fn:adjust-time-to-timezone
    9.7 Adding and Subtracting Durations From dateTime, date and time
        9.7.1 fn:subtract-dateTimes-yielding-yearMonthDuration
        9.7.2 fn:subtract-dateTimes-yielding-dayTimeDuration
        9.7.3 op:subtract-dates
        9.7.4 op:subtract-times
        9.7.5 op:add-yearMonthDuration-to-dateTime
        9.7.6 op:add-dayTimeDuration-to-dateTime
        9.7.7 op:subtract-yearMonthDuration-from-dateTime
        9.7.8 op:subtract-dayTimeDuration-from-dateTime
        9.7.9 op:add-yearMonthDuration-to-date
        9.7.10 op:add-dayTimeDuration-to-date
        9.7.11 op:subtract-yearMonthDuration-from-date
        9.7.12 op:subtract-dayTimeDuration-from-date
        9.7.13 op:add-dayTimeDuration-to-time
        9.7.14 op:subtract-dayTimeDuration-from-time
10 Functions Related to QNames
    10.1 Additional Constructor Functions for QNames
        10.1.1 fn:resolve-QName
        10.1.2 fn:expanded-QName
    10.2 Operators and Functions Related to QNames
        10.2.1 op:QName-equal
        10.2.2 fn:get-local-name-from-QName
        10.2.3 fn:get-namespace-uri-from-QName
        10.2.4 fn:get-namespace-uri-for-prefix
        10.2.5 fn:get-in-scope-prefixes
11 Functions and Operators for anyURI
    11.1 fn:resolve-uri
    11.2 op:anyURI-equal
        11.2.1 Examples
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 Functions and Operators on Nodes
        14.1.1 fn:name
        14.1.2 fn:local-name
        14.1.3 fn:namespace-uri
        14.1.4 fn:number
        14.1.5 fn:lang
        14.1.6 op:is-same-node
        14.1.7 op:node-before
        14.1.8 op:node-after
        14.1.9 fn:root
15 Functions and Operators on Sequences
    15.1 Functions and Operators on Sequences
        15.1.1 fn:zero-or-one
        15.1.2 fn:one-or-more
        15.1.3 fn:exactly-one
        15.1.4 fn:boolean
        15.1.5 op:concatenate
        15.1.6 fn:index-of
        15.1.7 fn:empty
        15.1.8 fn:exists
        15.1.9 fn:distinct-values
        15.1.10 fn:insert-before
        15.1.11 fn:remove
        15.1.12 fn:reverse
        15.1.13 fn:subsequence
        15.1.14 fn:unordered
    15.2 Equals, Union, Intersection and Except
        15.2.1 fn:deep-equal
        15.2.2 op:union
        15.2.3 op:intersect
        15.2.4 op:except
    15.3 Aggregate Functions
        15.3.1 fn:count
        15.3.2 fn:avg
        15.3.3 fn:max
        15.3.4 fn:min
        15.3.5 fn:sum
    15.4 Functions and Operators that Generate Sequences
        15.4.1 op:to
        15.4.2 fn:id
        15.4.3 fn:idref
        15.4.4 fn:doc
        15.4.5 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:default-collation
    16.7 fn:implicit-timezone
17 Casting Functions
    17.1 Casting from primitive types to primitive types
    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.5 Casting across the type hierarchy
    17.6 Casting from xs:stringxs:string, xdt:untypedAtomic and xdt:untypedAtomic
    17.7 Casting to xs:stringxs:string, xs:anySimpleType and xdt:untypedAtomic
    17.8 Casting to numeric types
        17.8.1 Casting to xs:float
        17.8.2 Casting to xs:double
        17.8.3 Casting to xs:decimal
        17.8.4 Casting to xs:integer
    17.9 Casting to duration types
    17.10 Casting to date and time types
    17.11 Casting to xs:boolean
    17.12 Casting to xs:base64Binary and1 , xs:hexBinary
    17.13 Casting to xs:anyURI
    17.14 Casting to xs:QName
        17.14.1 Usage Note
    17.15 Casting to xs:NOTATION

Appendices

A References
    A.1 Normative
    A.2 Non-normative
B Compatibility with XPath 1.0 (Non-Normative)
C Illustrative User-written Functions (Non-Normative)
    C.1 eg:if-empty and eg:if-absent
        C.1.1 eg:if-empty
        C.1.2 eg:if-absent
    C.2 union, intersect and except on sequences of values
        C.2.1 eg:value-union
        C.2.2 eg:value-intersect
        C.2.3 eg:value-except
    C.3 eg:index-of-node
    C.4 eg:string-pad
    C.5 eg:distinct-nodes-stable
    C.6 Working With xs:duration Values
D Error Summary (Non-Normative)
E Functions and Operators Issues List (Non-Normative)
F ChangeLog since Last Call Version on 2003-05-02 (Non-Normative)
G Function and Operator Quick Reference (Non-Normative)
    G.1 Functions and Operators by Section
    G.2 Functions and Operators Alphabetically


1 Introduction

This document defines a few new datatypes, 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] defines a number of primitive and derived datatypes, collectively known as built-in datatypes. This document defines operations on these datatypes as well as the two datatypes defined in 1.5 xdt:anyAtomicType and xdt:untypedAtomic and the two totally ordered subtypes of xs:duration defined in 9.2 Two Totally Ordered Subtypes of Duration, for use in [XPath 2.0], [XQuery 1.0: An XML Query Language]and [XSLT 2.0]and related XML standards. This document also discusses operators and functions on nodes and node sequences as defined in the [XQuery 1.0 and XPath 2.0 Data Model] for use in [XPath 2.0], [XQuery 1.0: An XML Query Language]and [XSLT 2.0]and other related XML standards.

Referencesto specific sections of some of the above documents areindicated by cross-document links in this document. Eachsuch link consists of a pointerto a specific section followedasuperscript specifying the linkeddocument. Thesuperscripts have the following meanings: 'XQ'[XQuery 1.0: An XML Query Language],'XT' [XSLT 2.0],'XP' [XPath 2.0],'DM' [XQuery 1.0 and XPath 2.0 Data Model]and 'FS'[XQuery 1.0 and XPath 2.0 Formal Semantics].

1.1 FunctionOverloading

Ingeneral, the specifications named above do not support function overloading. Consequently,there are no overloaded functions in this document except for legacy[XPath 1.0]functions such as fn:string(),whichaccepts a single argument ofa variety of types, and concat()which acceptsavariablenumber of xs:string arguments. Inaddition, the functions defined in 6 Functions and Operators on Numericsthat accept numeric argumentsaccept arguments of type xs:integer,xs:decimal, xs:floator xs:double. See1.2 Function stable Most Signatures and Descriptions. Operatorssuch as "+" may be overloaded.

1.2 Function Signatures and Descriptions

Eachfunction is defined by specifying its signature, a description ofthe return type and each ofthe parameters and its semantics. For many functions, examples are included to illustrate theiruse.

Eachfunction's signature is presented ina form like this:

Inthis notation, function-name, in bold-face,isthenameof thefunction whose signature isbeing specified. Ifthe function takes no parameters,then the name is followed by an empty set ofparentheses: "()";otherwise, the name isfollowed by a parenthesized list of parameter declarations,each declaration specifying the static type ofthe parameter, in italics, and a non-normative nameused to describe the function's semantics. If thereare twoor more parameter declarations, they are separatedby a comma. The return-type,also in italics,specifies the static type of the value returnedby the function. Inmost cases, the dynamic typereturned by the function is the same as its statictype. Thetypes "node"and "item"are indicated in function signatures as "node()" and "item()" repectively.

In some cases the word "numeric" is usedin function signaturesas ashorthand to indicate the four numeric types: xs:integer,xs:decimal, xs:floatand xs:double. Forexample, a function with the signature

representsthe followingfour functions signatures:
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 ...
Similarly, for return types.

For most functions there is a initialparagraph describing what the function does followedby semantic rules. These rulesare meant to be followed in the order thatthey appear in this document.

In some cases, the dynamic type returned by afunction depends onthetype(s) of itsargument(s). These special functions are indicated byusing bolditalicsfor the return type. Thesemantic rules specifyingthe type of the value returned are documentedin thefunction definition. The rules are described more formally in Section 6.2 Standard functions with specific typing rulesFS.

Thefunction name is a QNameas defined in [XML Schema Part 2: Datatypes]and must adhereto its syntactic conventions. Following [XPath 1.0], function names are composed of English words separated by hyphens,"-". Ifa function name contains a [XML Schema Part 2: Datatypes]datatype name, it may have intercapitalized spelling andis usedin the function name as such. For example, fn:get-timezone-from-dateTime.

As is customary, theparameter type name indicates thatthefunction accepts arguments of that type, or types derived fromit, in that position. This is called subtype substitution.Details of the semantics of passing arguments to functionsare discussed in Section B.1 Type PromotionXQ .

Somefunctions accept the emptysequence as an argument and some may return the empty sequence. This is indicated in the function signature by following the parameter or returntype name with a question mark: "?",indicating that either a singlevalue or the empty sequence must appear. Seebelow.

fn:function-name($parameter-name as parameter-type?) as return-type?

Notethat thisfunction signature is different from a signature in which the parameter isomitted. See,for example, the two signatures forfn:string(). Inthe first signature, the parameteris omitted and theargument defaults tothe context-item(.). Inthe second signature, the argumentmust be present but may bethe empty sequence ().

Somefunctions accepta sequenceas an argument.This is indicated byfollowingthe nameof type of the items in the sequence with *. The sequence may contain zero or more items of the named type. Forexample, the function below acceptsa sequence of xs:double andreturns a xs:doubleor the empty sequence.

fn:median($arg as xs:double*) as xs:double?

1.3 NamespaceTerminology

Thisdocument uses the phrase "namespace URI" toidentify the concept identified in[Namespaces in XML] as "namespace name", and the phrase "local name" to identifythe concept identified in [Namespaces in XML]as "local part".

It alsouses the term "expanded-QName".

[Definition] Expanded-QName

Anexpanded-QName is a pair ofvalues consisting of a namespaceURI and a local name. They belong to the value space of the [XML Schema Part 2: Datatypes]datatypexs:QName. When this document refers toxs:QName we always mean thevalue space, i.e. a namespace URI, local name pair (and notthe lexical spacereferring to constructs of the form prefix:local-name).

1.4 Type Hierarchy

The diagram below shows the types for which functions are defined inthis document. These include the built-in types defined by [XML Schema Part 2: Datatypes] (shownon the right) as well as types defined in [XPath 2.0](shown on the left). Solidlines connect a base datatypeabove to a derived datatype exceptin the case of xsIDREFS, xs:IDREFS, xs:NMTOKENS, xs:ENTITIES and user-defined listand union types. These types are lists or unions of their parent types(s) ratherthan true subtypes.Dashed lines connect a uniontype above with its component types below.

Type hierarchy   graphic

Theinformation in the above diagram isreproduced below in tabular form. Forease of presentation the information is divided into three tables. The firsttable shows the top three layers of the hierarchy starting at xs:anyType. The second table shows the typesderived from xdt:anyAtomicType. The third table showsthe types defined in [XPath 2.0]

Each type whose name is indented is derived from thetypewhosename appearsnearest above with one less level of indent.

xs:anyType
user-defined complex types
xdt:untypedAny
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]built-in datatypes as wellas the two totallyordered subtypes of duration defined 9.2 Two Totally Ordered Subtypes of Duration.

Each type whose nameis indented is derived from the type whose name appears nearest above with one less level of indent.

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: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

Thetable below shows type hierarchy for the types introduced in [XPath 2.0].For these types, each type whose nameis indented is a component of the union type whose name appears nearest above with one less level of indent.

item
xdt:anyAtomicType
node
attribute
user-defined attribute types
comment
document
user-defined document types
element
user-defined element types
processing-instruction
text

1.5 xdt:anyAtomicType and xdt:untypedAtomic

1.5.1 xdt:anyAtomicType

The abstract datatype xdt:anyAtomicTypeis a child of xs:anySimpleType and is the base type for allthe primitive atomic types described in [XML Schema Part 2: Datatypes].This datatypecannot be used in [XML Schema Part 1: Structures]type declarations, norcan it beused as a base for user-defined atomic types. Itcan be used,as discussed in the Section 3.12 Expressions on SequenceTypesXQ, todefine a required type (for example in a function signature) to indicate that any of the primitive atomic types or xdt:untypedAtomicis acceptable. Thisdatatype resides inthe namespace http://www.w3.org/2003/11/xpath-datatypes.

1.5.2 xdt:untypedAtomic

Theabstract datatype xdt:untypedAtomicis a child of xdt:anyAtomicTypeand serves as a special type annotation to indicate atomic values that have notbeen validated by a XML Schema or a DTD or have received an instance type annotationof xs:anySimpleType in the PSVI. This datatype cannot be used in [XML Schema Part 1: Structures]type declarations, nor can it be used asa base for user-defined atomic types.It can be used, as discussed inthe Section 3.12 Expressions on SequenceTypesXQ, todefine a required type (for example in afunction signature) to indicate that only an untyped atomic value is acceptable. This datatype resides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

1.5.3 xdt:untypedAny

The abstract datatype xdt:untypedAnyis a child of xs:anyTypeand serves as a special type annotation to indicate types that have notbeen validated by a XML Schema or a DTD. This type cannot be usedin [XML Schema Part 1: Structures]typedeclarations, nor can it beused asa base for user-defined types. It can be used, asdiscussed in the Section 3.12 Expressions on SequenceTypesXQ, to define a requiredtype (for example ina function signature) to indicate that only an untyped value is acceptable. This datatyperesides in the namespace http://www.w3.org/2003/11/xpath-datatypes.

1.6 xs:dateTime,xs:date andxs:time values

xs:dateTime, xs:date and xs:time valuesare represented in the Section 3.3.1 Mapping PSVI Additions to TypesDMastuples: a xs:dateTime, xs:dateor xs:time value without a timezone and a timezone represented as a xdt:dayTimeDuration value.The value space of these types consistsof the normalized value for these datatypes. Thismeans that the xs:dateTime, xs:dateor xs:timeis first normalized to UTC or timezone Z. To create a value from a lexical representation of xs:dateTime, xs:dateand xs:timelexical representations that have a timezone are converted to timezone Zas defined by[XML Schema Part 2: Datatypes]and the timezone in the lexical representationis converted toa xdt:dayTimeDuration value. Lexicalrepresentations that do not contain a timezone are assumedto be in timezone Zand the timezonepart of the value set to the empty sequence "()".

We also define the localizedvaluefor a xs:dateTime, xs:date and xs:timeas the xs:dateTime, xs:dateand xs:timevalue in its original timezone or no timezone, as thecase may be,followed by thetimezonerepresented as a xdt:dayTimeDuration.Lexical representations that donot contain a timezone are given a timezone valueset to the empty sequence "()".

1.7 Namespaces andPrefixes

The functions and operators discussed in this document are contained in one of three 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] 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 is fn: for the functions available to users and op: for the operator functions. The purpose ofthe functions indicated by the op: prefix is to definethe semantics of operators in the host languages. In [XQuery 1.0: An XML Query Language]and [XPath 2.0] they are not directly accessible by users.

The datatypes described in this document in 1.5 xdt:anyAtomicType and xdt:untypedAtomic and 9.2 Two Totally Ordered Subtypes of Duration are contained in a separate namespace and are named using the prefix xdt:.

The namespace prefix for these functions and datatypes can vary, as long as the prefix is bound to the correct URI.

The URIs of the namespaces are:

  • http://www.w3.org/2001/XMLSchema for constructors

  • http://www.w3.org/2003/11/xpath-functions for functions.

  • http://www.w3.org/2003/11/xpath-datatypes for the datatypes.

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 [XPath 2.0], [XQuery 1.0: An XML Query Language] and [XSLT 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

1.8 Terminology

The terminology used to describe thefunctions and operators on [XML Schema Part 2: Datatypes]is defined in the body of this specification. The terms defined in the following list are used in building those definitions:

[Definition] for compatibility
[Definition] may
[Definition] must
[Definition] implementation defined
[Definition] implementation-dependent
[Definition] stable

Most of the functions in the core library have the property that calling the same function twice 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. The scope over which the results are stable depends on the processing context. 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.

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.

2 Accessors

Accessors andtheir 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.

FunctionAccessorAcceptsReturns

2.4 fn:base-uri

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.1 base-uri AccessorDM.

If $arg is the empty sequence, the empty sequence is returned.

Document, element and processing-instruction nodes have a base-uri property whichmay be empty. The base-uri of all other node types is the empty sequence. If the base-uri property for $argis non-empty, its value isreturned. If the base-uri propertyfor $argis empty, the base-uri of that node's parent is returned. If the node has no parent, the empty sequence is returned.

fn:base-uri() as xs:string

Summary: This version of the function returns the value of the base-uri property from the static context using the preceding rules. The static context is discussed in Section 2.1.1 Static ContextXQ .

2.5 fn:document-uri

Summary: Returns the value of the document-uri property for $arg as defined by the accessor function dm:document-uri in Section 5.1 base-uri AccessorDM.

If $arg is the empty sequence, the empty sequence is returned.

Returns theempty sequence if the node is not a document node or if its document-uri property is a relative URI. Otherwise, returns an absolute URI expressed as an xs:string.

If the document-uri property of $arg is not the empty sequence, then the following expression always holds:


fn:doc(fn:document-uri($arg)) is $arg

3 The Error Function

In this document, as well as in [XQuery 1.0: An XML Query Language], [XPath 2.0], and [XQuery 1.0 and XPath 2.0 Formal Semantics], the phrase "an error is raised" is used to describethe behavior of conforming processorsin certain situations.When such situations arise in a runningsystem, a conforming implementationof this specification must invoke the fn:error function defined in this section.

The phrase is normally accompanied by specification of a specific error, in which case the phrase "an error is raised [name of error]" is used. The"name of error" specifies aphrase that is mnemonic for the actual error, but the error code to which it refersis an xs:QName. Each error defined in this document is identified by an xs:QName that is in the namespace asssociated with the xdt: prefix. It is the xs:QName that is actually passed as an argument to the fn:error function invocation. Invocation of this function causes the evaluation phase of the outermost XQuery or transformation to be terminated. For a more detailed treatment of error handing, see Section 2.5.2 Handling Dynamic ErrorsXQ and Section 6.2.5 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 and XPath 2.0 applications with, forexample, an xs:string argument.

fn:error() as none
fn:error(
$arg as item()?
) as none

One version of thefn:error function takesno argments;asecond version of the function accepts an optional item() as argument. The fn:error function never returns a value.

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.

4 The Trace Function

This function is intended to be used in debugging queries by providing a trace of their execution.

The input $value is returned, unchanged, as the result of the function. In addition, the inputs $value and $label are directed to a trace data set. The location and format of the trace data set are ·implementation dependent·. The ordering of output from invocations of the fn:trace() function is ·implementation dependent·.

5 Constructor Functions

5.1 Constructor Functions for XML Schema Built-in Types

Every built-in atomic type that is defined in [XML Schema Part 2: Datatypes], except xs:NOTATIONhas an associated constructorfunction; as do xdt:untypedAtomic, defined in 1.5 xdt:anyAtomicType and xdt:untypedAtomic and the two derived types xdt:yearMonthDuration and xdt:dayTimeDuration defined in 9.2 Two Totally Ordered Subtypes of Duration.The form of that function for a type pref:TYPE is:

pref:TYPE(
$arg as xdt:anyAtomicType
) as pref:TYPE

For example, the signature of the constructor function corresponding to the xs:unsignedInt type defined in [XML Schema Part 2: Datatypes] 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 value equal to the xs:unsignedInt 12. The standard features described in Section 2.3.2 AtomizationXQ would 'atomize' the node to extract its 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 [invalid value for constructor].

If the argument to a constructor function is an xs:string,whitespace normalization is appliedas indicated by the whiteSpace facet for the datatype. The resulting whitespace-normalized stringmust be a valid lexical form for the type, as specified in [XML Schema Part 2: Datatypes]. The semantics of constructor functions wheninvoked with a xs:string are identical to XML Schema validation. In the case of xs:dateTime, xs:date and xs:time, the value returned differs from [XML Schema Part 2: Datatypes] and is defined in 1.6 xs:dateTime,of xs:date andargument(s). These xs:time values.

The semantics of the constructor function "xs:TYPE(arg)" areidentical to the semantics of "arg cast as xs:TYPE". See 17 Casting Functions. In some cases, the semantics of casting areexplained using constructor functions; but there is no circularity. The constructors used invariably take xs:string arguments and, in this case, the semantics arethe semantics of XML Schema validation as discussed above.

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.

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").

  • xs:double(
    $arg as xdt:anyAtomicType
    ) as xs:double

    Implementations ·may· return negative zero for xs:double("-0.0E0").

  • xs:duration(
    $arg as xdt:anyAtomicType
    ) as xs:duration
  • xs:dateTime(
    $arg as xdt:anyAtomicType
    ) as (xs:dateTime, xdt:dayTimeDuration)
  • xs:time(
    $arg as xdt:anyAtomicType
    ) as (xs:time, xdt:dayTimeDuration)
  • xs:date(
    $arg as xdt:anyAtomicType
    ) as (xs:date, xdt:dayTimeDuration)
  • 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 xdt:anyAtomicType) as xs:QName

    See 17.14 Casting to xs:QName for semantics of xs:QName.

  • 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
  • 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

5.2 Constructor Functions for User-Defined Types

For every globally-defined atomic type in the static context (See Section 2.1.1 Static ContextXQ that is derived by restriction from a primitive type, except types derived from xs:NOTATION, 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.

In the case of types whose name has a null namespace URI, it will not be possible to call the constructor function if a default namespace for functions is defined. In this case, the cast syntax must be used instead.

Consider a situation where the static context contains a type called hatSize defined in a schema that 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.

6 Functions and Operators on Numerics

This section discusses arithmetic operators on the numeric datatypes defined in [XML Schema Part 2: Datatypes]. It uses an approach that permits lightweight implementation whenever possible.

6.1 Numeric Types

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 indent.

xs:decimal
xs:integer
xs:float
xs:double

They also apply to types derived by restriction from these types.

Note:

The value space for xs:float and xs:double, as defined in the errata to [XML Schema Part 2: Datatypes], defines only a single zero. [IEEE 754-1985] arithmetic, however, can produce distinct results of positive zero and negative zero. Theseare two differentmachine representations for the same value. The text accompanyingseveral functions discusses behaviour for both positive andnegative zero inputsin the interest of alignmentwith [IEEE 754-1985].

6.2 Operators on Numeric Values

The following functions definethe semanticsof operators defined in [XQuery 1.0: An XML Query Language] and [XPath 2.0] on these numeric types.

OperatorsMeaning
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 to return the same type. The one exception is op:numeric-divide, which returns an xs:decimal if called with two xs:integer operands.)

Operands of type xdt:untypedAtomic are converted to xs:double, except for arguments to 6.2.5 op:numeric-integer-divide which are converted to xs:integer. If the two operands are not of the same type, subtype substitution and type promotion areused to obtain two operands of the same type. Section B.1 Type PromotionXQdescribes the semantics of these operations in detail.

  1. Subtype substitution: A derived type may substitute for its base type. In particular, xs:integer may be used where xs:decimal is expected.

  2. Type promotion: xs:decimal may be promoted to xs:float, and xs:float may be promoted to xs:double.

The result type of operations depends on their argument datatypes and is defined in the following table:

OperatorReturns
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:float, and xs:float can be promoted to xs:double. As far as possible, the promotions should be done in a single step. Specifically, when a decimal is promoted to a double, it should not be converted to a float and then to 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:

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.

The number of digits of precision returned by various numeric functions is ·implementation dependent·.

6.2.6 op:numeric-mod

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 idivb)*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: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/b)*b+(a mod b) = a. Division is truncating division, analogous to integer division, not [IEEE 754-1985] rounding division.

6.3 Comparison of Numeric Values

This specification defines the following comparison operators on numeric values. Comparisons take two arguments of the same type. Arguments of type xdt:untypedAtomic are converted to xs:double. 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.

OperatorMeaning
op:numeric-equal Equality comparison
op:numeric-less-than Less-than comparison
op:numeric-greater-than Greater-than comparison

6.4 Functions 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.

FunctionMeaning
fn:abs Returns the absolute value of the argument.
fn:ceiling Returns thelargest 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.

6.4.4 fn:round

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. More formally, fn:round(x) produces the same result as fn:floor(x+0.5). If type of $arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the return is the same as the type of $arg. If the type of $arg is a type derived from one of the numeric types, the type of the return is the parent numeric type.

For xs:float and xs:double arguments, if the argument is positive zero (+0), then positive zero (+0) is returned. If the argument is negative zero (-0), then negative zero (-0) is returned. If the argument is less than zero (0), but greater than or equal to -0.5, then negative zero (-0) is returned.

For detailed type semantics, see Section 6.2.1 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS

6.4.5 fn:round-half-to-even

Summary: The value returned is the nearest (that is, numerically closest) numeric to $argthat is a multipleof ten to the power of minus $precision. If two suchvalues areequally near (e.g. if the fractional part in $argis exactly .500...), returns the one whose least significant digitis even. If type of $argis one ofthe four numeric types xs:float, xs:double,xs:decimalor xs:integerthetype of the return is the same as the type of $arg. Ifthe typeof $arg is a type derived from oneof the numeric types, the type of the returnis the parent numerictype.

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 6.2.1 The fn:abs, fn:ceiling, fn:floor, fn:round, and fn:round-half-to-even functionsFS

7 Functions on Strings

This section discusses functions and operators on the [XML Schema Part 2: Datatypes] xs:string datatype and the datatypes derived from it.

7.1 String Types

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 indent.

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 these types.

Note:

This document uses the term "code point",sometimes spelt "codepoint", asdefined in [The Unicode Standard], ranging from #x0000 to #x10FFFF inclusive. The use ofthe word "character"in this document isin the sense of production [2] of [XML 1.0 Recommendation (Second Edition)], so it may include codepoints which have not yet been assignedto characters."

Note:

Infunctions that involve character counting such as fn:substring,fn:string-lengthand fn:translate, what iscounted is the of XML characters in the string(or equivalently, the numberof 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.

Unless explicitly stated, the xs:string values returned by thefunctions in this document are not normalizedin the sense of [Character Model for the World Wide Web 1.0].

7.3 Equality and Comparison of Strings

7.3.1 Collations

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] 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 that two different codepoints are, in fact, equal for comparisonpurposes (e.g., "v" and "w" are considered equivalent in Swedish). Strings can be compared codepoint-by-codepoint or in a linguistically appropriatemanner, 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/2003/11/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.

While the [Character Model for the World Wide Web 1.0] recommends that all strings be subjected to early Unicode normalization, 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 interoperable results of operations on XML documents in general, there may be collations that operate on unnormalized strings, other collations that raise runtime errors when unnormalized strings are encountered, and still other collations that implicitly normalize strings for the purposes of collating them. For alignment with the [Character Model for the World Wide Web 1.0], applications may choose collations that treat unnormalized strings as though they were normalized (that is, that implicitly normalize the strings). Note that collations based on the Unicode collation algorithm 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.

Functions such as fn:compareand fn:maxthat compare xs:string values usea single collation URI to identify all aspectsof the collation rules. This means that any parameters such as the strength of the collation must be specified as part ofthe collation URI. For example, suppose thereis a collation"http://www.example.com/collations/French" thatrefers to a French collation that compares on the basis of base characters. Collations that use the same basic rules, butwith higher strengths, for example, base characters and accents, or base characters, accents and case, would need to be given differentnames, say "http://www.example.com/collations/French1" and "http://www.example.com/collations/French2". Note that somespecifications use the term collation to refer to an algorithm that can be parameterized, but in this specification, each possible parameterization is considered to bea distinct collation.

The XQuery/XPath static context includes a provision for a default collation that canbe used for string comparisons (including orderingoperations). However, the static context is not required to have a default collation specified. Seethe description of the static context in Section 2.1.1 Static ContextXQ. Ifthe static context does not havea default collation specified, a system defined default can beinvoked. If this is not provided, the Unicode code point collation is used as the defaultcollation.

The decision of what collation to use for a given comparison or ordering function is determined by the following algorithm:

  1. 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 [unsupported collation].

  2. If no collation is explicitly specified for the function and the function is fn:contains, fn:starts-with, fn:ends-with, fn:substring-before or fn:substring-after the Unicode code point collation (http://www.w3.org/2003/11/xpath-functions/collation/codepoint) is used.

  3. If no collation is explicitly specified for the function and the function is not one of the abovefunctions and the XQuery/XPath static context specifies a collation, CollationB, then:

    • If CollationB is supported by the implementation, then CollationB is used.

    • Otherwise, an error is raised [unsupported collation].

  4. Otherwise, the Unicode code pointcollation (http://www.w3.org/2003/11/xpath-functions/collation/codepoint)is used.

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.

7.3.2 fn:compare

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 the value of $comparand2 begins with a string that is equal to the value of $comparand1 (according to the collation that is used) and has additional code pointsfollowing that beginning string, then the result is -1. If the value of $comparand1 begins with a string that is equal to the value of $comparand2 (according to the collation that is used) and has additional code pointsfollowing that beginning string, then the result is 1.

If either argument is the empty sequence, the result is the empty sequence.

This function, invokedwith the second signature, backs up the "eq", "ne", "gt", "lt", "le" and "ge" operators on string values.

7.4 Functions on String Values

The following functions are defined on values of typexs:stringand types derived from it. Several of these functions use collations.See 7.3.1 Collations for a discussion of collations.

FunctionMeaning

Note:

Whenthe above operators and functions are applied to datatypes derived from xs:string, they are guaranteed to return legal xs:strings, but they might not return a legal value for the particular subtype to which they were applied.

7.4.3 fn:substring

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 valueof $sourceString beginning at the position indicated bythe value of $startingLoc and continuing for the number of charactersindicated by the value of $length. More specifically, returns the characters in $sourceString whoseposition $pobeys:

fn:round($startingLoc)<= $p < fn:round($startingLoc) + fn:round($length)

Inthe abovecomputation, 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.

If $startingLoc is zero or negative, the substring includes characters from thebeginning of the $sourceString.

If $length is not specified, the substring includes characters tothe end of $sourceString.

If$length is greater than the number of characters inthe value of $sourceString following $startingLoc,the substring includes characters to the end of $sourceString.

The firstcharacter of a string is located at position 1, not position 0.

7.4.6 fn:normalize-unicode

fn:normalize-unicode($arg as xs:string?,
$normalizationForm as xs:string) as xs:string

Summary: Returns the valueof $arg normalized according to the normalization criteria for a normalizationform identified by the value of $normalizationForm. The effective valueof the $normalizationFormis computedby removing leading and trailing blanks, ifpresent, and convertingto upper case.

If the value of $arg isthe empty sequence, returns thezero-length string.

See[Character Model for the World Wide Web 1.0] fora description of the normalization forms.

Ifthe $normalizationFormis absent, as in the first format above, it shall be assumed tobe "NFC"

  • If the effective value of $normalizationForm is "NFC",then the valuereturned by the function is the value of $arg in Unicode Normalization Form C (NFC).

  • Ifthe effective value of $normalizationForm is "NFD",then the value returned by the function isthe value of $argin Unicode Normalization Form D (NFD).

  • Ifthe effective value of$normalizationForm is"NFKC",then the value returned bythe function is the value of $arg in UnicodeNormalization Form KC (NFKC).

  • If the effective value of $normalizationForm is "NFKD",then the valuereturned 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 valuereturned by the function is thevalue of $arg is the fullynormalized form.

  • Ifthe effective value of $normalizationForm isthe zero-length string, no normalization is performed and $arg isreturned.

Conformingimplementations ·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. Ifthe effective value of the $normalizationFormis other than one of the values supported bythe implementation, then an error is raised [unsupported normalization form].

7.4.7 fn:upper-case

Summary:Returns the value of $srcvalafter translating every characterto its upper-case correspondent. Every character that does nothave an upper-case correspondent is included in the returned value inits original form. The precise mapping is determined using [Unicode Case Mappings].

If thevalue of $arg is the empty sequence, the zero-length string is returned.

Note:

Case mappings may change thelength of a string. In general, the two functions are not inverses of each other fn:lower-case(fn:upper-case($arg)) is not guaranteedto return $arg, nor is fn:upper-case(fn:lower-case($arg)).The Latin small letter dotless i (as used in Turkish) is perhapsthe most prominentlower-case letterwhich willnot round-trip. TheLatin capital letter i with dot above is the most prominentupper-case letter which will not round trip; there are others.

Thesefunctions maynot alwaysbe linguistically appropriate (e.g. Turkish i withoutdot) or appropriate for the application (e.g. titlecase).Incases such as Turkish,a simple translation should be used first.

Resultsmay violateuser expectations(in Quebec,for example, the standarduppercase equivalent of "è"is "È", while inmetropolitan Franceit is morecommonly "E";onlyone of these issupported by thefunctions as defined).

Manycharacters of class Ll lack uppercase equivalents in the Unicodecase mappingtables; manycharacters of class Lu lacklowercase equivalents.

7.4.8 fn:lower-case

Summary, returns the valueof $srcval after translating every characterto its lower-case correspondent. Every character that does not have anlower-case correspondent is included in the returned value in its original form. The precise mapping is determined using [Unicode Case Mappings].

If the value of $arg is the empty sequence, the zero-length string is returned.

Note:

Case mappings may change thelength ofa string. In general,the two functions are not inverses of eachother fn:lower-case(fn:upper-case($arg))is not guaranteedto return $arg, nor isfn:upper-case(fn:lower-case($arg)). The Latin small letter dotless i (as used inTurkish) is perhaps the most prominent lower-case letter which will not round-trip. TheLatin capital letter i with dot above isthe most prominentupper-case letter which will not round trip; there are others.

Thesefunctions may not always be linguistically appropriate (e.g. Turkish i withoutdot) or appropriate for the application (e.g. titlecase). In cases suchas Turkish, a simple translation should be used first.

Resultsmay violate user expectations (in Quebec, for example, the standard uppercase equivalent of "è" is "È", while in metropolitan France it is more commonly "E"; onlyone 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.

7.4.10 fn:escape-uri

fn:escape-uri($uri-part as xs:string?,
$escape-reserved as xs:boolean) as xs:string

Summary: This function applies the URI escaping rulesdefined in section 2 of [RFC 2396]as amended by [RFC 2732], with one exception, tothe string supplied as$uri-part, which typically represents allor part of a URI.The effect of the function is toreplace any special character in the string by an escape sequence ofthe form %HH, whereHH... is the hexadecimal representation of theoctets used to represent thecharacter in UTF-8.

The set of characters that are escapeddepends on the setting of the boolean argument $escape-reserved.

If $uri-part is the empty sequence, returns the zero-length string.

If $escape-reserved is true, all characters are escaped other than the lower case lettersa-z, the upper case lettersA-Z, the digits 0-9, the PERCENT SIGN "%" andthe NUMBER SIGN "#" characters andthe characters referredto in[RFC 2396]as "marks": specifically,HYPHEN-MINUS ("-"), LOWLINE ("_"), FULLSTOP ".", EXCLAMATIONMARK "!", TILDE"~", ASTERISK "*", APOSTROPHE "'", LEFT PARENTHESIS "(", and RIGHT PARENTHESIS ")".

If$escape-reservedis false,the behavior differs in that charactersreferred to in [RFC 2396] and[RFC 2732]as reserved characters,together with the NUMBER SIGN '#' character,(See [Uniform Resource Identifiers (URI): Generic Syntax])are not escaped. These charactersare SEMICOLON ";", SOLIDUS"/", QUESTION MARK"?", COLON ":", COMMERCIAL AT "@", AMPERSAND "&", EQUALS SIGN "=", PLUS SIGN "+", DOLLAR SIGN "$", COMMA "," NUMBER SIGN "#", LEFT SQUARE BRACKET "[" and RIGHT SQUARE BRACKET "]".

[RFC 2396]does not define whetherescaped URIs should use lower case or upper case for hexadecimal digits. To ensure that escaped URIs can be compared using string comparisonfunctions, this function mustalways generate hexadecimal values using the upper-case lettersA-F.

Generally,$escape-reservedshould be set totrue when escaping a string that is to form a single partof a URI, and to false when escaping an entire URI or URI reference.

7.5 Functions Based on Substring Matching

The functions described in thesection examine a string $arg1to see whetherit contains another string $arg2 as a substring. The result depends on whether $arg2 isa substring of $arg1,and if so, onthe range of characters in $arg1which $arg2matches.

Inthe absenceof a collation argument, or when the Unicode code point Collationis used, this simply involvesdetermining whether $arg1 contains a contiguous sequence of characters whose codepoints are the same, one for one, withthe code points of the characters in $arg2.

When a collationis specified, the rules are more complex.

Allcollations support the capability of decidingwhether two strings areconsidered equal, andif not, which of thestrings should be regarded as precedingthe 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 additionalproperty:it must be able to decomposethe stringinto asequence ofcollationunits, each unit consisting of one or more characters, such that two stringscan be compared by pairwise comparisonof these units. The string$arg1 is then considered to contain $arg2as a substring if the sequence of collation units corresponding to $arg2 is a subsequence of thesequence ofthe collation units corresponding to$arg1. The characters in $arg1that match are the characters correspondingto 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, inwhich 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 expressionfn:contains("Jaeger","eg")will return false. The results of these functions thus depends stronglyon the properties of the collationthat is used.

Inthe definitions below, we say that$arg1contains $arg2at positions mthrough nif the collation units corresponding to charactersin positions mto nof $arg1are the same as the collation units correspondingto all the characters of $arg2.In thesimple case of the Unicode codepoint collation, thecollation units are the same as thecharacters of thestring.

It is possible to definecollations that do not have the abilityto decomposea string into unitssuitable for substring matching. Anargument to afunction defined in this sectionmay be a URI that identifies a collation that is able to comparetwo strings, but that does not have the capability to split thestring into collationunits.Such a collationmay fail, orgive unexpected resultsand the system may rejectit.

7.6 String Functions that Use Pattern Matching

The three functions described in this section make use of a regular expression syntax for pattern matching. This is described below.

FunctionMeaning
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:strings 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.

7.6.1 Regular Expression Syntax

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]), 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.

7.6.1.1 Flags

All these functions provide an optional parameter, $flags, toset options for the interpretation of the regular expression. The parameter accepts a xs:string, in which individualletters are used to set options.The presence of a letter within the string indicates that the option is on; its absence indicates thatthe 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 [invalid regular expression flags].

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 metacharacter . matches any character except a newline (#x0A) character. In dot-all mode, the metacharacter . 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 metacharacter ^ 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. Otherwise, the match operates incase-sensitive mode. In case-sensitive mode, a character in the input string matches a character specified by the pattern only if the Unicode code-points match. In case-insensitive mode, a character in the input string matches a character specified by the pattern if there is a canonical caseless match between the two characters as defined in section 2.5 of [Unicode Case Mappings].

  • x: If present, whitespace characters within the regular expression are ignored. By default, whitespace characters match themselves. This allows, for example, regular expressions to be broken up into lines for readability.

The regular expression syntax and semantics are identical to those defined in [XML Schema Part 2: Datatypes] with the following additions:

  • Two meta-characters, ^ and $ are added. Bydefault, the metacharacter ^ 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]:

    [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 | "^" | "$"

  • In string mode, the metacharacter . matches any character whatsoever. In multiline mode, the metacharacter . matches any character except a newline (#x0A) character. Suppose the input contains "hello" and "world" on two lines. This will not be matched by the regular expression "hello.*world" in multiline mode.

  • 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]:

    [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] 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-referencesare allowed. The construct \nwhere n isa single digitis alwaysrecognized as a back-reference; if this is followed by furtherdigits,these digitsare takento bepart of the back-referenceif andonly if the back-reference is preceded by sufficiently many capturing subexpressions.A back-reference matches the string that wasmatched by the n'th capturing subexpression within the regular expression, that is, the parenthesizedsubexpression whose opening left parenthesis is then'th unescapedleft parenthesis within the regular expression. The closing right parenthesisof this subexpression must occur before the back-reference. For example,the regular expression ('|").*\1matches a sequence of characters delimitedeither by an apostrophe at the start and end, or by aquotation markat the startand end.

    Backreferences change the followingproduction:

    [23]charClassEsc ::=( SingleCharEsc | MultiCharEsc | catEsc | complEsc )

    to

    [23]charClassEsc ::=(SingleCharEsc |MultiCharEsc | catEsc | complEsc| backReference )

    [23a]backReference ::= "\" [0-9]+

7.6.2 fn:matches

fn:matches($input as xs:string?,
$pattern as xs:string,
$flags as xs:string) as xs:boolean

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, itis interpretedas thezero-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], where regular expressions are implicitly anchored.

An error is raised [invalid regular expression]if the value of $pattern is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

An error is raised [invalid regular expression flags]if the value of $flags is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

7.6.3 fn:replace

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

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, itis interpretedas the zero-lengthstring.

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, the variables $1 to $9 may be used to refer to the substring captured by each of the first nine parenthesized sub-expressions in the regular expression. $0 refers to the substring captured by the regular expression as a whole. A literal "$" symbol must be written as "\$". A literal "\" symbol must be written as "\\". For each match of the pattern, these variables are assigned the value of the content of the relevant captured sub-expression, and the modified replacement string is then substituted for the characters in $input that matched the pattern.

If a variable $n is present in the replacement string, but there is no nth captured substring (which may happen because there were fewer than n parenthesized sub-expressions, or because the nth parenthesized sub-expression was not matched) then the variable is replaced by a zero-length string.

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 [invalid regular expression]if the value of $pattern is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

An error is raised [invalid regular expression flags]if the value of $flags is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

An error is raised [regular expression matches zero-length string]if the patternmatches 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 [invalid replacement string]if the value of $replacement contains a "$" character that is not immediately followed by a digit 1-9 and not immediately preceded by a "\".

An error is raised [invalid replacement string]if the value of $replacement contains a "\" character that is not part of a "\\" pair, unless it is immediately followed by a "$" character.

7.6.4 fn:tokenize

fn:tokenize($input as xs:string?,
$pattern as xs:string,
$flags as xs:string) as xs: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 way as for the fn:matches() function.

If $input is the empty sequence, the result is the zero-length string.

If the supplied $pattern matches a zero-length string, thatis, if fn:matches("",$pattern, $flags) returnstrue,then an error is raised: [regular expression matches zero-length string].

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 [invalid regular expression]if the value of $pattern is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

An error is raised [invalid regular expression flags]if the value of $flags is invalid according to the rules described in section 7.6.1 Regular Expression Syntax.

8 Functions and Operators on Boolean Values

This section defines functionsand operators on the [XML Schema Part 2: Datatypes] boolean datatype.

9 Functions and Operators on Durations, Dates and Times

This section discusses operations on the [XML Schema Part 2: Datatypes] date and time types. Italso discusses operations on two subtypes of xs:duration that are defined in this document. See 9.2 Two Totally Ordered Subtypes of Duration.

The functions described in this section follow the principle of locale-independent storage for these datatypes that originated with [XML Schema Part 2: Datatypes]. Thus, a single calendar (Gregorian) and a single timezone (UTC) is chosen to represent normalized date and time values. Since the value tuple (See Section 3.3.1 Mapping PSVI Additions to TypesDM) also contains the timezone specified in the lexical representation, applicationsand other processing systems are free to present this information in locale-specific representations.

9.1 Duration, Date and Time Types

The operators described in this section are defined on the following date and time types:

In addition, operators are defined on the 9.2 Two Totally Ordered Subtypes of Duration:

  • xdt:yearMonthDuration

  • xdt:dayTimeDuration

No operators are defined on the [XML Schema Part 2: Datatypes] datatype xs:duration. Appendix C.6 Working With xs:duration Values discusses how to work with xs:duration values.

9.1.1 Limits andPrecision

For a number of the above datatypes [XML Schema Part 2: Datatypes] 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.

For this specification, 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.

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 9.7 Adding and Subtracting Durations From dateTime, date and time. In these situations, the processor ·must· return zero in case of underflow and ·must· raise an error [overflow in date/time arithmetic]in case of overflow.

The value spaces of the two totally ordered subtypes of xs:duration described in 9.2 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 9.5 Arithmetic Functions on xdt:yearMonthDuration and xdt:dayTimeDuration. In these situations the processor ·must· return zero in case of underflow and ·must· raise an error [overflow in duration arithmetic]in case of overflow.

9.2 Two Totally Ordered Subtypes of Duration

Two totally ordered subtypes of xs:duration are defined in this specification using the mechanisms described in [XML Schema Part 2: Datatypes] for defining user-defined types. They are available in the namespace http://www.w3.org/2003/11/xpath-datatypes.

Note:

The W3C XML Query Working Group has requested the W3C XML Schema Working Group that these two subtypes of xs:duration be included in the built-in datatypes described in [XML Schema Part 2: Datatypes]. If the W3C XML Schema Working Group agrees to this request, these two datatypes will be removed from the above name space and moved into the XML Schema namespace http://www.w3.org/2001/XMLSchema.

9.2.1 xdt:yearMonthDuration

[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.

xdt:yearMonthDuration is derived from xs:duration as follows.

<xs:simpleType name='yearMonthDuration'>
    <xs:restriction base='xs:duration'>
        <xs:pattern value="[\-]?P[0-9]+(Y([0-9]+M)?|M)"/>
    </xs:restriction>
</xs:simpleType>
9.2.1.1 Lexical representation

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 prededing digit and M must have one preceding digit.

9.2.2 xdt:dayTimeDuration

[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. xdt:dayTimeDuration is derived from xs:duration as follows. To make the long pattern easier to read, it has been formatted on six lines using additional new line andspace characters in the pattern string. These additional characters should notbe interpreted as part of the pattern.

<xs:simpleType name='dayTimeDuration'>
    <xs:restriction base='xs:duration'>
     	 <xs:pattern value="[\-]?P([0-9]+D(T([0-9]+(H([0-9]+(M([0-9]+(\.[0-9]*)?S
     	 	|\.[0-9]+S)?|(\.[0-9]*)?S)|(\.[0-9]*)?S)?|M([0-9]+
     	 	(\.[0-9]*)?S|\.[0-9]+S)?|(\.[0-9]*)?S)|\.[0-9]+S))?
     	 	|T([0-9]+(H([0-9]+(M([0-9]+(\.[0-9]*)?S|\.[0-9]+S)?
     	 	|(\.[0-9]*)?S)|(\.[0-9]*)?S)?|M([0-9]+(\.[0-9]*)?S|\.[0-9]+S)?
     	 	|(\.[0-9]*)?S)|\.[0-9]+S))"/>
    </xs:restriction>
</xs:simpleType>
9.2.2.1 Lexical representation

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.

9.2.2.3 Canonical representation

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], 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. 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".

9.3 Comparisons of Duration, Date and Time Values

OperatorMeaning
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: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] date, time and duration datatypes. Each operator takes two operands of the same type and returns a boolean result. As discussed in [XML Schema Part 2: Datatypes], the order relation on xs:duration and the date and time datatypes is not a total order but, rather, a partial order. For this reason, no functions are defined on xs:duration. A full complement of comparison and arithmetic functions are defined on the two subtypes of duration described in 9.2 Two Totally Ordered Subtypes of Duration.

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 evaluation context, is assumed to be present as part of the value. This creates a total order for all date and time values. The order relations on date and time datatypes is defined in [XML Schema Part 2: Datatypes].

Note that for xs:dateTime, xs:date and xs:time, as discussed in 1.6 xs:dateTime,of xs:date andargument(s). These xs:time values the value is defined as a tuple. Comparison operators on these three datatypes operate on the first, or normalized value, part of the tuple and disregard the second, or timezone, part of the tuple. If the timezone part is (), the implicit timezone is used to adjust the normalized value as necessary.

9.4 Component Extraction Functions on Duration, Date and Time Values

The duration, date and time datatypes may be considered to be composite datatypes in that they contain distinct components. The extraction functions specified below extract a single component from a duration, date or time value. For xs:dateTime, xs:date and xs:time the localized value is used. To get the value of a component from the normalized value, the xs:dateTime, xs:date or xs:time must first be adjusted to UTC or timezone Z. This is illustrated in some of the examples in this section.

FunctionMeaning
fn:get-years-from-yearMonthDuration Returns the year component of an xdt:yearMonthDuration value.
fn:get-months-from-yearMonthDuration Returns the months component of an xdt:yearMonthDuration value.
fn:get-days-from-dayTimeDuration Returns the days component of an xdt:dayTimeDuration value.
fn:get-hours-from-dayTimeDuration Returns the hours component of an xdt:dayTimeDuration value.
fn:get-minutes-from-dayTimeDuration Returns the minutes component of an xdt:dayTimeDuration value.
fn:get-seconds-from-dayTimeDuration Returns the seconds component of an xdt:dayTimeDuration value.
fn:get-year-from-dateTime Returns the year from an xs:dateTime value.
fn:get-month-from-dateTime Returns the month from an xs:dateTime value.
fn:get-day-from-dateTime Returns the day from an xs:dateTime value.
fn:get-hours-from-dateTime Returns the hours from an xs:dateTime value.
fn:get-minutes-from-dateTime Returns the minutes from an xs:dateTime value.
fn:get-seconds-from-dateTime Returns the seconds from an xs:dateTime value.
fn:get-timezone-from-dateTime Returns the timezone from an xs:dateTime value.
fn:get-year-from-date Returns the year from an xs:date value.
fn:get-month-from-date Returns the month from an xs:date value.
fn:get-day-from-date Returns the day from an xs:date value.
fn:get-timezone-from-date Returns the timezone from an xs:date value.
fn:get-hours-from-time Returns the hours from an xs:time value.
fn:get-minutes-from-time Returns the minutes from an xs:time value.
fn:get-seconds-from-time Returns the seconds from an xs:time value.
fn:get-timezone-from-time Returns the timezone from an xs:time value.

9.5 Arithmetic Functions on xdt:yearMonthDuration and xdt:dayTimeDuration

FunctionMeaning
op:add-yearMonthDurations Adds two xdt:yearMonthDurations. 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:decimal. Returns an xdt:yearMonthDuration.
op:divide-yearMonthDuration Divides an xdt:yearMonthDuration by an xs:decimal. Returns an xdt:yearMonthDuration.
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:decimal. Returns an xdt:dayTimeDuration.
op:divide-dayTimeDuration Divides an xdt:dayTimeDuration by an xs:decimal. Returns an xdt:dayTimeDuration.

9.6 Timezone Adjustment on dateTime, date and time Values

FunctionMeaning
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.

Thesefunctions adjust an xs:dateTime, xs:date or xs:timevalue to thegiven or implicittimezone.

9.6.1 fn:adjust-dateTime-to-timezone

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 evaluation context.

If $arg is the empty sequence, then the result is the empty sequence.

A dynamic error is raised (invalid timezone value) if $timezone is less than -PT14H00M or greater than PT14H00M.

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.

9.6.2 fn:adjust-date-to-timezone

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 evaluation context.

If $arg is the empty sequence, then the result is the empty sequence.

A dynamic error is raised (invalid timezone value) if $timezone is less than -PT14H00M or greater than PT14H00M.

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 $timezone is not the empty sequence, then the result is $arg with $timezone as its timezone component.

9.6.3 fn:adjust-time-to-timezone

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 evaluation context.

If $arg is the empty sequence, then the result is the empty sequence.

A dynamic error is raised (invalid timezone value) if $timezone is less than -PT14H00M or greater than PT14H00M.

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:

9.7 Adding and Subtracting Durations From dateTime, date and time

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] describes an algorithm for performing such operations.

If any of the arguments to the functions below is an xs:dateTime, xs:date or xs:time that does not contain an explicit timezone then, for the purpose of the operation, an implicit timezone, provided by the evaluation context, is assumed to be present as part of the value.

FunctionMeaning
fn:subtract-dateTimes-yielding-yearMonthDuration Returns the difference between two xs:dateTimes as an xdt:yearMonthDuration.
fn:subtract-dateTimes-yielding-dayTimeDuration Returns the difference between two xs:dateTimes as an xdt:dayTimeDuration.
op:subtract-dates Returns the difference between two xs:dates as an xdt:dayTimeDuration.
op:subtract-times Returns the difference between two xs:times 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.

9.7.5 op:add-yearMonthDuration-to-dateTime

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. 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.

9.7.6 op:add-dayTimeDuration-to-dateTime

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. 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.

9.7.7 op:subtract-yearMonthDuration-from-dateTime

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. 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.

9.7.8 op:subtract-dayTimeDuration-from-dateTime

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. 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.

9.7.9 op:add-yearMonthDuration-to-date

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. If $arg2 is negative, then the xs:date returned 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:date and xdt:yearMonthDuration values.

9.7.10 op:add-dayTimeDuration-to-date

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. If $arg2 is negative, then the xs:date returned 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:date and xdt:dayTimeDuration values.

9.7.11 op:subtract-yearMonthDuration-from-date

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. If $arg2 is negative, then the xs:date returned 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:date and xdt:yearMonthDuration values.

9.7.12 op:subtract-dayTimeDuration-from-date

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 normalized value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes]. If $arg2 is negative, then the xs:date returned 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:date and xdt:dayTimeDuration values.

10 Functions Related to QNames

10.1 Additional Constructor Functions for QNames

This section defines additional constructor functions for QName as defined in [XML Schema Part 2: Datatypes]. Leading and trailing whitespace, if present, is stripped from string arguments before the result is constructed.

FunctionMeaning
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:expanded-QName Returns an xs:QName with the namespace URI given in the first argument and the local name in the second argument.

10.1.1 fn:resolve-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 [invalid lexical value].

If $qname is the empty sequence, returns the empty sequence. If $element is the empty sequence, an error is raised [invalid lexical value].

More specifically, the function searches the namespace nodes of $element for a node 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 node.

If the $qname has a prefix and if there is no namespace node for $element that matches this prefix, then an error is raised [no namespace found for prefix].

If the $qname has no prefix, and there is no namespace node for $element corresponding tothe default (unnamed) namespace, then the resulting expanded QName has no namespace part.

10.2 Operators and Functions Related to QNames

This section discusses functions on QNames as defined in [XML Schema Part 2: Datatypes].

FunctionMeaning
op:QName-equal Returns true if the local names and namespace URIs of the two arguments are equal.
fn:get-local-name-from-QName Returns an xs:string representing the local name of the xs:QName argument.
fn:get-namespace-uri-from-QName
fn:get-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:get-in-scope-prefixes Returns the prefixes of the in-scope namespaces for the given element.

11 Functions and Operators for anyURI

This section specifies functions that take anyURI as arguments.

FunctionMeaning
fn:resolve-uri Returns an
xs:string
representing an absolute xs:anyURI given a base URI and a relative URI.
op:anyURI-equal Returns true if the two arguments are equal.

11.1 fn:resolve-uri

Summary:If$relative isa relative URI reference,the first formof this functionresolves it against the valueof the base-uri property from the static context. If $relative is an absolute URI reference ,it is returned unchanged. If thebase-uri property is not initialized in the static context anerror is raised [base uri not defined in the static context].

The secondform of this functionexpects $base tobe an absolute URI and $relative tobe an absolute or a relativeURI reference as definedin [RFC 2396]. If $relativeis a relative URI reference, it is resolvedagainst the base-uri, $base, andthe resultingabsolute URI reference is returned. If $relative is an absolute URI reference,it is returned unchanged. If $baseis not an absolute URI,an error is raised [base uri argument to fn:resolve-uri is not an absolute uri].

If$relativeor $base is not a valid anyURIan error is raised [invalid argument to fn:resolve-uri()].

If $relative isthe empty sequence, the empty sequence isreturned.

Note:

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 [base uri not defined in the static context]) and $base in the second form.

Note:

Resolving a URI does not dereference it. This is merely a syntactic operation on two character strings.

12 Functions and Operators on base64Binary and hexBinary

13 Functions and Operators on NOTATION

14 Functions and Operators on Nodes

This section discusses functions and operators on nodes. Nodes are formally defined in Section 6 NodesDM.

14.1 Functions and Operators on Nodes

FunctionMeaning
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:string for the xs:QName of the argument node or the context node if the argument is omitted. This may be the zero-length string if the xs:QName is in no namespace.
fn:number Returns the value of the context node or the specified item converted to an xs:double.
fn:lang Returns true or false, depending on whether the language of 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 operating on a PurchaseOrderdocument containing a number of line-item elements. Each line-item has child elements called description, price, quantity, etc. Quantity has simple content of type xs:decimal. Further assume that variables $item1, $item2, etc. are each bound to singleline-item element nodes in the document in sequenceand that the value of the quantity child of the first line-item is 5.0.

14.1.1 fn:name

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 there is no context node (that is, if there is no context item, or if the context item is not a node), the zero-length string is returned.

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 node having no name), the function returns the zero-length string.

Otherwise, the value returned is an xs:string whose lexical form is an xs:QName.

If $arg is a processing instruction or a namespace 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.3 node-name AccessorDM) is in no namespace, then the function returns the local part of the expanded-QName.

If $arg is an attribute node whose expanded-QName is in a namespace, then a prefix is determined using the following rule: if the attribute has a parent, in the same way that a prefix would beconstructed for that element, otherwise a non-empty prefix is chosen arbitrarily, and no attempt is made to associatethe prefix with the namespace URI.

If $arg is an element node whose expanded-QName is in a namespace, then a prefix is determinedusing the following rules: if the element has at least one namespace node whose namespace URI is the same as the namespace name of the xs:QName returned by the fn:node-name, it returns the local part of the name of that namespace node or the empty string if thenamespace node has no name. If there are several such namespace nodes, it chooses one of them arbitrarily. If there is no such namespace node, it generates an arbitrary prefix that is distinct from the fn:node-name of any of the element node's namespaces. The prefix is the empty stringif the element has an empty namespace name i.e. if it isin the nullnamespace.

This prefix is then combined with the local part of the node's expanded-QName to form a string which will take one of the forms "prefix:local-part" (if the prefix is a non-zero length string) or "local-part" (if the prefix is a zero-length string).

Note:

Some host languages, such as [XQuery 1.0: An XML Query Language], will never provide a namespace node as an argument to this function.

14.1.4 fn:number

Summary: Returns the value indicated by $arg or, if $arg is not specified, the context node, converted to an xs:double. If there is no context node (that is, if there is no context item, or if the context item is not a node), NaN is returned.

If $arg, or the context node, is the empty sequence, the xs:double value NaN is returned.

If $arg, or the context node, is atomic, the value obtained by converting it to xs:double following the rules of 17.8 Casting to numeric types is returned..

If $arg, or the context node, is a node with an atomic type, itsvalue converted to xs:double following the rules of 17.8 Casting to numeric types is returned..

Otherwise, $arg, or the context node, is convertedto an xs:string as if by a call to the fn:string() function and the result converted to an xs:double following the rules of 17.8 Casting to numeric types.

If the conversion to xs:double fails because the lexical representation is not a valid lexical representation of a numeric simple type as defined in [XML Schema Part 2: Datatypes], the xs:double value NaN is returned.

14.1.5 fn:lang

Summary:Thisfunction tests whether the language of the context node, as specifiedby xml:lang attributes is the same as, or is a sublanguage of, the language specified by $testlang. If there is no context node (that is, if there is no context item, or if the context item is not a node), then returns false. The language of the context node is determined by the value of the xml:lang attribute on the context node, or, if the context node has no such attribute, by the value of the xml:lang attribute on the nearest ancestor of the context node that has an xml:lang attribute. If there is no such ancestor, then returns false

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 ignoring case, or if the string-value of the relevant testlang attribute contains a hyphen, "-" (The character "-" isHYPHEN-MINUS, %x002D) such that the part of the string-value preceding that hyphen is equal to $testlang, ignoring case.

14.1.9 fn:root

Summary: Returns the root of the tree to which $arg belongs. This will usually, but not necessarily, be a document node.

If the function is called without an argument, the context item is used as the default argument. If there is no context node (that is, if there is no context item, or if the context item is not a node), an error is raised [context item is not a node].

14.1.9.1 Examples

Theseexamples 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 [XSLT 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:

We could make the final three examples type-safe by wrapping their operands with fn:exactly-one().

15 Functions and Operators on Sequences

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 [XPath 2.0].

15.1 Functions and Operators on Sequences

The following functions are defined on sequences.

FunctionMeaning

Functions fn:zero-or-one, fn:one-or-more, and fn:exactly-one check that the length 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] 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.

As in the previous section, for the illustrative examples below, assume an XQuery operating on a 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 individual line-item nodes in the sequence.

15.1.6 fn:index-of

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: Returnsa 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 items in the sequence $seqParam are compared with $srchParam under the rules for the eq operator, using the selected collation when comparing strings. If the type of the items in $seqParam is not xs:string and $collation is specified, the collation is ignored. If an item compares equal, then the position of that item in the sequence $srchParam is included in the result. If the items are not comparable, then an error is raised [items not comparable].

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.

15.1.9 fn:distinct-values

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 eqoperator is not defined for their types, are consideredto bedistinct.

Thecollation used by the invocation of this functionis determinedaccording to the rules in 7.3.1 Collations.

If $arg is the emptysequence, theempty sequence is returned.

Values oftype xdt:untypedAtomicare compared as if theywere of type xs:string.

For xs:float and xs:double values, 0.0 is equal to -0.0 and, although NaN does not equal itself, if $arg contains multipleNaN values a single NaN is returned.

If an xs:dateTime, xs:date or xs:time value does not have a timezone, an implicit timezone is provided by the evaluation context. The normalized value is adjusted using this implicit timezone if necessary. The adjusted normalized value is used to compute distinctness.

Equality of string values is determined according to the collation that is used. If the type of the items in $argisnot xs:stringand $collationis specified,the collation is ignored.

Whichvalue of a set of values that compare equal is returned, alongwithits original type annotation, is ·implementation dependent·. Notethat xs:dateTime, xs:date or xs:time values can compare equal even if their timezones are different. The order in whichthe sequence of valuesis returned is ·implementation dependent·.

15.1.13 fn:subsequence

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. More specifically, returns the items in $sourceString whose position $p obeys:

fn:round($startingLoc) <= $p < fn:round($startingLoc) + fn:round($length)

In the above computation, the rules for op:numeric-less-than() and op:numeric-greater-than() apply.

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 6.2.9 The fn:subsequence functionFS

15.1.14 fn:unordered

Summary: This function takes a sequence, or more typically, an expression, that evaluates to a sequence, as input and returns an arbitrary ·implementation dependent· permutationof the input sequence. Query optimizers may be able to do a better job if the orderof the output sequence is not specified. For example, if you want to retrieve all the prices from a purchase order, and if there is an index on prices, it may be possible to compute an unordered result more efficiently.

15.2 Equals, Union, Intersection and Except

FunctionMeaning

As in the previous sections, for the illustrative examples below, assume an XQuery 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.

15.2.1 fn:deep-equal

fn:deep-equal($parameter1 as item()*,
$parameter2 as item()*,
$collation as string) as xs:boolean

Summary: If the sequences that are the values of $parameter1 and $parameter2 have the same values (that is, they have the same number of items and items in corresponding positions in the two sequences compare equal), the function returns true; otherwise, the function returns false. Equality of corresponding items is determined based on the eq operator if they are atomic values and based on deep equality of nodes, as defined below, if they are nodes.

Returns true if both of its arguments are the empty sequence. Returns false if one, but not both, of its arguments is the empty sequence.

If equality is not defined for the types of two corresponding values the function returns false.

String values are compared using a collation. If the type of the items in $parameter1 and $parameter2 is not xs:string and $collation is specified, the collation is ignored.

15.2.1.1 Deep Equality of Nodes

The following (recursive) tests are applied in order to determine whether two nodes are deep equal. This uses a function called is-namespace-node()which checks, by elimination, whethera nodeis anamespace node. Notethat somehost languages may not support namespace nodes.

Returntrue if thethe two nodes have names that compare equal as xs:QNamesor if they do not have names.

Nowperform specific tests based on the kind of nodes in hand. First,test element nodes:

Testtextnodes by comparing their string values:

Here is the complete algorithm:

if ($parameter1 instance of element() and not ($parameter2 instance of
element())) then fn:false() else

if ($parameter1 instance of attribute() and not ($parameter2 instance of
attribute())) then fn:false() else

if ($parameter1 instance of text() and not ($parameter2 instance of
text())) then fn:false() else

if ($parameter1 instance of comment() and not ($parameter2 instance of
comment())) then fn:false() else

(: if ($parameter1 instance of document-node() and not ($parameter2
instance of document-node())) then fn:false() else :)

if ($parameter1 instance of processing-instruction() and
 not ($parameter2 instance of processing-instruction())) then fn:false() else 

if (is-namespace-node($parameter1) and not is-namespace-node($parameter2)) 
   then fn:false()
   else 
if (not(fn:deep-equal(fn:node-name($parameter1), fn:node-name($parameter2)))) 
then fn:false()
else

if ($parameter1 instance of element()) then      (: element nodes :)  
  if (some $a1 in $parameter1/@* satisfies       (: have attributes :)
      not (some $a2 in $parameter2/@* 
           satisfies fn:deep-equal($a1, $a2, $collation))
      or (some $a2 in $parameter2/@* satisfies
      not (some $a1 in $parameter1/@* 
           satisfies fn:deep-equal($a1, $a2, $collation))))
then fn:false() else

if ($parameter1 instance of element(*, xs:anySimpleType) and 
     ($parameter2 instance of element(*, xs:anySimpleType))
       return fn:deep-equal(fn:data($parameter1), fn:data($parameter2))
     else 
     if (not ($parameter1 instance of element(*, xs:anySimpleType)) and 
      not ($parameter2 instance of element(*, xs:anySimpleType))) then
                               (:compare children recursively :)
        return fn:deep-equal( $parameter1/(* | text()),  
                       $parameter2/(* | text()), $collation )
     else return fn:false()
else 
    
if ($parameter1 instance of attribute()) then    (: attribute nodes :)
   fn:deep-equal( fn:data($parameter1), fn:data($parameter2), $collation
)
else

if ($parameter1 instance of text()) then
   fn:compare
     (fn:string($parameter1), fn:string($parameter2), $collation) ne 0
else

if ($parameter1 instance of comment()) then
   fn:compare
     (fn:string($parameter1), fn:string($parameter2), $collation) ne 0
else

if ($parameter1 instance of processing-instruction()) then
   fn:compare
        (fn:string($parameter1), fn:string($parameter2), $collation) ne 0
else  (: Must be a namespace node by elimination :)
   fn:compare (fn:string($parameter1), fn:string($parameter2)) ne 0

15.3 Aggregate Functions

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.

FunctionMeaning
fn:count Returns the number of items in a sequence.
fn:avg Returns the average of a sequence of values.
fn:max Returns the member with maximum value from a sequence of comparable values.
fn:min Returns the member with minimum value from a sequence of comparable values.
fn:sum Returns the sum of a sequence of values.

15.3.3 fn:max

Summary:Selectsanitem 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·.

Any values of typexdt:untypedAtomic in the sequence $arg are cast to xs:double.The items in the resulting sequencemay be reordered in an arbitrary order. The resulting sequence is referred to below as theconverted sequence.

If the converted sequenceis empty, the empty sequence is returned.

Ifthe converted sequence contains thevalue NaN, the valueNaNis returned.

$arg must contain only items of a single type or one if its subtypes for which the gt operator is defined. 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. In addition, the values in the sequence must have a total order. If date/time values do not have a timezone, the implicit timezone provided by the evaluation context is added and the adjusted normalized value is used in the calculation. 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 an error is raised [invalid argument to aggregate function].

If theitems inthe valueof $arg are oftypexs:string or typesderived by restriction from xs:string,then the determination of the greatest item is madeaccording to the collationthat is used. If the type of the items in $arg isnot xs:stringand $collationis 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 theresult of theexpression:

   if (every $v in $c satisfies $c[1] ge $v)) 
   then $c[1] 
   else fn:max(fn:subsequence($c, 2))]

evaluatedwith$collation as the default collation if specified, and with $c as the converted sequence.

Note:

If the converted sequence contains exactly onevalue then that value is returned.

Note:

The default type whenthe fn:max function is applied to xdt:untypedAtomic values is xs:double.This differs from the default typeforoperators such as lt,and for sorting in XQuery and XSLT, which is xs:string.

15.3.4 fn:min

Summary:selectsan 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·.

Any values of typexdt:untypedAtomic in the sequence $arg are cast to xs:double. The itemsin the resulting sequence may be reordered in an arbitrary order. The resultingsequence is referred to below as theconverted sequence.

If the convertedsequence is empty, the empty sequenceis returned.

If the converted sequence contains the valueNaN, the valueNaNis returned.

$arg must contain only items of a single type or one if its subtypes for which the gt operator is defined. 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. In addition, the values in the sequence must have a total order. If date/time values do not have a timezone, the implicit timezone provided by the evaluation context is added and the adjusted normalized value is used in the calculation. 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 an error is raised [invalid argument to aggregate function].

If theitems inthe valueof $arg are oftypexs:string or typesderived by restriction from xs:string,then the determination of the greatest item is madeaccording to the collationthat is used. If the type of the items in $arg isnot xs:stringand $collationis 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 theresult of theexpression:

   if (every $v in $c satisfies $c[1] le $v)) 
   then $c[1] 
   else fn:min(fn:subsequence($c, 2))]

evaluatedwith$collation as the default collation if specified, and with $c as the converted sequence.

Note:

If the converted sequence contains exactly onevalue then that value is returned.

Note:

The default type whenthe fn:max function is applied to xdt:untypedAtomic values is xs:double.This differs from the default typefor operators such as lt,and for sorting in XQuery and XSLT, which is xs:string.

15.3.5 fn:sum

fn:sum($arg as xdt:anyAtomicType*,
$zero as xdt:anyAtomicType?) as xdt:anyAtomicType?

Summary: Returns a value obtainedby adding together the values in $arg. If the single-argument form of the functionis used, then the value returned for an empty sequence isthe xs:doublevalue0.0e0. If the two-argument form is used, then the value returned for an empty sequence is the value of the $zero argument.

If the above conditions are not met, an error is raised [invalid argument to aggregate function].

Otherwise,the result of the functionis theresult ofthe expression:

$c[1] + fn:sum(subsequence($c, 2))

where$c is the converted sequence.

For detailed type semantics, see Section 6.2.6 The fn:min, fn:max, fn:avg, and fn:sum functionsFS.

Note:

The second argument allows an appropriate value to be defined to represent thesum 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".

Note:

If the converted sequence contains exactly one value then that value is returned.

15.4 Functions and Operators that Generate Sequences

FunctionMeaning

15.4.2 fn:id

Summary: Returns the sequence of element nodes with ID values matching the values of one or more of the IDREF values supplied in $arg.

The result of the function is a sequence, in document order, of those elements that are in the same document as the context node, and that have an ID value equal to one or more of the IDREFs in the list of candidate IDREFs. An element has an ID value of V if it has an attribute whose type is xs:ID and whose value is V, or if the element itself is of (simple) type xs:ID and has a value of V.

An ID value matches a candidate IDREF if they consist of the same sequence of Unicode code-points. The default collation is not used in the comparison.

An error is raised[no context document]if there is no context item, or if the context item is not a node, or if thecontext item is a node in a tree whose root is not a document node.

No error is raised in respect of an IDREF value that does not match the ID of any element in the document. If no IDREF value matches any element, the function returns the empty sequence.

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 attribute that has a declared type of ID, but whose value does not conform to the lexical rules for an ID. Such an element will never be selected by this function.

15.4.4 fn:doc

Summary: Retrieves a document using anxs:anyURIsupplied as an xs:string. If $uri is not avalid xs:anyURI, an error is raised [invalid argument to fn:doc()].If it is a relative URI, it is resolved relative to the value of the base URI property from the static context.

$urimust not contain a fragment identifier.

If $uri is the empty sequence, the result is an empty sequence.

Note:

If $uriis 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 this function.

This function is ·stable·. Two calls on this function return the same document node if the same URI (after resolution to an absolute URI) 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")

If two calls on this function supply different absolute URIs, the same document node may be returned if the implementation can determine that the two URIs refer to the same resource.

The default processing performed by this function is as follows. The resource identified by the URI is retrieved. If the resource cannot be retrieved, an error is raised ("Error retrieving resource"). 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 [error parsing contents of resource].Otherwise, the result of the function is the document node at the root of the resulting tree.

The following 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.

  • 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.

For detailed type semantics, see Section 6.2.2 The fn:collection and fn:doc functionsFS.

16 Context Functions

The following functions are defined to obtain information from the evaluation context. The context is always defined but may be the empty sequence.

FunctionMeaning

17 Casting

Constructor functions and cast expressions accept an expression and return a value of a given type. Theyboth convert a value to a given type 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] built-in type (see 5.1 Constructor Functions for XML Schema Built-in Types) or user-derived type (see 5.2 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 " .

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.

If the empty sequence is passed to a cast expression an error is raised [invalid value for cast] .

17.1 Casting from primitive types to primitive types

This section defines casting between the 19 primitive types defined in [XML Schema Part 2: Datatypes] as well as xdt:untypedAtomic and the two derived types xdt:yearMonthDuration and xdt:dayTimeDuration. 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 succeedfor some values in the value space and fails for others.

Casting is notsupported to or from xs:anySimpleType. Thus, there is no row or column forthis 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 values with the type annotation xs:anySimpleType at runtime.

In the following table, the columns and rows are identified by short codes that identify simple types as follows:

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\TuAstrfltdbldecduryMDdTDdTtimdatgYMgYrgMDgDaygMonboolb64hxBaURIQNNOT
QNNNNNNNNNNNNNNNNNNNNYN
NOTYNNNNNNNNNNNNNNNNNNNY

17.2 Casting to derived types

Casting a value to a derived type can be separated into three cases:

  1. When the supplied value is an instance of a type that is derived by restriction from the target type. This is described in section 17.3 Casting from derived types to parent types.

  2. When the supplied value is of a type derived by restriction from the same primitive type as the target type. This is described in 17.4 Casting within a branch of the type hierarchy.

  3. When the derived type is derived, directly or indirectly, from a different primitive type than the source type. This is described in 17.5 Casting across the type hierarchy.

  4. When the supplied value is an instance of the target type, the cast always succeeds (Identity cast).

17.4 Casting within a branch of the type hierarchy

It is possible to cast a value to a target type if the type of the source value and the target 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. For example an instance of xs:byte can be cast to xs:unsignedShort, provided the value is not negative. This includes the case where the target type is derived from the type of the supplied value, as well as the case where both derive from a common supertype.

If the value does not conform to the facets defined for the target type, then an error is raised [invalid value for cast].See [XML Schema Part 2: Datatypes]. 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 data type (or the result of casting the value to a 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 sourcetype. 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:integerto my:distance will always fail, because the canonical representation of an xs:integerdoes not conform to this pattern.

In some cases, casting from a parent type to a derived type requires special rules. See 17.8 Casting to numeric types for rules regarding casting to xs:integer and 17.9 Casting to duration types for rules regarding casting to xdt:yearMonthDuration and xdt:dayTimeDuration.

17.7 Casting to xs:stringand xdt:untypedAtomic

Casting is permitted from any primitive type, except xs:QName,to the primitive types xs:stringand xdt:untypedAtomic.

When a value of any simple type is cast to xs:string, the derivation of the xs:string value TV depends on the source type ST and on the source value SV, as follows.

To cast to xdt:untypedAtomic the value is cast to xs:string, as described above, and the type annotation changed to xdt:untypedAtomic.

Note:

The string representations ofnumeric valuesare backwards compatible with XPath 1.0 exceptforthe special values positiveand negativeinfinity, and for values outside the range 1.0e-6 to 1.0e+6.

17.8 Casting to numeric types

17.8.1 Casting to xs:float

When a value of any simple type is cast to xs:float, the xs:float TV is derived from the source type ST and the source value SV as follows:

Note:

Implementations ·may· return negative zero for "-0.0E0" cast to xs:float.

17.10 Casting to date and time types

In several situations, casting to date and time types requires the extraction of a component from the source value 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 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 of efficiency.

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 := ($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:get-hours-from-dayTimeDuration($tz)
     let $tzm := fn:get-minutes-from-dayTimeDuration($tz)
     let $plusMinus := if ($tzh >= 0) then "+" else "-"
     let $tzhSimpleString := fn:abs($tzh) cast as xs:string
     let $tzhString := if (fn:length($tzhSimpleString) < 2)
                     then fn:concat("0", $tzhSimpleString)
                     else $tzhSimpleString
     let $tzmSimpleString := fn:abs($tzm) cast as xs:string
     let $tzmString := if (fn:length($tzmSimpleString) < 2)
                     then fn:concat("0", $tzmSimpleString)
                     else $tzmSimpleString
     return fn:concat($plusMinus, $tzhString, ":", $tzmString)
}

Conversion from primitive types to date and time types follows the rules below.

  1. When a value of any primitive type is cast to xs:dateTime, xs:time, xs:date, xs:gYearMonth, xs:gYear, xs:gMonthDay, xs:gDay, or xs:gMonth,

    let CYR be eg:convertToYearCharString( fn:get-year-from-dateTime( fn:current-dateTime())),

    let CMO be eg:convertTo2CharString( fn:get-month-from-dateTime( fn:current-dateTime())),

    let CDA be eg:convertTo2CharString( fn:get-day-from-dateTime( fn:current-dateTime() )) and

    let CTZ be eg:convertTZtoString(fn:get-timezone-from-dateTime(fn:current-dateTime() ).

  2. When a value of any primitive type is cast to xs:dateTime, the xs:dateTime value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:dateTime, then TV is SV.

    • If ST is xs:time, then let SHR be eg:convertTo2CharString(fn:get-hours-from-time( SV )) , let SMI be eg:convertTo2CharString(fn:get-minutes-from-time( SV )), let SSE be eg:convertSecondsToString(fn:get-seconds-from-time( SV )) and let STZ be eg:convertTZtoString( fn:get-timezone-from-time(SV)) ; TV is xs:dateTime( fn:concat( CYR , '-', CMO , '-', CDA , 'T', SHR , ':', SMI , ':', SSE, STZ ) ).

    • If ST is xs:date, then let SYR be eg:convertYearToString(fn:get-year-from-date( SV )), let SMO be eg:convertTo2CharString(fn:get-month-from-date( SV )), let SDA be eg:convertTo2CharString(fn:get-day-from-date( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-date(SV)) ; TV is xs:dateTime( fn:concat( SYR , '-', SMO , '-', SDA , 'T00:00:00 ', STZ ) ).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string and TV is xs:dateTime( IV ).

  3. When a value of any primitive type is cast to xs:time, the xs:time value TV is derived from the source type ST and the source value 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:get-hours-from-dateTime( SV )),':', eg:convertTo2CharString(fn:get-minutes-from-dateTime( SV )), ':', eg:convertSecondsToString(fn:get-seconds-from-dateTime( SV )),eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )))).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:time( IV ).

  4. When a value of any primitive type is cast to xs:date, the xs:date value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:date, then TV is SV.

    • If ST is xs:dateTime, then let SYR be eg:convertYearToString(fn:get-year-from-dateTime( SV )), let SMO be eg:convertTo2CharString(fn:get-month-from-dateTime( SV )), let SDA be eg:convertTo2CharString( fn:get-day-from-dateTime( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )); TV is xs:date( fn:concat( SYR , '-', SMO , '-', SDA, STZ ) ).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:date( IV ).

  5. When a value of any primitive type is cast to xs:gYearMonth, the xs:gYearMonth value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:gYearMonth, then TV is SV.

    • If ST is dateTime, then let SYR be eg:convertYearToString(fn:get-year-from-dateTime( SV )), let SMO be eg:convertTo2CharString(fn:get-month-from-dateTime( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )); TV is xs:gYearMonth( fn:concat( SYR , '-', SMO, STZ ) ).

    • If ST is date, then let SYR be eg:convertYearToString(fn:get-year-from-date( SV )), let SMO be eg:convertTo2CharString( fn:get-month-from-date( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-date( SV )); TV is xs:gYearMonth( fn:concat( SYR , '-', SMO, STZ ) ).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:gYearMonth( IV ).

  6. When a value of any primitive type is cast to xs:gYear, the xs:gYear value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:gYear, then TV is SV.

    • If ST is dateTime, let SYR be eg:convertYearToString(fn:get-year-from-dateTime( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )); TV is xs:gYear( SYR, STZ ).

    • If ST is date, let SYR be eg:convertYearToString(fn:get-year-from-date( SV )); and let STZ be eg:convertTZtoString( fn:get-timezone-from-date( SV )); TV is xs:gYear( SYR, STZ ).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:gYear( IV ).

  7. When a value of any primitive type is cast to xs:gMonthDay, the xs:gMonthDay value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:gMonthDay, then TV is SV.

    • If ST is dateTime, then let SMO be eg:convertTo2CharString(fn:get-month-from-dateTime( SV )), let SDA be eg:convertTo2CharString(fn:get-day-from-dateTime( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )); TV is xs:gYearMonth( fn:concat( '--', SMO , '-', SDA, STZ ) ).

    • If ST is date, then let SMO be eg:convertTo2CharString(fn:get-month-from-date( SV )), let SDA be eg:convertTo2CharString(fn:get-day-from-date( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-date( SV )); TV is xs:gYearMonth( fn:concat( , '--', SMO , '-', SDA, STZ ) ).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:gMonthDay( IV ).

  8. When a value of any primitive type is cast to xs:gDay, the xs:gDay value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:gDay, then TV is SV.

    • If ST is dateTime, then let SDA be eg:convertTo2CharString(fn:get-day-from-dateTime( SV )) and let STZ be eg:convertTZtoString( fn:get-timezone-from-dateTime( SV )); TV is xs:gDay( fn:concat( '---', SDA, STZ )).

    • If ST is date, then let SDA be eg:convertTo2CharString(fn:get-day-from-date( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-date( SV )); TV is xs:gDay( fn:concat( '---', SDA, STZ )).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:gDay( IV ).

  9. When a value of any primitive type is cast to xs:gMonth, the xs:gMonth value TV is derived from the source type ST and the source value SV as follows:

    • If ST is xs:gMonth, then TV is SV.

    • If ST is dateTime, then let SMO be eg:convertTo2CharString(fn:get-month-from-dateTime( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-dateTime( SV )); TV is xs:gMonth( fn:concat( '--' , SMO, STZ )).

    • If ST is date, then let SMO be eg:convertTo2CharString(fn:get-month-from-date( SV )) and let STZ be eg:convertTZtoString(fn:get-timezone-from-date( SV )); TV is xs:gMonth( fn:concat( '--', SMO, STZ )).

    • If ST is xdt:untypedAtomicor xs:string, or a type derived from xs:string, SV is converted to an intermediate value IV of type xs:string andTV is xs:gMonth( IV ).

17.14 Casting to xs:QName

It is possible to cast to xs:QName only from xdt:untypedAtomic, xs:string, or types derived from xs:stringIn each case the source value SV is treated like an xs:string.

The lexical form of SV must conform to the QName production of [Namespaces in XML]. If not, an error is raised [invalid value for constructor].

The effect of casting to xs:QName is context dependent. The local part of the resulting xs:QName is taken from the local part of SV. The namespace URI of the resulting xs:QName is determined as follows:

  • If SV has a prefix, then the prefix is mapped to a namespace URI using the in-scope namespaces from the static context. A dynamic error is raised ("No namespace for prefix") if there is no in-scope namespace with the given prefix.

  • If SV has no prefix, then the resulting xs:QName has the namespace URI given by the default namespace for elements and types, as defined in the static context. If there is no default namespace for elements and types, then the resulting xs:QName has no namespace.

A References

A.1 Normative

IEEE 754-1985
IEEE. IEEE Standard for Binary Floating-Point Arithmetic. See http://standards.ieee.org/reading/ieee/std_public/description/busarch/754-1985_desc.html
RFC 2396
IETF. RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax. See http://www.ietf.org/rfc/rfc2396.txt
RFC 2732
IETF. RFC 2732: Format for Literal IPv6 Addresses in URL's. See http://www.ietf.org/rfc/rfc2732.txt
Character Model for the World Wide Web 1.0
Character Model for the World Wide Web 1.0, Last Call Working Draft available at: http://www.w3.org/TR/2002/WD-charmod-20020430/
ISO 10967
ISO (International Organization for Standardization). ISO/IEC 10967-1:1994, Information technology — Language Independent Arithmetic — Part 1: Integer and floating point arithmetic [Geneva]: International Organization for Standardization, 1994. Available from: http://www.iso.ch/
The Unicode Standard
The Unicode Consortium. The Unicode Standard, Version 2.0. Reading, Mass.: Addison-Wesley Developers Press, 1996.
The Unicode Standard
Unicode Case Mappings
Unicode Technical Standard #21, Unicode Case Mappings. Available at: http://www.unicode.org/unicode/reports/tr21/
Unicode Collation Algorithm
Unicode Technical Standard #10, Unicode Collation Algorithm Available at: http://www.unicode.org/unicode/reports/tr10/
XML 1.0 Recommendation (Second Edition)
World Wide Web Consortium. Extensible Markup Language (XML) 1.0, Second Edition. Available at: http://www.w3.org/TR/REC-xml
XPath 2.0
World Wide Web Consortium. XML Path Language (XPath) Version 2.0. Available at: http://www.w3.org/TR/xpath20/
XSLT 2.0
World Wide Web Consortium. XSL Transformations Version 2.0. Available at: http://www.w3.org/TR/xslt20/
XQuery 1.0 and XPath 2.0 Data Model
World Wide Web Consortium. XQuery 1.0 and XPath 2.0 Data Model. Available at: http://www.w3.org/TR/query-datamodel/
XQuery 1.0 and XPath 2.0 Formal Semantics
World Wide Web Consortium. XQuery 1.0 and XPath 2.0 Formal Semantics. Available at: http://www.w3.org/TR/query-semantics/
XQuery 1.0: An XML Query Language
World Wide Web Consortium. XQuery 1.0: An XML Query Language. Available at: http://www.w3.org/TR/xquery/
XML Schema Part 1: Structures
XML Schema Part 1: Structures. Available at: http://www.w3.org/TR/xmlschema-1/
XML Schema Part 2: Datatypes
XML Schema Part 2: Datatypes. Available at: http://www.w3.org/TR/xmlschema-2/
Namespaces in XML
Namespaces in XML. Available at: http://www.w3.org/TR/1999/REC-xml-names-19990114/

B Compatibility with XPath 1.0 (Non-Normative)

This appendix summarizes the relationship between certain functions defined in [XPath 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 [XPath 1.0]. The third column discusses the differencesin the semantics of the corresponding functions. The functions appear in the order they appear in [XPath 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 [XPath 2.0]. If the mode is on, the following conversions are applied before the argument value is passed to the function:

XQuery 1.0 and XPath 2.0XPath 1.0Notes
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
fn:local-name() as xs:string
local-name(node-set?) => string
fn:local-name(
$arg as node()?
) as xs:string
fn:namespace-uri() as xs:string
namespace-uri(node-set?) => string In 2.0, the required type for this function is node. If compatibilityfallback conversion is enabled and $srcval is a node sequence, the first node in the 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
fn:string() as xs:string
string(object) => string If compatibility mode is off, andouble error will occur if argument has more than oneare node. Representations of numeric values are backwards compatible except for the special values positive and negativenode, infinity, and for values outside the range 1.0e-6 tocompatibility. 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, anare 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:starts-with($arg1 as xs:string?,
$arg2 as xs:string?,
$collation as xs:string) as xs:boolean?
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:contains($arg1 as xs:string?,
$arg2 as xs:string?,
$collation as xs:string) as xs:boolean?
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 backwards compatibility mode is off, numbers and booleans will give errors. Multiple nodes and more than one value will also give error.
fn:substring-before($arg1 as xs:string?,
$arg2 as xs:string?,
$collation as xs:string) as xs:string?
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 backwards 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?,
$collation as xs:string) as xs:string?
fn:substring($sourceString as xs:string?,
$startingLoc as xs:double) as xs:string?
substring(string, number, number?) => string In 1.0, returns "" if the first argument is an empty node-set. In 2.0, returns ().
fn:substring($sourceString as xs:string?,
$startingLoc as xs:double,
$length as xs:double) as xs:string?
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 oes 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 backwards 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?
fn:translate($arg as xs:string?,
$mapString as xs:string?,
$transString as xs:string?) 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
fn:number() as xs:double
number(object?) => number Error if argument has more than one node when not in backwards compatibility node.
fn:number(
$arg as item()?
) 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.together. 1.0 returns NaN. In 2.0 NaN values are removed from sequences of xs:float or xs:double before addition is performed.
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

C Illustrative User-written Functions (Non-Normative)

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.

C.1 eg:if-empty and eg:if-absent

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 signalled 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.

C.2 union, intersect and except on sequences of values

C.6 Working With xs:duration Values

This document does not define equality on xs:duration values. Nor does it define other comparison functions on such values. Users wanting to work with xs:duration values should cast them into xdt:yearMonthDuration and xdt:dayTimeDuration values and use the functions defined for comparing them in 9.3 Comparisons of Duration, Date and Time Values to define appropriate semnatics.

One way of comparing two xs:duration values for equality is to compare their yearMonth and dayTime components separately and return equal if both corresponding components are equal. This could be written as follows:

XSLT implementation

<xsl:function name="eg:duration-equal" as="xs:boolean">
  <xsl:param name="arg1" as="xs:duration"/>
  <xsl:param name="arg2" as="xs:duration"/>
  <xsl:sequence 
    select="(cast as xdt:yearMonthDuration (arg1) eq 
          cast as xdt:yearMonthDuration(arg2) and
        cast as xdt:dayTimeDuration(arg1) eq 
          cast as xdt:dayTimeDuration (arg2))
        )" />
</xsl:function>

XQuery implementation

declare function eg:duration-equal($arg1 as xs:duration, $arg2 as xs:duration)
    as xs:boolean 
{
  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()
}

D Error Summary (Non-Normative)

err:FOAR0001, division by zero

This error is raised whenever an attempt is made to divide by zero.

err:FOAR0002, numeric operation overflow/underflow

This error is raised whenever numeric operations result in an overflow or underflow.

err:FOCA0001, error in casting to decimal

.

err:FOCA0002, invalid lexical value

.

err:FOCA0003, input value too large for integer

.

err:FOCA0004, error in casting to integer

.

err:FOCA0005, NaN supplied as float/double value

.

err:FOCH0001, codepoint not valid

.

err:FOCH0002, unsupported collation

.

err:FOCH0003, unsupported normalization form

.

err:FOCH0004, collation unsuitable for this function

.

err:FODC0001, no context document

.

err:FODC0002, invalid argument to fn:doc()

.

err:FODC0003, error parsing contents of resource

.

err:FODC0004, invalid argument to fn:collection()

.

err:FODT0001, overflow in date/time arithmetic

.

err:FODT0002, overflow in duration arithmetic

.

err:FONC0001, undefined context item

.

err:FONS0002, default namespace is defined

.

err:FONS0003, no prefix defined for namespace

.

err:FONS0004, no namespace found for prefix

.

err:FONS0005, base uri not defined in the static context

.

err:FORG0001, invalid value for constructor

.

err:FORG0002, invalid argument to fn:resolve-uri()

.

err:FORG0003, fn:zero-or-one called with a sequence containing more than one item

.

err:FORG0004, fn:one-or-more called with a sequence containing no items

.

err:FORG0005, fn:exactly-one called with a sequence containing zero or more than one item

.

err:FORG0006, invalid position

.

err:FORG0007, invalid argument to aggregate function

.

err:FORG0008, invalid value for cast

.

err:FORG0009, base uri argument to fn:resolve-uri is not an absolute uri

.

err:FORX0001, invalid regular expression flags

.

err:FORX0002, invalid regular expression

.

err:FORX0003, regular expression matches zero-length string

.

err:FORX0004, invalid replacement string

.

err:FOTY0001, type error

This error is raised whenever a static type error is encountered.

err:FOTY0011, context item is not a node

.

err:FOTY0012, items not comparable

.

err:FOTY0013, type does not have equality defined

.

err:FOTY0014, type exception

.

E Functions and Operators Issues List (Non-Normative)

This appendix contains the current issues related to the operators specification.

F ChangeLog since Last Call Version on 2003-05-02 (Non-Normative)

Changesto thisdocument are in detailed in the lastcall issues document.

G Function and Operator Quick Reference (Non-Normative)

G.1 Functions and Operators by Section

Accessors
fn:node-name
fn:node-name(
$arg as node()?
) as xs:QName?
fn:string
fn:string() as xs:string
fn:string(
$arg as item()?
) as xs:string
fn:data
fn:data(
$arg as item()*
) as xdt:anyAtomicType*
fn:base-uri
fn:base-uri(
$arg as node()?
) as xs:string?
fn:base-uri() as xs:string
fn:document-uri
fn:document-uri(
$arg as node()?
) as xs:string?
The Error Function
fn:error() as none
fn:error(
$arg as item()?
) as none
The Trace Function
fn:trace($value as item()*, $label as xs:string) as item()*
Functions and Operators on Numerics
Operators on Numeric Values
op:numeric-add(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-subtract(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-multiply(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-divide(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-integer-divide(
$arg1 as xs:integer
, $arg2 as xs:integer
) as xs:integer
op:numeric-mod(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-unary-plus(
$arg as numeric
) as numeric
op:numeric-unary-minus(
$arg as numeric
) as numeric
Comparison of Numeric Values
op:numeric-equal(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
op:numeric-less-than(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
op:numeric-greater-than(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
Functions on Numeric Values
fn:abs($arg as numeric?) as numeric?
fn:ceiling(
$arg as numeric?
) as numeric?
fn:floor($arg as numeric?) as numeric?
fn:round($arg as numeric?) as numeric?
fn:round-half-to-even(
$arg as numeric?
) as numeric?
fn:round-half-to-even(
$arg as numeric?
, $precision as xs:integer
) as numeric?
Functions on Strings
Functions to Assemble and Disassemble Strings
fn:codepoints-to-string(
$arg as xs:integer*
) as xs:string
fn:string-to-codepoints(
$arg as xs:string?
) as xs:integer*
Equality and Comparison of Strings
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?
Functions on String Values
fn:concat(
$arg1 as xs:string?
, $arg2 as xs:string?
, ...) as xs:string
fn:string-join(
$arg1 as xs:string*
, $arg2 as xs:string
) as xs:string
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
fn:string-length() as xs:integer
fn:string-length($arg as xs:string) as xs:integer
fn:normalize-space() as xs:string
fn:normalize-space($arg as xs:string?) as xs:string
fn:normalize-unicode($arg as xs:string?) as xs:string
fn:normalize-unicode($arg as xs:string?, $normalizationForm as xs:string) as xs:string
fn:upper-case($arg as xs:string?) as xs:string
fn:lower-case($arg as xs:string?) as xs:string
fn:translate($arg as xs:string?, $mapString as xs:string, $transString as xs:string) as xs:string
fn:escape-uri($uri-part as xs:string?, $escape-reserved as xs:boolean) as xs:string
Functions Based on Substring Matchingfn:normalize-unicode
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
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
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
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
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
String Functions that Use Pattern Matching
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
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
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+
Functions and Operators on Boolean ValuesBooleans
Additional Boolean Constructor Functions
fn:true() as xs:boolean
fn:false() as xs:boolean
Operators on Boolean Values
op:boolean-equal($value1 as xs:boolean, $value2 as xs:boolean) as xs:boolean
op:boolean-less-than(
$arg1 as xs:boolean
, $arg2 as xs:boolean
) as xs:boolean
op:boolean-greater-than(
$arg1 as xs:boolean
, $arg2 as xs:boolean
) as xs:boolean
Functions on Boolean Values
fn:not(
$arg as item()*
) as xs:boolean
Functions and Operators on Durations, Dates and Times
Comparisons of Duration, Date and Time Values
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-equal(
$arg1 as xdt:dayTimeDuration
, $arg2 as xdt:dayTimeDuration
) 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:dateTime-equal(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:dateTime-less-than(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:dateTime-greater-than(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:date-equal(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:date-less-than(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:date-greater-than(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:time-equal(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:time-less-than(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:time-greater-than(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:gYearMonth-equal(
$arg1 as xs:gYearMonth
, $arg2 as xs:gYearMonth
) as xs:boolean
op:gYear-equal(
$arg1 as xs:gYear
, $arg2 as xs:gYear
) as xs:boolean
op:gMonthDay-equal(
$arg1 as xs:gMonthDay
, $arg2 as xs:gMonthDay
) as xs:boolean
op:gMonth-equal(
$arg1 as xs:gMonth
, $arg2 as xs:gMonth
) as xs:boolean
op:gDay-equal(
$arg1 as xs:gDay
, $arg2 as xs:gDay
) as xs:boolean
Component Extraction Functions on Duration, Date and Time Values
fn:get-years-from-yearMonthDuration(
$arg as xdt:yearMonthDuration?
) as xs:integer?
fn:get-months-from-yearMonthDuration(
$arg as xdt:yearMonthDuration?
) as xs:integer?
fn:get-days-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-hours-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-minutes-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-seconds-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:decimal?
fn:get-year-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-month-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-day-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-hours-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-minutes-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-seconds-from-dateTime(
$arg as xs:dateTime?
) as xs:decimal?
fn:get-timezone-from-dateTime(
$arg as xs:dateTime?
) as xdt:dayTimeDuration?
fn:get-year-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-month-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-day-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-timezone-from-date(
$arg as xs:date?
) as xdt:dayTimeDuration?
fn:get-hours-from-time(
$arg as xs:time?
) as xs:integer?
fn:get-minutes-from-time(
$arg as xs:time?
) as xs:integer?
fn:get-seconds-from-time(
$arg as xs:time?
) as xs:decimal?
fn:get-timezone-from-time(
$arg as xs:time?
) as xdt:dayTimeDuration?
Arithmetic Functions on xdt:yearMonthDuration and xdt:dayTimeDuration
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: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(
$arg1 as xdt:dayTimeDuration
, $arg2 as xs:double
) as xdt:dayTimeDuration
Timezone Adjustment on dateTime, date and time Values
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?
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?
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?
Adding and Subtracting Durations From dateTime, date and time
fn:subtract-dateTimes-yielding-yearMonthDuration($arg1 as xs:dateTime?, $arg2 as xs:dateTime?) as xdt:yearMonthDuration?
fn:subtract-dateTimes-yielding-dayTimeDuration($arg1 as xs:dateTime?, $arg2 as xs:dateTime?) as xdt:dayTimeDuration?
op:subtract-dates($arg1 as xs:date?, $arg2 as xs:date?) as xdt:dayTimeDuration?
op:subtract-times($arg1 as xs:time?, $arg2 as xs:time?) as xdt:dayTimeDuration?
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:add-yearMonthDuration-to-date(
$arg1 as xs:date
, $arg2 as xdt:yearMonthDuration
) as xs:date
op:add-dayTimeDuration-to-date(
$arg1 as xs:date
, $arg2 as xdt:dayTimeDuration
) as xs:date
op:subtract-yearMonthDuration-from-date(
$arg1 as xs:date
, $arg2 as xdt:yearMonthDuration
) as xs:date
op:subtract-dayTimeDuration-from-date(
$arg1 as xs:date
, $arg2 as xdt:dayTimeDuration
) as xs:date
op:add-dayTimeDuration-to-time(
$arg1 as xs:time
, $arg2 as xdt:dayTimeDuration
) as xs:time
op:subtract-dayTimeDuration-from-time(
$arg1 as xs:time
, $arg2 as xdt:dayTimeDuration
) as xs:time
Functions Related to QNames
Additional Constructor Functions for QNames
fn:resolve-QName($qname as xs:string?, $element as element()?) as xs:QName?
fn:expanded-QName($paramURI as xs:string?, $paramLocal as xs:string) as xs:QName
Operators and Functions Related to QNames
op:QName-equal($arg1 as xs:QName, $arg2 as xs:QName) as xs:boolean
fn:get-local-name-from-QName($arg as xs:QName?) as xs:string?
fn:get-namespace-uri-from-QName($arg as xs:QName?) as xs:string?
fn:get-namespace-uri-for-prefix($prefix as xs:string
, $element as element
) as xs:string?
fn:get-in-scope-prefixes($element as element) as xs:string*
Functions and Operators for anyURI
fn:resolve-uri
fn:resolve-uri($relative as xs:string?) as xs:string?
fn:resolve-uri($relative as xs:string?, $base as xs:string) as xs:string?
op:anyURI-equal
op:anyURI-equal(
$arg1 as xs:anyURI
, $arg2 as xs:anyURI
) as xs:boolean
Functions and Operators on base64Binary and hexBinary
Comparisons of base64Binary and hexBinary Values
op:hexBinary-equal($value1 as xs:hexBinary, $value2 as xs:hexBinary) as xs:boolean
op:base64Binary-equal($value1 as xs:base64Binary, $value2 as xs:base64Binary) as xs:boolean
Functions and Operators on NOTATION
Operators on NOTATION
op:NOTATION-equal(
$arg1 as xs:NOTATION
, $arg2 as xs:NOTATION
) as xs:boolean
Functions and Operators on Nodes
Functions and Operators on Nodes
fn:name() as xs:string
fn:name($arg as node()?) as xs:string
fn:local-name() as xs:string
fn:local-name(
$arg as node()?
) as xs:string
fn:namespace-uri() as xs:string
fn:namespace-uri(
$arg as node()?
) as xs:string
fn:number() as xs:double
fn:number(
$arg as item()?
) as xs:double
fn:lang(
$testlang as xs:string?
) as xs:boolean
op:is-same-node($parameter1 as node(), $parameter2 as node()) as xs:boolean
op:node-before(
$parameter1 as node()
, $parameter2 as node()
) as xs:boolean
op:node-after(
$parameter1 as node()
, $parameter2 as node()
) as xs:boolean
fn:root() as node()
fn:root($arg as node()?) as node()?
Functions and Operators on Sequences
Functions and Operators on Sequences
fn:zero-or-one($arg as item()*) as item()?
fn:one-or-more($arg as item()*) as item()+
fn:exactly-one($arg as item()*) as item()
fn:boolean(
$arg as item()*
) as xs:boolean
op:concatenate($seq1 as item()*, $seq2 as item()*) as item()*
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*
fn:empty(
$arg as item()*
) as xs:boolean
fn:exists(
$arg as item()*
) as xs:boolean
fn:distinct-values($arg as xdt:anyAtomicType*) as xdt:anyAtomicType*
fn:distinct-values($arg as xdt:anyAtomicType*, $collation as xs:string) as xdt:anyAtomicType*
fn:insert-before($target as item()*, $position as xs:integer, $inserts as item()*) as item()*
fn:remove($target as item()*, $position as xs:integer) as item()*
fn:reverse($arg as item()*) as item()*
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()*
fn:unordered($sourceSeq as item()*) as item()*
Equals, Union, Intersection and Except
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
op:union($parameter1 as node()*, $parameter2 as node()*) as node()*
op:intersect($parameter1 as node()*, $parameter2 as node()*) as node()*
op:except($parameter1 as node()*, $parameter2 as node()*) as node()*
Aggregate Functions
fn:count($arg as item()*) as xs:integer
fn:avg($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:max($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:max($arg as xdt:anyAtomicType*, $collation as string) as xdt:anyAtomicType?
fn:min($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:min($arg as xdt:anyAtomicType*, $collation as string) as xdt:anyAtomicType?
fn:sum($arg as xdt:anyAtomicType*) as xdt:anyAtomicType
fn:sum($arg as xdt:anyAtomicType*, $zero as xdt:anyAtomicType?) as xdt:anyAtomicType?
Functions and Operators that Generate Sequences
op:to($firstval as xs:integer, $lastval as xs:integer) as xs:integer*
fn:id($arg as xs:string*) as element()*
fn:idref($arg as xs:string*) as node()*
fn:doc($uri as xs:string?) as document?
fn:collection($arg as xs:string?) as node()*
Context Functions
fn:position
fn:position() as xs:integer
fn:last
fn:last() as xs:integer
fn:current-dateTime
fn:current-dateTime() as xs:dateTime
fn:current-date
fn:current-date() as xs:date
fn:current-time
fn:current-time() as xs:time
fn:default-collation
fn:default-collation() as xs:string
fn:implicit-timezone
fn:implicit-timezone() as xdt:dayTimeDuration?

G.2 Functions and Operators Alphabetically

fn:abs($arg as numeric?) as numeric?
op:add-dayTimeDuration-to-date(
$arg1 as xs:date
, $arg2 as xdt:dayTimeDuration
) as xs:date
op:add-dayTimeDuration-to-dateTime(
$arg1 as xs:dateTime
, $arg2 as xdt:dayTimeDuration
) as xs:dateTime
op:add-dayTimeDuration-to-time(
$arg1 as xs:time
, $arg2 as xdt:dayTimeDuration
) as xs:time
op:add-dayTimeDurations(
$arg1 as xdt:dayTimeDuration
, $arg2 as xdt:dayTimeDuration
) as xdt:dayTimeDuration
op:add-yearMonthDuration-to-date(
$arg1 as xs:date
, $arg2 as xdt:yearMonthDuration
) as xs:date
op:add-yearMonthDuration-to-dateTime(
$arg1 as xs:dateTime
, $arg2 as xdt:yearMonthDuration
) as xs:dateTime
op:add-yearMonthDurations(
$arg1 as xdt:yearMonthDuration
, $arg2 as xdt:yearMonthDuration
) as xdt:yearMonthDuration
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?
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?
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?
op:anyURI-equal(
$arg1 as xs:anyURI
, $arg2 as xs:anyURI
) as xs:boolean
fn:avg($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:base-uri(
$arg as node()?
) as xs:string?
fn:base-uri() as xs:string
op:base64Binary-equal($value1 as xs:base64Binary, $value2 as xs:base64Binary) as xs:boolean
fn:boolean(
$arg as item()*
) as xs:boolean
op:boolean-equal($value1 as xs:boolean, $value2 as xs:boolean) as xs:boolean
op:boolean-greater-than(
$arg1 as xs:boolean
, $arg2 as xs:boolean
) as xs:boolean
op:boolean-less-than(
$arg1 as xs:boolean
, $arg2 as xs:boolean
) as xs:boolean
fn:ceiling(
$arg as numeric?
) as numeric?
fn:codepoints-to-string(
$arg as xs:integer*
) as xs:string
fn:collection($arg as xs:string?) as node()*
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?
fn:concat(
$arg1 as xs:string?
, $arg2 as xs:string?
, ...) as xs:string
op:concatenate($seq1 as item()*, $seq2 as item()*) as item()*
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
fn:count($arg as item()*) as xs:integer
fn:current-date() as xs:date
fn:current-dateTime() as xs:dateTime
fn:current-time() as xs:time
fn:data(
$arg as item()*
) as xdt:anyAtomicType*
op:date-equal(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:date-greater-than(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:date-less-than(
$arg1 as xs:date
, $arg2 as xs:date
) as xs:boolean
op:dateTime-equal(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:dateTime-greater-than(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:dateTime-less-than(
$arg1 as xs:dateTime
, $arg2 as xs:dateTime
) as xs:boolean
op:dayTimeDuration-equal(
$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:dayTimeDuration-less-than(
$arg1 as xdt:dayTimeDuration
, $arg2 as xdt:dayTimeDuration
) as xs:boolean
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
fn:default-collation() as xs:string
fn:distinct-values($arg as xdt:anyAtomicType*) as xdt:anyAtomicType*
fn:distinct-values($arg as xdt:anyAtomicType*, $collation as xs:string) as xdt:anyAtomicType*
op:divide-dayTimeDuration(
$arg1 as xdt:dayTimeDuration
, $arg2 as xs:double
) as xdt:dayTimeDuration
op:divide-yearMonthDuration(
$arg1 as xdt:yearMonthDuration
, $arg2 as xs:double
) as xdt:yearMonthDuration
fn:doc($uri as xs:string?) as document?
fn:document-uri(
$arg as node()?
) as xs:string?
fn:empty(
$arg as item()*
) as xs:boolean
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
fn:error() as none
fn:error(
$arg as item()?
) as none
fn:escape-uri($uri-part as xs:string?, $escape-reserved as xs:boolean) as xs:string
fn:exactly-one($arg as item()*) as item()
op:except($parameter1 as node()*, $parameter2 as node()*) as node()*
fn:exists(
$arg as item()*
) as xs:boolean
fn:expanded-QName($paramURI as xs:string?, $paramLocal as xs:string) as xs:QName
fn:false() as xs:boolean
fn:floor($arg as numeric?) as numeric?
op:gDay-equal(
$arg1 as xs:gDay
, $arg2 as xs:gDay
) as xs:boolean
fn:get-day-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-day-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-days-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-hours-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-hours-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-hours-from-time(
$arg as xs:time?
) as xs:integer?
fn:get-in-scope-prefixes($element as element) as xs:string*
fn:get-local-name-from-QName($arg as xs:QName?) as xs:string?
fn:get-minutes-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-minutes-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:integer?
fn:get-minutes-from-time(
$arg as xs:time?
) as xs:integer?
fn:get-month-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-month-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-months-from-yearMonthDuration(
$arg as xdt:yearMonthDuration?
) as xs:integer?
fn:get-namespace-uri-for-prefix($prefix as xs:string
, $element as element
) as xs:string?
fn:get-namespace-uri-from-QName($arg as xs:QName?) as xs:string?
fn:get-seconds-from-dateTime(
$arg as xs:dateTime?
) as xs:decimal?
fn:get-seconds-from-dayTimeDuration(
$arg as xdt:dayTimeDuration?
) as xs:decimal?
fn:get-seconds-from-time(
$arg as xs:time?
) as xs:decimal?
fn:get-timezone-from-date(
$arg as xs:date?
) as xdt:dayTimeDuration?
fn:get-timezone-from-dateTime(
$arg as xs:dateTime?
) as xdt:dayTimeDuration?
fn:get-timezone-from-time(
$arg as xs:time?
) as xdt:dayTimeDuration?
fn:get-year-from-date(
$arg as xs:date?
) as xs:integer?
fn:get-year-from-dateTime(
$arg as xs:dateTime?
) as xs:integer?
fn:get-years-from-yearMonthDuration(
$arg as xdt:yearMonthDuration?
) as xs:integer?
op:gMonth-equal(
$arg1 as xs:gMonth
, $arg2 as xs:gMonth
) as xs:boolean
op:gMonthDay-equal(
$arg1 as xs:gMonthDay
, $arg2 as xs:gMonthDay
) as xs:boolean
op:gYear-equal(
$arg1 as xs:gYear
, $arg2 as xs:gYear
) as xs:boolean
op:gYearMonth-equal(
$arg1 as xs:gYearMonth
, $arg2 as xs:gYearMonth
) as xs:boolean
op:hexBinary-equal($value1 as xs:hexBinary, $value2 as xs:hexBinary) as xs:boolean
fn:id($arg as xs:string*) as element()*
fn:idref($arg as xs:string*) as node()*
fn:implicit-timezone() as xdt:dayTimeDuration?
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*
fn:insert-before($target as item()*, $position as xs:integer, $inserts as item()*) as item()*
op:intersect($parameter1 as node()*, $parameter2 as node()*) as node()*
op:is-same-node($parameter1 as node(), $parameter2 as node()) as xs:boolean
fn:lang(
$testlang as xs:string?
) as xs:boolean
fn:last() as xs:integer
fn:local-name() as xs:string
fn:local-name(
$arg as node()?
) as xs:string
fn:lower-case($arg as xs:string?) as xs:string
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
fn:max($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:max($arg as xdt:anyAtomicType*, $collation as string) as xdt:anyAtomicType?
fn:min($arg as xdt:anyAtomicType*) as xdt:anyAtomicType?
fn:min($arg as xdt:anyAtomicType*, $collation as string) as xdt:anyAtomicType?
op:multiply-dayTimeDuration(
$arg1 as xdt:dayTimeDuration
, $arg2 as xs:double
) as xdt:dayTimeDuration
op:multiply-yearMonthDuration(
$arg1 as xdt:yearMonthDuration
, $arg2 as xs:double
) as xdt:yearMonthDuration
fn:name() as xs:string
fn:name($arg as node()?) as xs:string
fn:namespace-uri() as xs:string
fn:namespace-uri(
$arg as node()?
) as xs:string
op:node-after(
$parameter1 as node()
, $parameter2 as node()
) as xs:boolean
op:node-before(
$parameter1 as node()
, $parameter2 as node()
) as xs:boolean
fn:node-name(
$arg as node()?
) as xs:QName?
fn:normalize-space() as xs:string
fn:normalize-space($arg as xs:string?) as xs:string
fn:normalize-unicode($arg as xs:string?) as xs:string
fn:normalize-unicode($arg as xs:string?, $normalizationForm as xs:string) as xs:string
fn:not(
$arg as item()*
) as xs:boolean
op:NOTATION-equal(
$arg1 as xs:NOTATION
, $arg2 as xs:NOTATION
) as xs:boolean
fn:number() as xs:double
fn:number(
$arg as item()?
) as xs:double
op:numeric-add(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-divide(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-equal(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
op:numeric-greater-than(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
op:numeric-integer-divide(
$arg1 as xs:integer
, $arg2 as xs:integer
) as xs:integer
op:numeric-less-than(
$arg1 as numeric
, $arg2 as numeric
) as xs:boolean
op:numeric-mod(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-multiply(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-subtract(
$arg1 as numeric
, $arg2 as numeric
) as numeric
op:numeric-unary-minus(
$arg as numeric
) as numeric
op:numeric-unary-plus(
$arg as numeric
) as numeric
fn:one-or-more($arg as item()*) as item()+
fn:position() as xs:integer
op:QName-equal($arg1 as xs:QName, $arg2 as xs:QName) as xs:boolean
fn:remove($target as item()*, $position as xs:integer) as item()*
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
fn:resolve-QName($qname as xs:string?, $element as element()?) as xs:QName?
fn:resolve-uri($relative as xs:string?) as xs:string?
fn:resolve-uri($relative as xs:string?, $base as xs:string) as xs:string?
fn:reverse($arg as item()*) as item()*
fn:root() as node()
fn:root($arg as node()?) as node()?
fn:round($arg as numeric?) as numeric?
fn:round-half-to-even(
$arg as numeric?
) as numeric?
fn:round-half-to-even(
$arg as numeric?
, $precision as xs:integer
) as numeric?
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
fn:string() as xs:string
fn:string(
$arg as item()?
) as xs:string
fn:string-join(
$arg1 as xs:string*
, $arg2 as xs:string
) as xs:string
fn:string-length() as xs:integer
fn:string-length($arg as xs:string) as xs:integer
fn:string-to-codepoints(
$arg as xs:string?
) as xs:integer*
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()*
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
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
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
op:subtract-dates($arg1 as xs:date?, $arg2 as xs:date?) as xdt:dayTimeDuration?
fn:subtract-dateTimes-yielding-dayTimeDuration($arg1 as xs:dateTime?, $arg2 as xs:dateTime?) as xdt:dayTimeDuration?
fn:subtract-dateTimes-yielding-yearMonthDuration($arg1 as xs:dateTime?, $arg2 as xs:dateTime?) as xdt:yearMonthDuration?
op:subtract-dayTimeDuration-from-date(
$arg1 as xs:date
, $arg2 as xdt:dayTimeDuration
) as xs:date
op:subtract-dayTimeDuration-from-dateTime(
$arg1 as xs:dateTime
, $arg2 as xdt:dayTimeDuration
) as xs:dateTime
op:subtract-dayTimeDuration-from-time(
$arg1 as xs:time
, $arg2 as xdt:dayTimeDuration
) as xs:time
op:subtract-dayTimeDurations(
$arg1 as xdt:dayTimeDuration
, $arg2 as xdt:dayTimeDuration
) as xdt:dayTimeDuration
op:subtract-times($arg1 as xs:time?, $arg2 as xs:time?) as xdt:dayTimeDuration?
op:subtract-yearMonthDuration-from-date(
$arg1 as xs:date
, $arg2 as xdt:yearMonthDuration
) as xs:date
op:subtract-yearMonthDuration-from-dateTime(
$arg1 as xs:dateTime
, $arg2 as xdt:yearMonthDuration
) as xs:dateTime
op:subtract-yearMonthDurations(
$arg1 as xdt:yearMonthDuration
, $arg2 as xdt:yearMonthDuration
) as xdt:yearMonthDuration
fn:sum($arg as xdt:anyAtomicType*) as xdt:anyAtomicType
fn:sum($arg as xdt:anyAtomicType*, $zero as xdt:anyAtomicType?) as xdt:anyAtomicType?
op:time-equal(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:time-greater-than(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:time-less-than(
$arg1 as xs:time
, $arg2 as xs:time
) as xs:boolean
op:to($firstval as xs:integer, $lastval as xs:integer) as xs:integer*
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+
fn:trace($value as item()*, $label as xs:string) as item()*
fn:translate($arg as xs:string?, $mapString as xs:string, $transString as xs:string) as xs:string
fn:true() as xs:boolean
op:union($parameter1 as node()*, $parameter2 as node()*) as node()*
fn:unordered($sourceSeq as item()*) as item()*
fn:upper-case($arg as xs:string?) as xs:string
op:yearMonthDuration-equal(
$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:yearMonthDuration-less-than(
$arg1 as xdt:yearMonthDuration
, $arg2 as xdt:yearMonthDuration
) as xs:boolean
fn:zero-or-one($arg as item()*) as item()?