Please check the errata for any errors or issues reported since publication.
See also translations.
This document is also available in these non-normative formats: XML and Change markings relative to previous edition.
Copyright © 2000 W3C® (MIT, ERCIM, Keio, Beihang). W3C liability, trademark and document use rules apply.
This document defines the XQuery and XPath Data Model 4.0, which is the data model of [XML Path Language (XPath) 4.0], [XSL Transformations (XSLT) Version 4.0], and [XQuery 4.0: An XML Query Language], and any other specifications that reference it. This document is the result of joint work by the [XSLT Working Group] and the [XML Query Working Group].
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 https://www.w3.org/TR/.
This document is governed by the 1 March 2017 W3C Process Document.
This is a Recommendation of the W3C. It was jointly developed by the W3C XML Query Working Group and the W3C XSLT Working Group, each of which is part of the XML Activity.
This Editor's Draft specifies the XQuery and XPath Data Model (XDM) version 4.0, a fully compatible extension of XDM version 3.1.
This specification is designed to be referenced normatively from other specifications defining a host language for it; it is not intended to be implemented outside a host language. The implementability of this specification has been tested in the context of its normative inclusion in host languages defined by the XQuery 3.1 and XSLT 3.0 specifications; see the XQuery 3.1 implementation report (and, in the future, the WGs expect that there will also be an XSLT 3.0 implementation report) for details.
No substantive changes have been made to this specification since its publication as a Proposed Recommendation.
Please report errors in this document using W3C's public Bugzilla system (instructions can be found at https://www.w3.org/XML/2005/04/qt-bugzilla). If access to that system is not feasible, you may send your comments to the W3C XSLT/XPath/XQuery public comments mailing list, public-qt-comments@w3.org. It will be very helpful if you include the string “[XDM31]” in the subject line of your report, whether made in Bugzilla or in email. Please use multiple Bugzilla entries (or, if necessary, multiple email messages) if you have more than one comment to make. Archives of the comments and responses are available at https://lists.w3.org/Archives/Public/public-qt-comments/.
This document has been reviewed by W3C Members, by software developers, and by other W3C groups and interested parties, and is endorsed by the Director as a W3C Recommendation. It is a stable document and may be used as reference material or cited from another document. W3C's role in making the Recommendation is to draw attention to the specification and to promote its widespread deployment. This enhances the functionality and interoperability of the Web.
This document was produced by groups operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures (W3C XML Query Working Group) and a public list of any patent disclosures (W3C XSLT Working Group) made in connection with the deliverables of each group; these pages also include instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
Changes in 4.0 ⬇
Use the arrows to browse significant changes since the 3.1 version of this specification.
Sections with significant changes are marked Δ in the table of contents.
This document defines the XQuery and XPath Data Model 4.0, which is the data model of [XML Path Language (XPath) 4.0], [XSL Transformations (XSLT) Version 4.0], and [XQuery 4.0: An XML Query Language].
The XQuery and XPath Data Model 4.0 (henceforth “data model”) serves two purposes. First, it defines the information contained in the input to an XSLT or XQuery processor. Second, it defines all permissible values of expressions in the XSLT, XQuery, and XPath languages. A language is closed with respect to a data model if the value of every expression in the language is guaranteed to be in the data model. XSLT 4.0, XQuery 4.0, and XPath 4.0 are all closed with respect to the data model.
The data model describes items similar to those of the [Infoset] (henceforth “Infoset”). It is written to provide a data model suitable for XPath, XQuery and XSLT, which was not a goal of the Infoset, and this leads to a number of differences, some of which are:
Support for XML Schema types. The XML Schema recommendations define features, such as structures ([Schema Part 1]) and simple data types ([Schema Part 2]), that extend the Infoset with precise type information.
Representation of collections of documents and of complex values.
Support for typed atomic items.
Support for ordered, heterogeneous sequences.
As with the Infoset, the XQuery and XPath Data Model 4.0 specifies what information in the documents is accessible but does not specify the programming-language interfaces or bindings used to represent or access the data.
The data model can represent various values, including not only the input and the output of a stylesheet or query but all values of expressions used during the intermediate calculations. Examples include the input document or document repository (represented as a document node or a sequence of document nodes), the result of a path expression (represented as a sequence of nodes), the result of an arithmetic or a logical expression (represented as an atomic item), a sequence expression resulting in a sequence of items, etc.
This document provides a precise definition of the properties of nodes in the XQuery and XPath Data Model 4.0, how they are accessed, and how they relate to values in the Infoset and PSVI.
This section outlines a number of general concepts that apply throughout this specification.
In this document, examples and material labeled as “Note” are provided for explanatory purposes and are not normative.
For a full glossary of terms, see C Glossary.
In this specification the phrases must, must not, should, should not, may, required, and recommended, when used in normative text and rendered in small capitals, are to be interpreted as described in [RFC 2119].
[Definition: Implementation-defined indicates an aspect that may differ between implementations, but must be specified by the implementer for each particular implementation.]
[Definition: Implementation-dependent indicates an aspect that may differ between implementations, is not specified by this or any W3C specification, and is not required to be specified by the implementer for any particular implementation.]
In all cases where this specification leaves the behavior implementation-defined or implementation-dependent, the implementation has the option of providing mechanisms that allow the user to influence the behavior.
This specification distinguishes between the data model as a general concept and specific items (documents, elements, atomic items, etc.) that are concrete examples of the data model by identifying all concrete examples as instances of the data model.
Sometimes it is necessary to distinguish the case where a particular property has no value in the data model. The canonical example of such a case is the namespace URI property of an expanded QName that is not in any namespace. For such properties, it is convenient to be able to speak of “the state of having no value”. [Definition: When a property has no value, we say that it is absent.]
Within this specification, the term URI refers to a Uniform Resource Identifier as defined in [RFC 3986] and extended in [RFC 3987] with the new name Internationalized Reference Identifier, IRI. The term URI has been retained in preference to IRI to avoid introducing new names for concepts such as “Base URI” that are defined or referenced across the whole family of XML specifications.
Clarified the terminology concerning atomic types and type annotations. [Issue 225 PR 232 5 November 2022]
The term atomic value has been replaced by atomic item. [Issue 1337 PR 1361 2 August 2024]
[Definition: Every instance of the data model is a sequence.]
[Definition: A sequence is an ordered collection of zero or more items.] A sequence cannot be a member of a sequence. A single item appearing on its own is modeled as a sequence containing one item. Sequences are defined in 2.6 Sequences.
[Definition: Because every value is a sequence, the term value is used synonymously with sequence.]
[Definition: An item is either a node, a function, or an atomic item.]
[Definition: An item type represents a class of items.] An item is said to be an instance of an item type (or to match the item type) if it is a member of that class. Items generally belong to more than one item type, and the membership of different item types is overlapping.
Every node is one of the seven kinds of nodes defined in Section 5 Nodes. Nodes form a tree. Each node has at most one parent (reachable via the dm:parent accessor) and zero or more descendant nodes that are reachable directly or indirectly via the dm:children, dm:attributes, and dm:namespace-nodes accessors.
[Definition: The root node is the topmost node of a tree, the node with no parent.] Every tree has exactly one root node and every other node can be reached from exactly one root node.
Note:
The term “root node” means any node that has no parent. It may be any kind of node. In the XPath 1.0 datamodel the term “root node” was used to refer to a document node.
Note:
Generally, the term tree is used to refer to a complete tree rooted at a parentless node. On occasions, which should be clear from the context, the same term is used to refer to a subtree, that is, a tree forming part of a larger tree.
[Definition: A tree whose root node is a document node is referred to as a document.]
[Definition: A tree whose root node is not a document node is referred to as a fragment.]
[Definition: An atomic item is a pair (T, D) where T (the type annotation) is an atomic type, and D (the datum) is a point in the value space of T.]
[Definition: The datum of an atomic item is a point in the value space of its type, which is also a point in the value space of the primitive type from which that type is derived.] There are 20 primitive atomic types (19 defined in XSD, plus xs:untypedAtomic
), and these have non-overlapping value spaces, so each datum belongs to exactly one primitive atomic type.
Note:
The term value space is defined in [Schema 1.1 Part 2] as a set of values. The term datum is used here in preference to value, because value has a different meaning in this data model.
[Definition: An atomic type is either a primitive simple typewith variety atomic
, or a type derived by restriction from another atomic type.] (Types derived by list or union are not atomic.)
Note:
Atomic types include the 19 primitive atomic types defined in XSD (such as xs:string
, xs:boolean
, and xs:decimal
), the built-in non-primitive types defined in XSD (such as xs:integer
, and xs:NCName
, and xs:dayTimeDuration
), atomic types derived from these in a user-defined schema, and the special type xs:untypedAtomic
.
[Definition: The primitive simple types are the types defined in 2.2.1 Types adopted from XML Schema.]
[Definition: The term type annotation has two slightly different meanings. For an atomic item, the type annotation of the value is the most specific atomic type that it is an instance of (it is also an instance of every type from which that type is derived). For an element or attribute node, the type annotation is the schema type (a simple or complex type) against which the node has been validated, defaulting to xs:untypedAtomic
for unvalidated attribute nodes, and xs:untyped
for unvalidated element nodes.]
Named types are identified in the data model by an expanded QName. A schema may also contain anonymous types, and these may be used as type annotations on nodes and atomic items; anonymous types, however, cannot be referenced explicitly in programs.
[Definition: An expanded QName is a triple consisting of a possibly absent prefix, a possibly absent namespace URI, and a local name.] See 3.3.3 QNames and NOTATIONS.
[Definition: A schema type corresponds to a type definition component as defined in XSD.] Schema types are either complex types or simple types; simple types are either atomic types, list types, or union types.
The data model adopts the following schema types:
The 19 primitive atomic types defined in Section 3.2 Primitive datatypesXS2 of [Schema Part 2].
Three built-in list types: xs:NMTOKENS
, xs:IDREFS
, and xs:ENTITIES
.
The following types, which were originally defined in [XQuery 1.0 and XPath 2.0 Data Model (XDM)] and were subsequently adopted by [Schema 1.1 Part 2]: xs:anyAtomicType
, xs:dayTimeDuration
, xs:yearMonthDuration
.
In the case of a processor that supports [Schema 1.1 Part 2], the new union type xs:error
(a type with no instances) and the new derived type xs:dateTimeStamp
.
The following types, which use the xs:
namespace and are defined here in the data model but not in XML Schema: xs:untypedAtomic
, and xs:numeric
, a union type whose members are xs:double
, xs:float
and xs:decimal
.
Schema types fulfill a role different from item types. Schema types other than atomic types arise in the data model only as type annotations on element and attribute nodes. Nodes are not instances of schema types in the sense of the XPath instance of
operator; but an element or attribute node may be an instance of the item type element(*, S)
or attribute(*, S)
where S
is a schema type. The node matches this item type if its type annotation is S
, or a type derived from S
, which will be the case if the node has been validated against type S
in the course of schema validation.
Schema types and item types form overlapping categories:
Atomic types belong to both categories.
Node types and function types are item types, but they are not schema types.
Complex types, list types, and union types are schema types, but they are not item types.
To explain the data model, this specification uses both prose and a defined set of accessor functions. The accessors are shown with the prefix dm:. This prefix is always shown in italics to emphasize that these functions are abstract; they exist to explain the interface between the data model and specifications that rely on the data model: they are not accessible directly from the host language.
Several prefixes are used throughout this document for notational convenience. The following bindings are assumed.
xs:
bound to http://www.w3.org/2001/XMLSchema
xsi:
bound to http://www.w3.org/2001/XMLSchema-instance
fn:
bound to http://www.w3.org/2005/xpath-functions
In practice, any prefix that is bound to the appropriate URI may be used.
The signature of accessor functions is shown using the same style as [XQuery and XPath Functions and Operators 4.0], described in Section 1.5 Function signatures and descriptionsFO40.
This document relies on the [Infoset] and Post-Schema-Validation Infoset (PSVI). Information items and properties are indicated by the styles information item and [infoset property], respectively.
Some aspects of type assignment rely on the ability to access properties of the schema components. Such properties are indicated by curly brackets, e.g., {component property}. Note that this does not mean a lightweight schema processor cannot be used, it only means that the application must have some mechanism to access the necessary properties.
Each node has a unique identity. The identity of a node is distinct from its value or other intrinsic properties; nodes may be distinct even when they have the same values for all intrinsic properties other than their identity. (The identity of atomic items, by contrast, is determined solely by their intrinsic properties. No two distinct integers, for example, have the same value; every instance of the value “5” as an integer is identical to every other instance of the value “5” as an integer.)
Note:
The concept of node identity should not be confused with the concept of a unique ID, which is a unique name assigned to an element by the author to represent references using ID/IDREF correlation.
[Definition: A document order is defined among all the nodes accessible during a given query or transformation. Document order is a total ordering, although the relative order of some nodes is implementation-dependent. Informally, document order is the order in which nodes appear in the XML serialization of a document.] [Definition: 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:
The root node is the first node.
Every node occurs before all of its children and descendants.
namespace nodes immediately follow the element node with which they are associated. The relative order of namespace nodes is stable but implementation-dependent.
attribute nodes immediately follow the namespace nodes of the element node with which they are associated, if any; otherwise they immediately follow the element node; with which they are associated. The relative order of attribute nodes is stable but implementation-dependent.
The relative order of siblings is the order in which they occur in the children property of their parent node.
Children and descendants occur before following siblings.
The relative order of nodes in distinct trees is stable but implementation-dependent, subject to the following constraint: If any node in a given tree, T1
, occurs before any node in a different tree, T2
, then all nodes in T1
are before all nodes in T2
.
An important characteristic of the data model is that there is no distinction between an item (a node, function, or atomic item) and a singleton sequence containing that item. An item is equivalent to a singleton sequence containing that item and vice versa.
A sequence may contain any mixture of nodes, functions, and atomic items. When a node is added to a sequence its identity remains the same. Consequently a node may occur in more than one sequence and a sequence may contain duplicate items.
Sequences never contain other sequences; if sequences are combined, the result is always a “flattened” sequence. In other words, appending “(d e)” to “(a b c)” produces a sequence of length 5: “(a b c d e)”. It does not produce a sequence of length 4: “(a b c (d e))”; such a nested sequence never occurs.
Note:
Sequences replace node-sets from XPath 1.0. In XPath 1.0, node-sets do not contain duplicates. In generalizing node-sets to sequences, duplicate removal is provided by functions on node sequences.
Note:
Arrays and maps are function items and therefore can also be contained within sequences.
The following constructor and accessor functions are defined for sequences; these provide a formal underpinning for user-visible functions, operators, and language constructs.
empty-sequence
Constructordm:empty-sequence
() as
item()*
The dm:empty-sequence
constructor returns a sequence containing no items.
The function is exposed in XPath as an empty sequence expression, written ()
.
sequence-concat
Constructordm:sequence-concat
($input1
as
item()*
, $input2
as
item()*
) as
item()*
The dm:sequence-concat
constructor returns a sequence by concatenating two supplied sequences.
The returned sequence contains the items in $input1
(retaining order), followed by the items in $input2
(also retaining order).
The function is exposed in XPath through the comma operator ,
.
count
Accessordm:count
($input
as
item()*
) as
xs:integer
The dm:count
accessor function returns the number of items in $input
.
The function is exposed in XPath through the fn:count
function.
iterate-sequence
Accessordm:iterate-sequence ( | $input | as array(*) , |
$action | as function(item(), xs:integer) as item()* ) as item()* |
The dm:iterate-sequence
accessor calls the supplied $action
function once for each item in $input
, in order, and returns the sequence concenation of the results. The $action
function is called with two arguments. The first argument is an item in $input
, and the second is the 1-based ordinal position of the item within $input
.
The function is exposed in XPath most directly through the function for-each
, as well as for
expressions in XPath, for
clauses in FLWOR expressions in XQuery, and the xsl:for-each
instruction in XSLT. It also underpins all other functions that manipulate sequences, such as fn:count
and fn:filter
.
The specifications [Namespaces in XML] and [Namespaces in XML 1.1] introduce the concept of a namespace name. In [Namespaces in XML] a namespace name is required to be a URI; in [Namespaces in XML 1.1] it is required to be an IRI; but both specifications explicitly do not require a processor to check that namespace names appearing in an instance document are in fact valid URIs or IRIs.
[Definition: This specification uses the term Namespace URI to refer to a namespace name, whether or not it is a valid URI or IRI]. Following the lead of [Namespaces in XML] and [Namespaces in XML 1.1], processors implementing this data model may raise an error if a namespace name is not a valid URI or IRI (depending on whether they support [Namespaces in XML] or [Namespaces in XML 1.1]), but they are not required to make any checks. Note that the use of a relative reference as a namespace name is deprecated and is defined to be meaningless, but it is not an error. Namespace names, whatever form they take, are treated as character strings and compared for equality using codepoint-by-codepoint comparison, subject only to whitespace normalization if they appear in a context (for example, within an attribute value) where this is appropriate.
In some interfaces, namespace names are held as values of type xs:anyURI
. For example, the namespace part of an expanded QName is defined to be a value of type xs:anyURI
. In [Schema Part 2], the type xs:anyURI
imposes some restrictions on the value space, but there is latitude for implementers to decide exactly what these restrictions are. In [Schema 1.1 Part 2] there are no restrictions on the form of an xs:anyURI
value, so any sequence of characters is acceptable within the value space. In this and related specifications, the use of the type xs:anyURI
to hold a namespace name does not imply any restrictions on the value space beyond those described in this section: implementations may reject character strings that are not valid URIs or IRIs, but they are not required to do so.
The data model supports strongly typed languages such as [XML Path Language (XPath) 4.0] and [XQuery 4.0: An XML Query Language] that have a type system based on [Schema Part 1]. To achieve this, the data model includes (by reference) the Schema Component Model described in [Schema Part 1].
Note:
The Schema Component Model includes a number of kinds of component, such as type definitions and element and attribute declarations, and defines the properties and relationships of these components. Many of these components and properties are not used by the language specifications that rely on XDM, and where this is the case, there is no requirement for implementations to make them visible. However, this specification makes no attempt to define the minimal subset of the schema component model that is needed to support the semantics of XPath and XQuery processing.
There are two main areas where the language semantics depend on information in schema components:
Expressions are evaluated with respect to a static context, which includes schema components, specifically type definitions, element declarations, and attribute declarations. The names of such components may be used in language constructs only if the components are present in the static context.
Values including element and attribute nodes, and atomic items, have a property called a type annotation whose value is a type: this is a reference to a type definition in the Schema Component Model.
The diagram below illustrates the schema type system, in which all types are derived from xs:anyType
.
XML Schema types (abstract)
anyType (built-in complex)
Simple types (abstract)
anySimpleType (built-inlist)
Atomic types (abstract)
anyAtomicType (built-in atomic)
list types (abstract)
ENTITIES (built-in list)
IDREFS (built-in list)
NMTOKENS (built-in list)
user-defined list types (user-defined)
union types (abstract)
numeric (built-in complex)
user-defined union types (user-defined)
complex types (complex)
untyped (built-in complex)
user-defined complex types (user-defined)
Legend:
Supertype
subtype
Abstract types (abstract)
Built-in atomic types (built-in atomic)
Built-in complex types (built-in complex)
Built-in list types (built-in list)
User-defined types (user-defined)
[Definition: Following the terminology of [Schema Part 1], a schema is defined as set of schema components. Schema components include, for example, element declarations and type definitions.]
Note:
This contrasts with a schema document, which is an XML document containing an xs:schema
element and other XML elements such as xs:element
and xs:complexType
. In popular usage, the term schema is often used inaccurately to refer to a schema document. A schema generally consists of the result of processing a set of schema documents linked using xs:include
and xs:import
declarations; it may also include built-in schema components that are known intrinsically to a processor, or schema components that are constructed programmatically.
It is possible for an application to use more than one schema. For example, a transformation may accept as input a source document validated against a schema X, and produce as output a result document validated against a different schema Y; the stylesheet or query might import a schema that is the union of X and Y. Different modules of a query, or different packages within a stylesheet, may import different schemas. When this happens, there is a requirement that the different schemas must be compatible with each other. This requirement is expanded in the following paragraphs.
[Definition: Two schemasX and Y are compatible if the union of X and Y is a valid schema.] This essentially means that there must be no schema components in X and Y that have the same name but different definitions.
An implication of this rule is that when one schema document uses xs:redefines
or xs:override
to modify the definitions found in another schema document, the resulting schemas will generally be incompatible.
The rule means that when a type T appears in both X and Y, the properties of the schema component corresponding to T, and the properties of all the schema components that it refers to, transitively, will be the same.
This will always be true (in the absence of xs:redefines
and xs:override
) if both schemas derive their definition of T from the same schema document. It may also be true if the definitions of T derive from different schema documents, but in this case processors may treat the definitions as incompatible without further analysis.
It will not always be the case that validating an element node N against type T using schema X has the same outcome as validating the same element node N against type T using schema Y. Cases where the outcome may be different include the following:
The content model of T includes an element particle E whose corresponding element declaration has different substitution group members in X and Y.
Schema X includes a type U that extends T, and U is not present in Y; element N has the attribute xsi:type="U"
, which references this extended type definition.
The content model of T includes a wildcard particle that specifies processContents="lax"
or processContents="strict"
; element N has a child C that is matched against this wildcard; a declaration for C is present in X but not in Y.
The content model of T (in XSD 1.1) includes a wildcard particle that specifies notQName="##defined
; element N has a child C that is matched against this wildcard; a declaration for C is present in X but not in Y.
It is essential that nodes validated against one schema can be passed to a stylesheet or query that is using a different but compatible schema. This is necessary, for example, to ensure that the validated output of one stylesheet can form the validated input of another. The definitions for schema-based item types such as element(*, T)
and schema-element(E)
therefore allow for the possibility that the node being tested against the item type was validated using a different but compatible schema, and by implication, that revalidation using the local schema might not succeed.
Note:
It is potentially useful to prevent differences arising between different schemas that share schema components by:
Disallowing extensions to element declarations and types by using attributes such as blockDefault="#all"
Avoiding use of wildcards whose effect depends on the presence of unrelated schema components, for example processContents="lax"
and processContents="strict"
.
Note:
This makes it the responsibility of the processor to ensure that the schema components used in the static context of a query or expression during static analysis are compatible with the schema components used to validate documents during query or expression evaluation. This specification does not say how this should be achieved.
It is also a constraint that the schema information available to the processor must contain at least the components and properties needed to correctly implement the semantics of the XPath and XQuery language. For example, this means that given an element node with a particular type annotation T, and a function that expects an argument of type element(*, S)
, there must be sufficient information available to the processor to establish whether or not T is derived from S. As with other consistency constraints described in this data model, it is a precondition that these constraints are satisfied; the specifications do not speculate on what happens if they are not.
The data model uses expanded QNames to represent the names of schema types, which include the built-in types defined by [Schema Part 2] and the five additional types defined by this specification, and may include other user- or implementation-defined types.
For XML Schema types, the namespace name of the expanded QName is the {target namespace} property of the type definition, and its local name is the {name} property of the type definition.
The data model relies on the fact that an expanded QName uniquely identifies every named type. Although it is possible for different schemas to define different types with the same expanded QName, at most one of them can be used in any given validation episode. The data model cannot support environments where different types with the same expanded QName are available.
The scope over which the names of anonymous types must be meaningful and distinct depends on the processing context. It is the responsibility of the host language to define the size and scope of the processing context.
Note:
The type annotation of a schema-validated node, or of an atomic item extracted by atomizing a schema-validated node, may be an anonymous type. Queries and expressions cannot refer explicitly to anonymous types, but it is always possible to test whether such an item matches a named type from which the anonymous type is derived.
The three atomic types xs:anyAtomicType
, xs:dayTimeDuration
, and xs:yearMonthDuration
were first introduced in the 2.0 version of this specification, and were subsequently adopted by XSD 1.1. These types are always present in the XDM data model, with the definitions as given in XSD 1.1, whether or not the processor actually supports XSD 1.1.
Note:
The types xs:dayTimeDuration
, and xs:yearMonthDuration
have a special status in these specifications because many arithmetic operations (such as comparing two durations) are available in XPath only on these subtypes of xs:duration
, not on the primitive type xs:duration
itself.
The datatype xs:anyAtomicType
is an atomic type that includes all atomic items (and no values that are not atomic). Its base type is xs:anySimpleType
, from which all simple types, including atomic, list, and union types are derived. All primitive atomic types, such as xs:decimal
and xs:string
, have xs:anyAtomicType
as their base type.
No type may be derived from xs:anyAtomicType
by restriction, union, or list.
The types xs:untyped
and xs:untypedAtomic
, although they have names in the XSD namespace, are defined in this XDM specification, and not in XSD.
The type xs:untypedAtomic denotes untyped atomic data, such as text that has not been assigned a more specific type. It is classified as an atomic type. An attribute that has not been validated (or that has been validated in skip mode) is represented in the data model by an attribute node with the type annotation xs:untypedAtomic
. No predefined types are derived from xs:untypedAtomic
and no such derivations are allowed.
The datatype xs:untyped is used as the type annotation of an element node that has not been validated, or that has been validated in skip mode. It is a classified as a complex type. The properties of xs:untyped
are the same as the properties of xs:anyType
except for the base type and name. The base type of xs:untyped
is xs:anyType
. No predefined types are derived from xs:untyped
and no such derivations are allowed.
Some of the types defined in XML Schema have differing definitions in XSD 1.0 and XSD 1.1; furthermore, some types are defined by reference to other specifications, including XML and XML Namespaces, and these too may vary from one version of the specification to the next.
As a general policy, implementations of data types should support the latest definitive version of any referenced specification, even if that is published after the date of this specification.
This means, for example, that the xs:string
data type should support the set of characters defined by Unicode. Similarly, the xs:anyURI
data type should support the definition used in XSD 1.1 (which allows any sequence of characters), and the xs:NCName
data type should support the definition based on the syntax of a name as defined in both XML 1.1 Second Edition and XML 1.0 Fifth Edition (which provide the same definition).
In practice interoperability problems can arise both because specifications are not always in synchronization with each other (for example, XSD 1.0 contains references to dated versions of XML 1.0 other than the latest version), and also because implementations may use third-party components (such as XML parsers, serializers, and schema validators) that were built against different versions of the base specifications. For these reasons, use of the latest version of referenced specifications is generally recommended but not required. It is implementation-dependent how a processor handles any such conflicts.
[Definition: A string is a sequence of zero or more characters.]
[Definition: A character is any Unicode character.] Implementations may restrict characters to those Unicode characters allowed by the Char
production in [XML]. Unpaired surrogates are always forbidden.
[Definition: A codepoint is a non-negative integer assigned to a character by the Unicode consortium, or reserved for future assignment to a character.]
The definitions of string and character in the data model allow an implementation to accept input that cannot occur in a well-formed XML document. For example, an implementation might allow the unparsed-text()
function to return the content of a text file that includes the control character U+0007 (BEL) or might not restrict what codepoints-to-string()
can return.
An implementation that allows a broader repertoire of characters to be consumed by the processor, must ensure that
Any characters serialized with the XML or XHTML output methods satisfy the well-formedness criteria of the selected version of XML.
Any schema validation carried out using an XML Schema 1.0 or 1.1 schema rejects any nodes or atomic items containing characters that do not satisfy the constraints of the selected version of XML.
Note:
The lexical space of type xs:duration
is defined in XSD 1.1 part 2 (§3.3.6.2) in two different ways: with a BNF grammar starting with the production durationLexicalRep
, and with a regular expression. The two definitions are inconsistent: the BNF allows a decimal point at the start or end of the seconds component, while the regular expression requires any decimal point to be preceded and followed by a digit. For the purposes of this specification, the regular expression is considered to be correct, and the BNF incorrect; this makes the representation identical to that in XSD 1.0, and is compatible with ISO 8601.
Every value manipulated by XPath, XQuery, or XSLT is a sequence comprising zero or more items.
[Definition: A sequence type constrains the set of permitted sequences, by defining the permitted item types and the permitted number of items in the sequence (exactly zero, exactly one, zero-or-more, one-or-more, zero-or-one).]
Every item is an instance of one or more item types:
All items are instances of the type item()
.
Every node is an instance of the type node()
, and more specifically it is an instance of one of seven node kinds: document()
, element(*)
, attribute(*)
, text()
, comment()
, processing-instruction()
, or namespace()
. Nodes may also be instances of more specific types characterized by the node name and type annotation.
Every atomic item is an instance of a specific atomic type determined by its type annotation; it is also an instance of every type from which that type is derived by restriction (directly or indirectly), and of every union type that includes that type as a member type.
Every function item is an instance of the generic type function(*)
, and also of a specific function type defining the types of the function's parameters and the type of the result.
A map item, as well as being a function, is also an instance of the generic map type map(*)
, of more specific map types map(K, V)
defining the types of the keys and values, and perhaps of one or more record types that associate a type with specific key values.
An array item, as well as being a function, is also an instance of the generic array type array(*)
, and also of more specific array types array(M)
defining the type of the array's members.
This section describes how item types relate to each other.
The diagrams below show how nodes, functions, primitive simple types, and user defined types fit together into a type system. In the diagrams, connecting lines represent relationships between derived types and the types from which they are derived; the latter are always higher and to the left of the latter.
The xs:IDREFS
, xs:NMTOKENS
, xs:ENTITIES
types, and xs:numeric
, and both the user-defined list types
and user-defined union types
are special types in that these types are lists or unions rather than types derived by extension or restriction.
The first diagram illustrates the relationship of various item types. Item types in the data model form a directed graph, rather than a hierarchy or lattice: in the relationship defined by the derived-from(A, B)
function, some types are derived from more than one other type. Examples include functions (function(xs:string) as xs:int
is substitutable for function(xs:NCName) as xs:int
and also for function(xs:string) as xs:decimal
), and union types (A
is substitutable for the union type (A | B)
and also for the union type (A | C)
). In XDM, item types include node types, function types, and built-in atomic types. The list, which shows only hierarchic relationships, is therefore a simplification of the full model.
item (abstract)
anyAtomicType (built-in atomic)
node (node)
attribute (node)
user-defined attribute types (user-defined)
document (node)
user-defined document types (user-defined)
element (node)
user-defined element types (user-defined)
text (node)
comment (node)
processing-instruction (node)
namespace (node)
function(*) (function item)
array(*) (function item)
map(*) (function item)
Legend:
Supertype
subtype
Abstract types (abstract)
Built-in atomic types (built-in atomic)
Node types (node)
Function item types (function item)
User-defined types (user-defined)
The XPath Data Model is the abstraction over which XPath expressions are evaluated. Historically, all of the items in the data model could be derived directly (nodes) or indirectly (typed values, sequences) from an XML document. However, as the XPath expression language has matured, new features have been added which require additional types of items to appear in the data model. These items have no direct XML serialization, but they are never the less part of the data model.
The next diagram shows all of the atomic types, including the primitive simple types and the built-in types derived from the primitive simple types. This includes all the built-in datatypes defined in [Schema Part 2]. Atomic types act both as item types (meaning they can be used to declare the types of variables and function arguments), and as schema types (meaning they can be used as type annotations on nodes).
anyAtomicType
anyURI
base64Binary
boolean
date
dateTime
dateTimeStamp
decimal
integer
long
int
short
byte
nonNegativeInteger
positiveInteger
unsignedLong
unsignedInt
unsignedShort
unsignedByte
nonPositiveInteger
negativeInteger
double
duration
dayTimeDuration
yearMonthDuration
float
gDay
gMonth
gMonthDay
gYear
gYearMonth
hexBinary
NOTATION
QName
string
normalizedString
token
NMTOKEN
Name
NCName
ENTITY
ID
IDREF
language
time
Legend:
Supertype
subtype
Built-in atomic types
The term atomic value has been replaced by atomic item. [Issue 1337 PR 1361 2 August 2024]
An atomic item can be constructed from a lexical representation. Given a string and an atomic type, the atomic item is constructed in such a way as to be consistent with schema validation. If the string does not represent a valid value of the type, an error is raised. When xs:untypedAtomic
is specified as the type, no validation takes place. The details of the construction are described in Section 20 Constructor functionsFO40 and the related Section 21 CastingFO40 section of [XQuery and XPath Functions and Operators 4.0].
A string value can be constructed from an atomic item. Such a value is constructed by converting the atomic item to its string representation as described in Section 21 CastingFO40.
The xs:float
and xs:double
data types in the data model have the same value space as in XML Schema 1.1 ([Schema 1.1 Part 2]). Specifically they include both negative and positive zero, and in this respect they differ from XML Schema 1.0.
To accommodate this difference, when converting from an xs:string
to an xs:float
or xs:double
, it is implementation-defined whether the lexical value “-0” (and similar forms such as “-0.0”) convert to negative zero or to positive zero in the value space.
[Definition: A function item is an item that can be called. ] Function items have no serialization.
Note:
XDM 4.0 uses the term function item where XDM 3.1 used function. There is no distinction in meaning, but function item is preferred for clarity, because the unqualified term function has additional meanings in relation to function definitions in XSLT and XQuery.
A function item has the following properties:
name(xs:QName
): An expanded QName, possibly absent.
identity: An abstract property that can be used to test whether two variables refer to the same function or to different functions. This property is exposed only for this purpose.
Note:
Currently, the concept of function identity is used for two purposes: firstly, when functions appear in the arguments supplied to the fn:deep-equal
function; and secondly, in establishing whether the arguments and results of a function are "the same" when deciding whether the function is deterministic.
Note:
Function identity is not currently defined for maps and arrays, because in the circumstances where function identity would otherwise be used, maps and arrays are compared by examining their content.
parameter names(xs:QName*
): A list of distinct names, one for each of the function’s parameters.
Note:
This property is currently unused. There is no way of discovering the parameter names of a function item, and there is no functionality that depends on the parameter names.
signature[Definition: A function signature represents the type of a function.] The signature of a function item comprises:
The required types of its parameters (each one being a SequenceTypeXP40)
The required types of the function result (also a SequenceTypeXP40)
A sequence of zero or more function annotations. Each annotation consists of an annotation name (an instance of xs:QName
) and an annotation value (an arbitrary sequence of atomic items). Annotations are ordered and it is permitted for two annotations to share the same name.
body The body of a function provides the logic to map the arguments supplied in a function call into an instance of the function’s result type.
The function body is generally one of the following:
a user-written construct in XPath, XQuery, XSLT, or some other host language known to the processor.
vendor-supplied logic internal to the processor.
external logic written in some third-party programming language, to be invoked by the processor using implementation-dependent mechanisms.
These categories are not mutually exclusive; they may be used in combination.
Note:
The term “function body” replaces “function implementation”, to avoid confusion with the use of the term “implementation” in phrases such as “implementation-defined”.
captured context This includes a static and dynamic context for evaluation of the function body, as described in Section 2.2 Expression ContextXP40. In particular it includes a set of nonlocal variable bindings (a mapping from xs:QName
to item()*
), which provides a value for each of the function’s free variables (i.e., variables referenced by the function’s body, other than locals and parameters).
Note:
Where the function body is implemented in XPath, XQuery, or XSLT, the captured context includes the static context for the user-written code (for example, its in-scope namespaces) as well as any nonlocal variable bindings.
Functions implemented internally by the processor may capture specific parts of the static or dynamic context, for example fn:position#0
captures the value of the context position.
[Definition: The arity of a function item is the number of its parameters. ] The number of names in a function’s parameter names, and the number of parameter types in its signature, must equal the function’s arity.
All function items match the generic function type function(*)
, which is itself a subtype of item()
. A function signature defines a more specific function type, which is always a subtype of function(*)
. A function signature function(T1, T2, T3, ...) as TR
is a subtype of another function signature function(U1, U2, U3, ...) as UR
if (a) the two signatures have the same arity, (b) the return type TR is a subtype of UR, and (c) for each pair of parameter types, Tn is a supertype of Un. The rules are explained more fully in Section 3.3 Subtype RelationshipsXP40. For example:
function(item()) as item()
is a subtype of function(*)
function(item()) as xs:integer
is a subtype of function(item()) as item()
function(item()) as item()
is a subtype of function(xs:string) as item()
[Definition: A map item is a valuean item that represents a map (in(possibly ordered) set of key/value pairs, in which the keys are unique.] In other languages this is sometimes called a hash, dictionary, or associative array).] A map is logically a collection of key/value pairs. Each key. The keys are atomic items, and each key in the map is unique (there is no other key to which it is equal) and has. Each key is associated with it a value that is amay be any sequence of zero or more items. There is no uniqueness constraint on values, only on keys. The semantics of equality when comparing keys are described in Section 13.2.1 fn:atomic-equalFO40.
Note:
Maps have no intrinsic identity separate from their content. A map can be given a transient identity, represented by an id
property in its label, by applying the fn:pin
function. This property is expected to be used in defining operations for deep update of maps.
[Definition: A map item has a property called its ordering, which takes one of the three values undefined
, sorted
, or insertion
.]
[Definition: When the ordering of a map is undefined, the order of entries in the map is implementation dependent; in a typical implementation it might depend on the result of a randomizing hash function.]
[Definition: When the ordering of a map is sorted, the entries in the map are retrieved in order of their keys, which must be comparable so that the order is well defined.]
[Definition: When the ordering of a map is insertion, the map maintains an ordering of entries (first-in, first-out) based on the order in which entries were added, with new entries being added at the end, after existing entries.]
[Definition: The order of entries in a map (which is dependent on its ordering property) is referred to as entry order.] The entry order affects the result of functions such as map:keys and map:for-each, and also determines the order of entries when a map is serialized using the JSON output method.
Note:
Note the distinction between the ordering property of a map, which determines the policy for where new entries are added, and the entry order of the map, which determines the sequence in which existing entries are retrieved. The two things are of course closely related.
Constructor and accessor functions for maps are defined in the following sections.
empty-map
Constructordm:empty-map
() as
map(*)
dm:empty-map ( | $ordering | as enum('undefined', 'sorted', 'insertion') ) as map(*) |
The dm:empty-map
constructor returns a map containing no key/value pairs.
The function is exposed in XPath as an empty map constructor, which may be written {}
or map {}
.
The ordering property of the map is based on the value of the $ordering
argument.
In XPath an empty map constructor, written as {}
or map {}
, creates a map whose ordering. is undefined. An empty map with ordering sorted or insertion can be constructed using functions such as map:build, map:merge, or map:of-pairs.
map-put
Constructordm:map-put
($map
as
map(*)
, $key
as
xs:anyAtomicType
, $value
as
item()*
) as
map(*)
The dm:map-put
constructor returns a map based on the contents of a supplied map.
The key/value pairs in the returned map are as follows:
One key/value pair for every key/value pair present in $map
whose key is not equal to $key
; plus
One key/value pair whose key is $key
and whose associated value is $value
.
The ordering property of the returned map is the same as the ordering of the supplied $map
.
The detailed effect of the function depends on the ordering property, as follows:
If the ordering is undefined, the entry order in the returned map is implementation dependent, and bears no necessary relationship to the entry order in the supplied $map
.
If the ordering is sorted, the key of the new entry must be strictly comparable with the keys of existing entries (a dynamic error occurs if this is not the case), and the entry order in the returned map is such that an entry with key K1 precedes an entry with key K2 if and only if fn:compare(K1, K2, $CC) lt 0
, where $CC
is the Unicode codepoint collation.
[Definition: Two atomic items K1 and K2 are strictly comparable if (a) the function call fn:compare(K1, K2, $CC)
(where $CC
is the Unicode codepoint collation) does not fail with a type error, and (b) either both of the values have a timezone component, or neither of them has a timezone component.]
If the ordering is insertion, then the entry order in the returned map reflects the entry order in the supplied $map
. If the key of the new entry was present in $map
then the new entry replaces that entry retaining its current position; otherwise, the new entry is added after all existing entries.
The function is exposed in XPath through the function map:put.
iterate-map
Accessordm:iterate-map ( | $map | as map(*) , |
$action | as function(xs:anyAtomicType, item()*) as item()* ) as item()* |
The dm:iterate-map
accessor calls the supplied $action
function once for each key/value pair in $map
, in implementation-dependent order, and returns the sequence concenation of the results. The order in which entries are processed is the entry order of the map.
The function is exposed in XPath most directly through the function map:for-each, but it also underpins all other functions giving access to maps, such as map:size, map:contains, and map:get.
Constructors are added, and the single accessor function is now an iterator over the members of the array. [Issue 1335 20 July 2024]
[Definition: An array item is a value that represents an array.] An array is an ordered list of values; these values are called the members of the array. Unlike sequences, a member of an array can be any value (including a sequence or an array). The number of members in an array is called its size, and they are referenced by their position, in the range 1 to the size of the array.
Note:
Arrays have no intrinsic identity separate from their content. An array can be given a transient identity, represented by an id
property in its label, by applying the fn:pin
function. This property is expected to be used in defining operations for deep update of arrays.
Constructor and accessor functions for arrays are defined in the following sections.
empty-array
Constructordm:empty-array
() as
array(*)
The dm:empty-array
constructor returns an array containing no members.
The function is exposed in XPath as an empty array constructor, written []
or array {}
.
array-append
Constructordm:array-append
($array
as
array(*)
, $member
as
item()*
) as
array(*)
The dm:array-append
constructor returns an array based on the contents of a supplied array.
The returned array contains:
One member for every member present in $array
, at the same position; plus
One additional member, $member
, as the last member in the returned array.
The function is exposed in XPath through the function array:append
.
iterate-array
Accessordm:iterate-array ( | $array | as array(*) , |
$action | as function(item()*, xs:integer) as item()* ) as item()* |
The dm:iterate-array
accessor calls the supplied $action
function once for each member in $array
, in order, and returns the sequence concenation of the results. The $action
function is called with two arguments. The first argument is the array member (an arbitrary sequence), and the second is its 1-based ordinal position within the array.
The function is exposed in XPath most directly through the function array:for-each
(but note that array:for-each
delivers an array rather than a sequence). It also underpins all other functions giving access to arrays, such as array:size
and array:get
.
[Definition: A labeled item is a pair (S, L) where S (called the subject) is any item, and L (called the label) is a map containing supplementary information about the item.].
The keys in the map are always instances of xs:string
, and the associated values can be arbitrary values.
There are currently no constructs in the language that would cause either the subject or the label of a labeled item to itself be a labeled item. Nor is there anything that would cause the label to contain a labeled item.
Operations on labeled items fall into three categories:
Operations that select items which are present in their input return the labeled item unchanged (including its label). Examples are filter expressions, axis expressions, lookup expressions, and functions such as fn:head, fn:tail
, and fn:subsequence
.
Operations that construct new values from their input treat the labeled item exactly as if the operation were applied directly to the subject. That is, the label is ignored. Examples are arithmetic and comparison operators, operators such as is
and instance of
, cast expressions, atomization, and functions such as fn:avg
or fn:index-of
.
The fn:label
function is a special case: it returns the label of a labeled item, as a map. If applied to an item that is not labeled, it returns an empty map.
Note:
Two items representing the same node (such that $n1 is $n2
returns true) may nevertheless have different labels. It is perhaps helpful to think of such items not as nodes, but as references to nodes, which are automatically dereferenced by the majority of operations.
Note:
A labeled item matches a type if its subject matches the type; labels are thus extraneous to the type system.
Labeled items are returned by certain operations, such as the lookup operators ?
and ??
. As a result, the lookup operation can be treated at one level as if it returned a simple value (an entry found in a map or array), but applications that need extra information about the value can find this by examining the label: for example, they can identify the associated key value.
The function fn:pin
takes a map or array J as its argument, and returns a labeled map or array with J as its subject (or the subject of J, if J is itself a labeled item), and with a map M as its label, where M contains a single entry having the key "pinned"
(as an xs:string
) and an associated xs:boolean
value true
. An item $item
satisfying $item[label(.)?pinned]
is referred to as a pinned item.
This section describes the constraints on instances of the data model.
The data model supports well-formed XML documents conforming to [Namespaces in XML] or [Namespaces in XML 1.1]. Documents that are not well-formed are, by definition, not XML. XML documents that do not conform to [Namespaces in XML] or [Namespaces in XML 1.1] are not supported (nor are they supported by [Infoset]).
In other words, the data model supports the following classes of XML documents:
Well-formed documents conforming to [Namespaces in XML] or [Namespaces in XML 1.1].
DTD-valid documents conforming to [Namespaces in XML] or [Namespaces in XML 1.1], and
W3C XML Schema-validated documents.
This document describes how to construct an instance of the data model from an infoset ([Infoset]) or a Post Schema Validation Infoset (PSVI), the augmented infoset produced by an XML Schema validation episode.
An instance of the data model can also be constructed directly through application APIs, or from non-XML sources such as relational tables in a database. Data model construction from sources other than an Infoset or PSVI is implementation-defined. Regardless of how an instance of the data model is constructed, every node and atomic item in the data model must have a typed value that is consistent with its type.
The data model supports some kinds of values that are not supported by [Infoset]. Examples of these are document fragments and sequences of document nodes. The data model also supports values that are not nodes. Examples of these are sequences of atomic items, or sequences mixing nodes and atomic items. These are necessary to be able to represent the results of intermediate expressions in the data model during expression processing.
Although this document describes construction of an instance of the data model in terms of infoset properties, an infoset is not a necessary precondition for building an instance of the data model.
There are no constraints on how an instance of the data model may be constructed directly, save that the resulting instance must satisfy all of the constraints described in this document.
An instance of the data model can be constructed from an infoset that satisfies the following general constraints:
All general and external parsed entities must be fully expanded. The Infoset must not contain any unexpanded entity reference information items.
The infoset must provide all of the properties identified as “required” in this document. The properties identified as “optional” may be used, if they are present. All other properties are ignored.
An instance of the data model constructed from an information set must be consistent with the description provided for each node kind.
Furthermore, construction of an instance of the data model from an Infoset is guaranteed to be well-defined only for those Infosets that could have been derived from a conforming XML document.
An instance of the data model can be constructed from a PSVI, whose element and attribute information items have been strictly assessed, laxly assessed, or have not been assessed. Constructing an instance of the data model from a PSVI must be consistent with the description provided in this section and with the description provided for each node kind.
Data model construction requires that the PSVI provide unique names for all anonymous schema types.
Note:
[Schema Part 1] does not require all schema processors to provide unique names for anonymous schema types. In order to build an instance of the data model from a PSVI produced by a processor that does not provide the names, some post-processing will be required in order to ensure that they are all uniquely identified before construction begins.
[Definition: An incompletely validated document is an XML document that has a corresponding schema but whose schema-validity assessment has resulted in one or more element or attribute information items being assigned values other than ‘valid’ for the [validity] property in the PSVI.]
The data model supports incompletely validated documents. Elements and attributes that are not valid are treated as having unknown types.
The most significant difference between Infoset construction and PSVI construction occurs in the area of schema type assignment. Other differences can also arise from schema processing: default attribute and element values may be provided, white space normalization of element content may occur, and the user-supplied lexical form of elements and attributes with atomic schema types may be lost.
A PSVI element or attribute information item may have a [validity] property. The [validity] property may be “valid ”, “invalid ”, or “notKnown ” and reflects the outcome of schema-validity assessment. In the data model, precise schema type information is exposed for element and attribute nodes that are “valid ”. Nodes that are not “valid ” are treated as if they were simply well-formed XML and only very general schema type information is associated with them.
The precise definition of the schema type of an element or attribute information item depends on the properties of the PSVI. In the PSVI, [Schema Part 1] defines a [type definition] property as well as the [type definition namespace], [type definition name] and [type definition anonymous] properties, which are effectively short-cut terms for properties of the type definition. Further, the [element declaration] and [attribute declaration] properties are defined for elements and attributes, respectively. These declarations in turn will identify the [type definition] declared for the element or attribute. To distinguish the [type definition] given in the PSVI for the element or attribute instance from the [type definition] associated with the declaration, the former is referred to below as the actual type and the latter as the declared type of the element or attribute instance in question.
The type depends on the declared type, the actual type, and the [validity] and [validation attempted] properties in the PSVI. If:
The [validity] and [validation attempted] properties exist and have the values “valid ” and “full ”, respectively, the schema type of an element or attribute information item is represented by an expanded QName whose namespace and local name correspond to the first applicable items in the following list:
If the declared type exists and is a union and the actual type is (not the same as the declared type, and not a type derived from the declared type, but) one of the member types of the union, or derived from one of its member types:
If the {name} property of the declared type is present: the {target namespace} and {name} properties of the declared type.
If the {name} property of the declared type is absent: the namespace and local name of the anonymous type name supplied for the declared type.
If there is no declared type, and the actual type is a union, then:
If the {name} property of the actual type is present: the {target namespace} and {name} properties of the actual type.
If the {name} property of the actual type is absent: the namespace and local name of the anonymous type name supplied for the actual type.
Otherwise:
If [type definition anonymous] is false: the {target namespace} and {name} properties of the actual type.
If [type definition anonymous] is true: the namespace and local name of the anonymous type name supplied for the actual type.
The [validity] property exists and is “invalid ”, or the [validation attempted] property exists and is “partial ”, the schema type of an element is xs:anyType
and the type of an attribute is xs:anySimpleType
.
The [validity] property exists and is “notKnown ”, the schema type of an element is xs:anyType
and the type of an attribute is xs:anySimpleType
.
The [validity] or [validation attempted] properties do not exist, the schema type of an element is xs:untyped
and the type of an attribute is xs:untypedAtomic
.
The prefix associated with the type names is implementation-dependent.
This section describes how the typed value of an element or attribute node is computed from an element or attribute PSVI information item, where the information item has either a simple type or a complex type with simple content. For other kinds of element nodes, see 5.2.4 Construction from a PSVI; for other kinds of attribute nodes, see 5.3.4 Construction from a PSVI.
The typed value of attribute nodes and some element nodes is a sequence of atomic items. The types of the items in the typed value of a node may differ from the type of the node itself. This section describes how the typed value of a node is derived from the properties of an information item in a PSVI.
The types of the items in the typed value of a node are determined as follows. The process begins with a type, T
. If the schema type of the node itself, as represented in the PSVI, is a complex type with simple content, then T
is the {content type} of the schema type of the node; otherwise, T
is the schema type of the node itself. For each primitive or ordinary simple type T
, the W3C XML Schema specification defines a function M
mapping the lexical representation of a value onto the value itself.
Note:
For atomic and list types, the mapping is the “lexical mapping” defined for T
in [Schema Part 2]; for union types, the mapping is the lexical mapping defined in [Schema Part 2] modified as appropriate by any applicable rules in [Schema Part 1]. The mapping, so modified, is a function (in the mathematical sense) which maps to a single value even in cases where the lexical mapping proper maps to multiple values.
The typed value is determined as follows:
If the nilled property of the node in question is true
, then the typed value is the empty sequence.
If T
is xs:anySimpleType
or xs:anyAtomicType
, the typed value is the [schema normalized value] as an instance of xs:untypedAtomic
.
Otherwise, the typed value is the result of applying M
to the string value as an instance of the appropriate value type, where the appropriate value type is the [member type definition] if T
is a union type, otherwise it is simply T
.
The typed value determination process is guaranteed to result in a sequence of atomic items, each having a well-defined atomic type. This sequence of atomic items, in turn, determines the typed-value property of the node in the data model.
Element and attribute nodes have both typed-value and string-value properties (the terms typed value and string value are defined at Section 2.5.2 Typed Value and String ValueXP40 of [XML Path Language (XPath) 4.0]). However, implementations are allowed some flexibility in how these properties are stored. An implementation may choose to store the string-value property only and derive the typed-value property from it, or to store the typed-value property only and derive the string-value property from it, or to store both the string-value property and the typed-value property.
To permit these various implementation strategies, some variations in the string value of a node are defined as insignificant. Implementations that store only the typed value of a node are permitted to return a string value that is different from the original lexical form of the node content. For example, consider the following element:
<offset xsi:type="xs:integer">0030</offset>
Assuming that the node is valid, it has a typed value of 30 as an xs:integer
. An implementation may return either “30
” or “0030
” as the string value of the node. Any string that is a valid lexical representation of the typed value is acceptable. In this specification, we express this rule by saying that the relationship between the string value of a node and its typed value must be “consistent with schema validation.”
If an implementation stores only the string value of a node, the following considerations apply:
Where union types occur, the implementation must be able to deliver the typed value as an instance of the appropriate member type. For example, if the type of an element node is my:integer-or-string
, which is defined as a union of xs:integer
and xs:string
, and the string value of the node is “47”, the implementation must be able to deliver the typed value of the node as either the integer 47
or the string "47"
, depending on which member type validated the element.
Where types of xs:QName
, xs:NOTATION
, or types derived from one of these types occur, the implementation must be able to deliver the typed value as a triple consisting of a local name, a namespace prefix, and a namespace URI, even though the namespace URI is not part of the string-value (see 3.3.3 QNames and NOTATIONS).
Where an element with a complex type and element-only content occurs, it is an error to attempt to access the typed-value of the element node.
If an implementation stores only the typed value of a node, it must be prepared to construct string values from not only the node, but in some cases also the descendants of that node. For example, an element with a complex type and element-only content has no typed value but does have a string value that is the concatenation of the string values of all its text node descendants in document order.
A further caveat applies if an implementation stores the typed value of a node. If a new data model is constructed by copying portions of another data model, and the copy operation does not preserve inherited namespaces, and the type is a union type that is sensitive to the namespace context, then the typed value may be different than what would be obtained by revalidating the node within its new namespace context. Although this may stretch the semantics of “consistent with schema validation”, we accept this possibility; it is not an error.
Creating a subtype by restriction generally reduces the value space of the original schema type. For example, expressing a hat size as a restriction of decimal with a minimum value of 6.5 and maximum value of 8.0 creates a schema type whose valid values are only those in the range 6.5 to 8.0.
The pattern facet is different because it restricts the lexical space of the schema type, not its value space. Expressing a three-digit number as a restriction of integer with the pattern facet “[0-9]{3}” creates a schema type whose valid values are only those with a lexical form consisting of three digits.
The pattern facet is not reversible in practice. A given point in the value space might have several lexical representations. In general, there is no practical way to determine which, if any, of these representations satisfies the pattern facet of the type.
As a consequence, pattern facets are not respected when mapping to an Infoset or during serialization, and values in the data model that were originally valid with respect to a schema that contains pattern-based restrictions may be invalid after serialization.
The date and time types require special attention. This section applies to implementations that store the typed value of xs:dateTime
, xs:date
, xs:time
, xs:gYearMonth
, xs:gYear
, xs:gMonthDay
, xs:gMonth
, xs:gDay
, and types that are derived from them. These are known collectively as the date/time types in this specification.
The values of the date/time types are represented in the data model using seven components:
An xs:integer
.
An xs:integer
between 1 and 12, inclusive.
An xs:integer
between 1 and 31, inclusive, possibly restricted further depending on the values of month and year.
An xs:integer
between 0 and 23, inclusive.
An xs:integer
between 0 and 59, inclusive.
An xs:decimal
greater than or equal to zero and less than 60. Leap seconds are not supported.
An xs:dayTimeDuration
between -PT14H00M and PT14H00M, inclusive. All timezone values must be an integral number of minutes.
Components that are intrinsic to the datatype (for example, day, month, and year in a xs:date
) are required; components that can never be part of a datatype (for example, years in a xs:time
) must be missing. Missing components are represented by the empty sequence. When a component is present, it contains the “local value” that has not been normalized in any way. The timezone component is optional for all the date/time datatypes.
Thus, the lexical xs:dateTime
representation “2003-01-02T11:30:00-05:00
” is stored as “{2003, 1, 2, 11, 30, 0.0, -PT05H00M}
”. The value of the lexical representation “2003-01-16T16:30:00
” is stored as “{2003, 1, 16, 16, 30, 0, ()}
” because it has no timezone. The value of the lexical xs:gDay
representation “---30+10:30
” is stored as “{(), (), 30, (), (), (), PT10H30M}
”.
The lexical form “24:00:00
” is normalized in the component model. As a xs:time
, it is stored as “{(), (), (), 0, 0, 0.0, ()}
” and the xs:dateTime
representation “1999-12-31T24:00:00
” is stored as “{2000, 1, 1, 0, 0, 0.0, ()}
”.
Note:
Implementations are permitted to store date/time values in any representation that is convenient for them, provided that the individual properties can be accessed and modified.
The QName
and NOTATION
data types require special attention. The following sections apply to xs:QName
, xs:NOTATION
, and types derived from them. These types are referred to collectively as “qualified names”.
As defined in XML Schema, the lexical space for qualified names includes a local name and an optional namespace prefix. The value space for qualified names contains a local name and an optional namespace URI. Therefore, it is not possible to derive a lexical value from the typed value, or vice versa, without access to some context that defines the namespace bindings.
When qualified names exist as values of nodes in a well-formed document, it is always possible to determine such a namespace context. However, the data model also allows qualified names to exist as freestanding atomic items, or as the name or value of a parentless attribute node, and in these cases no namespace context is available.
In this Data Model, therefore, the value space for qualified names contains a local-name, an optional namespace URI, and an optional prefix. The prefix is used only when producing a lexical representation of the value, that is, when casting the value to a string. The prefix plays no part in other operations involving qualified names: in particular, two qualified names are equal if their local names and namespace URIs match, regardless whether they have the same prefix.
The following consistency constraints apply:
If the namespace URI of a qualified name is absent, then the prefix must also be absent.
For every element node whose name has a prefix, the prefix must be one that has a binding to the namespace URI of the element name in the namespaces property of the element.
For every element node whose name has no prefix, the element must have a binding for the empty prefix to the namespace URI of the element name, or must have no binding for the empty prefix in the case where the name of the element has no namespace URI.
For every attribute node whose name has a prefix, the attribute node must either be parentless, or the prefix must be one that has a binding to the namespace URI of the attribute name in the namespaces property of the parent element.
For every qualified name that contains a prefix and that is included in the typed value of an element node, or of an attribute node that has an element node as its parent, the prefix must be one that is bound to the namespace URI of the qualified name in the namespaces property of that element.
For every qualified name that contains a namespace URI and no prefix, and that is included in the typed value of an element node, or of an attribute node that has an element node as its parent, that element node must have a binding for the empty prefix to that namespace URI in its namespace property.
For every qualified name that contains neither a namespace URI nor a prefix, and that is included in the typed value of an element node, or of an attribute node that has an element node as its parent, that node must not have a binding for the empty prefix.
No qualified name that contains a prefix may be included in the typed value of an attribute node that has no parent.
A set of accessors is defined on nodes in the data model. For consistency, all the accessors are defined on every kind of node, although several accessors return a constant empty sequence on some kinds of nodes.
In order for processors to be able to operate on instances of the data model, the model must expose the properties of the items it contains. The data model does this by defining a family of accessor functions. These are not functions in the literal sense; they are not available for users or applications to call directly. Rather they are descriptions of the information that an implementation of the data model must expose to applications. Functions and operators available to end users are described in [XQuery and XPath Functions and Operators 4.0].
Some typed values in the data model are absent. Attempting to access an absent typed value is an error. Behavior in these cases is implementation defined and the host language is responsible for determining the result.
attributes
Accessordm:attributes
($n
as
node()
) as
attribute()*
The dm:attributes accessor returns the attributes of a node as a sequence containing zero or more attribute nodes. The order of attribute nodes is stable but implementation dependent.
It is defined on all seven node kinds.
base-uri
Accessordm:base-uri
($n
as
node()
) as
xs:anyURI?
The dm:base-uri accessor returns the base URI of a node as a sequence containing zero or one URI reference. For more information about base URIs, see [XML Base].
It is defined on all seven node kinds.
children
Accessordm:children
($n
as
node()
) as
node()*
The dm:children accessor returns the children of a node as a sequence containing zero or more nodes.
It is defined on all seven node kinds.
document-uri
Accessordm:document-uri
($node
as
node()
) as
xs:anyURI?
The dm:document-uri accessor returns the absolute URI of the resource from which the document node was constructed, if the absolute URI is available. If there is no URI available, or if it cannot be made absolute when the document node is constructed, or if it is used on a node other than a document node, the empty sequence is returned.
It is defined on all seven node kinds.
is-id
Accessordm:is-id
($node
as
node()
) as
xs:boolean?
The dm:is-id accessor returns true if the node is an XML ID. Exactly what constitutes an ID depends in part on how the data model was constructed, see 5.2 Element nodes and 5.3 Attribute nodes.
It is defined on all seven node kinds.
is-idrefs
Accessordm:is-idrefs
($node
as
node()
) as
xs:boolean?
The dm:is-idrefs accessor returns true if the node is an XML IDREF or IDREFS. Exactly what constitutes an IDREF or IDREFS depends in part on how the data model was constructed, see 5.2 Element nodes and 5.3 Attribute nodes.
It is defined on all seven node kinds.
namespace-nodes
Accessordm:namespace-nodes
($n
as
node()
) as
node()*
The dm:namespace-nodes accessor returns the dynamic, in-scope namespaces associated with a node as a sequence containing zero or more namespace nodes. The order of namespace nodes is stable but implementation dependent.
It is defined on all seven node kinds.
nilled
Accessordm:nilled
($n
as
node()
) as
xs:boolean?
The dm:nilled accessor returns true if the node is “nilled”. [Schema Part 1] introduced the nilled mechanism to signal that an element should be accepted as valid when it has no content even when it has a content type which does not require or even necessarily allow empty content.
It is defined on all seven node kinds.
node-kind
Accessordm:node-kind
($n
as
node()
) as
xs:string
The dm:node-kind accessor returns a string identifying the kind of node. It will be one of the following, depending on the kind of node: “attribute”, “comment”, “document”, “element”, “namespace”, “processing-instruction”, or “text”.
It is defined on all seven node kinds.
node-name
Accessordm:node-name
($n
as
node()
) as
xs:QName?
The dm:node-name accessor returns the name of the node as a sequence of zero or one xs:QName
s. Note that the QName value includes an optional prefix as described in 3.3.3 QNames and NOTATIONS.
It is defined on all seven node kinds.
parent
Accessordm:parent
($n
as
node()
) as
node()?
The dm:parent accessor returns the parent of a node as a sequence containing zero or one nodes.
It is defined on all seven node kinds.
string-value
Accessordm:string-value
($n
as
node()
) as
xs:string
The dm:string-value accessor returns the string value of a node.
It is defined on all seven node kinds.
type-name
Accessordm:type-name
($n
as
node()
) as
xs:QName?
The dm:type-name accessor returns the name of the schema type of a node as a sequence of zero or one xs:QName
s.
It is defined on all seven node kinds.
typed-value
Accessordm:typed-value
($n
as
node()
) as
xs:anyAtomicType*
The dm:typed-value accessor returns the typed value of the node as a sequence of zero or more atomic items.
It is defined on all seven node kinds.
unparsed-entity-public-id
Accessordm:unparsed-entity-public-id ( | $node | as node() , |
$entityname | as xs:string ) as xs:string? |
The dm:unparsed-entity-public-id accessor returns the public identifier of an unparsed external entity declared in the specified document. If no entity with the name specified in $entityname
exists, or if the entity is not an external unparsed entity, or if the entity has no public identifier, the empty sequence is returned.
It is defined on all seven node kinds.
unparsed-entity-system-id
Accessordm:unparsed-entity-system-id ( | $node | as node() , |
$entityname | as xs:string ) as xs:anyURI? |
The dm:unparsed-entity-system-id accessor returns the system identifier of an unparsed external entity declared in the specified document. The value is an absolute URI, and is obtained by resolving the [system identifier] of the unparsed entity information item against the [declaration base URI] of the same item. If no entity with the name specified in $entityname
exists, or if the entity is not an external unparsed entity, the empty sequence is returned.
It is defined on all seven node kinds.
[Definition: There are seven kinds of nodes in the data model: document, element, attribute, text, namespace, processing instruction, and comment.] Each kind of node is described in the following sections.
Each section consists of an overview of the node, followed by information on accessors and methods construction from an Infoset or a PSVI. The final section provides a mapping to Infosets. No mapping is provided, nor can it be provided, for producing a PSVI. Validation must be used to obtain a PSVI for a (portion of a) data model instance.
All nodes must satisfy the following general constraints:
Every node must have a unique identity, distinct from all other nodes.
The children property of a node must not contain two consecutive text nodes.
The children property of a node must not contain any empty text nodes.
No node may appear more than once in the children or attributes properties of a node.
Document nodes encapsulate XML documents. Documents have the following properties:
base-uri, possibly empty.
children, possibly empty.
unparsed-entities, possibly empty.
document-uri, possibly empty.
string-value
typed-value
Document nodes must satisfy the following constraints.
The childrenmust consist exclusively of element, processing instruction, comment, and text nodes if it is not empty. Attribute, namespace, and document nodes can never appear as children
If a node N is among the children of a document node D, then the parent of Nmust be D.
If a node N has a parent document node D, then Nmust be among the children of D.
The string-value property of a document node must be the concatenation of the string-values of all its text node descendants in document order or, if the document has no such descendants, the zero-length string.
In the [Infoset], a document information item must have at least one child, its children must consist exclusively of element information items, processing instruction information items and comment information items, and exactly one of the children must be an element information item. This data model is more permissive: a document node may be empty, it may have more than one element node as a child, and it also permits text nodes as children.
Implementations that support DTD processing and access to the unparsed entity accessors use the unparsed-entities property to associate information about an unordered collection of unparsed entities with a document node. This property is accessed indirectly through the dm:unparsed-entity-system-id and dm:unparsed-entity-public-id functions. There is at most one unparsed entity associated with any given name. Conforming XML documents may include more than one unparsed entity declaration for the same name, but XML mandates that only the first such declaration is significant.
Returns the empty sequence
Returns the value of the base-uri property.
Returns the value of the children property.
Returns the absolute URI of the resource from which the document node was constructed, or the empty sequence if no such absolute URI is available.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “document
”.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the string-value property.
Returns the empty sequence.
Returns the value of the typed-value property.
Returns the public identifier of the specified unparsed entity or the empty sequence if no such entity exists.
Returns the system identifier of the specified unparsed entity or the empty sequence if no such entity exists.
The document information item is required. A document node is constructed for each document information item.
The following infoset properties are required: [children] and [base URI].
The following infoset properties are optional: [unparsed entities].
Document node properties are derived from the infoset as follows:
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, and comment found in the [children] property, a corresponding element, processing instruction, or comment node is constructed and that sequence of nodes is used as the value of the children property.
If present among the [children], the document type declaration information item is ignored.
If the [unparsed entities] property is present and is not the empty set, the values of the unparsed entity information items must be used to support the dm:unparsed-entity-system-id and dm:unparsed-entity-public-id accessors.
The internal structure of the values of the unparsed-entities property is implementation defined.
The concatenation of the string-values of all its text node descendants in document order. If the document has no such descendants, the zero-length string.
The dm:string-value of the node as an xs:untypedAtomic
value.
The document-uri property holds the absolute URI for the resource from which the document node was constructed, if one is available and can be made absolute. For example, if a collection of documents is returned by the fn:collection function, the document-uri property may serve to distinguish between them even though each has the same base-uri property.
If the document-uri is not the empty sequence, then the following constraint must hold: the node returned by evaluating fn:doc()
with the document-uri as its argument must return the document node that provided the value of the document-uri property.
In other words, for any document node $arg
, either fn:document-uri($arg)
must return the empty sequence or fn:doc(fn:document-uri($arg))
must return $arg
.
Construction from a PSVI is identical to construction from the Infoset.
A document node maps to a document information item. The mapping fails and produces no value if the document node contains text node children that do not consist entirely of white space or if the document node contains more than one element node child.
The following properties are specified by this mapping:
A list of information items obtained by processing each of the dm:children in order and mapping each to the appropriate information item(s).
The element information item that is among the [children].
An unordered set of unparsed entity information items constructed from the unparsed-entities.
Each unparsed entity maps to an unparsed entity information item. The following properties are specified by this mapping:
The name of the entity.
The system identifier of the entity.
The public identifier of the entity.
Implementation defined. In many cases, the document-uri is the correct answer and implementations must use this value if they have no better information. Implementations that keep track of the original [declaration base URI] for entities should use that value.
The following properties of the unparsed entity information item have no value: [notation name], [notation].
The following properties of the document information item have no value: [notations][character encoding scheme][standalone][version][all declarations processed].
Element nodes encapsulate XML elements. Elements have the following properties:
base-uri, possibly empty.
node-name
parent, possibly empty
schema-type
children, possibly empty
attributes, possibly empty
namespaces
nilled
string-value
typed-value
is-id
is-idrefs
Element nodes must satisfy the following constraints.
The childrenmust consist exclusively of element, processing instruction, comment, and text nodes if it is not empty. attribute, namespace, and document nodes can never appear as children
The attribute nodes of an element must have distinct xs:QName
s.
If a node N is among the children of an element E, then the parent of Nmust be E.
Exclusive of attribute and namespace nodes, if a node N has a parent element E, then Nmust be among the children of E. (Attribute and namespace nodes have a parent, but they do not appear among the children of their parent.)
The data model permits element nodes without parents (to represent partial results during expression processing, for example). Such element nodes must not appear among the children of any other node.
An element may not be its own child or its own parent.
If an attribute node A is among the attributes of an element E, then the parent of Amust be E.
If an attribute node A has a parent element E, then Amust be among the attributes of E.
The data model permits attribute nodes without parents. Such attribute nodes must not appear among the attributes of any element node.
If a namespace node N is among the namespaces of an element E, then the parent of Nmust be E.
If a namespace node N has a parent element E, then Nmust be among the namespaces of E.
The data model permits namespace nodes without parents. Such namespace nodes must not appear among the namespaces of any element node. This constraint is irrelevant for implementations that do not support namespace nodes.
If the dm:type-name of an element node is xs:untyped
, then the dm:type-name of all its descendant elements must also be xs:untyped
and the dm:type-name of all its attribute nodes must be xs:untypedAtomic
.
If the dm:type-name of an element node is xs:untyped
, then the nilled property must be false
.
If the nilled property is true
, then the children property must not contain element nodes or text nodes.
For every expanded QName that appears in the dm:node-name of the element, in the dm:node-name of any attribute node among the attributes of the element, or in any value of type xs:QName
or xs:NOTATION
(or any type derived from those types) that appears in the typed-value of the element or the typed-value of any of its attributes, if the expanded QName has a non-empty URI, then there must be a prefix binding for this URI among the namespaces of this element node.
If any of the expanded QNames has an empty URI, then there must not be any binding among the namespaces of this element node which binds the empty prefix to a URI.
Every element must include a namespace node and/or namespace binding for the prefix xml
bound to the URI http://www.w3.org/XML/1998/namespace
and there must be no other prefix bound to that URI.
The string-value property of an element node must be the concatenation of the string-values of all its text node descendants in document order or, if the element has no such descendants, the zero-length string.
Returns the value of the attributes property. The order of attribute nodes is stable but implementation dependent.
Returns the value of the base-uri property.
Returns the value of the children property.
Returns the empty sequence.
Returns the value of the is-id property.
Returns the value of the is-idrefs property.
Returns the value of the namespaces property as a sequence of namespace nodes. The order of namespace nodes is stable but implementation dependent.
Returns the value of the nilled property.
Returns “element
”.
Returns the value of the node-name property.
Returns the value of the parent property.
Returns the value of the string-value property.
Returns the value of the schema-type property.
Returns the value of the typed-value property.
Returns the empty sequence.
Returns the empty sequence.
The element information items are required. An element node is constructed for each element information item.
The following infoset properties are required: [namespace name], [local name], [children], [attributes], [in-scope namespaces], [base URI], and [parent].
Element node properties are derived from the infoset as follows:
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
An xs:QName
constructed from the [prefix], [local name], and [namespace name] properties.
The node that corresponds to the value of the [parent] property or the empty sequence if there is no parent.
All element nodes constructed from an infoset have the type xs:untyped
.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, comment, and maximal sequence of adjacent character information items found in the [children] property, a corresponding element, processing instruction, comment, or text node is constructed and that sequence of nodes is used as the value of the children property.
Because the data model requires that all general entities be expanded, there will never be unexpanded entity reference information item children.
A set of attribute nodes constructed from the attribute information items appearing in the [attributes] property. This includes all of the “special” attributes (xml:lang
, xml:space
, xsi:type
, etc.) but does not include namespace declarations (because they are not attributes).
Default and fixed attributes provided by the DTD are added to the [attributes] and are therefore included in the data model attributes of an element.
A set of namespace nodes constructed from the namespace information items appearing in the [in-scope namespaces] property. Implementations that do not support namespace nodes may simply preserve the relevant bindings in this property.
Implementations may ignore namespace information items for namespaces which are not known to be used. A namespace is known to be used if:
It appears in the expanded QName of the node-name of the element.
It appears in the expanded QName of the node-name of any of the element’s attributes.
Note: applications may rely on namespaces that are not known to be used, for example when QNames are used in content and that content does not have a type of xs:QName
Such applications may have difficulty processing data models where some namespaces have been ignored.
All element nodes constructed from an infoset have a nilled property of “false ”.
The string-value is constructed from the character information item[children] of the element and all its descendants. The precise rules for selecting significant character information items and constructing characters from them is described in 5.7.3 Construction from an Infoset of 5.7 Text nodes.
This process is equivalent to concatenating the dm:string-values of all of the text node descendants of the resulting element node.
If the element has no such descendants, the string-value is the empty string.
The string-value as an xs:untypedAtomic
.
All element nodes constructed from an infoset have a is-id property of “false ”.
All element nodes constructed from an infoset have a is-idrefs property of “false ”.
The following element node properties are affected by PSVI properties.
The schema-type is determined as described in 3.3.1.1 Element and Attribute Node Types.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, comment, and maximal sequence of adjacent character information items found in the [children] property, a corresponding element, processing instruction, comment, or text node is constructed and that sequence of nodes is used as the value of the children property.
For elements with schema simple types, or complex types with simple content, if the [schema normalized value] PSVI property exists, the processor may use a sequence of nodes containing the processing instruction and comment nodes corresponding to the processing instruction and comment information items found in the [children] property, plus an optional single text node whose string value is the [schema normalized value] for the children property. If the [schema normalized value] is the empty string, the text node must not be present, otherwise it must be present. The relative order of Processing Instruction and comment nodes must be preserved, but the position of the text node, if it is present, among them is implementation defined.
The effect of the above rules is that where a fixed or default value for an element is defined in the schema, and the element takes this default value, a text node will be created to contain the value, even though there are no character information items representing the value in the PSVI. The position of this text node relative to any comment or processing instruction children is implementation-dependent.
[Schema Part 1] also permits an element with mixed content to take a default or fixed value (which will always be a simple value), but it is unclear how such a defaulted value is represented in the PSVI. Implementations therefore may represent such a default value by creating a text node, but are not required to do so.
Note:
Section 3.3.1 in [Schema 1.1 Part 1] clarifies the PSVI contributions of element default or fixed values in mixed content: additional character information items are not added to the PSVI.
Because the data model requires that all general entities be expanded, there will never be unexpanded entity reference information item children.
A set of attribute nodes constructed from the attribute information items appearing in the [attributes] property. This includes all of the “special” attributes (xml:lang
, xml:space
, xsi:type
, etc.) but does not include namespace declarations (because they are not attributes).
Default and fixed attributes provided by XML Schema processing are added to the [attributes] and are therefore included in the data model attributes of an element.
A set of namespace nodes constructed from the namespace information items appearing in the [in-scope namespaces] property. Implementations that do not support namespace nodes may simply preserve the relevant bindings in this property.
Implementations may ignore namespace information items for namespaces which are not known to be used. A namespace is known to be used if:
It appears in the expanded QName of the node-name of the element.
It appears in the expanded QName of the node-name of any of the element’s attributes.
It appears in the expanded QName of any values of type xs:QName
that appear among the element’s children or the typed values of its attributes.
Note: applications may rely on namespaces that are not known to be used, for example when QNames are used in content and that content does not have a type of xs:QName
Such applications may have difficulty processing data models where some namespaces have been ignored.
If the [validity] property exists on an information item and is “valid ” then if the [nil] property exists and is true, then the nilled property is “true ”. In all other cases, including all cases where schema validity assessment was not attempted or did not succeed, the nilled property is “false ”.
The string-value is calculated as follows:
If the element is empty: its string value is the zero length string.
If the element has a type of xs:untyped
, a complex type with element-only content, or a complex type with mixed content: its string-value is the concatenation of the string-values of all its text node descendants in document order.
If the element has a simple type or a complex type with simple content: its string-value is the [schema normalized value] of the node.
If an implementation stores only the typed value of an element, it may use any valid lexical representation of the typed value for the string-value property.
The typed-value is calculated as follows:
If the element is of type xs:untyped
, its typed-value is its dm:string-value as an xs:untypedAtomic
.
If the element has a complex type with empty content, its typed-value is the empty sequence.
If the element has a simple type or a complex type with simple content: its typed value is computed as described in 3.3.1.2 Typed Value Determination. The result is a sequence of zero or more atomic items. The relationship between the type-name, typed-value, and string-value of an element node is consistent with XML Schema validation.
Note that in the case of dates and times, the timezone is preserved as described in 3.3.2 Dates and Times, and in the case of xs:QName
s and xs:NOTATION
s, the prefix is preserved as described in 3.3.3 QNames and NOTATIONS.
If the element has a complex type with mixed content (including xs:anyType
), its typed-value is its dm:string-value as an xs:untypedAtomic
.
Otherwise, the element must be a complex type with element-only content. The typed-value of such an element is absent. Attempting to access this property with the dm:typed-value accessor always raises an error.
If the element has a complex type with element-only content, the is-id property is false
. Otherwise, if the typed-value of the element consists of exactly one atomic item and that value is of type xs:ID
, or a type derived from xs:ID
, the is-id property is true
, otherwise it is false
.
Note:
This means that in the case of a type constructed by list from xs:ID
, the ID is recognized provided that the list is of length one. A type constructed as a union involving xs:ID
is recognized provided the actual value is of type xs:ID
.
Note:
The element that is marked with the is-id property, and which will therefore be retrieved by the fn:id function, is the node whose typed value contains the xs:ID
value. This node is a child of the element node that, according to XML Schema, is uniquely identified by this ID.
If the element has a complex type with element-only content, the is-idrefs property is false
. Otherwise, if any of the atomic items in the typed-value of the element is of type xs:IDREF
or xs:IDREFS
, or a type derived from one of those types, the is-idrefs property is true
, otherwise it is false
.
All other properties have values that are consistent with construction from an infoset.
An element node maps to an element information item.
The following properties are specified by this mapping:
The namespace name of the value of dm:node-name.
The local part of the value of dm:node-name.
The prefix associated with the value of dm:node-name.
A list of information items obtained by processing each of the dm:children in order and mapping each to the appropriate information item(s).
An unordered set of information items obtained by processing each of the dm:attributes and mapping each to the appropriate information item(s).
An unordered set of namespace information items constructed from the namespaces.
Each in-scope namespace maps to a namespace information item. The following properties are specified by this mapping:
The prefix associated with the namespace.
The URI associated with the namespace.
The value of dm:base-uri.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
The following property has no value: [namespace attributes].
Attribute nodes represent XML attributes. Attributes have the following properties:
node-name
parent, possibly empty
schema-type
string-value
typed-value
is-id
is-idrefs
Attribute nodes must satisfy the following constraints.
If an attribute node A is among the attributes of an element E, then the parent of Amust be E.
If a attribute node A has a parent element E, then Amust be among the attributes of E.
The data model permits attribute nodes without parents (to represent partial results during expression processing, for example). Such attributes must not appear among the attributes of any element node.
In the node-name of an attribute node, if a namespace URI is present then a prefix must also be present.
For convenience, the element node that owns this attribute is called its “parent” even though an attribute node is not a “child” of its parent element.
Returns the empty sequence.
If the attribute has a parent, returns the value of the dm:base-uri of its parent; otherwise it returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the is-id property.
Returns the value of the is-idrefs property.
Returns the empty sequence.
Returns the empty sequence.
Returns “attribute
”.
Returns the value of the node-name property.
Returns the value of the parent property.
Returns the value of the string-value property.
Returns the value of the schema-type property.
Returns the value of the typed-value property.
Returns the empty sequence.
Returns the empty sequence.
The attribute information items are required. An attribute node is constructed for each attribute information item.
The following infoset properties are required: [namespace name], [local name], [normalized value], [attribute type], and [owner element].
Attribute node properties are derived from the infoset as follows:
An xs:QName
constructed from the [prefix], [local name], and [namespace name] properties.
The element node that corresponds to the value of the [owner element] property or the empty sequence if there is no owner.
The value xs:untypedAtomic
.
The [normalized value] of the attribute.
The attribute’s typed-value is its dm:string-value as an xs:untypedAtomic
.
If the attribute is named xml:id
and its [attribute type] property does not have the value ID
, then [xml:id] processing is performed. This will ensure that the value does have the type ID
and that it is properly normalized. If an error is encountered during xml:id
processing, an implementation may raise a dynamic error. The is-id property is always true
for attributes named xml:id
.
If the [attribute type] property has the value ID
, true
, otherwise false
.
If the [attribute type] property has the value IDREF
or IDREFS
, true
, otherwise false
.
The following attribute node properties are affected by PSVI properties.
The [schema normalized value] PSVI property if that exists.
Otherwise, the [normalized value] property.
If an implementation stores only the typed value of an attribute, it may use any valid lexical representation of the typed value for the string-value property.
The schema-type is determined as described in 3.3.1.1 Element and Attribute Node Types.
The typed-value is calculated as follows:
If the attribute is of type xs:untypedAtomic
: its typed-value is its dm:string-value as an xs:untypedAtomic
.
Otherwise, a sequence of zero or more atomic items as described in 3.3.1.2 Typed Value Determination. The relationship between the type-name, typed-value, and string-value of an attribute node is consistent with XML Schema validation.
If the attribute is named xml:id
and its [attribute type] property does not have the value xs:ID
or a type derived from xs:ID
, then [xml:id] processing is performed. This will ensure that the value does have the type xs:ID
and that it is properly normalized. If an error is encountered during xml:id
processing, an implementation may raise a dynamic error. The is-id property is always true for attributes named xml:id
.
Otherwise, if the typed-value of the attribute consists of exactly one atomic item and that value is of type xs:ID
, or a type derived from xs:ID
, the is-id property is true
, otherwise it is false
.
Note:
This means that in the case of a type constructed by list from xs:ID
, the ID is recognized provided that the list is of length one. A type constructed as a union involving xs:ID
is recognized provided the actual value is of type xs:ID
.
If any of the atomic items in the typed-value of the attribute is of type xs:IDREF
or xs:IDREFS
, or a type derived from one of those types, the is-idrefs property is true
, otherwise it is false
.
Note:
This rule means that a node whose type is constructed by list with an item type of xs:IDREF
(or a type derived from xs:IDREF
) may have the is-idrefs property, whether or not the list type is named xs:IDREFS
or is derived from xs:IDREFS
. Because union types are allowed, it also means that an element or attribute with the is-idrefs property can contain atomic items of type xs:IDREF
alongside values of other types. A node has the is-idrefs property only if the typed value contains at least one atomic item that is an instance of xs:IDREF
; it is not sufficient that the type annotation permits such values.
All other properties have values that are consistent with construction from an infoset.
Note: attributes from the XML Schema instance namespace, “http://www.w3.org/2001/XMLSchema-instance
” (xsi:schemaLocation
, xsi:type
, etc.), appear as ordinary attributes in the data model.
An attribute node maps to an attribute information item.
The following properties are specified by this mapping:
The namespace name of the value of dm:node-name.
The local part of the value of dm:node-name.
The prefix associated with the value of dm:node-name.
The value of dm:string-value.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
The following properties have no value: [specified][attribute type][references].
Each namespace node represents the binding of a namespace URI to a namespace prefix or to the default namespace. Implementations that do not use namespace nodes may represent the same information using the namespaces property of an element node. Namespaces have the following properties:
prefix, possibly empty
uri
parent, possibly empty
Namespace nodes must satisfy the following constraints.
If a namespace node N is among the namespaces of an element E, then the parent of Nmust be E.
If a namespace node N has a parent element E, then Nmust be among the namespaces of E.
A namespace node must not have the name xmlns
nor the string-value http://www.w3.org/2000/xmlns/
.
The data model permits namespace nodes without parents; see below.
In XPath 1.0, namespace nodes were directly accessible by applications, by means of the namespace axis. In XPath 3.1 the namespace axis is deprecated, and it is not available at all in XQuery 3.1. XPath 3.1 implementations are not required to expose the namespace axis, though they may do so if they wish to offer backwards compatibility.
The information held in namespace nodes is instead made available to applications using functions defined in [XQuery and XPath Functions and Operators 4.0]. Some properties of namespace nodes are not exposed by these functions: in particular, properties related to the identity of namespace nodes, their parentage, and their position in document order. Implementations that do not expose the namespace axis can therefore avoid the overhead of maintaining this information.
Implementations that expose the namespace axis must provide unique namespace nodes for each element. Each element has an associated set of namespace nodes, one for each distinct namespace prefix that is in scope for the element (including the xml
prefix, which is implicitly declared by [Namespaces in XML] and one for the default namespace if one is in scope for the element. The element is the parent of each of these namespace nodes; however, a namespace node is not a child of its parent element. In implementations that expose the namespace axis, elements never share namespace nodes.
Note:
In implementations that do not expose the namespace axis, there is no means by which the host language can tell if namespace nodes are shared or not and, in such circumstances, sharing namespace nodes may be a very reasonable implementation strategy.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “namespace
”.
If the prefix is not empty, returns an xs:QName
with the value of the prefix property in the local-name and an empty namespace name, otherwise returns the empty sequence.
Returns the value of the parent property.
Returns the value of the uri property.
Returns the empty sequence.
Returns the value of the uri property as an xs:string
.
Returns the empty sequence.
Returns the empty sequence.
The namespace information items are required.
The following infoset properties are required: [prefix], [namespace name].
Namespace node properties are derived from the infoset as follows:
The [prefix] property.
The [namespace name] property.
The element in whose [in-scope namespaces] property the namespace information item appears, if the implementation exposes any mechanism for accessing the dm:parent accessor of namespace nodes.
Construction from a PSVI is identical to construction from the Infoset.
A namespace node maps to a namespace information item.
The following properties are specified by this mapping:
The prefix associated with the namespace.
The value of dm:string-value.
Processing instruction nodes encapsulate XML processing instructions. Processing instructions have the following properties:
target
content
base-uri, possibly empty
parent, possibly empty
Processing instruction nodes must satisfy the following constraints.
The string “?>” must not occur within the content.
The targetmust be an NCName
.
Returns the empty sequence.
Returns the value of the base-uri property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “processing-instruction
”.
Returns an xs:QName
with the value of the target property in the local-name and an empty namespace URI and empty prefix.
Returns the value of the parent property.
Returns the value of the content property.
Returns the empty sequence.
Returns the value of the content property as a xs:string
.
Returns the empty sequence.
Returns the empty sequence.
A processing instruction node is constructed for each processing instruction information item that is not ignored.
The following infoset properties are required: [target], [content], [base URI], and [parent].
Processing instruction node properties are derived from the infoset as follows:
The value of the [target] property.
The value of the [content] property.
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
The node corresponding to the value of the [parent] property.
There are no processing instruction nodes for processing instructions that are children of a document type declaration information item.
Construction from a PSVI is identical to construction from the Infoset.
An processing instruction node maps to a processing instruction information item.
The following properties are specified by this mapping:
The local part of the value of dm:node-name.
The value of dm:string-value.
The value of dm:base-uri.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
No value.
Comment nodes encapsulate XML comments. Comments have the following properties:
content
parent, possibly empty
Comment nodes must satisfy the following constraints.
The string “--” must not occur within the content.
The character “-” must not occur as the last character of the content.
Returns the empty sequence.
If the comment has a parent, returns the value of the dm:base-uri of its parent; otherwise, returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “comment
”.
Returns the empty sequence.
Returns the value of the parent property.
Returns the value of the content property.
Returns the empty sequence.
Returns the value of the content property as a xs:string
.
Returns the empty sequence.
Returns the empty sequence.
The comment information items are optional.
A comment node is constructed for each comment information item.
The following infoset properties are required: [content] and [parent].
Comment node properties are derived from the infoset as follows:
The value of the [content] property.
The node corresponding to the value of the [parent] property.
There are no comment nodes for comments that are children of a document type declaration information item.
Construction from a PSVI is identical to construction from the Infoset.
A comment node maps to a comment information item.
The following properties are specified by this mapping:
The value of the dm:string-value.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
Text nodes encapsulate XML character content. Text has the following properties:
content
parent, possibly empty.
Text nodes must satisfy the following constraint:
If the parent of a text node is not empty, the text node must not contain the zero-length string as its content.
In addition, Document and element nodes impose the constraint that two consecutive text nodes can never occur as adjacent siblings. When a Document or element node is constructed, text nodes that would be adjacent must be combined into a single text node. If the resulting text node is empty, it must never be placed among the children of its parent; it is simply discarded.
Returns the empty sequence.
If the text node has a parent, returns the value of the dm:base-uri of its parent; otherwise, returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “text
”.
Returns the empty sequence.
Returns the value of the parent property.
Returns the value of the content property.
Returns xs:untypedAtomic
.
Returns the value of the content property as an xs:untypedAtomic
.
Returns the empty sequence.
Returns the empty sequence.
The character information items are required. A text node is constructed for each maximal sequence of character information items in document order.
The following infoset properties are required: [character code] and [parent].
The following infoset properties are optional: [element content whitespace].
A sequence of character information items is maximal if it satisfies the following constraints:
All of the information items in the sequence have the same parent.
The sequence consists of adjacent character information items uninterrupted by other types of information item.
No other such sequence exists that contains any of the same character information items and is longer.
Text node properties are derived from the infoset as follows:
A string comprised of characters that correspond to the [character code] properties of each of the character information items.
If the resulting text node consists entirely of whitespace and the [element content whitespace] property of the character information items used to construct this node are true
, the content of the text node is the zero-length string. text nodes are allowed to be empty only if they have no parents; an empty text node will be discarded when its parent is constructed, if it has a parent.
The content of the text node is not necessarily normalized as described in the [Character Model]. It is the responsibility of data producers to provide normalized text, and the responsibility of applications to make sure that operations do not de-normalize text.
The node corresponding to the value of the [parent] property.
For text nodes constructed from the [schema normalized value] of elements, content contains the value of the [schema normalized value].
Otherwise, construction from a PSVI is the same as construction from the Infoset except for the content property. When constructing the content property, [element content whitespace] is not used to test if whitespace is collapsed. Instead, if the resulting text node consists entirely of whitespace and the character information items used to construct this node have a parent and that parent is an element and its {content type} is not “mixed
”, then the content of the text node is the zero-length string.
text nodes are allowed to be empty only if they have no parents; an empty text node will be discarded when its parent is constructed, if it has a parent.
A text node maps to a sequence of character information items.
Each character of the dm:string-value of the node is converted into a character information item as specified by this mapping:
The Unicode code point value of the character.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
Unknown.
This sequence of characters constitutes the infoset mapping.
The data model is intended primarily as a component that can be used by other specifications. Therefore, the data model relies on specifications that use it (such as [XML Path Language (XPath) 4.0], [XSL Transformations (XSLT) Version 4.0], and [XQuery 4.0: An XML Query Language]) to specify conformance criteria for the data model in their respective environments. Specifications that set conformance criteria for their use of the data model must not relax the constraints expressed in this specification.
Authors of conformance criteria for the use of the data model should pay particular attention to the following features of the data model:
Support for the normative construction from an infoset described in 3.2 Construction from an Infoset.
Support for the normative construction from a PSVI described in 3.3 Construction from a PSVI.
Support for XML 1.0 and XML 1.1.
Support for data types in XML Schema 1.0 and XML Schema 1.1.
How namespaces are supported, through nodes or through the alternative, implementation-dependent representation.
Note:
In addition, the dm:is-id and dm:base-uri accessors are required by functions in [XQuery and XPath Functions and Operators 4.0]. These refer to the specifications [xml:id] and [XML Base] respectively.
This specification conforms to the XML Information Set [Infoset]. The following information items must be exposed by the infoset producer to construct a data model unless they are explicitly identified as optional:
The Document Information Item with [base URI], [children], and, optionally, [unparsed entities] properties. If the [unparsed entities] property is supported, the Unparsed Entity Information Items must also be supported.
Element Information Items with [base URI], [children], [attributes], [in-scope namespaces], [prefix], [local name], [namespace name], [parent] properties.
Attribute Information Items with [namespace name], [prefix], [local name], [normalized value], [attribute type], and [owner element] properties.
Character Information Items with [character code], [parent], and, optionally, [element content whitespace] properties.
Processing Instruction Information Items with [base URI], [target], [content] and [parent] properties.
Comment Information Items with [content] and [parent] properties.
Namespace Information Items with [prefix] and [namespace name] properties.
Other information items and properties made available by the Infoset processor are ignored. In addition to the properties above, the following PSVI properties are required on Element Information Items and Attribute Information Items if the data model is constructed from a PSVI:
[validity], [validation attempted], [type definition], [type definition namespace], [type definition name], [type definition anonymous], [nil], [member type definition], [member type definition namespace], [member type definition name], [member type definition anonymous] and [schema normalized value].
When a property has no value, we say that it is absent.
An array item is a value that represents an array.
An atomic item is a pair (T, D) where T (the type annotation) is an atomic type, and D (the datum) is a point in the value space of T.
An atomic type is either a primitive simple typewith variety atomic
, or a type derived by restriction from another atomic type.
A character is any Unicode character.
A codepoint is a non-negative integer assigned to a character by the Unicode consortium, or reserved for future assignment to a character.
Two schemasX and Y are compatible if the union of X and Y is a valid schema.
The datum of an atomic item is a point in the value space of its type, which is also a point in the value space of the primitive type from which that type is derived.
A tree whose root node is a document node is referred to as a document.
A document order is defined among all the nodes accessible during a given query or transformation. Document order is a total ordering, although the relative order of some nodes is implementation-dependent. Informally, document order is the order in which nodes appear in the XML serialization of a document.
The order of entries in a map (which is dependent on its ordering property) is referred to as entry order.
An expanded QName is a triple consisting of a possibly absent prefix, a possibly absent namespace URI, and a local name.
A tree whose root node is not a document node is referred to as a fragment.
The arity of a function item is the number of its parameters.
A function item is an item that can be called.
A function signature represents the type of a function.
Implementation-defined indicates an aspect that may differ between implementations, but must be specified by the implementer for each particular implementation.
Implementation-dependent indicates an aspect that may differ between implementations, is not specified by this or any W3C specification, and is not required to be specified by the implementer for any particular implementation.
An incompletely validated document is an XML document that has a corresponding schema but whose schema-validity assessment has resulted in one or more element or attribute information items being assigned values other than ‘valid’ for the [validity] property in the PSVI.
When the ordering of a map is insertion, the map maintains an ordering of entries (first-in, first-out) based on the order in which entries were added, with new entries being added at the end, after existing entries.
Every instance of the data model is a sequence.
An item is either a node, a function, or an atomic item.
An item type represents a class of items.
A labeled item is a pair (S, L) where S (called the subject) is any item, and L (called the label) is a map containing supplementary information about the item.
A map item is a value that represents a map (in other languages this is sometimes called a hash, dictionary, or associative array).
A map item is an item that represents a (possibly ordered) set of key/value pairs, in which the keys are unique.
This specification uses the term Namespace URI to refer to a namespace name, whether or not it is a valid URI or IRI
There are seven kinds of nodes in the data model: document, element, attribute, text, namespace, processing instruction, and comment.
A map item has a property called its ordering, which takes one of the three values undefined
, sorted
, or insertion
.
The primitive simple types are the types defined in 2.2.1 Types adopted from XML Schema.
The root node is the topmost node of a tree, the node with no parent.
Following the terminology of [Schema Part 1], a schema is defined as set of schema components. Schema components include, for example, element declarations and type definitions.
A schema type corresponds to a type definition component as defined in XSD.
A sequence is an ordered collection of zero or more items.
A sequence type constrains the set of permitted sequences, by defining the permitted item types and the permitted number of items in the sequence (exactly zero, exactly one, zero-or-more, one-or-more, zero-or-one).
When the ordering of a map is sorted, the entries in the map are retrieved in order of their keys, which must be comparable so that the order is well defined.
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.
Two atomic items K1 and K2 are strictly comparable if (a) the function call fn:compare(K1, K2, $CC)
(where $CC
is the Unicode codepoint collation) does not fail with a type error, and (b) either both of the values have a timezone component, or neither of them has a timezone component.
A string is a sequence of zero or more characters.
The term type annotation has two slightly different meanings. For an atomic item, the type annotation of the value is the most specific atomic type that it is an instance of (it is also an instance of every type from which that type is derived). For an element or attribute node, the type annotation is the schema type (a simple or complex type) against which the node has been validated, defaulting to xs:untypedAtomic
for unvalidated attribute nodes, and xs:untyped
for unvalidated element nodes.
When the ordering of a map is undefined, the order of entries in the map is implementation dependent; in a typical implementation it might depend on the result of a randomizing hash function.
Because every value is a sequence, the term value is used synonymously with sequence.
The following XML document is used to illustrate the information contained in a data model:
<?xml version="1.0"?> <?xml-stylesheet type="text/xsl" href="dm-example.xsl"?> <catalog xmlns="http://www.example.com/catalog" xmlns:html="http://www.w3.org/1999/xhtml" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.example.com/catalog dm-example.xsd" xml:lang="en" version="0.1"> <!-- This example is for data model illustration only. It does not demonstrate good schema design. --> <tshirt code="T1534017" label=" Staind : Been Awhile " xlink:href="http://example.com/0,,1655091,00.html" sizes="M L XL"> <title> Staind: Been Awhile Tee Black (1-sided) </title> <description> <html:p> Lyrics from the hit song 'It's Been Awhile' are shown in white, beneath the large 'Flock & Weld' Staind logo. </html:p> </description> <price> 25.00 </price> </tshirt> <album code="A1481344" label=" Staind : Its Been A While " formats="CD"> <title> It's Been A While </title> <description xsi:nil="true" /> <price currency="USD"> 10.99 </price> <artist> Staind </artist> </album> </catalog>
The document is associated with the URI “http://www.example.com/catalog.xml”, and is valid with respect to the following XML schema:
<?xml version="1.0"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:cat="http://www.example.com/catalog" xmlns:xlink="http://www.w3.org/1999/xlink" targetNamespace="http://www.example.com/catalog" elementFormDefault="qualified"> <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd" /> <xs:import namespace="http://www.w3.org/1999/xlink" schemaLocation="https://www.w3.org/XML/2008/06/xlink.xsd" /> <xs:element name="catalog"> <xs:complexType> <xs:sequence> <xs:element ref="cat:_item" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="version" type="xs:string" fixed="0.1" use="required" /> <xs:attribute ref="xml:base" /> <xs:attribute ref="xml:lang" /> </xs:complexType> </xs:element> <xs:element name="_item" type="cat:itemType" abstract="true" /> <xs:complexType name="itemType"> <xs:sequence> <xs:element name="title" type="xs:token" /> <xs:element name="description" type="cat:description" nillable="true" /> <xs:element name="price" type="cat:price" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute name="label" type="xs:token" /> <xs:attribute name="code" type="xs:ID" use="required" /> <xs:attributeGroup ref="xlink:simpleAttrs" /> </xs:complexType> <xs:element name="tshirt" type="cat:tshirtType" substitutionGroup="cat:_item" /> <xs:complexType name="tshirtType"> <xs:complexContent> <xs:extension base="cat:itemType"> <xs:attribute name="sizes" type="cat:clothesSizes" use="required" /> <xs:attribute ref="xml:lang" use="optional"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:simpleType name="clothesSizes"> <xs:union memberTypes="cat:sizeList"> <xs:simpleType> <xs:restriction base="xs:token"> <xs:enumeration value="oneSize" /> </xs:restriction> </xs:simpleType> </xs:union> </xs:simpleType> <xs:simpleType name="sizeList"> <xs:restriction> <xs:simpleType> <xs:list itemType="cat:clothesSize" /> </xs:simpleType> <xs:minLength value="1" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="clothesSize"> <xs:union memberTypes="cat:numberedSize cat:categorySize" /> </xs:simpleType> <xs:simpleType name="numberedSize"> <xs:restriction base="xs:integer"> <xs:enumeration value="4" /> <xs:enumeration value="6" /> <xs:enumeration value="8" /> <xs:enumeration value="10" /> <xs:enumeration value="12" /> <xs:enumeration value="14" /> <xs:enumeration value="16" /> <xs:enumeration value="18" /> <xs:enumeration value="20" /> <xs:enumeration value="22" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="categorySize"> <xs:restriction base="xs:token"> <xs:enumeration value="XS" /> <xs:enumeration value="S" /> <xs:enumeration value="M" /> <xs:enumeration value="L" /> <xs:enumeration value="XL" /> <xs:enumeration value="XXL" /> </xs:restriction> </xs:simpleType> <xs:element name="album" type="cat:albumType" substitutionGroup="cat:_item" /> <xs:complexType name="albumType"> <xs:complexContent> <xs:extension base="cat:itemType"> <xs:sequence> <xs:element name="artist" type="xs:string" /> </xs:sequence> <xs:attribute name="formats" type="cat:formatsType" use="required" /> <xs:attribute ref="xml:lang" use="optional"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:simpleType name="formatsType"> <xs:list itemType="cat:formatType" /> </xs:simpleType> <xs:simpleType name="formatType"> <xs:restriction base="xs:token"> <xs:enumeration value="CD" /> <xs:enumeration value="MiniDisc" /> <xs:enumeration value="tape" /> <xs:enumeration value="vinyl" /> </xs:restriction> </xs:simpleType> <xs:complexType name="description" mixed="true"> <xs:sequence> <xs:any namespace="http://www.w3.org/1999/xhtml" processContents="lax" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> <xs:attribute ref="xml:lang" use="optional"/> </xs:complexType> <xs:complexType name="price"> <xs:simpleContent> <xs:extension base="cat:monetaryAmount"> <xs:attribute name="currency" type="cat:currencyType" default="USD" /> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:simpleType name="currencyType"> <xs:restriction base="xs:token"> <xs:pattern value="[A-Z]{3}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="monetaryAmount"> <xs:restriction base="xs:decimal"> <xs:fractionDigits value="3" /> <xs:pattern value="\d+(\.\d{2,3})?" /> </xs:restriction> </xs:simpleType> </xs:schema>
The schema is associated with the URI “http://www.example.com/dm-example.xsd”.
This example exposes the data model for a document that has an associated schema and has been validated successfully against it. In general, an XML Schema is not required, that is, the data model can represent a schemaless, well-formed XML document with the rules described in 2.8 Schema Information.
The XML document is represented by the nodes described below. The value D1 represents a document node; the values E1, E2, etc. represent element nodes; the values A1, A2, etc. represent attribute nodes; the values N1, N2, etc. represent namespace nodes; the values P1, P2, etc. represent processing instruction nodes; the values T1, T2, etc. represent text nodes.
For brevity:
Text nodes in the data model that contain only white space are not shown.
Literal strings are shown in quotes without the xs:string()
constructor.
Literal decimals are shown without the xs:decimal()
constructor.
Nodes are referred to using the syntax [nodeID].
xs:QNames are used with the following prefixes bindings:
xs | http://www.w3.org/2001/XMLSchema |
xsi | http://www.w3.org/2001/XMLSchema-instance |
cat | http://www.example.com/catalog |
xlink | http://www.w3.org/1999/xlink |
html | http://www.w3.org/1999/xhtml |
anon | An implementation-dependent prefix associated with anonymous type names |
The abbreviation “\n
” is used in string literals to represent a newline character; this is not supported in XPath, but it makes this presentation clearer.
Accessors that return the empty sequence have been omitted.
To simplify the presentation, we assume an implementation that does not expose the namespace axis. Therefore, namespace nodes are shared across multiple elements. See 5.4 Namespace nodes.
// Document node D1 | ||
dm:base-uri(D1) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(D1) | = | "document" |
dm:string-value(D1) | = | " Staind: Been Awhile Tee Black (1-sided) \n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n 25.00 It's Been A While 10.99 Staind " |
dm:typed-value(D1) | = | xs:untypedAtomic(" Staind: Been Awhile Tee Black (1-sided) \n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n 25.00 It's Been A While 10.99 Staind ") |
dm:children(D1) | = | ([P1], [E1]) |
// Namespace node N1 | ||
dm:node-kind(N1) | = | "namespace" |
dm:node-name(N1) | = | () |
dm:string-value(N1) | = | "http://www.example.com/catalog" |
dm:typed-value(N1) | = | "http://www.example.com/catalog" |
// Namespace node N2 | ||
dm:node-kind(N2) | = | "namespace" |
dm:node-name(N2) | = | xs:QName("", "html") |
dm:string-value(N2) | = | "http://www.w3.org/1999/xhtml" |
dm:typed-value(N2) | = | "http://www.w3.org/1999/xhtml" |
// Namespace node N3 | ||
dm:node-kind(N3) | = | "namespace" |
dm:node-name(N3) | = | xs:QName("", "xlink") |
dm:string-value(N3) | = | "http://www.w3.org/1999/xlink" |
dm:typed-value(N3) | = | "http://www.w3.org/1999/xlink" |
// Namespace node N4 | ||
dm:node-kind(N4) | = | "namespace" |
dm:node-name(N4) | = | xs:QName("", "xsi") |
dm:string-value(N4) | = | "http://www.w3.org/2001/XMLSchema-instance" |
dm:typed-value(N4) | = | "http://www.w3.org/2001/XMLSchema-instance" |
// Namespace node N5 | ||
dm:node-kind(N5) | = | "namespace" |
dm:node-name(N5) | = | xs:QName("", "xml") |
dm:string-value(N5) | = | "http://www.w3.org/XML/1998/namespace" |
dm:typed-value(N5) | = | "http://www.w3.org/XML/1998/namespace" |
// Processing Instruction node P1 | ||
dm:base-uri(P1) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(P1) | = | "processing-instruction" |
dm:node-name(P1) | = | xs:QName("", "xml-stylesheet") |
dm:string-value(P1) | = | "type="text/xsl" href="dm-example.xsl"" |
dm:typed-value(P1) | = | "type="text/xsl" href="dm-example.xsl"" |
dm:parent(P1) | = | ([D1]) |
// Element node E1 | ||
dm:base-uri(E1) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E1) | = | "element" |
dm:node-name(E1) | = | xs:QName("http://www.example.com/catalog", "catalog") |
dm:string-value(E1) | = | " Staind: Been Awhile Tee Black (1-sided) \n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n 25.00 It's Been A While 10.99 Staind " |
dm:typed-value(E1) | = | fn:error() |
dm:type-name(E1) | = | anon:TYP000001 |
dm:is-id(E1) | = | false |
dm:is-idrefs(E1) | = | false |
dm:parent(E1) | = | ([D1]) |
dm:children(E1) | = | ([C1], [E2], [E7]) |
dm:attributes(E1) | = | ([A1], [A2], [A3]) |
dm:namespace-nodes(E1) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E1) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Attribute node A1 | ||
dm:node-kind(A1) | = | "attribute" |
dm:node-name(A1) | = | xs:QName("http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation") |
dm:string-value(A1) | = | "http://www.example.com/catalog dm-example.xsd" |
dm:typed-value(A1) | = | (xs:anyURI("http://www.example.com/catalog"), xs:anyURI("catalog.xsd")) |
dm:type-name(A1) | = | anon:TYP000002 |
dm:is-id(A1) | = | false |
dm:is-idrefs(A1) | = | false |
dm:parent(A1) | = | ([E1]) |
// Attribute node A2 | ||
dm:node-kind(A2) | = | "attribute" |
dm:node-name(A2) | = | xs:QName("http://www.w3.org/XML/1998/namespace", "xml:lang") |
dm:string-value(A2) | = | "en" |
dm:typed-value(A2) | = | "en" |
dm:type-name(A2) | = | xs:NMTOKEN |
dm:is-id(A2) | = | false |
dm:is-idrefs(A2) | = | false |
dm:parent(A2) | = | ([E1]) |
// Attribute node A3 | ||
dm:node-kind(A3) | = | "attribute" |
dm:node-name(A3) | = | xs:QName("", "version") |
dm:string-value(A3) | = | "0.1" |
dm:typed-value(A3) | = | "0.1" |
dm:type-name(A3) | = | xs:string |
dm:is-id(A3) | = | false |
dm:is-idrefs(A3) | = | false |
dm:parent(A3) | = | ([E1]) |
// Comment node C1 | ||
dm:base-uri(C1) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(C1) | = | "comment" |
dm:string-value(C1) | = | " This example is for data model illustration only.\n It does not demonstrate good schema design. " |
dm:typed-value(C1) | = | " This example is for data model illustration only.\n It does not demonstrate good schema design. " |
dm:parent(C1) | = | ([E1]) |
// Element node E2 | ||
dm:base-uri(E2) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E2) | = | "element" |
dm:node-name(E2) | = | xs:QName("http://www.example.com/catalog", "tshirt") |
dm:string-value(E2) | = | " Staind: Been Awhile Tee Black (1-sided) \n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n 25.00 " |
dm:typed-value(E2) | = | fn:error() |
dm:type-name(E2) | = | cat:tshirtType |
dm:is-id(E2) | = | false |
dm:is-idrefs(E2) | = | false |
dm:parent(E2) | = | ([E1]) |
dm:children(E2) | = | ([E3], [E4], [E6]) |
dm:attributes(E2) | = | ([A4], [A5], [A6], [A7]) |
dm:namespace-nodes(E2) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E2) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Attribute node A4 | ||
dm:node-kind(A4) | = | "attribute" |
dm:node-name(A4) | = | xs:QName("", "code") |
dm:string-value(A4) | = | "T1534017" |
dm:typed-value(A4) | = | xs:ID("T1534017") |
dm:type-name(A4) | = | xs:ID |
dm:is-id(A4) | = | true |
dm:is-idrefs(A4) | = | false |
dm:parent(A4) | = | ([E2]) |
// Attribute node A5 | ||
dm:node-kind(A5) | = | "attribute" |
dm:node-name(A5) | = | xs:QName("", "label") |
dm:string-value(A5) | = | "Staind : Been Awhile" |
dm:typed-value(A5) | = | xs:token("Staind : Been Awhile") |
dm:type-name(A5) | = | xs:token |
dm:is-id(A5) | = | false |
dm:is-idrefs(A5) | = | false |
dm:parent(A5) | = | ([E2]) |
// Attribute node A6 | ||
dm:node-kind(A6) | = | "attribute" |
dm:node-name(A6) | = | xs:QName("http://www.w3.org/1999/xlink", "xlink:href") |
dm:string-value(A6) | = | "http://example.com/0,,1655091,00.html" |
dm:typed-value(A6) | = | xs:anyURI("http://example.com/0,,1655091,00.html") |
dm:type-name(A6) | = | xs:anyURI |
dm:is-id(A6) | = | false |
dm:is-idrefs(A6) | = | false |
dm:parent(A6) | = | ([E2]) |
// Attribute node A7 | ||
dm:node-kind(A7) | = | "attribute" |
dm:node-name(A7) | = | xs:QName("", "sizes") |
dm:string-value(A7) | = | "M L XL" |
dm:typed-value(A7) | = | (xs:token("M"), xs:token("L"), xs:token("XL")) |
dm:type-name(A7) | = | cat:sizeList |
dm:is-id(A7) | = | false |
dm:is-idrefs(A7) | = | false |
dm:parent(A7) | = | ([E2]) |
// Element node E3 | ||
dm:base-uri(E3) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E3) | = | "element" |
dm:node-name(E3) | = | xs:QName("http://www.example.com/catalog", "title") |
dm:string-value(E3) | = | "Staind: Been Awhile Tee Black (1-sided)" |
dm:typed-value(E3) | = | xs:token("Staind: Been Awhile Tee Black (1-sided)") |
dm:type-name(E3) | = | xs:token |
dm:is-id(E3) | = | false |
dm:is-idrefs(E3) | = | false |
dm:parent(E3) | = | ([E2]) |
dm:children(E3) | = | ([T1]) |
dm:attributes(E3) | = | () |
dm:namespace-nodes(E3) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E3) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Text node T1 | ||
dm:base-uri(T1) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T1) | = | "text" |
dm:string-value(T1) | = | "Staind: Been Awhile Tee Black (1-sided)" |
dm:typed-value(T1) | = | xs:untypedAtomic("Staind: Been Awhile Tee Black (1-sided)") |
dm:type-name(T1) | = | xs:untypedAtomic |
dm:parent(T1) | = | ([E3]) |
// Element node E4 | ||
dm:base-uri(E4) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E4) | = | "element" |
dm:node-name(E4) | = | xs:QName("http://www.example.com/catalog", "description") |
dm:string-value(E4) | = | "\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n " |
dm:typed-value(E4) | = | xs:untypedAtomic("\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n ") |
dm:type-name(E4) | = | cat:description |
dm:is-id(E4) | = | false |
dm:is-idrefs(E4) | = | false |
dm:parent(E4) | = | ([E2]) |
dm:children(E4) | = | ([E5]) |
dm:attributes(E4) | = | () |
dm:namespace-nodes(E4) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E4) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Element node E5 | ||
dm:base-uri(E5) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E5) | = | "element" |
dm:node-name(E5) | = | xs:QName("http://www.w3.org/1999/xhtml", "html:p") |
dm:string-value(E5) | = | "\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n " |
dm:typed-value(E5) | = | xs:untypedAtomic("\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n ") |
dm:type-name(E5) | = | xs:anyType |
dm:is-id(E5) | = | false |
dm:is-idrefs(E5) | = | false |
dm:parent(E5) | = | ([E4]) |
dm:children(E5) | = | ([T2]) |
dm:attributes(E5) | = | () |
dm:namespace-nodes(E5) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E5) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Text node T2 | ||
dm:base-uri(T2) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T2) | = | "text" |
dm:string-value(T2) | = | "\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n " |
dm:typed-value(T2) | = | xs:untypedAtomic("\n Lyrics from the hit song 'It's Been Awhile'\n are shown in white, beneath the large\n 'Flock & Weld' Staind logo.\n ") |
dm:type-name(T2) | = | xs:untypedAtomic |
dm:parent(T2) | = | ([E5]) |
// Element node E6 | ||
dm:base-uri(E6) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E6) | = | "element" |
dm:node-name(E6) | = | xs:QName("http://www.example.com/catalog", "price") |
dm:string-value(E6) | = | "25.00" |
// The typed-value is based on the content type of the complex type for the element | ||
dm:typed-value(E6) | = | cat:monetaryAmount(25.0) |
dm:type-name(E6) | = | cat:price |
dm:is-id(E6) | = | false |
dm:is-idrefs(E6) | = | false |
dm:parent(E6) | = | ([E2]) |
dm:children(E6) | = | ([T3]) |
dm:attributes(E6) | = | () |
dm:namespace-nodes(E6) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E6) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Text node T3 | ||
dm:base-uri(T3) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T3) | = | "text" |
dm:string-value(T3) | = | "25.00" |
dm:typed-value(T3) | = | xs:untypedAtomic("25.00") |
dm:type-name(T3) | = | xs:untypedAtomic |
dm:parent(T3) | = | ([E6]) |
// Element node E7 | ||
dm:base-uri(E7) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E7) | = | "element" |
dm:node-name(E7) | = | xs:QName("http://www.example.com/catalog", "album") |
dm:string-value(E7) | = | " It's Been A While 10.99 Staind " |
dm:typed-value(E7) | = | fn:error() |
dm:type-name(E7) | = | cat:albumType |
dm:is-id(E7) | = | false |
dm:is-idrefs(E7) | = | false |
dm:parent(E7) | = | ([E1]) |
dm:children(E7) | = | ([E8], [E9], [E10], [E11]) |
dm:attributes(E7) | = | ([A8], [A9], [A10]) |
dm:namespace-nodes(E7) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E7) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Attribute node A8 | ||
dm:node-kind(A8) | = | "attribute" |
dm:node-name(A8) | = | xs:QName("", "code") |
dm:string-value(A8) | = | "A1481344" |
dm:typed-value(A8) | = | xs:ID("A1481344") |
dm:type-name(A8) | = | xs:ID |
dm:is-id(A8) | = | true |
dm:is-idrefs(A8) | = | false |
dm:parent(A8) | = | ([E7]) |
// Attribute node A9 | ||
dm:node-kind(A9) | = | "attribute" |
dm:node-name(A9) | = | xs:QName("", "label") |
dm:string-value(A9) | = | "Staind : Its Been A While" |
dm:typed-value(A9) | = | xs:token("Staind : Its Been A While") |
dm:type-name(A9) | = | xs:token |
dm:is-id(A9) | = | false |
dm:is-idrefs(A9) | = | false |
dm:parent(A9) | = | ([E7]) |
// Attribute node A10 | ||
dm:node-kind(A10) | = | "attribute" |
dm:node-name(A10) | = | xs:QName("", "formats") |
dm:string-value(A10) | = | "CD" |
dm:typed-value(A10) | = | cat:formatType("CD") |
dm:type-name(A10) | = | cat:formatType |
dm:is-id(A10) | = | false |
dm:is-idrefs(A10) | = | false |
dm:parent(A10) | = | ([E7]) |
// Element node E8 | ||
dm:base-uri(E8) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E8) | = | "element" |
dm:node-name(E8) | = | xs:QName("http://www.example.com/catalog", "title") |
dm:string-value(E8) | = | "It's Been A While" |
dm:typed-value(E8) | = | xs:token("It's Been A While") |
dm:type-name(E8) | = | xs:token |
dm:is-id(E8) | = | false |
dm:is-idrefs(E8) | = | false |
dm:parent(E8) | = | ([E7]) |
dm:children(E8) | = | ([T4]) |
dm:attributes(E8) | = | () |
dm:namespace-nodes(E8) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E8) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Text node T4 | ||
dm:base-uri(T4) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T4) | = | "text" |
dm:string-value(T4) | = | "It's Been A While" |
dm:typed-value(T4) | = | xs:untypedAtomic("It's Been A While") |
dm:type-name(T4) | = | xs:untypedAtomic |
dm:parent(T4) | = | ([E8]) |
// Element node E9 | ||
dm:base-uri(E9) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E9) | = | "element" |
dm:node-name(E9) | = | xs:QName("http://www.example.com/catalog", "description") |
dm:string-value(E9) | = | "" |
// xsi:nil is true so the typed value is the empty sequence | ||
dm:typed-value(E9) | = | () |
dm:type-name(E9) | = | cat:description |
dm:is-id(E9) | = | false |
dm:is-idrefs(E9) | = | false |
dm:parent(E9) | = | ([E7]) |
dm:children(E9) | = | () |
dm:attributes(E9) | = | ([A11]) |
dm:namespace-nodes(E9) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E9) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Attribute node A11 | ||
dm:node-kind(A11) | = | "attribute" |
dm:node-name(A11) | = | xs:QName("http://www.w3.org/2001/XMLSchema-instance", "xsi:nil") |
dm:string-value(A11) | = | "true" |
dm:typed-value(A11) | = | xs:boolean("true") |
dm:type-name(A11) | = | xs:boolean |
dm:is-id(A11) | = | false |
dm:is-idrefs(A11) | = | false |
dm:parent(A11) | = | ([E9]) |
// Element node E10 | ||
dm:base-uri(E10) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E10) | = | "element" |
dm:node-name(E10) | = | xs:QName("http://www.example.com/catalog", "price") |
dm:string-value(E10) | = | "10.99" |
dm:typed-value(E10) | = | cat:monetaryAmount(10.99) |
dm:type-name(E10) | = | cat:price |
dm:is-id(E10) | = | false |
dm:is-idrefs(E10) | = | false |
dm:parent(E10) | = | ([E7]) |
dm:children(E10) | = | ([T5]) |
dm:attributes(E10) | = | ([A12]) |
dm:namespace-nodes(E10) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E10) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Attribute node A12 | ||
dm:node-kind(A12) | = | "attribute" |
dm:node-name(A12) | = | xs:QName("", "currency") |
dm:string-value(A12) | = | "USD" |
dm:typed-value(A12) | = | cat:currencyType("USD") |
dm:type-name(A12) | = | cat:currencyType |
dm:is-id(A12) | = | false |
dm:is-idrefs(A12) | = | false |
dm:parent(A12) | = | ([E10]) |
// Text node T5 | ||
dm:base-uri(T5) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T5) | = | "text" |
dm:string-value(T5) | = | "10.99" |
dm:typed-value(T5) | = | xs:untypedAtomic("10.99") |
dm:type-name(T5) | = | xs:untypedAtomic |
dm:parent(T5) | = | ([E10]) |
// Element node E11 | ||
dm:base-uri(E11) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(E11) | = | "element" |
dm:node-name(E11) | = | xs:QName("http://www.example.com/catalog", "artist") |
dm:string-value(E11) | = | " Staind " |
dm:typed-value(E11) | = | " Staind " |
dm:type-name(E11) | = | xs:string |
dm:is-id(E11) | = | false |
dm:is-idrefs(E11) | = | false |
dm:parent(E11) | = | ([E7]) |
dm:children(E11) | = | ([T6]) |
dm:attributes(E11) | = | () |
dm:namespace-nodes(E11) | = | ([N1], [N2], [N3], [N4], [N5]) |
dm:namespace-bindings(E11) | = | ("", "http://www.example.com/catalog", "html", "http://www.w3.org/1999/xhtml", "xlink", "http://www.w3.org/1999/xlink", "xsi", "http://www.w3.org/2001/XMLSchema-instance", "xml", "http://www.w3.org/XML/1998/namespace") |
// Text node T6 | ||
dm:base-uri(T6) | = | xs:anyURI("http://www.example.com/catalog.xml") |
dm:node-kind(T6) | = | "text" |
dm:string-value(T6) | = | " Staind " |
dm:typed-value(T6) | = | xs:untypedAtomic(" Staind ") |
dm:type-name(T6) | = | xs:untypedAtomic |
dm:parent(T6) | = | ([E11]) |
A graphical representation of the data model for the preceding example is shown below. Document order in this representation can be found by following the traditional left-to-right, depth-first traversal; however, because the image has been rotated for easier presentation, this appears to be bottom-to-top, depth-first order.
Graphic representation of the data model. [large view, SVG] |
The following items are implementation-defined.
xs:string
to an xs:float
or xs:double
, it is implementation-defined whether the lexical value “-0” (and similar forms such as “-0.0”) convert to negative zero or to positive zero in the value space. (See 2.9.3 Negative Zero)The following items are implementation-dependent.
The following substantive changes have been made to this document since the XPath and XQuery Data Model 3.1 Recommendation of 21 March 2017.
Use the arrows to browse significant changes since the 3.1 version of this specification.
See 1 Introduction
Sections with significant changes are marked Δ in the table of contents.
See 1 Introduction
Constructors are added, and the single accessor function is now an iterator over the key/value pairs in the map.
See 2.9.5 Map Items
Constructors are added, and the single accessor function is now an iterator over the members of the array.
PR 232
Clarified the terminology concerning atomic types and type annotations.
PR 525
Introduced the concept of function identity.
PR 546
Relaxed the rules regarding use of non-XML characters in instances of xs:string
.
PR 988
Introduced the concept of labeled items.
PR 1361
The term atomic value has been replaced by atomic item.
PR 1609
Ordered maps are introduced.
See 2.9.5 Map Items
This section summarizes the return values of each accessor by node type.
Returns the empty sequence
Returns the value of the attributes property. The order of attribute nodes is stable but implementation dependent.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the base-uri property.
Returns the value of the base-uri property.
If the attribute has a parent, returns the value of the dm:base-uri of its parent; otherwise it returns the empty sequence.
Returns the empty sequence.
Returns the value of the base-uri property.
If the comment has a parent, returns the value of the dm:base-uri of its parent; otherwise, returns the empty sequence.
If the text node has a parent, returns the value of the dm:base-uri of its parent; otherwise, returns the empty sequence.
Returns the value of the children property.
Returns the value of the children property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the absolute URI of the resource from which the document node was constructed, or the empty sequence if no such absolute URI is available.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the is-id property.
Returns the value of the is-id property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the is-idrefs property.
Returns the value of the is-idrefs property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the namespaces property as a sequence of namespace nodes. The order of namespace nodes is stable but implementation dependent.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the nilled property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns “document
”.
Returns “element
”.
Returns “attribute
”.
Returns “namespace
”.
Returns “processing-instruction
”.
Returns “comment
”.
Returns “text
”.
Returns the empty sequence.
Returns the value of the node-name property.
Returns the value of the node-name property.
If the prefix is not empty, returns an xs:QName
with the value of the prefix property in the local-name and an empty namespace name, otherwise returns the empty sequence.
Returns an xs:QName
with the value of the target property in the local-name and an empty namespace URI and empty prefix.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the value of the parent property.
Returns the value of the parent property.
Returns the value of the parent property.
Returns the value of the parent property.
Returns the value of the parent property.
Returns the value of the parent property.
Returns the value of the string-value property.
Returns the value of the string-value property.
Returns the value of the string-value property.
Returns the value of the uri property.
Returns the value of the content property.
Returns the value of the content property.
Returns the value of the content property.
Returns the empty sequence.
Returns the value of the schema-type property.
Returns the value of the schema-type property.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns xs:untypedAtomic
.
Returns the value of the typed-value property.
Returns the value of the typed-value property.
Returns the value of the typed-value property.
Returns the value of the uri property as an xs:string
.
Returns the value of the content property as a xs:string
.
Returns the value of the content property as a xs:string
.
Returns the value of the content property as an xs:untypedAtomic
.
Returns the public identifier of the specified unparsed entity or the empty sequence if no such entity exists.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the system identifier of the specified unparsed entity or the empty sequence if no such entity exists.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
Returns the empty sequence.
This section summarizes data model construction from an Infoset for each kind of information item. General notes occur elsewhere.
The document information item is required. A document node is constructed for each document information item.
The following infoset properties are required: [children] and [base URI].
The following infoset properties are optional: [unparsed entities].
Document node properties are derived from the infoset as follows:
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, and comment found in the [children] property, a corresponding element, processing instruction, or comment node is constructed and that sequence of nodes is used as the value of the children property.
If present among the [children], the document type declaration information item is ignored.
If the [unparsed entities] property is present and is not the empty set, the values of the unparsed entity information items must be used to support the dm:unparsed-entity-system-id and dm:unparsed-entity-public-id accessors.
The internal structure of the values of the unparsed-entities property is implementation defined.
The concatenation of the string-values of all its text node descendants in document order. If the document has no such descendants, the zero-length string.
The dm:string-value of the node as an xs:untypedAtomic
value.
The document-uri property holds the absolute URI for the resource from which the document node was constructed, if one is available and can be made absolute. For example, if a collection of documents is returned by the fn:collection function, the document-uri property may serve to distinguish between them even though each has the same base-uri property.
If the document-uri is not the empty sequence, then the following constraint must hold: the node returned by evaluating fn:doc()
with the document-uri as its argument must return the document node that provided the value of the document-uri property.
In other words, for any document node $arg
, either fn:document-uri($arg)
must return the empty sequence or fn:doc(fn:document-uri($arg))
must return $arg
.
The element information items are required. An element node is constructed for each element information item.
The following infoset properties are required: [namespace name], [local name], [children], [attributes], [in-scope namespaces], [base URI], and [parent].
Element node properties are derived from the infoset as follows:
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
An xs:QName
constructed from the [prefix], [local name], and [namespace name] properties.
The node that corresponds to the value of the [parent] property or the empty sequence if there is no parent.
All element nodes constructed from an infoset have the type xs:untyped
.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, comment, and maximal sequence of adjacent character information items found in the [children] property, a corresponding element, processing instruction, comment, or text node is constructed and that sequence of nodes is used as the value of the children property.
Because the data model requires that all general entities be expanded, there will never be unexpanded entity reference information item children.
A set of attribute nodes constructed from the attribute information items appearing in the [attributes] property. This includes all of the “special” attributes (xml:lang
, xml:space
, xsi:type
, etc.) but does not include namespace declarations (because they are not attributes).
Default and fixed attributes provided by the DTD are added to the [attributes] and are therefore included in the data model attributes of an element.
A set of namespace nodes constructed from the namespace information items appearing in the [in-scope namespaces] property. Implementations that do not support namespace nodes may simply preserve the relevant bindings in this property.
Implementations may ignore namespace information items for namespaces which are not known to be used. A namespace is known to be used if:
It appears in the expanded QName of the node-name of the element.
It appears in the expanded QName of the node-name of any of the element’s attributes.
Note: applications may rely on namespaces that are not known to be used, for example when QNames are used in content and that content does not have a type of xs:QName
Such applications may have difficulty processing data models where some namespaces have been ignored.
All element nodes constructed from an infoset have a nilled property of “false ”.
The string-value is constructed from the character information item[children] of the element and all its descendants. The precise rules for selecting significant character information items and constructing characters from them is described in 5.7.3 Construction from an Infoset of 5.7 Text nodes.
This process is equivalent to concatenating the dm:string-values of all of the text node descendants of the resulting element node.
If the element has no such descendants, the string-value is the empty string.
The string-value as an xs:untypedAtomic
.
All element nodes constructed from an infoset have a is-id property of “false ”.
All element nodes constructed from an infoset have a is-idrefs property of “false ”.
The attribute information items are required. An attribute node is constructed for each attribute information item.
The following infoset properties are required: [namespace name], [local name], [normalized value], [attribute type], and [owner element].
Attribute node properties are derived from the infoset as follows:
An xs:QName
constructed from the [prefix], [local name], and [namespace name] properties.
The element node that corresponds to the value of the [owner element] property or the empty sequence if there is no owner.
The value xs:untypedAtomic
.
The [normalized value] of the attribute.
The attribute’s typed-value is its dm:string-value as an xs:untypedAtomic
.
If the attribute is named xml:id
and its [attribute type] property does not have the value ID
, then [xml:id] processing is performed. This will ensure that the value does have the type ID
and that it is properly normalized. If an error is encountered during xml:id
processing, an implementation may raise a dynamic error. The is-id property is always true
for attributes named xml:id
.
If the [attribute type] property has the value ID
, true
, otherwise false
.
If the [attribute type] property has the value IDREF
or IDREFS
, true
, otherwise false
.
The namespace information items are required.
The following infoset properties are required: [prefix], [namespace name].
Namespace node properties are derived from the infoset as follows:
The [prefix] property.
The [namespace name] property.
The element in whose [in-scope namespaces] property the namespace information item appears, if the implementation exposes any mechanism for accessing the dm:parent accessor of namespace nodes.
A processing instruction node is constructed for each processing instruction information item that is not ignored.
The following infoset properties are required: [target], [content], [base URI], and [parent].
Processing instruction node properties are derived from the infoset as follows:
The value of the [target] property.
The value of the [content] property.
The value of the [base URI] property, if available. Note that the base URI property, if available, is always an absolute URI (if an absolute URI can be computed) though it may contain Unicode characters that are not allowed in URIs. These characters, if they occur, are present in the base-uri property and will have to be encoded and escaped by the application to obtain a URI suitable for retrieval, if retrieval is required.
In practice a [base URI] is not always known. In this case the value of the base-uri property of the document node will be the empty sequence. This is not intrinsically an error, though it may cause some operations that depend on the base URI to fail.
The node corresponding to the value of the [parent] property.
There are no processing instruction nodes for processing instructions that are children of a document type declaration information item.
The comment information items are optional.
A comment node is constructed for each comment information item.
The following infoset properties are required: [content] and [parent].
Comment node properties are derived from the infoset as follows:
The value of the [content] property.
The node corresponding to the value of the [parent] property.
There are no comment nodes for comments that are children of a document type declaration information item.
The character information items are required. A text node is constructed for each maximal sequence of character information items in document order.
The following infoset properties are required: [character code] and [parent].
The following infoset properties are optional: [element content whitespace].
A sequence of character information items is maximal if it satisfies the following constraints:
All of the information items in the sequence have the same parent.
The sequence consists of adjacent character information items uninterrupted by other types of information item.
No other such sequence exists that contains any of the same character information items and is longer.
Text node properties are derived from the infoset as follows:
A string comprised of characters that correspond to the [character code] properties of each of the character information items.
If the resulting text node consists entirely of whitespace and the [element content whitespace] property of the character information items used to construct this node are true
, the content of the text node is the zero-length string. text nodes are allowed to be empty only if they have no parents; an empty text node will be discarded when its parent is constructed, if it has a parent.
The content of the text node is not necessarily normalized as described in the [Character Model]. It is the responsibility of data producers to provide normalized text, and the responsibility of applications to make sure that operations do not de-normalize text.
The node corresponding to the value of the [parent] property.
This section summarizes data model construction from a PSVI for each kind of information item. General notes occur elsewhere.
Construction from a PSVI is identical to construction from the Infoset.
The following element node properties are affected by PSVI properties.
The schema-type is determined as described in 3.3.1.1 Element and Attribute Node Types.
The sequence of nodes constructed from the information items found in the [children] property.
For each element, processing instruction, comment, and maximal sequence of adjacent character information items found in the [children] property, a corresponding element, processing instruction, comment, or text node is constructed and that sequence of nodes is used as the value of the children property.
For elements with schema simple types, or complex types with simple content, if the [schema normalized value] PSVI property exists, the processor may use a sequence of nodes containing the processing instruction and comment nodes corresponding to the processing instruction and comment information items found in the [children] property, plus an optional single text node whose string value is the [schema normalized value] for the children property. If the [schema normalized value] is the empty string, the text node must not be present, otherwise it must be present. The relative order of Processing Instruction and comment nodes must be preserved, but the position of the text node, if it is present, among them is implementation defined.
The effect of the above rules is that where a fixed or default value for an element is defined in the schema, and the element takes this default value, a text node will be created to contain the value, even though there are no character information items representing the value in the PSVI. The position of this text node relative to any comment or processing instruction children is implementation-dependent.
[Schema Part 1] also permits an element with mixed content to take a default or fixed value (which will always be a simple value), but it is unclear how such a defaulted value is represented in the PSVI. Implementations therefore may represent such a default value by creating a text node, but are not required to do so.
Note:
Section 3.3.1 in [Schema 1.1 Part 1] clarifies the PSVI contributions of element default or fixed values in mixed content: additional character information items are not added to the PSVI.
Because the data model requires that all general entities be expanded, there will never be unexpanded entity reference information item children.
A set of attribute nodes constructed from the attribute information items appearing in the [attributes] property. This includes all of the “special” attributes (xml:lang
, xml:space
, xsi:type
, etc.) but does not include namespace declarations (because they are not attributes).
Default and fixed attributes provided by XML Schema processing are added to the [attributes] and are therefore included in the data model attributes of an element.
A set of namespace nodes constructed from the namespace information items appearing in the [in-scope namespaces] property. Implementations that do not support namespace nodes may simply preserve the relevant bindings in this property.
Implementations may ignore namespace information items for namespaces which are not known to be used. A namespace is known to be used if:
It appears in the expanded QName of the node-name of the element.
It appears in the expanded QName of the node-name of any of the element’s attributes.
It appears in the expanded QName of any values of type xs:QName
that appear among the element’s children or the typed values of its attributes.
Note: applications may rely on namespaces that are not known to be used, for example when QNames are used in content and that content does not have a type of xs:QName
Such applications may have difficulty processing data models where some namespaces have been ignored.
If the [validity] property exists on an information item and is “valid ” then if the [nil] property exists and is true, then the nilled property is “true ”. In all other cases, including all cases where schema validity assessment was not attempted or did not succeed, the nilled property is “false ”.
The string-value is calculated as follows:
If the element is empty: its string value is the zero length string.
If the element has a type of xs:untyped
, a complex type with element-only content, or a complex type with mixed content: its string-value is the concatenation of the string-values of all its text node descendants in document order.
If the element has a simple type or a complex type with simple content: its string-value is the [schema normalized value] of the node.
If an implementation stores only the typed value of an element, it may use any valid lexical representation of the typed value for the string-value property.
The typed-value is calculated as follows:
If the element is of type xs:untyped
, its typed-value is its dm:string-value as an xs:untypedAtomic
.
If the element has a complex type with empty content, its typed-value is the empty sequence.
If the element has a simple type or a complex type with simple content: its typed value is computed as described in 3.3.1.2 Typed Value Determination. The result is a sequence of zero or more atomic items. The relationship between the type-name, typed-value, and string-value of an element node is consistent with XML Schema validation.
Note that in the case of dates and times, the timezone is preserved as described in 3.3.2 Dates and Times, and in the case of xs:QName
s and xs:NOTATION
s, the prefix is preserved as described in 3.3.3 QNames and NOTATIONS.
If the element has a complex type with mixed content (including xs:anyType
), its typed-value is its dm:string-value as an xs:untypedAtomic
.
Otherwise, the element must be a complex type with element-only content. The typed-value of such an element is absent. Attempting to access this property with the dm:typed-value accessor always raises an error.
If the element has a complex type with element-only content, the is-id property is false
. Otherwise, if the typed-value of the element consists of exactly one atomic item and that value is of type xs:ID
, or a type derived from xs:ID
, the is-id property is true
, otherwise it is false
.
Note:
This means that in the case of a type constructed by list from xs:ID
, the ID is recognized provided that the list is of length one. A type constructed as a union involving xs:ID
is recognized provided the actual value is of type xs:ID
.
Note:
The element that is marked with the is-id property, and which will therefore be retrieved by the fn:id function, is the node whose typed value contains the xs:ID
value. This node is a child of the element node that, according to XML Schema, is uniquely identified by this ID.
If the element has a complex type with element-only content, the is-idrefs property is false
. Otherwise, if any of the atomic items in the typed-value of the element is of type xs:IDREF
or xs:IDREFS
, or a type derived from one of those types, the is-idrefs property is true
, otherwise it is false
.
All other properties have values that are consistent with construction from an infoset.
The following attribute node properties are affected by PSVI properties.
The [schema normalized value] PSVI property if that exists.
Otherwise, the [normalized value] property.
If an implementation stores only the typed value of an attribute, it may use any valid lexical representation of the typed value for the string-value property.
The schema-type is determined as described in 3.3.1.1 Element and Attribute Node Types.
The typed-value is calculated as follows:
If the attribute is of type xs:untypedAtomic
: its typed-value is its dm:string-value as an xs:untypedAtomic
.
Otherwise, a sequence of zero or more atomic items as described in 3.3.1.2 Typed Value Determination. The relationship between the type-name, typed-value, and string-value of an attribute node is consistent with XML Schema validation.
If the attribute is named xml:id
and its [attribute type] property does not have the value xs:ID
or a type derived from xs:ID
, then [xml:id] processing is performed. This will ensure that the value does have the type xs:ID
and that it is properly normalized. If an error is encountered during xml:id
processing, an implementation may raise a dynamic error. The is-id property is always true for attributes named xml:id
.
Otherwise, if the typed-value of the attribute consists of exactly one atomic item and that value is of type xs:ID
, or a type derived from xs:ID
, the is-id property is true
, otherwise it is false
.
Note:
This means that in the case of a type constructed by list from xs:ID
, the ID is recognized provided that the list is of length one. A type constructed as a union involving xs:ID
is recognized provided the actual value is of type xs:ID
.
If any of the atomic items in the typed-value of the attribute is of type xs:IDREF
or xs:IDREFS
, or a type derived from one of those types, the is-idrefs property is true
, otherwise it is false
.
Note:
This rule means that a node whose type is constructed by list with an item type of xs:IDREF
(or a type derived from xs:IDREF
) may have the is-idrefs property, whether or not the list type is named xs:IDREFS
or is derived from xs:IDREFS
. Because union types are allowed, it also means that an element or attribute with the is-idrefs property can contain atomic items of type xs:IDREF
alongside values of other types. A node has the is-idrefs property only if the typed value contains at least one atomic item that is an instance of xs:IDREF
; it is not sufficient that the type annotation permits such values.
All other properties have values that are consistent with construction from an infoset.
Note: attributes from the XML Schema instance namespace, “http://www.w3.org/2001/XMLSchema-instance
” (xsi:schemaLocation
, xsi:type
, etc.), appear as ordinary attributes in the data model.
Construction from a PSVI is identical to construction from the Infoset.
Construction from a PSVI is identical to construction from the Infoset.
Construction from a PSVI is identical to construction from the Infoset.
For text nodes constructed from the [schema normalized value] of elements, content contains the value of the [schema normalized value].
Otherwise, construction from a PSVI is the same as construction from the Infoset except for the content property. When constructing the content property, [element content whitespace] is not used to test if whitespace is collapsed. Instead, if the resulting text node consists entirely of whitespace and the character information items used to construct this node have a parent and that parent is an element and its {content type} is not “mixed
”, then the content of the text node is the zero-length string.
text nodes are allowed to be empty only if they have no parents; an empty text node will be discarded when its parent is constructed, if it has a parent.
This section summarizes the infoset mapping for each kind of node.
A document node maps to a document information item. The mapping fails and produces no value if the document node contains text node children that do not consist entirely of white space or if the document node contains more than one element node child.
The following properties are specified by this mapping:
A list of information items obtained by processing each of the dm:children in order and mapping each to the appropriate information item(s).
The element information item that is among the [children].
An unordered set of unparsed entity information items constructed from the unparsed-entities.
Each unparsed entity maps to an unparsed entity information item. The following properties are specified by this mapping:
The name of the entity.
The system identifier of the entity.
The public identifier of the entity.
Implementation defined. In many cases, the document-uri is the correct answer and implementations must use this value if they have no better information. Implementations that keep track of the original [declaration base URI] for entities should use that value.
The following properties of the unparsed entity information item have no value: [notation name], [notation].
The following properties of the document information item have no value: [notations][character encoding scheme][standalone][version][all declarations processed].
An element node maps to an element information item.
The following properties are specified by this mapping:
The namespace name of the value of dm:node-name.
The local part of the value of dm:node-name.
The prefix associated with the value of dm:node-name.
A list of information items obtained by processing each of the dm:children in order and mapping each to the appropriate information item(s).
An unordered set of information items obtained by processing each of the dm:attributes and mapping each to the appropriate information item(s).
An unordered set of namespace information items constructed from the namespaces.
Each in-scope namespace maps to a namespace information item. The following properties are specified by this mapping:
The prefix associated with the namespace.
The URI associated with the namespace.
The value of dm:base-uri.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
The following property has no value: [namespace attributes].
An attribute node maps to an attribute information item.
The following properties are specified by this mapping:
The namespace name of the value of dm:node-name.
The local part of the value of dm:node-name.
The prefix associated with the value of dm:node-name.
The value of dm:string-value.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
The following properties have no value: [specified][attribute type][references].
A namespace node maps to a namespace information item.
The following properties are specified by this mapping:
The prefix associated with the namespace.
The value of dm:string-value.
An processing instruction node maps to a processing instruction information item.
The following properties are specified by this mapping:
The local part of the value of dm:node-name.
The value of dm:string-value.
The value of dm:base-uri.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
No value.
A comment node maps to a comment information item.
The following properties are specified by this mapping:
The value of the dm:string-value.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
A text node maps to a sequence of character information items.
Each character of the dm:string-value of the node is converted into a character information item as specified by this mapping:
The Unicode code point value of the character.
If this node is the root of the infoset mapping operation, unknown.
If this node has a parent, the information item that corresponds to the node returned by dm:parent.
Otherwise no value.
Unknown.
This sequence of characters constitutes the infoset mapping.