XPath, XQuery et XSLTFonctionsManuel de référence des fonctions
Le manuel de référence suivant définit les fonctions dans XPath 2.0, XQuery 1.0 et XSLT 2.0.
Manuel de référence des fonctions
Le préfixe par défaut de l'espace de noms des fonctions est fn:
L'URI de l'espace de noms des fonctions est : http://www.w3.org/2005/xpath-functions
Fonctions d'accès
| Name | Description |
|---|---|
| fn:node-name(node) | Renvoie le nom du nœud passé en argument. |
| fn:nilled(node) | Renvoie une valeur booléenne indiquant si le nœud passé en argument est rejeté. |
| fn:data(item.item,...) | Accepte une séquence d'éléments et renvoie une séquence de valeurs atomiques. |
|
Renvoie la valeur de la propriété base-uri du nœud courant ou du nœud spécifié. |
| fn:document-uri(node) | Renvoie la valeur de la propriété document-uri du nœud spécifié. |
Fonctions d'erreur et de traçage
| Name | Description |
|---|---|
|
Exemple : error(fn:QName('http://example.com/test', 'err:toohigh'), 'Error: Price is too high') Résultat : Renvoie http://example.com/test#toohigh et la chaîne "Error: Price is too high" à l'environnement de traitement externe. |
| fn:trace(value,label) | Utilisé pour le débogage des requêtes. |
Fonctions numériques
| Name | Description |
|---|---|
| fn:number(arg) |
Renvoie la valeur numérique de l'argument. L'argument peut être une valeur booléenne, une chaîne de caractères ou un ensemble de nœuds. Exemple : number('100') Résultat : 100 |
| fn:abs(num) |
Renvoie la valeur absolue de l'argument. Exemple : abs(3.14) Résultat : 3.14 Exemple : abs(-3.14) Résultat : 3.14 |
| fn:ceiling(num) |
Renvoie le plus petit entier supérieur à l'argument num. Exemple : ceiling(3.14) Résultat : 4 |
| fn:floor(num) |
Renvoie le plus grand entier inférieur ou égal à l'argument num. Exemple : floor(3.14) Résultat : 3 |
| fn:round(num) |
Arrondit l'argument num à l'entier le plus proche. Exemple : round(3.14) Résultat : 3 |
| fn:round-half-to-even() |
Exemple : round-half-to-even(0.5) Résultat : 0 Exemple : round-half-to-even(1.5) Résultat : 2 Exemple : round-half-to-even(2.5) Résultat : 2 |
Fonctions de chaînes
| Name | Description |
|---|---|
| fn:string(arg) |
Renvoie la valeur de chaîne de l'argument. L'argument peut être un nombre, une valeur logique ou un ensemble de nœuds. Exemple : string(314) Résultat : "314" |
| fn:codepoints-to-string(int,int,...) |
Renvoie une chaîne à partir d'une séquence de points de code. Exemple : codepoints-to-string(84, 104, 233, 114, 232, 115, 101) Résultat : 'Thérèse' |
| fn:string-to-codepoints(string) |
Renvoie une séquence de points de code à partir d'une chaîne. Exemple : string-to-codepoints("Thérèse") Résultat : 84, 104, 233, 114, 232, 115, 101 |
| fn:codepoint-equal(comp1,comp2) | Selon la collation des points de code Unicode, renvoie true si la valeur de comp1 est égale à la valeur de comp2. (http://www.w3.org/2005/02/xpath-functions/collation/codepoint), sinon renvoie false. |
|
Renvoie -1 si comp1 est inférieur à comp2. Renvoie 0 si comp1 est égal à comp2. Renvoie 1 si comp1 est supérieur à comp2. (Selon les règles de collation utilisées.) Exemple : compare('ghi', 'ghi') Résultat : 0 |
| fn:concat(string,string,...) |
Renvoie la concaténation de chaînes. Exemple : concat('XPath ','is ','FUN!') Résultat : 'XPath is FUN!' |
| fn:string-join((string,string,...),sep) |
Renvoie la chaîne concaténée des arguments de chaîne, en utilisant l'argument sep comme séparateur. Exemple : string-join(('We', 'are', 'having', 'fun!'), ' ') Résultat : ' We are having fun! ' Exemple : string-join(('We', 'are', 'having', 'fun!')) Résultat : 'Wearehavingfun!' Exemple : string-join((), 'sep') Résultat : '' |
|
Renvoie la sous-chaîne de la longueur spécifiée à partir de la position start. L'indice du premier caractère est 1. Si l'argument len est omis, renvoie la sous-chaîne de la position start jusqu'à la fin de la chaîne. Exemple : substring('Beatles',1,4) Résultat : 'Beat' Exemple : substring('Beatles',2) Résultat : 'eatles' |
|
Renvoie la longueur de la chaîne spécifiée. Si aucun argument de type chaîne n'est fourni, renvoie la longueur de la valeur de chaîne du nœud courant. Exemple : string-length('Beatles') Résultat : 7 |
|
Supprime les espaces blancs au début et à la fin de la chaîne spécifiée, remplace toutes les séquences d'espaces blancs internes par un seul espace, et renvoie le résultat. Si aucun argument de type chaîne n'est fourni, le nœud courant est traité. Exemple : normalize-space(' The XML ') Résultat : 'The XML' |
| fn:normalize-unicode() | Effectue une normalisation Unicode. |
| fn:upper-case(string) |
Convertit l'argument chaîne en majuscules. Exemple : upper-case('The XML') Résultat : 'THE XML' |
| fn:lower-case(string) |
Convertit l'argument chaîne en minuscules. Exemple : lower-case('The XML') Résultat : 'the xml' |
| fn:translate(string1,string2,string3) |
Remplace string2 par string3 dans string1. Exemple : translate('12:30','30','45') Résultat : '12:45' Exemple : translate('12:30','03','54') Résultat : '12:45' Exemple : translate('12:30','0123','abcd') Résultat : 'bc:da' |
| fn:escape-uri(stringURI,esc-res) |
Exemple : escape-uri("http://example.com/test#car", true()) Résultat : "http%3A%2F%2Fexample.com%2Ftest#car" Exemple : escape-uri("http://example.com/test#car", false()) Résultat : "http://example.com/test#car" Exemple : escape-uri ("http://example.com/~bébé", false()) Résultat : "http://example.com/~b%C3%A9b%C3%A9" |
| fn:contains(string1,string2) |
Renvoie true si string1 contient string2, sinon renvoie false. Exemple : contains('XML','XM') Résultat : true |
| fn:starts-with(string1,string2) |
Renvoie true si string1 commence par string2, sinon renvoie false. Exemple : starts-with('XML','X') Résultat : true |
| fn:ends-with(string1,string2) |
Renvoie true si string1 se termine par string2, sinon renvoie false. Exemple : ends-with('XML','X') Résultat : false |
| fn:substring-before(string1,string2) |
Renvoie la sous-chaîne précédant l'apparition de string2 dans string1. Exemple : substring-before('12/10','/') Résultat : '12' |
| fn:substring-after(string1,string2) |
Renvoie la sous-chaîne après l'apparition de string2 dans string1. Exemple : substring-after('12/10','/') Résultat : '10' |
| fn:matches(string,pattern) |
Renvoie true si l'argument de chaîne correspond au modèle spécifié, sinon renvoie false. Exemple : matches("Merano", "ran") Résultat : true |
| fn:replace(string,pattern,replace) |
Remplace le modèle spécifié par le paramètre replace et renvoie le résultat. Exemple : replace("Bella Italia", "l", "*") Résultat : 'Be**a Ita*ia' Exemple : replace("Bella Italia", "l", "") Résultat : 'Bea Itaia' |
| fn:tokenize(string,pattern) |
Exemple : tokenize("XPath is fun", "\s+") Résultat : ("XPath", "is", "fun") |
Fonctions pour anyURI
| Name | Description |
|---|---|
| fn:resolve-uri(relative,base) |
Fonctions sur les valeurs booléennes
| Name | Description |
|---|---|
| fn:boolean(arg) | Renvoie la valeur booléenne d'un nombre, d'une chaîne ou d'un ensemble de nœuds. |
| fn:not(arg) |
Utilise d'abord la fonction boolean() pour réduire l'argument à une valeur booléenne. Si cette valeur booléenne est false, renvoie true ; si cette valeur booléenne est true, renvoie false. Exemple : not(true()) Résultat : false |
| fn:true() |
Renvoie la valeur booléenne true. Exemple : true() Résultat : true |
| fn:false() |
Renvoie la valeur booléenne false. Exemple : false() Résultat : false |
Fonctions liées aux durées, aux dates et aux heures
Fonctions d'extraction de composants pour les dates, les heures et les durées
| Name | Description |
|---|---|
| fn:dateTime(date,time) | Convertit l'argument en une date et une heure. |
| fn:years-from-duration(datetimedur) | Renvoie l'entier de la partie année de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:months-from-duration(datetimedur) | Renvoie l'entier de la partie mois de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:days-from-duration(datetimedur) | Renvoie l'entier de la partie jour de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:hours-from-duration(datetimedur) | Renvoie l'entier de la partie heures de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:minutes-from-duration(datetimedur) | Renvoie l'entier de la partie minutes de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:seconds-from-duration(datetimedur) | Renvoie le nombre décimal de la partie minutes de la valeur de l'argument, exprimée en représentation lexicale standard. |
| fn:year-from-dateTime(datetime) |
Renvoie l'entier de la partie année de la valeur locale de l'argument. Exemple : year-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Résultat : 2005 |
| fn:month-from-dateTime(datetime) |
Renvoie l'entier de la partie mois de la valeur locale de l'argument. Exemple : month-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Résultat : 01 |
| fn:day-from-dateTime(datetime) |
Renvoie l'entier de la partie jour de la valeur locale de l'argument. Exemple : day-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Résultat : 10 |
| fn:hours-from-dateTime(datetime) |
Renvoie l'entier de la partie heures de la valeur locale de l'argument. Exemple : hours-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Résultat : 12 |
| fn:minutes-from-dateTime(datetime) |
Renvoie l'entier de la partie minutes de la valeur locale de l'argument. Exemple : minutes-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Résultat : 30 |
| fn:seconds-from-dateTime(datetime) |
Renvoie le nombre décimal de la partie secondes de la valeur locale de l'argument. Exemple : seconds-from-dateTime(xs:dateTime("2005-01-10T12:30:00-04:10")) Résultat : 0 |
| fn:timezone-from-dateTime(datetime) | Renvoie la partie fuseau horaire de l'argument, si présente. |
| fn:year-from-date(date) |
Renvoie l'entier représentant l'année dans la valeur locale de l'argument. Exemple : year-from-date(xs:date("2005-04-23")) Résultat : 2005 |
| fn:month-from-date(date) |
Renvoie l'entier représentant le mois dans la valeur locale de l'argument. Exemple : month-from-date(xs:date("2005-04-23")) Résultat : 4 |
| fn:day-from-date(date) |
Renvoie l'entier représentant le jour dans la valeur locale de l'argument. Exemple : day-from-date(xs:date("2005-04-23")) Résultat : 23 |
| fn:timezone-from-date(date) | Renvoie la partie fuseau horaire de l'argument, si présente. |
| fn:hours-from-time(time) |
Renvoie l'entier représentant la partie heures dans la valeur locale de l'argument. Exemple : hours-from-time(xs:time("10:22:00")) Résultat : 10 |
| fn:minutes-from-time(time) |
Renvoie l'entier représentant la partie minutes dans la valeur locale de l'argument. Exemple : minutes-from-time(xs:time("10:22:00")) Résultat : 22 |
| fn:seconds-from-time(time) |
Renvoie l'entier représentant la partie secondes dans la valeur locale de l'argument. Exemple : seconds-from-time(xs:time("10:22:00")) Résultat : 0 |
| fn:timezone-from-time(time) | Renvoie la partie fuseau horaire de l'argument, si présente. |
| fn:adjust-dateTime-to-timezone(datetime,timezone) | Si l'argument timezone est vide, renvoie le dateTime sans fuseau horaire. Sinon, renvoie le dateTime avec fuseau horaire. |
| fn:adjust-date-to-timezone(date,timezone) | Si l'argument timezone est vide, renvoie la date sans timezone. Sinon, renvoie la date avec timezone. |
| fn:adjust-time-to-timezone(time,timezone) | Si l'argument timezone est vide, renvoie l'heure sans timezone. Sinon, renvoie l'heure avec timezone. |
Fonctions liées aux QNames
| Name | Description |
|---|---|
| fn:QName() | |
| fn:local-name-from-QName() | |
| fn:namespace-uri-from-QName() | |
| fn:namespace-uri-for-prefix() | |
| fn:in-scope-prefixes() | |
| fn:resolve-QName() |
Fonctions sur les nœuds
| Name | Description |
|---|---|
|
Renvoie le nom du nœud courant ou du premier nœud de l'ensemble de nœuds spécifié. |
|
Renvoie le nom du nœud courant ou du premier nœud de l'ensemble de nœuds spécifié - sans préfixe d'espace de noms. |
|
Renvoie l'URI d'espace de noms du nœud courant ou du premier nœud de l'ensemble de nœuds spécifié. |
| fn:lang(lang) |
Renvoie vrai si la langue du nœud courant correspond à la langue spécifiée. Exemple : Lang("en") est vrai pour <p xml:lang="en">...</p> Exemple : Lang("de") est faux pour <p xml:lang="en">...</p> |
|
Renvoie le nœud racine de l'arbre auquel appartient le nœud actuel ou le nœud spécifié. Généralement, le nœud document. |
Fonctions liées aux séquences
Fonctions génériques
| Name | Description |
|---|---|
| fn:index-of((item,item,...),searchitem) |
Renvoie la position dans la séquence des éléments égaux au paramètre searchitem. Exemple : index-of ((15, 40, 25, 40, 10), 40) Résultat : (2, 4) Exemple : index-of (("a", "dog", "and", "a", "duck"), "a") Résultat (1, 4) Exemple : index-of ((15, 40, 25, 40, 10), 18) Résultat : () |
| fn:remove((item,item,...),position) |
Retourne une nouvelle séquence construite à partir du paramètre item, en supprimant l'élément spécifié par le paramètre position. Exemple : remove(("ab", "cd", "ef"), 0) Résultat : ("ab", "cd", "ef") Exemple : remove(("ab", "cd", "ef"), 1) Résultat : ("cd", "ef") Exemple : remove(("ab", "cd", "ef"), 4) Résultat : ("ab", "cd", "ef") |
| fn:empty(item,item,...) |
Retourne true si la valeur de l'argument est une séquence vide, sinon retourne false. Exemple : empty(remove(("ab", "cd"), 1)) Résultat : false |
| fn:exists(item,item,...) |
Renvoie true si la valeur de l'argument n'est pas une séquence vide, sinon renvoie false. Exemple : exists(remove(("ab"), 1)) Résultat : false |
| fn:distinct-values((item,item,...),collation) |
Renvoie les valeurs distinctes uniques. Exemple : distinct-values((1, 2, 3, 1, 2)) Résultat : (1, 2, 3) |
| fn:insert-before((item,item,...),pos,inserts) |
Renvoie une nouvelle séquence construite à partir du paramètre item - insère également la valeur du paramètre inserts à la position spécifiée par le paramètre pos. Exemple : insert-before(("ab", "cd"), 0, "gh") Résultat : ("gh", "ab", "cd") Exemple : insert-before(("ab", "cd"), 1, "gh") Résultat : ("gh", "ab", "cd") Exemple : insert-before(("ab", "cd"), 2, "gh") Résultat : ("ab", "gh", "cd") Exemple : insert-before(("ab", "cd"), 5, "gh") Résultat : ("ab", "cd", "gh") |
| fn:reverse((item,item,...)) |
Renvoie les éléments dans l'ordre inverse. Exemple : reverse(("ab", "cd", "ef")) Résultat : ("ef", "cd", "ab") Exemple : reverse(("ab")) Résultat : ("ab") |
| fn:subsequence((item,item,...),start,len) |
Renvoie la séquence d'éléments commençant à la position spécifiée par le paramètre start, avec la longueur spécifiée par le paramètre len. Le premier élément a la position 1. Exemple : subsequence(($item1, $item2, $item3,...), 3) Résultat : ($item3, ...) Exemple : subsequence(($item1, $item2, $item3, ...), 2, 2) Résultat : ($item2, $item3) |
| fn:unordered((item,item,...)) | Renvoie les éléments dans un ordre dépendant de l'implémentation. |
Fonctions pour tester la capacité d'une séquence
| Name | Description |
|---|---|
| fn:zero-or-one(item,item,...) | Si l'argument contient zéro ou un élément, renvoie l'argument ; sinon, génère une erreur. |
| fn:one-or-more(item,item,...) | Si l'argument contient un ou plusieurs éléments, renvoie l'argument ; sinon, génère une erreur. |
| fn:exactly-one(item,item,...) | Si l'argument contient exactement un élément, renvoie l'argument ; sinon, génère une erreur. |
Égalité, Union, Intersection et Except
| Name | Description |
|---|---|
| fn:deep-equal(param1,param2,collation) | Renvoie true si param1 et param2 sont égaux l'un à l'autre (deep-equal), sinon renvoie false. |
Fonctions d'agrégation
| Name | Description |
|---|---|
| fn:count((item,item,...)) | Renvoie le nombre de nœuds. |
| fn:avg((arg,arg,...)) | Renvoie la moyenne des valeurs des arguments. Exemple : avg((1,2,3)) Résultat : 2 |
| fn:max((arg,arg,...)) | Renvoie l'argument qui est supérieur à tous les autres arguments. Exemple : max((1,2,3)) Résultat : 3 Exemple : max(('a', 'k')) Résultat : 'k' |
| fn:min((arg,arg,...)) | Renvoie l'argument qui est inférieur à tous les autres arguments. Exemple : min((1,2,3)) Résultat : 1 Exemple : min(('a', 'k')) Résultat : 'a' |
| fn:sum(arg,arg,...) | Retourne la somme des valeurs numériques de chaque nœud dans l'ensemble de nœuds spécifié. |
Fonctions de génération de séquences
| Name | Description |
|---|---|
| fn:id((string,string,...),node) | Retourne une séquence de nœuds d'élément ayant une valeur ID égale à la valeur d'une ou plusieurs des valeurs spécifiées dans l'argument string |
| fn:idref((string,string,...),node) | Retourne une séquence de nœuds d'élément ou d'attribut ayant une valeur IDREF égale à la valeur d'une ou plusieurs des valeurs spécifiées dans l'argument string |
| fn:doc(URI) | |
| fn:doc-available(URI) | Retourne true si la fonction doc() retourne un nœud de document, sinon retourne false. |
|
Fonctions de contexte
| Name | Description |
|---|---|
| fn:position() |
Renvoie la position d'index du nœud en cours de traitement. Exemple : //book[position()<=3] Résultat : sélectionne les trois premiers éléments book |
| fn:last() |
Renvoie le nombre d'éléments dans la liste des nœuds en cours de traitement. Exemple : //book[last()] Résultat : sélectionne le dernier élément book |
| fn:current-dateTime() | Renvoie le dateTime actuel (avec fuseau horaire). |
| fn:current-date() | Renvoie la date actuelle (avec fuseau horaire). |
| fn:current-time() | Renvoie l'heure actuelle (avec fuseau horaire). |
| fn:implicit-timezone() | Renvoie la valeur du fuseau horaire implicite. |
| fn:default-collation() | Renvoie la valeur de la collation par défaut. |
| fn:static-base-uri() | Renvoie la valeur de l'URI de base. |