XPath, XQuery, and XSLT Functions

• fn:base-uri()
• fn:base-uri(node)

• fn:error()
• fn:error(error)
• fn:error(error,description)
• fn:error(error,description,error-object)

Example: error(fn:QName('http://example.com/test', 'err:toohigh'), 'Error: Price is too high')

Result: Returns http://example.com/test#toohigh to the external processing environment along with the string "Error: Price is too high".

Returns the numeric value of the argument. The argument can be a boolean value, a string, or a node set.

Example: number('100')

Result: 100

Returns the absolute value of the argument.

Example: abs(3.14)

Result: 3.14

Example: abs(-3.14)

Result: 3.14

Returns the smallest integer greater than the num parameter.

Example: ceiling(3.14)

Result: 4

Returns the largest integer not greater than the num parameter.

Example: floor(3.14)

Result: 3

Rounds the num parameter to the nearest integer.

Example: round(3.14)

Result: 3

Example: round-half-to-even(0.5)

Result: 0

Example: round-half-to-even(1.5)

Result: 2

Example: round-half-to-even(2.5)

Result: 2

Returns the string value of the argument. The argument can be a number, a logical value, or a node set.

Example: string(314)

Result: "314"

Returns a string from a sequence of code points.

Example: codepoints-to-string(84, 104, 233, 114, 232, 115, 101)

Result: 'Thérèse'

Returns a sequence of code points from a string.

Example: string-to-codepoints("Thérèse")

Result: 84, 104, 233, 114, 232, 115, 101

• fn:compare(comp1,comp2)
• fn:compare(comp1,comp2,collation)

If comp1 is less than comp2, returns -1. If comp1 is equal to comp2, returns 0. If comp1 is greater than comp2, returns 1. (According to the used comparison rules).

Example: compare('ghi', 'ghi')

Result: 0

Returns the concatenation of strings.

Example: concat('XPath ','is ','FUN!')

Result: 'XPath is FUN!'

Uses the sep parameter as a separator to return the concatenated string of the string parameter.

Example: string-join(('We', 'are', 'having', 'fun!'), ' ')

Result: ' We are having fun! '

Example: string-join(('We', 'are', 'having', 'fun!'))

Result: 'Wearehavingfun!'

Example: string-join((), 'sep')

Result: ''

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

Returns a substring of the specified length starting from the start position. The index of the first character is 1. If the len parameter is omitted, it returns the substring from position start to the end of the string.

Example: substring('Beatles',1,4)

Result: 'Beat'

Example: substring('Beatles',2)

Result: 'eatles'

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

Returns the length of the specified string. If no string parameter is provided, it returns the length of the string value of the current node.

Example: string-length('Beatles')

Result: 7

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

Removes leading and trailing whitespace from the specified string, replaces all internal sequences of whitespace with a single space, and then returns the result. If no string parameter is provided, it processes the current node.

Example: normalize-space(' The　　　XML ')

Result: 'The XML'

Converts the string parameter to uppercase.

Example: upper-case('The XML')

Result: 'THE XML'

Converts the string parameter to lowercase.

Example: lower-case('The XML')

Result: 'the xml'

Replaces string2 with string3 in string1.

Example: translate('12:30','30','45')

Result: '12:45'

Example: translate('12:30','03','54')

Result: '12:45'

Example: translate('12:30','0123','abcd')

Result: 'bc:da'

Example: escape-uri("http://example.com/test#car", true())

Result: "http%3A%2F%2Fexample.com%2Ftest#car"

Example: escape-uri("http://example.com/test#car", false())

Result: "http://example.com/test#car"

Example: escape-uri ("http://example.com/~bébé", false())

Result: "http://example.com/~b%C3%A9b%C3%A9"

Returns true if string1 contains string2, otherwise returns false.

Example: contains('XML','XM')

Result: true

Returns true if string1 starts with string2, otherwise returns false.

Example: starts-with('XML','X')

Result: true

Returns true if string1 ends with string2, otherwise returns false.

Example: ends-with('XML','X')

Result: false

Returns the substring that precedes the occurrence of string2 within string1.

Example: substring-before('12/10','/')

Result: '12'

Returns the substring that follows the occurrence of string2 within string1.

Example: substring-after('12/10','/')

Result: '10'

Returns true if the string parameter matches the specified pattern, otherwise returns false.

Example: matches("Merano", "ran")

Result: true

Replaces the specified pattern with the replace parameter and returns the result.

Example: replace("Bella Italia", "l", "*")

Result: 'Be**a Ita*ia'

Example: replace("Bella Italia", "l", "")

Result: 'Bea Itaia'

Example: tokenize("XPath is fun", "\s+")

Result: ("XPath", "is", "fun")

First, the boolean() function restores the parameter to a boolean value. If the boolean value is false, it returns true; otherwise, it returns true.

Example: not(true())

Result: false

Returns the boolean value true.

Example: true()

Result: true

Returns the boolean value false.

Example: false()

Result: false

Returns the integer representing the year part of the local value of the parameter.

Example: year-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 2005

Returns the integer representing the month part of the local value of the parameter.

Example: month-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 01

Returns the integer representing the day part of the local value of the parameter.

Example: day-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 10

Returns the integer representing the hours part of the local value of the parameter.

Example: hours-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 12

Returns the integer representing the minutes part of the local value of the parameter.

Example: minutes-from-dateTime(xs:dateTime("2005-01-10T12:30-04:10"))

Result: 30

Returns the decimal number representing the seconds part of the local value of the parameter.

Example: seconds-from-dateTime(xs:dateTime("2005-01-10T12:30:00-04:10"))

Result: 0

Returns the integer representing the year in the local value of the parameter.

Example: year-from-date(xs:date("2005-04-23"))

Result: 2005

Returns the integer representing the month in the local value of the parameter.

Example: month-from-date(xs:date("2005-04-23"))

Result: 4

Returns the integer representing the day in the local value of the parameter.

Example: day-from-date(xs:date("2005-04-23"))

Result: 23

Returns the integer representing the hours part in the local value of the parameter.

Example: hours-from-time(xs:time("10:22:00"))

Result: 10

Returns the integer representing the minutes part in the local value of the parameter.

Example: minutes-from-time(xs:time("10:22:00"))

Result: 22

Returns the integer representing the seconds part in the local value of the parameter.

Example: seconds-from-time(xs:time("10:22:00"))

Result: 0

• fn:name()
• fn:name(nodeset)

• fn:local-name()
• fn:local-name(nodeset)

• fn:namespace-uri()
• fn:namespace-uri(nodeset)

Returns true if the language of the current node matches the specified language.

Example: Lang("en") is true for <p xml:lang="en">...</p>

Example: Lang("de") is false for <p xml:lang="en">...</p>

• fn:root()
• fn:root(node)

Returns the positions in the item sequence that are equal to the searchitem parameter.

Example: index-of ((15, 40, 25, 40, 10), 40)

Result: (2, 4)

Example: index-of (("a", "dog", "and", "a", "duck"), "a")

Result (1, 4)

Example: index-of ((15, 40, 25, 40, 10), 18)

Result: ()

Returns a new sequence constructed by the item parameter, while deleting the item at the specified position.

Example: remove(("ab", "cd", "ef"), 0)

Result: ("ab", "cd", "ef")

Example: remove(("ab", "cd", "ef"), 1)

Result: ("cd", "ef")

Example: remove(("ab", "cd", "ef"), 4)

Result: ("ab", "cd", "ef")

Returns true if the parameter value is an empty sequence, otherwise returns false.

Example: empty(remove(("ab", "cd"), 1))

Result: false

Returns true if the parameter value is not an empty sequence, otherwise returns false.

Example: exists(remove(("ab"), 1))

Result: false

Returns unique distinct values.

Example: distinct-values((1, 2, 3, 1, 2))

Result: (1, 2, 3)

Returns a new sequence constructed by the item parameter - inserting the value of the inserts parameter at the position specified by the pos parameter.

Example: insert-before(("ab", "cd"), 0, "gh")

Result: ("gh", "ab", "cd")

Example: insert-before(("ab", "cd"), 1, "gh")

Result: ("gh", "ab", "cd")

Example: insert-before(("ab", "cd"), 2, "gh")

Result: ("ab", "gh", "cd")

Example: insert-before(("ab", "cd"), 5, "gh")

Result: ("ab", "cd", "gh")

Returns the reversed order of specified items.

Example: reverse(("ab", "cd", "ef"))

Result: ("ef", "cd", "ab")

Example: reverse(("ab"))

Result: ("ab")

Returns a sequence of items starting from the position specified by the start parameter and with a length specified by the len parameter. The position of the first item is 1.

Example: subsequence(($item1, $item2, $item3,...), 3)

Result: ($item3, ...)

Example: subsequence(($item1, $item2, $item3, ...), 2, 2)

Result: ($item2, $item3)

Returns the average of the values of the arguments.

Example: avg((1,2,3))

Result: 2

Returns the argument that is greater than the other parameters.

Example: max((1,2,3))

Result: 3

Example: max(('a', 'k'))

Result: 'k'

Returns the argument that is less than the other parameters.

Example: min((1,2,3))

Result: 1

Example: min(('a', 'k'))

Result: 'a'

• fn:collection()
• fn:collection(string)

Return the index position of the current node being processed.

Example: //book[position()<=3]

Result: Select the first three book elements

Return the number of items in the list of nodes being processed.

Example: //book[last()]

Result: Select the last book element