XPath, XQuery und XSLTFunktionenFunktionsreferenzhandbuch
Das folgende Referenzhandbuch definiert die Funktionen in XPath 2.0, XQuery 1.0 und XSLT 2.0.
Funktionsreferenzhandbuch
Das Standardpräfix für den Funktions-Namespace ist fn:
Die URI des Funktions-Namespace ist: http://www.w3.org/2005/xpath-functions
Zugriffsfunktionen
| Name | Beschreibung |
|---|---|
| fn:node-name(node) | Gibt den Knotennamen des Argumentknotens zurück. |
| fn:nilled(node) | Gibt einen booleschen Wert zurück, der angibt, ob der Argumentknoten abgelehnt wird. |
| fn:data(item.item,...) | Akzeptiert eine Sequenz von Elementen und gibt eine Sequenz atomarer Werte zurück. |
|
Gibt den Wert der base-uri-Eigenschaft des aktuellen Knotens oder des angegebenen Knotens zurück. |
| fn:document-uri(node) | Gibt den Wert der document-uri-Eigenschaft des angegebenen Knotens zurück. |
Fehler- und Tracing-Funktionen
| Name | Beschreibung |
|---|---|
|
Beispiel: error(fn:QName('http://example.com/test', 'err:toohigh'), 'Error: Price is too high') Ergebnis: Gibt http://example.com/test#toohigh und die Zeichenkette "Error: Price is too high" an die externe Verarbeitungsumgebung zurück. |
| fn:trace(value,label) | Wird zum Debuggen von Abfragen verwendet. |
Numerische Funktionen
| Name | Beschreibung |
|---|---|
| fn:number(arg) |
Gibt den numerischen Wert des Arguments zurück. Das Argument kann ein boolescher Wert, eine Zeichenkette oder eine Knotenmenge sein. Beispiel: number('100') Ergebnis: 100 |
| fn:abs(num) |
Gibt den Absolutwert des Arguments zurück. Beispiel: abs(3.14) Ergebnis: 3.14 Beispiel: abs(-3.14) Ergebnis: 3.14 |
| fn:ceiling(num) |
Gibt die kleinste ganze Zahl zurück, die größer als das Argument num ist. Beispiel: ceiling(3.14) Ergebnis: 4 |
| fn:floor(num) |
Gibt die größte ganze Zahl zurück, die nicht größer als das Argument num ist. Beispiel: floor(3.14) Ergebnis: 3 |
| fn:round(num) |
Rundet das Argument num auf die nächstgelegene ganze Zahl. Beispiel: round(3.14) Ergebnis: 3 |
| fn:round-half-to-even() |
Beispiel: round-half-to-even(0.5) Ergebnis: 0 Beispiel: round-half-to-even(1.5) Ergebnis: 2 Beispiel: round-half-to-even(2.5) Ergebnis: 2 |
String-Funktionen
| Name | Beschreibung |
|---|---|
| fn:string(arg) |
Gibt den Zeichenkettenwert des Arguments zurück. Das Argument kann eine Zahl, ein logischer Wert oder eine Knotenmenge sein. Beispiel: string(314) Ergebnis: "314" |
| fn:codepoints-to-string(int,int,...) |
Gibt eine Zeichenkette auf Basis einer Folge von Codepunkten zurück. Beispiel: codepoints-to-string(84, 104, 233, 114, 232, 115, 101) Ergebnis: 'Thérèse' |
| fn:string-to-codepoints(string) |
Gibt eine Folge von Codepunkten auf Basis einer Zeichenkette zurück. Beispiel: string-to-codepoints("Thérèse") Ergebnis: 84, 104, 233, 114, 232, 115, 101 |
| fn:codepoint-equal(comp1,comp2) | Gemäß der Unicode-Codepoint-Kollation gibt true zurück, wenn der Wert von comp1 gleich dem Wert von comp2 ist. (http://www.w3.org/2005/02/xpath-functions/collation/codepoint), andernfalls gibt false zurück. |
|
Gibt -1 zurück, wenn comp1 kleiner als comp2 ist. Gibt 0 zurück, wenn comp1 gleich comp2 ist. Gibt 1 zurück, wenn comp1 größer als comp2 ist. (Gemäß den verwendeten Kollationsregeln.) Beispiel: compare('ghi', 'ghi') Ergebnis: 0 |
| fn:concat(string,string,...) |
Gibt die Verkettung von Zeichenketten zurück. Beispiel: concat('XPath ','is ','FUN!') Ergebnis: 'XPath is FUN!' |
| fn:string-join((string,string,...),sep) |
Gibt die verkettete Zeichenkette der Zeichenkettenargumente zurück und verwendet das Argument sep als Trennzeichen. Beispiel: string-join(('We', 'are', 'having', 'fun!'), ' ') Ergebnis: ' We are having fun! ' Beispiel: string-join(('We', 'are', 'having', 'fun!')) Ergebnis: 'Wearehavingfun!' Beispiel: string-join((), 'sep') Ergebnis: '' |
|
Gibt die Teilzeichenkette der angegebenen Länge ab der Position start zurück. Der Index des ersten Zeichens ist 1. Wenn das Argument len weggelassen wird, wird die Teilzeichenkette von der Position start bis zum Ende der Zeichenkette zurückgegeben. Beispiel: substring('Beatles',1,4) Ergebnis: 'Beat' Beispiel: substring('Beatles',2) Ergebnis: 'eatles' |
|
Gibt die Länge der angegebenen Zeichenkette zurück. Wenn kein Zeichenkettenargument angegeben ist, wird die Länge des Zeichenkettenwerts des aktuellen Knotens zurückgegeben. Beispiel: string-length('Beatles') Ergebnis: 7 |
|
Entfernt Leerraum am Anfang und Ende der angegebenen Zeichenkette, ersetzt alle internen Leerraumsequenzen durch eine einzige und gibt das Ergebnis zurück. Wenn kein Zeichenkettenargument angegeben ist, wird der aktuelle Knoten verarbeitet. Beispiel: normalize-space(' The XML ') Ergebnis: 'The XML' |
| fn:normalize-unicode() | Führt eine Unicode-Normalisierung durch. |
| fn:upper-case(string) |
Wandelt das Zeichenkettenargument in Großbuchstaben um. Beispiel: upper-case('The XML') Ergebnis: 'THE XML' |
| fn:lower-case(string) |
Wandelt das Zeichenkettenargument in Kleinbuchstaben um. Beispiel: lower-case('The XML') Ergebnis: 'the xml' |
| fn:translate(string1,string2,string3) |
Ersetzt string2 in string1 durch string3. Beispiel: translate('12:30','30','45') Ergebnis: '12:45' Beispiel: translate('12:30','03','54') Ergebnis: '12:45' Beispiel: translate('12:30','0123','abcd') Ergebnis: 'bc:da' |
| fn:escape-uri(stringURI,esc-res) |
Beispiel: escape-uri("http://example.com/test#car", true()) Ergebnis: "http%3A%2F%2Fexample.com%2Ftest#car" Beispiel: escape-uri("http://example.com/test#car", false()) Ergebnis: "http://example.com/test#car" Beispiel: escape-uri ("http://example.com/~bébé", false()) Ergebnis: "http://example.com/~b%C3%A9b%C3%A9" |
| fn:contains(string1,string2) |
Gibt true zurück, wenn string1 string2 enthält, andernfalls false. Beispiel: contains('XML','XM') Ergebnis: true |
| fn:starts-with(string1,string2) |
Gibt true zurück, wenn string1 mit string2 beginnt, andernfalls false. Beispiel: starts-with('XML','X') Ergebnis: true |
| fn:ends-with(string1,string2) |
Gibt true zurück, wenn string1 mit string2 endet, andernfalls false. Beispiel: ends-with('XML','X') Ergebnis: false |
| fn:substring-before(string1,string2) |
Gibt den Teilstring zurück, der in string1 vor string2 steht. Beispiel: substring-before('12/10','/') Ergebnis: '12' |
| fn:substring-after(string1,string2) |
Gibt die Teilzeichenkette nach dem Auftreten von string2 in string1 zurück. Beispiel: substring-after('12/10','/') Ergebnis: '10' |
| fn:matches(string,pattern) |
Gibt true zurück, wenn das String-Argument mit dem angegebenen Muster übereinstimmt, andernfalls false. Beispiel: matches("Merano", "ran") Ergebnis: true |
| fn:replace(string,pattern,replace) |
Ersetzt das angegebene Muster durch den Parameter replace und gibt das Ergebnis zurück. Beispiel: replace("Bella Italia", "l", "*") Ergebnis: 'Be**a Ita*ia' Beispiel: replace("Bella Italia", "l", "") Ergebnis: 'Bea Itaia' |
| fn:tokenize(string,pattern) |
Beispiel: tokenize("XPath is fun", "\s+") Ergebnis: ("XPath", "is", "fun") |
Funktionen für anyURI
| Name | Beschreibung |
|---|---|
| fn:resolve-uri(relative,base) |
Funktionen zu booleschen Werten
| Name | Beschreibung |
|---|---|
| fn:boolean(arg) | Gibt den booleschen Wert einer Zahl, Zeichenkette oder Knotenmenge zurück. |
| fn:not(arg) |
Zuerst wird die Funktion boolean() verwendet, um das Argument auf einen booleschen Wert zu reduzieren. Ist dieser boolesche Wert false, wird true zurückgegeben; ist dieser boolesche Wert true, wird false zurückgegeben. Beispiel: not(true()) Ergebnis: false |
| fn:true() |
Gibt den booleschen Wert true zurück. Beispiel: true() Ergebnis: true |
| fn:false() |
Gibt den booleschen Wert false zurück. Beispiel: false() Ergebnis: false |
Funktionen im Zusammenhang mit Dauern, Datumsangaben und Uhrzeiten
Funktionen zum Extrahieren von Komponenten für Datumsangaben, Uhrzeiten und Dauern
| Name | Beschreibung |
|---|---|
| fn:dateTime(date,time) | Konvertiert das Argument in ein Datum und eine Uhrzeit. |
| fn:years-from-duration(datetimedur) | Gibt den ganzzahligen Wert des Jahresanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:months-from-duration(datetimedur) | Gibt den ganzzahligen Wert des Monatsanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:days-from-duration(datetimedur) | Gibt den ganzzahligen Wert des Tagesanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:hours-from-duration(datetimedur) | Gibt den ganzzahligen Wert des Stundenanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:minutes-from-duration(datetimedur) | Gibt den ganzzahligen Wert des Minutenanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:seconds-from-duration(datetimedur) | Gibt die Dezimalzahl des Minutenanteils des Argumentwerts zurück, ausgedrückt in der standardmäßigen lexikalischen Darstellung. |
| fn:year-from-dateTime(datetime) |
Gibt den ganzzahligen Wert des Jahresanteils des lokalen Werts des Arguments zurück. Beispiel: year-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Ergebnis: 2005 |
| fn:month-from-dateTime(datetime) |
Gibt den ganzzahligen Wert des Monatsanteils des lokalen Werts des Arguments zurück. Beispiel: month-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Ergebnis: 01 |
| fn:day-from-dateTime(datetime) |
Gibt den ganzzahligen Wert des Tagesanteils des lokalen Werts des Arguments zurück. Beispiel: day-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Ergebnis: 10 |
| fn:hours-from-dateTime(datetime) |
Gibt die Ganzzahl des Stundenanteils des lokalen Werts des Arguments zurück. Beispiel: hours-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Ergebnis: 12 |
| fn:minutes-from-dateTime(datetime) |
Gibt die Ganzzahl des Minutenanteils des lokalen Werts des Arguments zurück. Beispiel: minutes-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10")) Ergebnis: 30 |
| fn:seconds-from-dateTime(datetime) |
Gibt die Dezimalzahl des Sekundenanteils des lokalen Werts des Arguments zurück. Beispiel: seconds-from-dateTime(xs:dateTime("2005-01-10T12:30:00-04:10")) Ergebnis: 0 |
| fn:timezone-from-dateTime(datetime) | Gibt den Zeitzonen-Teil des Arguments zurück, falls vorhanden. |
| fn:year-from-date(date) |
Gibt die Ganzzahl zurück, die das Jahr im lokalen Wert des Arguments darstellt. Beispiel: year-from-date(xs:date("2005-04-23")) Ergebnis: 2005 |
| fn:month-from-date(date) |
Gibt die Ganzzahl zurück, die den Monat im lokalen Wert des Arguments darstellt. Beispiel: month-from-date(xs:date("2005-04-23")) Ergebnis: 4 |
| fn:day-from-date(date) |
Gibt die Ganzzahl zurück, die den Tag im lokalen Wert des Arguments darstellt. Beispiel: day-from-date(xs:date("2005-04-23")) Ergebnis: 23 |
| fn:timezone-from-date(date) | Gibt den Zeitzonen-Teil des Arguments zurück, falls vorhanden. |
| fn:hours-from-time(time) |
Gibt die ganze Zahl zurück, die den Stundenanteil im lokalen Wert des Arguments darstellt. Beispiel: hours-from-time(xs:time("10:22:00")) Ergebnis: 10 |
| fn:minutes-from-time(time) |
Gibt die ganze Zahl zurück, die den Minutenanteil im lokalen Wert des Arguments darstellt. Beispiel: minutes-from-time(xs:time("10:22:00")) Ergebnis: 22 |
| fn:seconds-from-time(time) |
Gibt die ganze Zahl zurück, die den Sekundenanteil im lokalen Wert des Arguments darstellt. Beispiel: seconds-from-time(xs:time("10:22:00")) Ergebnis: 0 |
| fn:timezone-from-time(time) | Gibt den Zeitzonen-Teil des Arguments zurück, falls vorhanden. |
| fn:adjust-dateTime-to-timezone(datetime,timezone) | Wenn das Zeitzonenargument leer ist, wird der dateTime ohne Zeitzone zurückgegeben. Andernfalls wird der dateTime mit Zeitzone zurückgegeben. |
| fn:adjust-date-to-timezone(date,timezone) | Wenn das Zeitzonenargument leer ist, wird das Datum ohne Zeitzone zurückgegeben. Andernfalls wird das Datum mit Zeitzone zurückgegeben. |
| fn:adjust-time-to-timezone(time,timezone) | Wenn das Zeitzonenargument leer ist, wird die Uhrzeit ohne Zeitzone zurückgegeben. Andernfalls wird die Uhrzeit mit Zeitzone zurückgegeben. |
Funktionen zu QNames
| Name | Beschreibung |
|---|---|
| fn:QName() | |
| fn:local-name-from-QName() | |
| fn:namespace-uri-from-QName() | |
| fn:namespace-uri-for-prefix() | |
| fn:in-scope-prefixes() | |
| fn:resolve-QName() |
Funktionen zu Knoten
| Name | Beschreibung |
|---|---|
|
Gibt den Namen des aktuellen Knotens oder des ersten Knotens in der angegebenen Knotenmenge zurück. |
|
Gibt den Namen des aktuellen Knotens oder des ersten Knotens in der angegebenen Knotenmenge zurück – ohne Namespace-Präfix. |
|
Gibt die Namespace-URI des aktuellen Knotens oder des ersten Knotens in der angegebenen Knotenmenge zurück. |
| fn:lang(lang) |
Gibt true zurück, wenn die Sprache des aktuellen Knotens mit der angegebenen Sprache übereinstimmt. Beispiel: Lang("en") ist true für <p xml:lang="en">...</p> Beispiel: Lang("de") ist false für <p xml:lang="en">...</p> |
|
Gibt den Wurzelknoten des Baums zurück, zu dem der aktuelle Knoten oder der angegebene Knoten gehört. Normalerweise der Dokumentknoten. |
Funktionen für Sequenzen
Generische Funktionen
| Name | Beschreibung |
|---|---|
| fn:index-of((item,item,...),searchitem) |
Gibt die Position in der Sequenz der Elemente zurück, die gleich dem Parameter searchitem sind. Beispiel: index-of ((15, 40, 25, 40, 10), 40) Ergebnis: (2, 4) Beispiel: index-of (("a", "dog", "and", "a", "duck"), "a") Ergebnis (1, 4) Beispiel: index-of ((15, 40, 25, 40, 10), 18) Ergebnis: () |
| fn:remove((item,item,...),position) |
Gibt eine neue Sequenz zurück, die aus dem item-Parameter aufgebaut wird – dabei wird das durch den position-Parameter angegebene Element entfernt. Beispiel: remove(("ab", "cd", "ef"), 0) Ergebnis: ("ab", "cd", "ef") Beispiel: remove(("ab", "cd", "ef"), 1) Ergebnis: ("cd", "ef") Beispiel: remove(("ab", "cd", "ef"), 4) Ergebnis: ("ab", "cd", "ef") |
| fn:empty(item,item,...) |
Gibt true zurück, wenn der Argumentwert eine leere Sequenz ist, andernfalls false. Beispiel: empty(remove(("ab", "cd"), 1)) Ergebnis: false |
| fn:exists(item,item,...) |
Gibt true zurück, wenn der Wert des Arguments keine leere Sequenz ist, andernfalls false. Beispiel: exists(remove(("ab"), 1)) Ergebnis: false |
| fn:distinct-values((item,item,...),collation) |
Gibt die eindeutigen Werte zurück. Beispiel: distinct-values((1, 2, 3, 1, 2)) Ergebnis: (1, 2, 3) |
| fn:insert-before((item,item,...),pos,inserts) |
Gibt eine neue Sequenz zurück, die aus dem Parameter item konstruiert wird – außerdem wird der Wert des Parameters inserts an der durch den Parameter pos angegebenen Position eingefügt. Beispiel: insert-before(("ab", "cd"), 0, "gh") Ergebnis: ("gh", "ab", "cd") Beispiel: insert-before(("ab", "cd"), 1, "gh") Ergebnis: ("gh", "ab", "cd") Beispiel: insert-before(("ab", "cd"), 2, "gh") Ergebnis: ("ab", "gh", "cd") Beispiel: insert-before(("ab", "cd"), 5, "gh") Ergebnis: ("ab", "cd", "gh") |
| fn:reverse((item,item,...)) |
Gibt die Elemente in umgekehrter Reihenfolge zurück. Beispiel: reverse(("ab", "cd", "ef")) Ergebnis: ("ef", "cd", "ab") Beispiel: reverse(("ab")) Ergebnis: ("ab") |
| fn:subsequence((item,item,...),start,len) |
Gibt die Sequenz von Elementen zurück, beginnend an der durch den Parameter start angegebenen Position, mit der durch den Parameter len angegebenen Länge. Das erste Element hat Position 1. Beispiel: subsequence(($item1, $item2, $item3,...), 3) Ergebnis: ($item3, ...) Beispiel: subsequence(($item1, $item2, $item3, ...), 2, 2) Ergebnis: ($item2, $item3) |
| fn:unordered((item,item,...)) | Gibt Elemente in einer implementierungsabhängigen Reihenfolge zurück. |
Funktionen zum Testen der Sequenzkapazität
| Name | Beschreibung |
|---|---|
| fn:zero-or-one(item,item,...) | Wenn das Argument null oder ein Element enthält, wird das Argument zurückgegeben; andernfalls wird ein Fehler generiert. |
| fn:one-or-more(item,item,...) | Wenn das Argument ein oder mehrere Elemente enthält, wird das Argument zurückgegeben; andernfalls wird ein Fehler generiert. |
| fn:exactly-one(item,item,...) | Wenn das Argument genau ein Element enthält, wird das Argument zurückgegeben; andernfalls wird ein Fehler generiert. |
Gleichheit, Vereinigung, Schnittmenge und Differenz
| Name | Beschreibung |
|---|---|
| fn:deep-equal(param1,param2,collation) | Gibt true zurück, wenn param1 und param2 gleich sind (deep-equal), andernfalls false. |
Aggregatfunktionen
| Name | Beschreibung |
|---|---|
| fn:count((item,item,...)) | Gibt die Anzahl der Knoten zurück. |
| fn:avg((arg,arg,...)) | Gibt den Durchschnitt der Argumentwerte zurück. Beispiel: avg((1,2,3)) Ergebnis: 2 |
| fn:max((arg,arg,...)) | Gibt das Argument zurück, das größer als alle anderen Argumente ist. Beispiel: max((1,2,3)) Ergebnis: 3 Beispiel: max(('a', 'k')) Ergebnis: 'k' |
| fn:min((arg,arg,...)) | Gibt das Argument zurück, das kleiner als alle anderen Argumente ist. Beispiel: min((1,2,3)) Ergebnis: 1 Beispiel: min(('a', 'k')) Ergebnis: 'a' |
| fn:sum(arg,arg,...) | Gibt die Summe der numerischen Werte jedes Knotens in der angegebenen Knotenmenge zurück. |
Funktionen zur Generierung von Sequenzen
| Name | Beschreibung |
|---|---|
| fn:id((string,string,...),node) | Gibt eine Sequenz von Elementknoten zurück, deren ID-Wert gleich dem Wert eines oder mehrerer der im String-Argument angegebenen Werte ist |
| fn:idref((string,string,...),node) | Gibt eine Sequenz von Element- oder Attributknoten zurück, deren IDREF-Wert gleich dem Wert eines oder mehrerer der im String-Argument angegebenen Werte ist |
| fn:doc(URI) | |
| fn:doc-available(URI) | Gibt true zurück, wenn die Funktion doc() einen Dokumentknoten zurückgibt, andernfalls false. |
|
Kontextfunktionen
| Name | Beschreibung |
|---|---|
| fn:position() |
Gibt die Indexposition des aktuell verarbeiteten Knotens zurück. Beispiel: //book[position()<=3] Ergebnis: wählt die ersten drei book-Elemente aus |
| fn:last() |
Gibt die Anzahl der Elemente in der Liste der aktuell verarbeiteten Knoten zurück. Beispiel: //book[last()] Ergebnis: wählt das letzte book-Element aus |
| fn:current-dateTime() | Gibt den aktuellen dateTime (mit Zeitzone) zurück. |
| fn:current-date() | Gibt das aktuelle Datum (mit Zeitzone) zurück. |
| fn:current-time() | Gibt die aktuelle Uhrzeit zurück (mit Zeitzone). |
| fn:implicit-timezone() | Gibt den Wert der impliziten Zeitzone zurück. |
| fn:default-collation() | Gibt den Wert der Standard-Collation zurück. |
| fn:static-base-uri() | Gibt den Wert der Basis-URI zurück. |