XPath, XQuery и XSLTФункцииСправочное руководство по функциям


Следующее справочное руководство определяет функции в XPath 2.0, XQuery 1.0 и XSLT 2.0.


Справочное руководство по функциям

NoteПрефикс по умолчанию для пространства имен функций — fn:

NoteURI пространства имен функций: http://www.w3.org/2005/xpath-functions

Функции доступа

Name Описание
fn:node-name(node) Возвращает имя узла-аргумента.
fn:nilled(node) Возвращает логическое значение, указывающее, отвергнут ли узел-аргумент.
fn:data(item.item,...) Принимает последовательность элементов и возвращает последовательность атомарных значений.
  • fn:base-uri()
  • fn:base-uri(node)
Возвращает значение свойства base-uri текущего узла или указанного узла.
fn:document-uri(node) Возвращает значение свойства document-uri указанного узла.

Функции ошибок и трассировки

Name Описание
  • fn:error()
  • fn:error(error)
  • fn:error(error,description)
  • fn:error(error,description,error-object)

Пример: error(fn:QName('http://example.com/test', 'err:toohigh'), 'Error: Price is too high')

Результат: Возвращает http://example.com/test#toohigh и строку "Error: Price is too high" во внешнюю среду обработки.

fn:trace(value,label) Используется для отладки запросов.

Числовые функции

Name Описание
fn:number(arg)

Возвращает числовое значение аргумента. Аргумент может быть логическим значением, строкой или набором узлов.

Пример: number('100')

Результат: 100

fn:abs(num)

Возвращает абсолютное значение аргумента.

Пример: abs(3.14)

Результат: 3.14

Пример: abs(-3.14)

Результат: 3.14

fn:ceiling(num)

Возвращает наименьшее целое число, большее аргумента num.

Пример: ceiling(3.14)

Результат: 4

fn:floor(num)

Возвращает наибольшее целое число, не большее аргумента num.

Пример: floor(3.14)

Результат: 3

fn:round(num)

Округляет аргумент num до ближайшего целого числа.

Пример: round(3.14)

Результат: 3

fn:round-half-to-even()

Пример: round-half-to-even(0.5)

Результат: 0

Пример: round-half-to-even(1.5)

Результат: 2

Пример: round-half-to-even(2.5)

Результат: 2

Строковые функции

Name Описание
fn:string(arg)

Возвращает строковое значение аргумента. Аргумент может быть числом, логическим значением или набором узлов.

Пример: string(314)

Результат: "314"

fn:codepoints-to-string(int,int,...)

Возвращает строку на основе последовательности кодовых точек.

Пример: codepoints-to-string(84, 104, 233, 114, 232, 115, 101)

Результат: 'Thérèse'

fn:string-to-codepoints(string)

Возвращает последовательность кодовых точек на основе строки.

Пример: string-to-codepoints("Thérèse")

Результат: 84, 104, 233, 114, 232, 115, 101

fn:codepoint-equal(comp1,comp2) Согласно сопоставлению кодовых точек Unicode, возвращает true, если значение comp1 равно значению comp2. (http://www.w3.org/2005/02/xpath-functions/collation/codepoint), иначе возвращает false.
  • fn:compare(comp1,comp2)
  • fn:compare(comp1,comp2,collation)

Возвращает -1, если comp1 меньше comp2. Возвращает 0, если comp1 равно comp2. Возвращает 1, если comp1 больше comp2. (В соответствии с используемыми правилами сопоставления.)

Пример: compare('ghi', 'ghi')

Результат: 0

fn:concat(string,string,...)

Возвращает конкатенацию строк.

Пример: concat('XPath ','is ','FUN!')

Результат: 'XPath is FUN!'

fn:string-join((string,string,...),sep)

Возвращает объединённую строку из строковых аргументов, используя аргумент sep в качестве разделителя.

Пример: string-join(('We', 'are', 'having', 'fun!'), ' ')

Результат: ' We are having fun! '

Пример: string-join(('We', 'are', 'having', 'fun!'))

Результат: 'Wearehavingfun!'

Пример: string-join((), 'sep')

Результат: ''

  • fn:substring(string,start,len)
  • fn:substring(string,start)

Возвращает подстроку указанной длины, начиная с позиции start. Индекс первого символа равен 1. Если аргумент len опущен, возвращает подстроку от позиции start до конца строки.

Пример: substring('Beatles',1,4)

Результат: 'Beat'

Пример: substring('Beatles',2)

Результат: 'eatles'

  • fn:string-length(string)
  • fn:string-length()

Возвращает длину указанной строки. Если строковый аргумент отсутствует, возвращает длину строкового значения текущего узла.

Пример: string-length('Beatles')

Результат: 7

  • fn:normalize-space(string)
  • fn:normalize-space()

Удаляет пробельные символы в начале и конце указанной строки, заменяет все внутренние последовательности пробельных символов одной и возвращает результат. Если строковый аргумент отсутствует, обрабатывается текущий узел.

Пример: normalize-space(' The XML ')

Результат: 'The XML'

fn:normalize-unicode() Выполняет нормализацию Unicode.
fn:upper-case(string)

Преобразует строковый аргумент в верхний регистр.

Пример: upper-case('The XML')

Результат: 'THE XML'

fn:lower-case(string)

Преобразует строковый аргумент в нижний регистр.

Пример: lower-case('The XML')

Результат: 'the xml'

fn:translate(string1,string2,string3)

Заменяет string2 в string1 на string3.

Пример: translate('12:30','30','45')

Результат: '12:45'

Пример: translate('12:30','03','54')

Результат: '12:45'

Пример: translate('12:30','0123','abcd')

Результат: 'bc:da'

fn:escape-uri(stringURI,esc-res)

Пример: escape-uri("http://example.com/test#car", true())

Результат: "http%3A%2F%2Fexample.com%2Ftest#car"

Пример: escape-uri("http://example.com/test#car", false())

Результат: "http://example.com/test#car"

Пример: escape-uri ("http://example.com/~bébé", false())

Результат: "http://example.com/~b%C3%A9b%C3%A9"

fn:contains(string1,string2)

Возвращает true, если string1 содержит string2, в противном случае возвращает false.

Пример: contains('XML','XM')

Результат: true

fn:starts-with(string1,string2)

Возвращает true, если string1 начинается с string2, в противном случае возвращает false.

Пример: starts-with('XML','X')

Результат: true

fn:ends-with(string1,string2)

Возвращает true, если string1 заканчивается на string2, в противном случае возвращает false.

Пример: ends-with('XML','X')

Результат: false

fn:substring-before(string1,string2)

Возвращает подстроку перед появлением string2 в string1.

Пример: substring-before('12/10','/')

Результат: '12'

fn:substring-after(string1,string2)

Возвращает подстроку после появления string2 в string1.

Пример: substring-after('12/10','/')

Результат: '10'

fn:matches(string,pattern)

Возвращает true, если строковый аргумент соответствует указанному шаблону, иначе возвращает false.

Пример: matches("Merano", "ran")

Результат: true

fn:replace(string,pattern,replace)

Заменяет указанный шаблон на параметр replace и возвращает результат.

Пример: replace("Bella Italia", "l", "*")

Результат: 'Be**a Ita*ia'

Пример: replace("Bella Italia", "l", "")

Результат: 'Bea Itaia'

fn:tokenize(string,pattern)

Пример: tokenize("XPath is fun", "\s+")

Результат: ("XPath", "is", "fun")

Функции для anyURI

Name Описание
fn:resolve-uri(relative,base)  

Функции для булевых значений

Name Описание
fn:boolean(arg) Возвращает логическое значение числа, строки или набора узлов.
fn:not(arg)

Сначала использует функцию boolean(), чтобы привести аргумент к логическому значению. Если это логическое значение false, возвращает true; если это логическое значение true, возвращает false.

Пример: not(true())

Результат: false

fn:true()

Возвращает логическое значение true.

Пример: true()

Результат: true

fn:false()

Возвращает логическое значение false.

Пример: false()

Результат: false

Функции, связанные с длительностями, датами и временем

Функции извлечения компонентов для дат, времени и длительностей

Name Описание
fn:dateTime(date,time) Преобразует аргумент в дату и время.
fn:years-from-duration(datetimedur) Возвращает целое число части года значения аргумента, выраженное в стандартном лексическом представлении.
fn:months-from-duration(datetimedur) Возвращает целое число части месяца значения аргумента, выраженное в стандартном лексическом представлении.
fn:days-from-duration(datetimedur) Возвращает целое число части дня значения аргумента, выраженное в стандартном лексическом представлении.
fn:hours-from-duration(datetimedur) Возвращает целое число части часов значения аргумента, выраженное в стандартном лексическом представлении.
fn:minutes-from-duration(datetimedur) Возвращает целое число части минут значения аргумента, выраженное в стандартном лексическом представлении.
fn:seconds-from-duration(datetimedur) Возвращает десятичное число части минут значения аргумента, выраженное в стандартном лексическом представлении.
fn:year-from-dateTime(datetime)

Возвращает целое число, соответствующее году в локальном значении аргумента.

Пример: year-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Результат: 2005

fn:month-from-dateTime(datetime)

Возвращает целое число, соответствующее месяцу в локальном значении аргумента.

Пример: month-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Результат: 01

fn:day-from-dateTime(datetime)

Возвращает целое число, соответствующее дню в локальном значении аргумента.

Пример: day-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Результат: 10

fn:hours-from-dateTime(datetime)

Возвращает целое число, представляющее часы в локальном значении аргумента.

Пример: hours-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Результат: 12

fn:minutes-from-dateTime(datetime)

Возвращает целое число, представляющее минуты в локальном значении аргумента.

Пример: minutes-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Результат: 30

fn:seconds-from-dateTime(datetime)

Возвращает десятичное число, представляющее секунды в локальном значении аргумента.

Пример: seconds-from-dateTime(xs:dateTime("2005-01-10T12:30:00-04:10"))

Результат: 0

fn:timezone-from-dateTime(datetime) Возвращает часть часового пояса аргумента, если она присутствует.
fn:year-from-date(date)

Возвращает целое число, представляющее год в локальном значении аргумента.

Пример: year-from-date(xs:date("2005-04-23"))

Результат: 2005

fn:month-from-date(date)

Возвращает целое число, представляющее месяц в локальном значении аргумента.

Пример: month-from-date(xs:date("2005-04-23"))

Результат: 4

fn:day-from-date(date)

Возвращает целое число, представляющее день в локальном значении аргумента.

Пример: day-from-date(xs:date("2005-04-23"))

Результат: 23

fn:timezone-from-date(date) Возвращает часть часового пояса аргумента, если она присутствует.
fn:hours-from-time(time)

Возвращает целое число, представляющее часовую часть в локальном значении аргумента.

Пример: hours-from-time(xs:time("10:22:00"))

Результат: 10

fn:minutes-from-time(time)

Возвращает целое число, представляющее минутную часть в локальном значении аргумента.

Пример: minutes-from-time(xs:time("10:22:00"))

Результат: 22

fn:seconds-from-time(time)

Возвращает целое число, представляющее секундную часть в локальном значении аргумента.

Пример: seconds-from-time(xs:time("10:22:00"))

Результат: 0

fn:timezone-from-time(time) Возвращает часть часового пояса аргумента, если она присутствует.
fn:adjust-dateTime-to-timezone(datetime,timezone) Если аргумент timezone пуст, возвращает dateTime без часового пояса. В противном случае возвращает dateTime с часовым поясом.
fn:adjust-date-to-timezone(date,timezone) Если аргумент timezone пуст, возвращает дату без часового пояса. В противном случае возвращает дату с часовым поясом.
fn:adjust-time-to-timezone(time,timezone) Если аргумент timezone пуст, возвращает время без часового пояса. В противном случае возвращает время с часовым поясом.

Функции, связанные с QNames

Name Описание
fn:QName()  
fn:local-name-from-QName()  
fn:namespace-uri-from-QName()  
fn:namespace-uri-for-prefix()  
fn:in-scope-prefixes()  
fn:resolve-QName()  

Функции, относящиеся к узлам

Name Описание
  • fn:name()
  • fn:name(nodeset)
Возвращает имя текущего узла или первого узла в указанном наборе узлов.
  • fn:local-name()
  • fn:local-name(nodeset)
Возвращает имя текущего узла или первого узла в указанном наборе узлов — без префикса пространства имён.
  • fn:namespace-uri()
  • fn:namespace-uri(nodeset)
Возвращает URI пространства имён текущего узла или первого узла в указанном наборе узлов.
fn:lang(lang)

Возвращает true, если язык текущего узла совпадает с указанным языком.

Пример: Lang("en") истинно для <p xml:lang="en">...</p>

Пример: Lang("de") имеет значение false для <p xml:lang="en">...</p>

  • fn:root()
  • fn:root(node)
Возвращает корневой узел дерева, к которому принадлежит текущий или указанный узел. Обычно это узел документа.

Функции, связанные с последовательностями

Обобщённые функции

Name Описание
fn:index-of((item,item,...),searchitem)

Возвращает позицию в последовательности элементов, равных параметру searchitem.

Пример: index-of ((15, 40, 25, 40, 10), 40)

Результат: (2, 4)

Пример: index-of (("a", "dog", "and", "a", "duck"), "a")

Результат (1, 4)

Пример: index-of ((15, 40, 25, 40, 10), 18)

Результат: ()

fn:remove((item,item,...),position)

Возвращает новую последовательность, построенную из параметра item - удаляя элемент, указанный параметром position.

Пример: remove(("ab", "cd", "ef"), 0)

Результат: ("ab", "cd", "ef")

Пример: remove(("ab", "cd", "ef"), 1)

Результат: ("cd", "ef")

Пример: remove(("ab", "cd", "ef"), 4)

Результат: ("ab", "cd", "ef")

fn:empty(item,item,...)

Возвращает true, если значение аргумента - пустая последовательность, в противном случае возвращает false.

Пример: empty(remove(("ab", "cd"), 1))

Результат: false

fn:exists(item,item,...)

Возвращает true, если значение аргумента не является пустой последовательностью, иначе возвращает false.

Пример: exists(remove(("ab"), 1))

Результат: false

fn:distinct-values((item,item,...),collation)

Возвращает уникальные различающиеся значения.

Пример: distinct-values((1, 2, 3, 1, 2))

Результат: (1, 2, 3)

fn:insert-before((item,item,...),pos,inserts)

Возвращает новую последовательность, построенную из параметра item, а также вставляет значение параметра inserts в позицию, указанную параметром pos.

Пример: insert-before(("ab", "cd"), 0, "gh")

Результат: ("gh", "ab", "cd")

Пример: insert-before(("ab", "cd"), 1, "gh")

Результат: ("gh", "ab", "cd")

Пример: insert-before(("ab", "cd"), 2, "gh")

Результат: ("ab", "gh", "cd")

Пример: insert-before(("ab", "cd"), 5, "gh")

Результат: ("ab", "cd", "gh")

fn:reverse((item,item,...))

Возвращает элементы в обратном порядке.

Пример: reverse(("ab", "cd", "ef"))

Результат: ("ef", "cd", "ab")

Пример: reverse(("ab"))

Результат: ("ab")

fn:subsequence((item,item,...),start,len)

Возвращает последовательность элементов, начиная с позиции, указанной параметром start, и длиной, указанной параметром len. Первый элемент имеет позицию 1.

Пример: subsequence(($item1, $item2, $item3,...), 3)

Результат: ($item3, ...)

Пример: subsequence(($item1, $item2, $item3, ...), 2, 2)

Результат: ($item2, $item3)

fn:unordered((item,item,...)) Возвращает элементы в порядке, зависящем от реализации.

Функции для проверки размера последовательности

Name Описание
fn:zero-or-one(item,item,...) Если аргумент содержит ноль или один элемент, возвращает аргумент; в противном случае генерирует ошибку.
fn:one-or-more(item,item,...) Если аргумент содержит один или несколько элементов, возвращает аргумент; в противном случае генерирует ошибку.
fn:exactly-one(item,item,...) Если аргумент содержит ровно один элемент, возвращает аргумент; в противном случае генерирует ошибку.

Равно, Объединение, Пересечение и Исключение

Name Описание
fn:deep-equal(param1,param2,collation) Возвращает true, если param1 и param2 равны друг другу (deep-equal), иначе возвращает false.

Агрегатные функции

Name Описание
fn:count((item,item,...)) Возвращает количество узлов.
fn:avg((arg,arg,...)) Возвращает среднее значение аргументов. Пример: avg((1,2,3)) Результат: 2
fn:max((arg,arg,...)) Возвращает аргумент, который больше всех остальных аргументов. Пример: max((1,2,3)) Результат: 3 Пример: max(('a', 'k')) Результат: 'k'
fn:min((arg,arg,...)) Возвращает аргумент, который меньше всех остальных аргументов. Пример: min((1,2,3)) Результат: 1 Пример: min(('a', 'k')) Результат: 'a'
fn:sum(arg,arg,...) Возвращает сумму числовых значений каждого узла в указанном наборе узлов.

Функции для генерации последовательностей

Name Описание
fn:id((string,string,...),node) Возвращает последовательность элементных узлов, имеющих значение ID, равное значению одного или нескольких значений, указанных в строковом аргументе
fn:idref((string,string,...),node) Возвращает последовательность элементных узлов или узлов атрибутов, имеющих значение IDREF, равное значению одного или нескольких значений, указанных в строковом аргументе
fn:doc(URI)  
fn:doc-available(URI) Возвращает true, если функция doc() возвращает узел документа, иначе возвращает false.
  • fn:collection()
  • fn:collection(string)
 

Контекстные функции

Name Описание
fn:position()

Возвращает позицию индекса текущего обрабатываемого узла.

Пример: //book[position()<=3]

Результат: выбирает первые три элемента book

fn:last()

Возвращает количество элементов в списке обрабатываемых узлов.

Пример: //book[last()]

Результат: выбирает последний элемент book

fn:current-dateTime() Возвращает текущий dateTime (с часовым поясом).
fn:current-date() Возвращает текущую дату (с часовым поясом).
fn:current-time() Возвращает текущее время (с часовым поясом).
fn:implicit-timezone() Возвращает значение неявного часового пояса.
fn:default-collation() Возвращает значение коллации по умолчанию.
fn:static-base-uri() Возвращает значение base-uri.
Другие расширения