W3C

XQuery 1.0: An XML Query Language

W3C Working Draft 12 November 2003

This version:
http://www.w3.org/TR/2003/WD-xquery-20031112/
Latest version:
http://www.w3.org/TR/xquery/
Previous versions:
http://www.w3.org/TR/2003/WD-xquery-20030822/ http://www.w3.org/TR/2003/WD-xquery-20030502/ http://www.w3.org/TR/2002/WD-xquery-20021115/ http://www.w3.org/TR/2002/WD-xquery-20020816/
Editors:
Scott Boag (XSL WG), IBM Research <scott_boag@us.ibm.com>
Don Chamberlin (XML Query WG), IBM Almaden Research Center <chamberlin@almaden.ibm.com>
Mary F. Fernández (XML Query WG), AT&T Labs <mff@research.att.com>
Daniela Florescu (XML Query WG), BEA Systems <danielaf@bea.com>
Jonathan Robie (XML Query WG), DataDirect Technologies <jonathan.robie@datadirect-technologies.com>
Jérôme Siméon (XML Query WG), Bell Labs, Lucent Technologies <simeon@research.bell-labs.com>

Abstract

XML is a versatile markup language, capable of labeling the information content of diverse data sources including structured and semi-structured documents, relational databases, and object repositories. A query language that uses the structure of XML intelligently can express queries across all these kinds of data, whether physically stored in XML or viewed as XML via middleware. This specification describes a query language called XQuery, which is designed to be broadly applicable across many types of XML data sources.

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 current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

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

XQuery 1.0 has been defined jointly by the XML Query Working Group and the XSL Working Group (both part of the XML Activity). The XPath 2.0 and XQuery 1.0 Working Drafts are generated from a common source. These languages are closely related, sharing much of the same expression syntax and semantics, and much of the text found in the two Working Drafts is identical.

This version contains several changes. The section entitled "SequenceType Matching" has been rewritten and includes new material on handling of unrecognized types. A new concrete type, xdt:untypedAny, has been introduced, and the isnot comparison operator has been removed. Rules for static and dynamic implementations have been clarified. A complete list of changes can be found in I Revision Log.

XQuery Issue 152, concerning an XML syntax for XQuery, has been resolved. The XML Query Working Group plans to issue an XQueryX Working Draft in the near future to reflect this issue's resolution.

This is a Last Call Working Draft. 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 [XQuery] at 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 at http://www.w3.org/2002/08/xmlquery-IPR-statements and the XSL Working Group's patent disclosure page at http://www.w3.org/Style/XSL/Disclosures.

Table of Contents

1 Introduction
2 Basics
    2.1 Expression Context
        2.1.1 Static Context
        2.1.2 Dynamic Context
    2.2 Processing Model
        2.2.1 Data Model Generation
        2.2.2 Schema Import Processing
        2.2.3 Expression Processing
            2.2.3.1 Static Analysis Phase
            2.2.3.2 Dynamic Evaluation Phase
        2.2.4 Serialization
        2.2.5 Consistency Constraints
    2.3 Documents
        2.3.1 Document Order
        2.3.2 Atomization
        2.3.3 Effective Boolean Value
        2.3.4 Input Sources
    2.4 Types
        2.4.1 Predefined Types
        2.4.2 Typed Value and String Value
        2.4.3 SequenceType Syntax
        2.4.4 SequenceType Matching
            2.4.4.1 Matching a SequenceType and a Value
            2.4.4.2 Matching an ItemType and an Item
            2.4.4.3 Matching an ElementTest and an Element Node
            2.4.4.4 Matching an AttributeTest and an Attribute Node
    2.5 Error Handling
        2.5.1 Kinds of Errors
        2.5.2 Handling Dynamic Errors
        2.5.3 Errors and Optimization
    2.6 Optional Features
        2.6.1 Schema Import Feature
        2.6.2 Static Typing Feature
        2.6.3 Full Axis Feature
        2.6.4 Module Feature
        2.6.5 Pragmas
        2.6.6 Must-Understand Extensions
            2.6.6.1 XQuery Flagger
        2.6.7 Static Typing Extensions
            2.6.7.1 XQuery Static Flagger
3 Expressions
    3.1 Primary Expressions
        3.1.1 Literals
        3.1.2 Variable References
        3.1.3 Parenthesized Expressions
        3.1.4 Context Item Expression
        3.1.5 Function Calls
        3.1.6 XQuery Comments
    3.2 Path Expressions
        3.2.1 Steps
            3.2.1.1 Axes
            3.2.1.2 Node Tests
        3.2.2 Predicates
        3.2.3 Unabbreviated Syntax
        3.2.4 Abbreviated Syntax
    3.3 Sequence Expressions
        3.3.1 Constructing Sequences
        3.3.2 Combining Node Sequences
    3.4 Arithmetic Expressions
    3.5 Comparison Expressions
        3.5.1 Value Comparisons
        3.5.2 General Comparisons
        3.5.3 Node Comparisons
    3.6 Logical Expressions
    3.7 Constructors
        3.7.1 Direct Element Constructors
            3.7.1.1 Attributes
            3.7.1.2 Namespace Declaration Attributes
            3.7.1.3 Content
            3.7.1.4 Whitespace in Element Content
            3.7.1.5 Type of a Constructed Element
        3.7.2 Other Direct Constructors
        3.7.3 Computed Constructors
            3.7.3.1 Computed Element Constructors
            3.7.3.2 Computed Attribute Constructors
            3.7.3.3 Document Node Constructors
            3.7.3.4 Text Node Constructors
            3.7.3.5 Computed Processing Instruction Constructors
            3.7.3.6 Computed Comment Constructors
            3.7.3.7 Computed Namespace Constructors
        3.7.4 Namespace Nodes on Constructed Elements
    3.8 FLWOR Expressions
        3.8.1 For and Let Clauses
        3.8.2 Where Clause
        3.8.3 Order By and Return Clauses
        3.8.4 Example
    3.9 Unordered Expressions
    3.10 Conditional Expressions
    3.11 Quantified Expressions
    3.12 Expressions on SequenceTypes
        3.12.1 Instance Of
        3.12.2 Typeswitch
        3.12.3 Cast
        3.12.4 Castable
        3.12.5 Constructor Functions
        3.12.6 Treat
    3.13 Validate Expressions
4 Modules and Prologs
    4.1 Version Declaration
    4.2 Module Declaration
    4.3 Base URI Declaration
    4.4 Namespace Declaration
    4.5 Default Namespace Declaration
    4.6 Schema Import
    4.7 Module Import
    4.8 Variable Declaration
    4.9 Validation Declaration
    4.10 Xmlspace Declaration
    4.11 Default Collation Declaration
    4.12 Function Declaration

Appendices

A XQuery Grammar
    A.1 EBNF
        A.1.1 Grammar Notes
    A.2 Lexical structure
        A.2.1 White Space Rules
        A.2.2 Lexical Rules
    A.3 Reserved Function Names
    A.4 Precedence Order
B Type Promotion and Operator Mapping
    B.1 Type Promotion
    B.2 Operator Mapping
C Context Components
    C.1 Static Context Components
    C.2 Dynamic Context Components
    C.3 Serialization Parameters
D References
    D.1 Normative References
    D.2 Non-normative References
    D.3 Non-normative Background References
    D.4 Non-normative Informative Material
E Glossary
F Summary of Error Conditions
G Example Applications (Non-Normative)
    G.1 Joins
    G.2 Grouping
    G.3 Queries on Sequence
    G.4 Recursive Transformations
    G.5 Selecting Distinct Combinations
H XPath 2.0 and XQuery 1.0 Issues (Non-Normative)
I Revision Log (Non-Normative)
    I.1 12 November 2003


1 Introduction

As increasing amounts of information are stored, exchanged, and presented using XML, the ability to intelligently query XML data sources becomes increasingly important. One of the great strengths of XML is its flexibility in representing many different kinds of information from diverse sources. To exploit this flexibility, an XML query language must provide features for retrieving and interpreting information from these diverse sources.

XQuery is designed to meet the requirements identified by the W3C XML Query Working Group [XML Query 1.0 Requirements] and the use cases in [XML Query Use Cases]. It is designed to be a language in which queries are concise and easily understood. It is also flexible enough to query a broad spectrum of XML information sources, including both databases and documents. The Query Working Group has identified a requirement for both a human-readable query syntax and an XML-based query syntax. XQuery is designed to meet the first of these requirements. XQuery is derived from an XML query language called Quilt [Quilt], which in turn borrowed features from several other languages, including XPath 1.0 [XPath 1.0], XQL [XQL], XML-QL [XML-QL], SQL [SQL], and OQL [ODMG].

[Definition: XQuery operates on the abstract, logical structure of an XML document, rather than its surface syntax. This logical structure is known as the data model, which is defined in the [XQuery 1.0 and XPath 2.0 Data Model] document.]

XQuery Version 1.0 is an extension of XPath Version 2.0. Any expression that is syntactically valid and executes successfully in both XPath 2.0 and XQuery 1.0 will return the same result in both languages. Since these languages are so closely related, their grammars and language descriptions are generated from a common source to ensure consistency, and the editors of these specifications work together closely.

XQuery also depends on and is closely related to the following specifications:

This document specifies a grammar for XQuery, using the same Basic EBNF notation used in [XML 1.0], except that grammar symbols always have initial capital letters. Unless otherwise noted (see A.2 Lexical structure), whitespace is not significant in the grammar. Grammar productions are introduced together with the features that they describe, and a complete grammar is also presented in the appendix [A XQuery Grammar]. The appendix should be regarded as the normative version.

In the grammar productions in this document, nonterminal symbols are underlined and literal text is enclosed in double quotes. Certain productions (including the productions that define DecimalLiteral, DoubleLiteral, and StringLiteral) employ a regular-expression notation. The following example production describes the syntax of a function call:

[97]    FunctionCall    ::=    QName "(" (ExprSingle ("," ExprSingle)*)? ")"

The production should be read as follows: A function call consists of a QName followed by an open-parenthesis. The open-parenthesis is followed by an optional argument list. The argument list (if present) consists of one or more expressions, separated by commas. The optional argument list is followed by a close-parenthesis.

Certain aspects of language processing are described in this specification as implementation-defined or implementation-dependent.

This document normatively defines the dynamic semantics of XQuery. The static semantics of XQuery are normatively defined in [XQuery 1.0 and XPath 2.0 Formal Semantics]. In this document, examples and material labeled as "Note" are provided for explanatory purposes and are not normative.

2 Basics

The basic building block of XQuery is the expression, which is a string of Unicode characters. The language provides several kinds of expressions which may be constructed from keywords, symbols, and operands. In general, the operands of an expression are other expressions. [Definition: XQuery is a functional language, which means that expressions can be nested with full generality. (However, unlike a pure functional language, it does not allow variable substitutability if the variable declaration contains construction of new nodes.)] [Definition: XQuery is also a strongly-typed language in which the operands of various expressions, operators, and functions must conform to the expected types.]

Like XML, XQuery is a case-sensitive language. Keywords in XQuery use lower-case characters and are not reserved—that is, names in XQuery expressions are allowed to be the same as language keywords—except for the list of reserved function-names in A.3 Reserved Function Names.

The value of an expression is always a sequence. [Definition: A sequence is an ordered collection of zero or more items.] [Definition: An item is either an atomic value or a node.] [Definition: An atomic value is a value in the value space of an XML Schema atomic type, as defined in [XML Schema] (that is, a simple type that is not a list type or a union type).] [Definition: A node is an instance of one of the seven node kinds defined in [XQuery 1.0 and XPath 2.0 Data Model].] Each node has a unique node identity. Some kinds of nodes have typed values, string values, and names, which can be extracted from the node. The typed value of a node is a sequence of zero or more atomic values. The string value of a node is a value of type xs:string. The name of a node is a value of type xs:QName.

[Definition: A sequence containing exactly one item is called a singleton sequence.] An item is identical to a singleton sequence containing that item. Sequences are never nested—for example, combining the values 1, (2, 3), and ( ) into a single sequence results in the sequence (1, 2, 3). [Definition: A sequence containing zero items is called an empty sequence.]

Names in XQuery conform to the syntax in [XML Names]. This document uses the following predefined namespace prefixes:

In some cases, where the meaning is clear and namespaces are not important to the discussion, built-in XML Schema typenames such as integer and string are used without a namespace prefix.

2.1 Expression Context

[Definition: The expression context for a given expression consists of all the information that can affect the result of the expression.] This information is organized into two categories called the static context and the dynamic context.

2.1.1 Static Context

[Definition: The static context of an expression is the information that is available during static analysis of the expression, prior to its evaluation.] This information can be used to decide whether the expression contains a static error. If analysis of an expression relies on some component of the static context that has not been assigned a value, a static error is raised.[err:XP0001]

The individual components of the static context are summarized below. Further rules governing the semantics of these components can be found in C.1 Static Context Components.

  • [Definition: XPath 1.0 compatibility mode. This component must be set by all host languages that include XPath 2.0 as a subset, indicating whether rules for compatibility with XPath 1.0 are in effect. XQuery sets the value of this component to false. ]

  • [Definition: In-scope namespaces. This is a set of (prefix, URI) pairs. The in-scope namespaces are used for resolving prefixes used in QNames within the expression.]

    Some namespaces are predefined; additional namespaces can be defined by Prologs, by namespace declaration attributes, and by computed namespace constructors.

  • [Definition: Default element/type namespace. This is a namespace URI. This namespace is used for any unprefixed QName appearing in a position where an element or type name is expected.] The initial default element/type namespace may be provided by the external environmentor by a declaration in the Prolog of a module.

  • [Definition: Default function namespace. This is a namespace URI. This namespace URI is used for any unprefixed QName appearing as the function name in a function call. The initial default function namespace may be provided by the external environmentor by a declaration in the Prolog of a module.]

  • [Definition: In-scope schema definitions. This is a generic term for all the element, attribute, and type definitions that are in scope during processing of an expression.] It includes the following three parts:

    • [Definition: In-scope type definitions. Each named type definition is identified either by a QName (for a named type) or by an implementation-dependent type identifier (for an anonymous type). The in-scope type definitions include the predefined types as described in 2.4.1 Predefined Types. If the Schema Import Feature is supported, in-scope type definitions also include all type definitions found in imported schemas. ]

    • [Definition: In-scope element declarations. Each element declaration is identified either by a QName (for a top-level element declaration) or by an implementation-dependent element identifier (for a local element declaration). If the Schema Import Feature is supported, in-scope element declarations include all element declarations found in imported schemas. An element declaration includes information about the substitution groups to which this element belongs.]

    • [Definition: In-scope attribute declarations. Each attribute declaration is identified either by a QName (for a top-level attribute declaration) or by an implementation-dependent attribute identifier (for a local attribute declaration). If the Schema Import Feature is supported, in-scope attribute declarations include all attribute declarations found in imported schemas.]

  • [Definition: In-scope variables. This is a set of (QName, type) pairs. It defines the set of variables that are available for reference within an expression. The QName is the name of the variable, and the type is the static type of the variable.]

    Variable declarations in the Prolog of a module are added to the in-scope variables of the module. An expression that binds a variable (such as a let, for, some, or every expression) extends the in-scope variables of its subexpressions with the new bound variable and its type. Within a function declaration, the in-scope variables are extended by the names and types of the function parameters.

  • [Definition: In-scope functions. This component defines the set of functions that are available to be called from within an expression. Each function is uniquely identified by its expanded QName and its arity (number of parameters).] [Definition: Each function has a function signature that specifies the name of the function and the static types of its parameters and its result.]

    The in-scope functions include constructor functions, which are discussed in 3.12.5 Constructor Functions.

  • [Definition: In-scope collations. This is a set of (URI, collation) pairs. It defines the names of the collations that are available for use in function calls that take a collation name as an argument.] A collation may be regarded as an object that supports two functions: a function that given a set of strings, returns a sequence containing those strings in sorted order; and a function that given two strings, returns true if they are considered equal, and false if not.

  • [Definition: Default collation. This collation is used by string comparison functions and operators when no explicit collation is specified.] For exceptions to this rule, see 4.11 Default Collation Declaration.

  • [Definition: Validation mode. The validation mode specifies the mode in which validation is performed by element constructors and by validate expressions. ] Its value is one of strict, lax, or skip. The initial validation mode may be provided by the environment external to a query or by the validation declaration in the Prolog of a module. If no validation mode is specified in either of these ways, the initial validation mode is lax.

    The validation mode for a subexpression is inherited from the containing expression. A validate expression that specifies a mode changes the validation mode of its subexpressions to the specified mode.

  • [Definition: Validation context. An expression's validation context determines the context in which elements constructed by the expression are validated. ] Its value is either global or a context path that starts with the name of a top-level element declaration or top-level type definition in the in-scope schema definitions. The default validation context of a module is global.

    The validation context for a subexpression is inherited from the containing expression. An element constructor extends the validation context of its subexpressions with the name of the constructed element, and a validate expression that specifies a context redefines the validation context of its subexpressions.

  • [Definition: XMLSpace policy. This policy, declared in the Prolog, controls the processing of whitespace by element constructors.] Its value may be preserve or strip.

  • [Definition: Base URI. This is an absolute URI, used when necessary in the resolution of relative URIs (for example, by the fn:resolve-uri function.)]

  • [Definition: Statically-known documents. This is a mapping from strings onto types. The string represents the absolute URI of a resource that is potentially available using the fn:doc function. The type is the type of the document node that would result from calling the fn:doc function with this URI as its argument. ] If the argument to fn:doc is not a string literal that is present in statically-known documents, then the static type of fn:doc is document-node()?.

    Note:

    The purpose of the statically known documents is to provide type information, not to determine which documents are available. A URI need not be found in the statically known documents to be accessed using fn:doc.

  • [Definition: Statically-known collections. This is a mapping from strings onto types. The string represents the absolute URI of a resource that is potentially available using the fn:collection function. The type is the type of the sequence of nodes that would result from calling the fn:collection function with this URI as its argument.] If the argument to fn:collection is not a string literal that is present in statically-known collections, then the static type of fn:collection is node()?.

    Note:

    The purpose of the statically known collections is to provide type information, not to determine which collections are available. A URI need not be found in the statically known collections to be accessed using fn:collection.

2.1.2 Dynamic Context

[Definition: The dynamic context of an expression is defined as information that is available at the time the expression is evaluated.] If evaluation of an expression relies on some part of the dynamic context that has not been assigned a value, a dynamic error is raised.[err:XP0002]

The individual components of the dynamic context are summarized below. Further rules governing the semantics of these components can be found in C.2 Dynamic Context Components.

The dynamic context consists of all the components of the static context, and the additional components listed below.

[Definition: The first three components of the dynamic context (context item, context position, and context size) are called the focus of the expression. ] The focus enables the processor to keep track of which nodes are being processed by the expression.

Certain language constructs, notably the path expression E1/E2 and the predicate expression E1[E2], create a new focus for the evaluation of a sub-expression. In these constructs, E2 is evaluated once for each item in the sequence that results from evaluating E1. Each time E2 is evaluated, it is evaluated with a different focus. The focus for evaluating E2 is referred to below as the inner focus, while the focus for evaluating E1 is referred to as the outer focus. The inner focus exists only while E2 is being evaluated. When this evaluation is complete, evaluation of the containing expression continues with its original focus unchanged.

  • [Definition: The context item is the item currently being processed in a path expression. An item is either an atomic value or a node.][Definition: When the context item is a node, it can also be referred to as the context node.] The context item is returned by the expression ".". When an expression E1/E2 or E1[E2] is evaluated, each item in the sequence obtained by evaluating E1 becomes the context item in the inner focus for an evaluation of E2.

  • [Definition: The context position is the position of the context item within the sequence of items currently being processed in a path expression. ]It changes whenever the context item changes. Its value is always an integer greater than zero. The context position is returned by the expression fn:position(). When an expression E1/E2 or E1[E2] is evaluated, the context position in the inner focus for an evaluation of E2 is the position of the context item in the sequence obtained by evaluating E1. The position of the first item in a sequence is always 1 (one). The context position is always less than or equal to the context size.

  • [Definition: The context size is the number of items in the sequence of items currently being processed in a path expression.] Its value is always an integer greater than zero. The context size is returned by the expression fn:last(). When an expression E1/E2 or E1[E2] is evaluated, the context size in the inner focus for an evaluation of E2 is the number of items in the sequence obtained by evaluating E1.

  • [Definition: Dynamic variables. This is a set of (QName, value) pairs. It contains the same QNames as the in-scope variables in the static context for the expression. The QName is the name of the variable and the value is the dynamic value of the variable.]

  • [Definition: Function implementations. Each function in in-scope functions has a function implementation that enables the function to map instances of its parameter types into an instance of its result type. For a user-defined function, the function implementation is an XQuery expression. For an external function, the function implementation is implementation-dependent.]

  • [Definition: Current date and time. This information represents an implementation-dependent point in time during processing of a query or transformation. It can be retrieved by the fn:current-date, fn:current-time, and fn:current-dateTime functions. If invoked multiple times during the execution of a query or transformation, these functions always return the same result.]

  • [Definition: Implicit timezone. This is the timezone to be used when a date, time, or dateTime value that does not have a timezone is used in a comparison or in any other operation. This value is an instance of xdt:dayTimeDuration that is implementation-defined . See [ISO 8601] for the range of legal values of a timezone.]

  • [Definition: Available documents. This is a mapping of strings onto document nodes. The string represents the absolute URI of a resource. The document node is the root of a tree that represents that resource using the data model. The document node is returned by the fn:doc function when applied to that URI.] The set of available documents is not constrained by the set of statically-known documents, and it may be empty.

  • [Definition: Available collections. This is a mapping of strings onto sequences of nodes. The string represents the absolute URI of a resource. The sequence of nodes represents the result of the fn:collection function when that URI is supplied as the argument. ] The set of available collections is not constrained by the set of statically-known collections, and it may be empty.

2.2 Processing Model

XQuery is defined in terms of the data model and in terms of the expression context.

Processing Model Overview

Figure 1: Processing Model Overview

Figure 1 provides a schematic overview of the processing steps that are discussed in detail below. Some of these steps are completely outside the domain of XQuery; in Figure 1, these are depicted outside the line that represents the boundaries of the language, an area labeled the external processing domain. The external processing domain includes generation of the data model (see 2.2.1 Data Model Generation), schema import processing (see 2.2.2 Schema Import Processing) and serialization (see 2.2.4 Serialization). The area inside the boundaries of the language is known as the query processing domain, which includes the static analysis and dynamic evaluation phases (see 2.2.3 Expression Processing). Consistency constraints on the query processing domain are defined in 2.2.5 Consistency Constraints.

2.2.1 Data Model Generation

Before an expression can be processed, the input documents to be accessed by the expression must be represented in the data model. This process occurs outside the domain of XQuery, which is why Figure 1 represents it in the external processing domain. Here are some steps by which an XML document might be converted to the data model:

  1. A document may be parsed using an XML parser that generates an XML Information Set (see [XML Infoset]). The parsed document may then be validated against one or more schemas. This process, which is described in [XML Schema], results in an abstract information structure called the Post-Schema Validation Infoset (PSVI). If a document has no associated schema, its Information Set is preserved. (See DM1 in Fig. 1.)

  2. The Information Set or PSVI may be transformed into the data model by a process described in [XQuery 1.0 and XPath 2.0 Data Model]. (See DM2 in Fig. 1.)

The above steps provide an example of how a document in the data model might be constructed. A document or fragment might also be synthesized directly from a relational database, or constructed in some other way (see DM3 in Fig. 1.) XQuery is defined in terms of operations on the data model, but it does not place any constraints on how documents and instances in the data model are constructed.

Each atomic value, element node, and attribute node in the data model is annotated with its dynamic type. The dynamic type specifies a range of values—for example, an attribute named version might have the dynamic type xs:decimal, indicating that it contains a decimal value. For example, if the data model was derived from an input XML document, the dynamic types of the elements and attributes are derived from schema validation.

The value of an attribute is represented directly within the attribute node. An attribute node whose type is unknown (such as might occur in a schemaless document) is annotated with the dynamic type xdt:untypedAtomic.

The value of an element is represented by the children of the element node, which may include text nodes and other element nodes. The dynamic type of an element node indicates how the values in its child text nodes are to be interpreted. An element whose type is unknown (such as might occur in a schemaless document) is annotated with the type xdt:untypedAny.

An atomic value of unknown type is annotated with the type xdt:untypedAtomic.

2.2.2 Schema Import Processing

The in-scope schema definitions in the static context may be extracted from actual XML Schemata as described in [XQuery 1.0 and XPath 2.0 Formal Semantics] (see step SI1 in Figure 1) or may be generated by some other mechanism (see step SI2 in Figure 1). In either case, the result must satisfy the consistency constraints defined in 2.2.5 Consistency Constraints.

2.2.3 Expression Processing

XQuery defines two phases of processing called the static analysis phase and the dynamic evaluation phase (see Fig. 1). An implementation is free to use any strategy or algorithm whose result conforms to these specifications.

2.2.3.1 Static Analysis Phase

[Definition: The static analysis phase depends on the expression itself and on the static context. The static analysis phase does not depend on input data (other than schemas).]

During the static analysis phase, the query is parsed into an internal representation called the operation tree (step SQ1 in Figure 1). A parse error is raised as a static error.[err:XP0003] The static context is initialized by the implementation (step SQ2). The static context is then changed and augmented based on information in the prolog (step SQ3). If the Schema Import Feature is supported, the in-scope schema definitions are populated with information from imported schemata. The static context is used to resolve type names, function names, namespace prefixes and variable names. If a name in the operation tree is not found in the static context, a static error [err:XP0008] is raised (step SQ4).

The operation tree is then normalized by making explicit the implicit operations such as atomization, type promotion and extraction of Effective Boolean Values (step SQ5). The normalization process is described in [XQuery 1.0 and XPath 2.0 Formal Semantics].

If the Static Typing Feature is supported, each expression is assigned a static type (step SQ6). [Definition: The static type of an expression may be either a named type or a structural description—for example, xs:boolean? denotes an optional occurrence of the xs:boolean type. The rules for inferring the static types of various expressions are described in [XQuery 1.0 and XPath 2.0 Formal Semantics].] In some cases, the static type is derived from the lexical form of the expression; for example, the static type of the literal 5 is xs:integer. In other cases, the static type of an expression is inferred according to rules based on the static types of its operands; for example, the static type of the expression 5 + 1.2 is xs:decimal.

During the static analysis phase, if the Static Typing Feature is in effect and an operand of an expression is found to have a static type that is not appropriate for that operand, a type error is raised.[err:XP0004] If static type checking raises no errors and assigns a static type T to an expression, then execution of the expression on valid input data is guaranteed either to produce a value of type T or to raise a dynamic error.

During the static analysis phase, if the Static Typing Feature is in effect and the static type assigned to an expression other than () is empty, a static error is raised.[err:XP0005] This catches cases in which a query refers to an element or attribute that is not present in the in-scope schema definitions, possibly because of a spelling error.

The purpose of type-checking during the static analysis phase is to provide early detection of type errors and to infer type information that may be useful in optimizing the evaluation of an expression.

2.2.3.2 Dynamic Evaluation Phase

[Definition: The dynamic evaluation phase occurs after completion of the static analysis phase. During the dynamic evaluation phase, the value of the query is computed.]

The dynamic evaluation phase can occur only if no errors were detected during the static analysis phase. If the Static Typing Feature is in effect, all type errors are detected during static analysis and serve to inhibit the dynamic evaluation phase. If the Static Typing Feature is not in effect, an implementation is allowed to raise type-related warnings during the static analysis phase, but it must proceed with the dynamic evaluation phase despite these warnings. In this case, type errors must be detected and raised during the dynamic evaluation phase.

The dynamic evaluation phase depends on the operation tree of the expression being evaluated (step DQ1), on the input data (step DQ4), and on the dynamic context (step DQ5), which in turn draws information from the external environment (step DQ3) and the static context (step DQ2). Execution of the evaluation phase may create new data-model values (step DQ4) and it may extend the dynamic context (step DQ5)—for example, by binding values to variables.

[Definition: A dynamic type is associated with each value as it is computed. The dynamic type of a value may be either a structural description (such as "sequence of integers") or a named type.] The dynamic type of a value may be more specific than the static type of the expression that computed it (for example, the static type of an expression might be "zero or more integers or strings," but at evaluation time its value may have the dynamic type "integer.")

If an operand of an expression is found to have a dynamic type that is not appropriate for that operand, a type error is raised.[err:XP0006]

Even though static typing can catch many type errors before an expression is executed, it is possible for an expression to raise an error during evaluation that was not detected by static analysis. For example, an expression may contain a cast of a string into an integer, which is statically valid. However, if the actual value of the string at run time cannot be cast into an integer, a dynamic error will result. Similarly, an expression may apply an arithmetic operator to a value whose static type is xdt:untypedAtomic. This is not a static error, but at run time, if the value cannot be successfully cast to a numeric type, a dynamic error will be raised.

When the Static Typing Feature is in effect, it is also possible for static analysis of an expression to raise a type error, even though execution of the expression on certain inputs would be successful. For example, an expression might contain a function that requires an element as its parameter, and the static analysis phase might infer the static type of the function parameter to be an optional element. This case is treated as a type error and inhibits evaluation, even though the function call would have been successful for input data in which the optional element is present.

2.2.4 Serialization

[Definition: Serialization is the process of converting a set of nodes from the data model into a sequence of octets (step DM4 in Figure 1.) ] The general framework for serialization of the data model is described in [XSLT 2.0 and XQuery 1.0 Serialization].

An XQuery implementation is not required to provide a serialization interface. For example, an implementation may only provide a DOM interface or an interface based on an event stream. In these cases, serialization would be done outside of the scope of this specification.

[XSLT 2.0 and XQuery 1.0 Serialization] defines a set of serialization parameters that govern the serialization process. If an XQuery implementation provides a serialization interface, it must support the "xml" value of the method parameter. In addition, the serialization interface may support (and may expose to users) any of the serialization parameters listed (with default values) in C.3 Serialization Parameters.

2.2.5 Consistency Constraints

In order for XQuery to be well defined, the data model, the static context, and the dynamic context must be mutually consistent. The consistency constraints listed below are prerequisites for correct functioning of an XQuery implementation. Enforcement of these consistency constraints is beyond the scope of this specification.

Some of the consistency constraints use the term data model schema. [Definition: For a given node in the data model, the data model schema is defined as the schema from which the type annotation of that node was derived.] For a node that was constructed by some process other than schema validation, the data model schema consists simply of the type definition that is represented by the type annotation of the node.

2.3 Documents

XQuery is generally used to process documents. The representation of a document is normatively defined in [XQuery 1.0 and XPath 2.0 Data Model]. The functions used to access documents and collections are normatively defined in [XQuery 1.0 and XPath 2.0 Functions and Operators]. Because documents are centrally important in XQuery processing, we provide a summary of some key concepts here.

2.3.1 Document Order

An ordering called document order is defined among all the nodes used during a given query or transformation, which may consist of one or more trees (documents or fragments). Document order is defined in [XQuery 1.0 and XPath 2.0 Data Model], and its definition is repeated here for convenience.

Document order is a total ordering, although the relative order of some nodes is implementation-dependent. Informally, document order is the order returned by an in-order, depth-first traversal of the data model. Document order is stable, which means that the relative order of two nodes will not change during the processing of a given query or transformation, even if this order is implementation-dependent.

Within a tree, document order satisfies the following constraints:

  1. The root node is the first node.

  2. The relative order of siblings is determined by their order in the XML representation of the tree. A node N1 occurs before a node N2 in document order if and only if the start of N1 occurs before the start of N2 in the XML representation.

  3. Namespace nodes immediately follow the element node with which they are associated. The relative order of namespace nodes is stable but implementation-dependent.

  4. Attribute nodes immediately follow the namespace nodes of the element with which they are associated. The relative order of attribute nodes is stable but implementation-dependent.

  5. Element nodes occur before their children; children occur before following-siblings.

The relative order of nodes in distinct trees is stable but implementation-dependent, subject to the following constraint: If any node in tree T1 is before any node in tree T2, then all nodes in tree T1 are before all nodes in tree T2.

2.3.2 Atomization

The semantics of some XQuery operators depend on a process called atomization. [Definition: Atomization is applied to a value when the value is used in a context in which a sequence of atomic values is required. The result of atomization is either a sequence of atomic values or a type error. Atomization of a sequence is defined as the result of invoking the fn:data function on the sequence, as defined in [XQuery 1.0 and XPath 2.0 Functions and Operators].]

The semantics of fn:data are repeated here for convenience. The result of fn:data is the sequence of atomic values produced by applying the following rules to each item in the input sequence:

  • If the item is an atomic value, it is returned.

  • If the item is a node, its typed value is returned.

Atomization is used in processing the following types of expressions:

  • Arithmetic expressions

  • Comparison expressions

  • Function calls and returns

  • Cast expressions

  • Computed element and attribute constructors.

2.3.3 Effective Boolean Value

Under certain circumstances (listed below), it is necessary to find the effective boolean value of a value. [Definition: The effective boolean value of a value is defined as the result of applying the fn:boolean function to the value, as defined in [XQuery 1.0 and XPath 2.0 Functions and Operators].]

The semantics of fn:boolean are repeated here for convenience. fn:boolean returns false if its operand is any of the following:

  • An empty sequence

  • The boolean value false

  • A zero-length value of type xs:string or xdt:untypedAtomic

  • A numeric value that is equal to zero

  • The xs:double or xs:float value NaN

Otherwise, fn:boolean returns true.

The effective boolean value of a sequence is computed implicitly during processing of the following types of expressions:

  • Logical expressions (and, or)

  • The fn:not function

  • The where clause of a FLWOR expression

  • Certain types of predicates, such as a[b]

  • Conditional expressions (if)

  • Quantified expressions (some, every)

Note:

Note that the definition of effective boolean value is not used when casting a value to the type xs:boolean.

2.3.4 Input Sources

XQuery has a set of functions that provide access to input data. These functions are of particular importance because they provide a way in which an expression can reference a document or a collection of documents. The input functions are described informally here; they are defined in [XQuery 1.0 and XPath 2.0 Functions and Operators].

An expression can access input documents either by calling one of the input functions or by referencing some part of the expression context that is initialized by the external environment, such as a variable or a context item.

The input functions supported by XQuery are as follows:

  • The fn:doc function takes a string containing a URI that refers to an XML document, and returns a document node whose content is the data model representation of the given document.

  • The fn:collection function takes a string containing a URI, and returns the data model representation of the collection identified by the URI. A collection may be any sequence of nodes. For example, the expression fn:collection("http://example.org")//customer identifies all the customer elements that are descendants of nodes found in the collection whose URI is http://example.org.

If a given input function is invoked repeatedly with arguments that resolve to the same absolute URI during the scope of a single query or transformation, each invocation returns the same result.

2.4 Types

XQuery is a strongly typed language with a type system based on [XML Schema]. The XQuery type system is formally defined in [XQuery 1.0 and XPath 2.0 Formal Semantics].

2.4.1 Predefined Types

The in-scope type definitions in the static context are initialized with certain predefined types, including the built-in types of [XML Schema]. These built-in types are in the namespace http://www.w3.org/2001/XMLSchema, which has the predefined namespace prefix xs. Some examples of built-in schema types include xs:integer, xs:string, and xs:date. Element and attribute definitions in the xs namespace are not implicitly included in the static context.

In addition, the predefined types of XQuery include the types defined in the namespace http://www.w3.org/2003/11/xpath-datatypes, which has the predefined namespace prefix xdt. The types in this namespace are defined in [XQuery 1.0 and XPath 2.0 Functions and Operators] and are summarized below.

  1. xdt:anyAtomicType is an abstract type that includes all atomic values (and no values that are not atomic). It is a subtype of xs:anySimpleType, which is the base type for all simple types, including atomic, list, and union types. All specific atomic types such as xs:integer, xs:string, and xdt:untypedAtomic, are subtypes of xdt:anyAtomicType.

  2. xdt:untypedAny is a concrete type used to denote the dynamic type of an element node that has not been assigned a more specific type. It has no subtypes. An element that has been validated in skip mode, or that has a PSVI type property of xs:anyType, is represented in the Data Model by an element node with the type xdt:untypedAny.

  3. xdt:untypedAtomic is a concrete type used to denote untyped atomic data, such as text that has not been assigned a more specific type. It has no subtypes. An attribute that has been validated in skip mode, or that has a PSVI property of xs:anySimpleType, is represented in the Data Model by an attribute node with the type xdt:untypedAtomic.

  4. xdt:dayTimeDuration is a concrete subtype of xs:duration whose lexical representation contains only day, hour, minute, and second components.

  5. xdt:yearMonthDuration is a concrete subtype of xs:duration whose lexical representation is restricted to contain only year and month components.

The relationships among the types in the xs and xdt namespaces are illustrated in Figure 2. The abstract types, represented by ovals in the figure, may be assigned to an expression during the static analysis phase if no more specific type can be inferred for the expression. During the dynamic evaluation phase, each node or value in the data model is assigned a concrete type, represented by one of the types listed in the rectangular boxes in Figure 2. A more complete description of the XQuery type hierarchy can be found in [XQuery 1.0 and XPath 2.0 Functions and Operators].

Type Hierarchy Diagram

Figure 2: Summary of XQuery Type Hierarchy

2.4.2 Typed Value and String Value

In the data model, every node has a typed value and a string value. The typed value of a node is a sequence of atomic values and can be extracted by applying the fn:data function to the node. The typed value for each kind of node is defined by the dm:typed-value accessor in [XQuery 1.0 and XPath 2.0 Data Model]. The string value of a node is a string and can be extracted by applying the fn:string function to the node. The string value for each kind of node is defined by the dm:string-value accessor in [XQuery 1.0 and XPath 2.0 Data Model]. Element and attribute nodes have a type annotation, which represents (in an implementation-dependent way) the dynamic (run-time) type of the node. In the [XQuery 1.0 and XPath 2.0 Data Model], type annotation is defined by the dm:type accessor; however, XQuery does not provide a way to directly access the type annotation of an element or attribute node.

The relationship between the typed value and the string value for various kinds of nodes is described and illustrated by examples below.

  1. For text, document, and namespace nodes, the typed value of the node is the same as its string value, as an instance of the type xdt:untypedAtomic. (The string value of a document node is formed by concatenating the string values of all its descendant text nodes, in document order.)

  2. The typed value of a comment or processing instruction node is the same as its string value. It is an instance of the type xs:string.

  3. The typed value of an attribute node with the type annotation xdt:untypedAtomic is the same as its string value, as an instance of xdt:untypedAtomic. The typed value of an attribute node with any other type annotation is derived from its string value and type annotation in a way that is consistent with schema validation.

    Example: A1 is an attribute having string value "3.14E-2" and type annotation xs:double. The typed value of A1 is the xs:double value whose lexical representation is 3.14E-2.

    Example: A2 is an attribute with type annotation xs:IDREFS, which is a list datatype derived from the atomic datatype xs:IDREF. Its string value is "bar baz faz". The typed value of A2 is a sequence of three atomic values ("bar", "baz", "faz"), each of type xs:IDREF. The typed value of a node is never treated as an instance of a named list type. Instead, if the type annotation of a node is a list type (such as xs:IDREFS), its typed value is treated as a sequence of the atomic type from which it is derived (such as xs:IDREF).

  4. For an element node, the relationship between typed value and string value depends on the node's type annotation, as follows:

    1. If the type annotation is xdt:untypedAtomic, or denotes a complex type with mixed content, then the typed value of the node is equal to its string value, as an instance of xdt:untypedAtomic.

      Note:

      Since xs:untypedAny is a complex type with mixed content, this rule applies to elements whose type is xs:untypedAny.

      Example: E1 is an element node having type annotation xdt:untypedAny and string value "1999-05-31". The typed value of E1 is "1999-05-31", as an instance of xdt:untypedAtomic.

      Example: E2 is an element node with the type annotation formula, which is a complex type with mixed content. The content of E2 consists of the character "H", a child element named subscript with string value "2", and the character "O". The typed value of E2 is "H2O" as an instance of xdt:untypedAtomic.

    2. If the type annotation denotes a simple type or a complex type with simple content, then the typed value of the node is derived from its string value and its type annotation in a way that is consistent with schema validation.

      Example: E3 is an element node with the type annotation cost, which is a complex type that has several attributes and a simple content type of xs:decimal. The string value of E3 is "74.95". The typed value of E3 is 74.95, as an instance of xs:decimal.

      Example: E4 is an element node with the type annotation hatsizelist, which is a simple type derived from the atomic type hatsize, which in turn is derived from xs:integer. The string value of E4 is "7 8 9". The typed value of E4 is a sequence of three values (7, 8, 9), each of type hatsize.

    3. If the type annotation denotes a complex type with empty content, then the typed value of the node is the empty sequence.

    4. If the type annotation denotes a complex type with element-only content, then the typed value of the node is undefined. The fn:data function raises a type error [err:XP0007] when applied to such a node.

      Example: E5 is an element node with the type annotation weather, which is a complex type whose content type specifies element-only. E5 has two child elements named temperature and precipitation. The typed value of E5 is undefined, and the fn:data function applied to E5 raises an error.

2.4.3 SequenceType Syntax

[Definition: When it is necessary to refer to a type in an XQuery expression, the SequenceType syntax is used. The name SequenceType suggests that this syntax is used to describe the type of an XQuery value, which is always a sequence.]

[125]    SequenceType    ::=    (ItemType OccurrenceIndicator?)
| ("empty" "(" ")")
[144]    OccurrenceIndicator    ::=    "?" | "*" | "+"
[127]    ItemType    ::=    AtomicType | KindTest | ("item" "(" ")")
[126]    AtomicType    ::=    QName
[128]    KindTest    ::=    DocumentTest
| ElementTest
| AttributeTest
| PITest
| CommentTest
| TextTest
| AnyKindTest
[137]    PITest    ::=    "processing-instruction" "(" (NCName | StringLiteral)? ")"
[139]    CommentTest    ::=    "comment" "(" ")"
[140]    TextTest    ::=    "text" "(" ")"
[141]    AnyKindTest    ::=    "node" "(" ")"
[138]    DocumentTest    ::=    "document-node" "(" ElementTest? ")"
[129]    ElementTest    ::=    "element" "(" ((SchemaContextPath ElementName)
| (ElementNameOrWildcard ("," TypeNameOrWildcard "nillable"?)?))? ")"
[130]    AttributeTest    ::=    "attribute" "(" ((SchemaContextPath AttributeName)
| (AttribNameOrWildcard ("," TypeNameOrWildcard)?))? ")"
[131]    ElementName    ::=    QName
[132]    AttributeName    ::=    QName
[133]    TypeName    ::=    QName
[134]    ElementNameOrWildcard    ::=    ElementName | "*"
[135]    AttribNameOrWildcard    ::=    AttributeName | "*"
[136]    TypeNameOrWildcard    ::=    TypeName | "*"
[142]    SchemaContextPath    ::=    SchemaGlobalContext "/" (SchemaContextStep "/")*
[14]    SchemaGlobalContext    ::=    QName | SchemaGlobalTypeName
[15]    SchemaContextStep    ::=    QName
[13]    SchemaGlobalTypeName    ::=    "type" "(" QName ")"

QNames appearing in a SequenceType have their prefixes expanded to namespace URIs by means of the in-scope namespaces and the default element/type namespace. It is a static error [err:XP0008] to use a TypeName in an ElementTest or AttributeTest if that name is not found in the in-scope type definitions. It is a static error [err:XP0008] to use an ElementName in an ElementTest if that name is not found in the in-scope element definitions unless a TypeNameOrWildcard is specified. It is a static error [err:XP0008] to use a (SchemaContextPath ElementName) pair in an ElementTest if the ElementName can not be located from the in-scope element definitions using the SchemaContextPath. It is a static error [err:XP0008] to use an AttributeName in an AttributeTest if that name is not found in the in-scope attribute definitions unless a TypeNameOrWildcard is specified. It is a static error [err:XP0008] to use a (SchemaContextPath AttributeName) pair in an AttributeTest if the AttributeName can not be located from the in-scope attribute definitions using the SchemaContextPath. If a QName that is used as an AtomicType is not defined as an atomic type in the in-scope type definitions, a static error is raised. [err:XP0051]

Here are some examples of SequenceTypes that might be used in XQuery expressions:

  • xs:date refers to the built-in Schema type date

  • attribute()? refers to an optional attribute

  • element() refers to any element

  • element(po:shipto, po:address) refers to an element that has the name po:shipto (or is in the substitution group of that element), and has the type annotation po:address (or a subtype of that type)

  • element(po:shipto, *) refers to an element named po:shipto (or in the substitution group of po:shipto), with no restrictions on its type

  • element(*, po:address) refers to an element of any name that has the type annotation po:address (or a subtype of po:address). If the keyword nillable were used following po:address, that would indicate that the element may have empty content and the attribute xsi:nil="true", even though the declaration of the type po:address has required content.

  • node()* refers to a sequence of zero or more nodes of any type

  • item()+ refers to a sequence of one or more nodes or atomic values

2.4.4 SequenceType Matching

[Definition: During evaluation of an expression, it is sometimes necessary to determine whether a value with a known type "matches" an expected type, expressed in the SequenceType syntax. This process is known as SequenceType matching.] For example, an instance of expression returns true if the actual type of a given value matches a given type, or false if it does not.

Note:

In this specification, the word "type", when used without modification, represents a type that can be expressed using the SequenceType production. When we refer specifically to W3C XML Schema simple or complex types, appropriate modifiers are used to make this clear.

The rules for SequenceType matching compare the actual type of a value with an expected type. These rules are a subset of the static typing rules defined in [XQuery 1.0 and XPath 2.0 Formal Semantics], which compare the static type of an expression with the expected type of the context in which the expression is used. The static typing rules are a superset of the SequenceType matching rules because the static type of an expression is typically more general than the dynamic type of the value produced by evaluating the expression. For example, the static type of the expression if (expr) then "true" else 0 is xs:string | xs:integer, as described in [XQuery 1.0 and XPath 2.0 Formal Semantics]. However, if expr evaluates to true, then the dynamic type of this expression is xs:string.

Some of the rules for SequenceType matching require matching of simple or complex types to determine whether a given type is the same as or derived from an expected type. These types may be "known" types, which are defined in the in-scope schema definitions, or "unknown" types, which are not defined in the in-scope schema definitions. An unknown type might be encountered, for example, if the module in which the given type is encountered does not import the schema in which the given type is defined. In this case, an implementation is allowed (but is not required) to provide an implementation-dependent mechanism for determining whether the unknown type is compatible with the expected type. For example, an implementation might maintain a data dictionary containing information about type hierarchies.

We define the process of matching simple or complex types using a pseudo-function named type-matches(ET, AT) that takes an expected simple or complex type ET and an actual simple or complex type AT, and either returns a boolean value or raises a type error. [err:XP0004][err:XP0006] This pseudo-function type-matches is defined as follows:

  • type-matches(ET, AT) returns true if:

    1. AT is a known type, and is the same as ET, or is derived by one or more steps of restriction or extension from ET, or

    2. AT is an unknown type, and an implementation-dependent mechanism is able to determine that AT is derived by restriction from ET.

  • type-matches(ET, AT) returns false if:

    1. AT is a known type, and is not the same as ET, and is not derived by one or more steps of restriction or extension from ET, or

    2. AT is an unknown type, and an implementation-dependent mechanism is able to determine that AT is not derived by restriction from ET.

  • type-matches(ET, AT) raises a type error [err:XP0004][err:XP0006] if:

    1. ET is an unknown type, or

    2. AT is an unknown type, and the implementation is not able to determine whether AT is derived by restriction from ET.

Note:

The type-matches pseudo-function can not be written as a real XQuery function, because types are not valid function parameters.

The rules for SequenceType matching are given below, with examples (the examples are for purposes of illustration, and do not cover all possible cases).

2.4.4.1 Matching a SequenceType and a Value
  • The SequenceType empty() matches a value that is the empty sequence.

  • An ItemType with no OccurrenceIndicator matches any value that contains exactly one item if the ItemType matches that item (see 2.4.4.2 Matching an ItemType and an Item).

  • An ItemType with an OccurrenceIndicator matches a value if the number of items in the value matches the OccurrenceIndicator and the ItemType matches each of the items in the value.

An OccurrenceIndicator specifies the number of items in a sequence, as follows:

  • ? matches zero or one items

  • * matches zero or more items

  • + matches one or more items

As a consequence of these rules, any SequenceType whose OccurrenceIndicator is * or ? matches a value that is an empty sequence.

2.4.4.2 Matching an ItemType and an Item
  • An ItemType consisting simply of a QName is interpreted as an AtomicType. An AtomicType AtomicType matches an atomic value whose actual type is AT if type-matches(AtomicType, AT) is true.

    Example: The AtomicType xs:decimal matches the value 12.34 (a decimal literal). xs:decimal also matches a value whose type is shoesize, if shoesize is an atomic type derived by restriction from xs:decimal.

    A named atomic type may be a generic type such as xdt:anyAtomicType. Note that the names of non-atomic types such as xs:IDREFS are not accepted in this context, but can often be replaced by an atomic type with an occurrence indicator, such as xs:IDREF*.

  • item() matches any single item.

    Example: item() matches the atomic value 1 or the element <a/>.

  • node() matches any node.

  • text() matches any text node.

  • processing-instruction() matches any processing-instruction node.

  • processing-instruction(N) matches any processing-instruction node whose name (called its "PITarget" in XML) is equal to N, where N is an NCName.

    Example: processing-instruction(xml-stylesheet) matches any processing instruction whose PITarget is xml-stylesheet.

    For backward compatibility with XPath 1.0, the PITarget of a processing instruction may also be expressed as a string literal, as in this example: processing-instruction("xml-stylesheet").

  • comment() matches any comment node.

  • document-node() matches any document node.

  • document-node(E) matches any document node that contains zero or more comments and processing instructions and contains exactly one element node, if E is an ElementTest that matches the element node (see 2.4.4.3 Matching an ElementTest and an Element Node).

    Example: document-node(element(book)) matches any document node containing zero or more comments and processing instructions and exactly one element node that is matched by the ElementTest element(book).

  • An ItemType that is an ElementTest or AttributeTest matches an element or attribute node as described in the following sections.

2.4.4.3 Matching an ElementTest and an Element Node

[Definition: An ElementTest is used to match an element node by its name and/or type.]

In the following rules, ElementName and TypeName are names that match the corresponding productions in the grammar, where TypeName is optionally followed by the keyword nillable. The pair SchemaContextPath ElementName represents a path that matches the corresponding productions in the grammar. Note that the SchemaContextPath ElementName pair is just one path; for instance, the path hospital/staff/person is an example of such a pair, where hospital/staff/ is the SchemaContextPath and person is the ElementName. Two QNames "match" if their expanded forms (URIs and local names) are identical.

An ElementTest may take one of the following forms:

  1. element(), element(*), and element(*,*) match any single element node, regardless of its name or type.

  2. element(ElementName, TypeName) matches a given element node if:

    1. the name of the element node matches ElementName or matches the name of an element in a substitution group headed by an element with the name ElementName, and:

    2. type-matches(TypeName, AT) is true, where AT is the type of the given element node. However, if the given element node has the nilled property, then this rule is satisfied only if TypeName is followed by the keyword nillable.

    For this form, there is no requirement that ElementName be defined in the in-scope element declarations.

    Example: element(person, surgeon) matches an non-nilled element node whose name is person and whose type annotation is surgeon.

    Example: element(person, surgeon nillable) matches an element node whose name is person and whose type annotation is surgeon, and permits the element node to have the nilled property.

  3. element(ElementName) matches an element node if:

    1. the name of the element node matches ElementName or matches the name of an element in a substitution group headed by an element with the name ElementName, and:

    2. type-matches(ST, AT) is true, where ST is the simple or complex type of element ElementName in the in-scope element declarations, and AT is the type of the given element node. However, if the given element node has the nilled property, then this rule is satisfied only if ST includes the nillable option.

    Example: element(person) matches an element node whose name is person and whose type matches the type of the top-level person element declaration in the in-scope element declarations.

  4. element(ElementName, *) matches an element node of any type if the name of the element matches ElementName or matches the name of an element in a substitution group headed by an element with the name ElementName.

    For this form, there is no requirement that ElementName be defined in the in-scope element declarations.

    Example: element(person, *) matches any element node whose name is person, regardless of its type.

  5. element(*, TypeName) matches a given element node regardless of its name, if type-matches(TypeName, AT) is true, where AT is the type of the given element node. However, if the given element node has the nilled property, then this rule is satisfied only if TypeName is followed by the keyword nillable.

    Example: element(*, surgeon) matches any non-nilled element node whose type annotation is surgeon, regardless of its name.

    Example: element(*, surgeon nillable) matches any element node whose type annotation is surgeon, regardless of its name, and permits the element to have the nilled property.

  6. element(SchemaContextPath ElementName) matches a given element node if:

    1. the name of the given element node matches the ElementName, and:

    2. type-matches(ST, AT) is true, where ST is the type of the element declaration that would be associated with an element named ElementName in the context identified by SchemaContextPath. (This may be either a locally declared element or a top-level element.) However, if the given element node has the nilled property, then this rule is satisfied only if ST includes the nillable option. If SchemaContextPath and ElementName together do not identify a valid schema path in the in-scope schema definitions, a static error is raised.[err:XP0055]

    Example: element(hospital/staff/person) matches an element node whose name is person and whose type matches the type of the element identified by the schema path hospital/staff/person.

    Example: element(type(schedule)/person) matches an element node whose name is person and whose type matches the type of a person element within the named type schedule.

2.4.4.4 Matching an AttributeTest and an Attribute Node

[Definition: An AttributeTest is used to match an attribute node by its name and/or type.]

In the following rules, AttributeName and TypeName are names that match the corresponding productions in the grammar. The pair SchemaContextPath AttributeName represents a path that matches the corresponding productions in the grammar. Note that the SchemaContextPath AttributeName pair is just one path; for instance, the path catalog/product/price is an example of such a pair, where catalog/product/ is the SchemaContextPath and price is the AttributeName. Two QNames "match" if their expanded forms (URIs and local names) are identical.

An AttributeTest may take one of the following forms:

  1. attribute(), attribute(*), and attribute(*,*) match any single attribute node, regardless of its name or type.

  2. attribute(AttributeName, TypeName) matches a given attribute node if:

    1. the name of the given attribute node matches AttributeName, and:

    2. type-matches(TypeName, AT) is true, where AT is the type annotation of the given attribute node.

    For this form, there is no requirement that AttributeName be defined in the in-scope attribute declarations.

    Example: attribute(price, currency) matches an attribute node whose name is price and whose type annotation is currency.

  3. attribute(AttributeName) matches a given attribute node if:

    1. the name of the given attribute node matches AttributeName, and:

    2. type-matches(ST, AT) is true, where ST is the simple or complex type of attribute AttributeName in the in-scope attribute declarations, and AT is the type of the given attribute node.

    Example: attribute(price) matches an attribute node whose name is price and whose type annotation matches the top-level attribute declaration for a price attribute.

  4. attribute(AttributeName, *) matches an attribute node of any type if the name of the node matches AttributeName.

    For this form, there is no requirement that AttributeName be defined in the in-scope attribute declarations.

    Example: attribute(price, *) matches any attribute node whose name is price, regardless of its type annotation.

  5. attribute(*, TypeName) matches a given attribute node if type-matches(TypeName, AT) is true, where AT is the type annotation of the given attribute node.

    Example: attribute(*, currency) matches any attribute node whose type annotation is currency, regardless of its name.

  6. attribute(SchemaContextPath AttributeName) matches a given attribute node if:

    1. the name of the given attribute node matches the AttributeName, and:

    2. type-matches(ST, AT) is true, where ST is the type of the attribute declaration that would be associated with an