public enum FuncDef extends Enum<FuncDef>
List of functions and their attributes according to the specification in XQuery 1.0 and XPath 2.0 Functions and Operators.
Enum Constant and Description |
---|
ADD_DTD
op:add-dayTimeDurations( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as
xs:dayTimeDuration
|
ADD_DTD2DATE
op:add-dayTimeDuration-to-date( $arg1 as xs:date, $arg2 as xs:dayTimeDuration) as xs:date
|
ADD_DTD2DT
op:add-dayTimeDuration-to-dateTime( $arg1 as xs:dateTime, $arg2 as xs:dayTimeDuration) as
xs:dateTime
|
ADD_DTD2TIME
op:add-dayTimeDuration-to-time( $arg1 as xs:time, $arg2 as xs:dayTimeDuration) as xs:time
|
ADD_YMD
op:add-yearMonthDurations( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as
xs:yearMonthDuration
|
ADD_YMD2DATE
op:add-yearMonthDuration-to-date( $arg1 as xs:date, $arg2 as xs:yearMonthDuration) as xs:date
|
ADD_YMD2DT
op:add-yearMonthDuration-to-dateTime( $arg1 as xs:dateTime, $arg2 as xs:yearMonthDuration) as
xs:dateTime
|
ADJUST_DATE2TZ
fn:adjust-date-to-timezone($arg as xs:date?) as xs:date?
|
ADJUST_DT2TZ
fn:adjust-dateTime-to-timezone($arg as xs:dateTime?) as xs:dateTime?
|
ADJUST_TIME2TZ
fn:adjust-time-to-timezone($arg as xs:time?) as xs:time?
|
AVG
fn:avg($arg as xs:anyAtomicType*) as xs:anyAtomicType?
|
B_EQ
op:boolean-equal($value1 as xs:boolean, $value2 as xs:boolean) as xs:boolean
|
B_GT
op:boolean-greater-than($arg1 as xs:boolean, $arg2 as xs:boolean) as xs:boolean
|
B_LT
op:boolean-less-than($arg1 as xs:boolean, $arg2 as xs:boolean) as xs:boolean
|
BASE_URI
fn:base-uri() as xs:anyURI?
|
BASE64BIN_EQ
op:base64Binary-equal( $value1 as xs:base64Binary, $value2 as xs:base64Binary) as xs:boolean
|
BOOLEAN
fn:boolean($arg as item()*) as xs:boolean
|
CODEPNT_EQ
fn:codepoint-equal( $comparand1 as xs:string?, $comparand2 as xs:string?) as xs:boolean?
|
CODEPNT2STR
fn:codepoints-to-string($arg as xs:integer*) as xs:string
|
COMP
fn:compare($comparand1 as xs:string?, $comparand2 as xs:string?) as xs:integer?
|
CONCAT
fn:concat( $arg1 as xs:anyAtomicType?, $arg2 as xs:anyAtomicType?, ...
|
CONTAINS
fn:contains($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
|
COUNT
fn:count($arg as item()*) as xs:integer
|
CURRENT_DATE
fn:current-date() as xs:date
|
CURRENT_DT
fn:current-dateTime() as xs:dateTime
|
CURRENT_TIME
fn:current-time() as xs:time
|
DA_EQ
op:date-equal($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
|
DA_GT
op:date-greater-than($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
|
DA_LT
op:date-less-than($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
|
DATA
fn:data($arg as item()*) as xs:anyAtomicType*
|
DAY_FROM_DATE
fn:day-from-date($arg as xs:date?) as xs:integer?
|
DAY_FROM_DT
fn:day-from-dateTime($arg as xs:dateTime?) as xs:integer?
|
DAYS_FROM_DUR
fn:days-from-duration($arg as xs:duration?) as xs:integer?
|
DEEP_EQ
fn:deep-equal($argumentseter1 as item()*, $argumentseter2 as item()*) as xs:boolean
|
DEFAULT_COLL
fn:default-collation() as xs:string
|
DIST_VALUES
fn:distinct-values($arg as xs:anyAtomicType*) as xs:anyAtomicType
|
DIV_DTD
op:divide-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as xs:double) as xs:dayTimeDuration
|
DIV_DTD_BY_DTD
op:divide-dayTimeDuration-by-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as
xs:dayTimeDuration) as xs:decimal
|
DIV_YMD
op:divide-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as xs:double) as
xs:yearMonthDuration
|
DIV_YMD_BY_YMD
op:divide-yearMonthDuration-by-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as
xs:yearMonthDuration) as xs:decimal
|
DOC_AVAILABLE
fn:doc-available($uri as xs:string?) as xs:boolean
|
DOC_URI
fn:document-uri($arg as node()?) as xs:anyURI?
|
DT_EQ
op:dateTime-equal($arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
|
DT_GT
op:dateTime-greater-than( $arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
|
DT_LT
op:dateTime-less-than($arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
|
DTD_GT
op:dayTimeDuration-greater-than( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as
xs:boolean
|
DTD_LT
op:dayTimeDuration-less-than( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as
xs:boolean
|
DUR_EQ
op:duration-equal($arg1 as xs:duration, $arg2 as xs:duration) as xs:boolean
|
EMPTY
fn:empty($arg as item()*) as xs:boolean
|
ENCODE_URI
fn:encode-for-uri($uri-part as xs:string?) as xs:string
|
ENDS_WITH
fn:ends-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
|
ESCAPE_HTML_URI
fn:escape-html-uri($uri as xs:string?) as xs:string
|
EXISTES
fn:exists($arg as item()*) as xs:boolean
|
FALSE
fn:false() as xs:boolean
|
GD_EQ
op:gDay-equal($arg1 as xs:gDay, $arg2 as xs:gDay) as xs:boolean
|
GM_EQ
op:gMonth-equal($arg1 as xs:gMonth, $arg2 as xs:gMonth) as xs:boolean
|
GMD_EQ
op:gMonthDay-equal($arg1 as xs:gMonthDay, $arg2 as xs:gMonthDay) as xs:boolean
|
GY_EQ
op:gYear-equal($arg1 as xs:gYear, $arg2 as xs:gYear) as xs:boolean
|
GYM_EQ
op:gYearMonth-equal( $arg1 as xs:gYearMonth, $arg2 as xs:gYearMonth) as xs:boolean
|
HEXBIN_EQ
op:hexBinary-equal( $value1 as xs:hexBinary, $value2 as xs:hexBinary) as xs:boolean
|
HOURS_FROM_DT
fn:hours-from-dateTime($arg as xs:dateTime?) as xs:integer?
|
HOURS_FROM_DUR
fn:hours-from-duration($arg as xs:duration?) as xs:integer?
|
HOURS_FROM_TIME
fn:hours-from-time($arg as xs:time?) as xs:integer?
|
IMPLICIT_TZ
fn:implicit-timezone() as xs:dayTimeDuration
|
IN_SCOPE_PREF
fn:in-scope-prefixes($element as element()) as xs:string
|
INDEX_OF
fn:index-of( $seqarguments as xs:anyAtomicType*, $srcharguments as xs:anyAtomicType) as xs:integer*
|
IRI2URI
fn:iri-to-uri($iri as xs:string?) as xs:string
|
IS_SAME_NODE
op:is-same-node($argumentseter1 as node(), $argumentseter2 as node()) as xs:boolean
|
LANG
fn:lang($testlang as xs:string?) as xs:boolean
|
LAST
fn:last() as xs:integer
|
LOC_NAME
fn:local-name() as xs:string
|
LOC_NAME_FROM_QNAME
fn:local-name-from-QName($arg as xs:QName?) as xs:NCName?
|
LOW_CASE
fn:lower-case($arg as xs:string?) as xs:string
|
MATCH
fn:matches($input as xs:string?, $pattern as xs:string) as xs:boolean
|
MAX
fn:max($arg as xs:anyAtomicType*) as xs:anyAtomicType?
|
MIN
fn:min($arg as xs:anyAtomicType*) as xs:anyAtomicType?
|
MIN_FROM_DT
fn:minutes-from-dateTime($arg as xs:dateTime?) as xs:integer?
|
MIN_FROM_DUR
fn:minutes-from-duration($arg as xs:duration?) as xs:integer?
|
MIN_FROM_TIME
fn:minutes-from-time($arg as xs:time?) as xs:integer?
|
MON_FROM_DATE
fn:month-from-date($arg as xs:date?) as xs:integer?
|
MON_FROM_DT
fn:month-from-dateTime($arg as xs:dateTime?) as xs:integer?
|
MON_FROM_DUR
fn:months-from-duration($arg as xs:duration?) as xs:integer?
|
MUL_DTD
op:multiply-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as xs:double) as xs:dayTimeDuration
|
MUL_YMD
op:multiply-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as xs:double) as
xs:yearMonthDuration
|
N_EQ
op:numeric-equal($arg1 as numeric, $arg2 as numeric) as xs:boolean
|
N_GT
op:numeric-greater-than($arg1 as numeric, $arg2 as numeric) as xs:boolean
|
N_LT
op:numeric-less-than($arg1 as numeric, $arg2 as numeric) as xs:boolean
|
NAME
fn:name() as xs:string
|
NILLED
fn:nilled : fn:nilled($arg as node()?) as xs:boolean?
|
NODE_AFTER
op:node-after($argumentseter1 as node(), $argumentseter2 as node()) as xs:boolean
|
NODE_BEFORE
op:node-before($argumentseter1 as node(), $argumentseter2 as node()) as
xs:boolean
|
NODE_NAME
fn:node-name($arg as node()?) as xs:QName?
|
NORM_SPACE
fn:normalize-space() as xs:string
|
NORM_UNI
fn:normalize-unicode($arg as xs:string?) as xs:string
|
NOT
fn:not($arg as item()*) as xs:boolean
|
NOTATION_EQ
op:NOTATION-equal($arg1 as xs:NOTATION, $arg2 as xs:NOTATION) as xs:boolean
|
NS_URI
fn:namespace-uri() as xs:anyURI
|
NS_URI_FROM_QNAME
fn:namespace-uri-from-QName($arg as xs:QName?) as xs:anyURI?
|
NS_URI4PREF
fn:namespace-uri-for-prefix( $prefix as xs:string?, $element as element()) as xs:anyURI?
|
NUMBER
fn:number() as xs:double fn:number($arg as xs:anyAtomicType?) as xs:double.
|
POS
fn:position() as xs:integer
|
POSITION
fn:position with no argument
|
QNAME
fn:QName($argumentsURI as xs:string?, $argumentsQName as xs:string) as xs:QName
|
QNAME_EQ
op:QName-equal($arg1 as xs:QName, $arg2 as xs:QName) as xs:boolean
|
REPLACE
fn:replace( $input as xs:string?, $pattern as xs:string, $replacement as xs:string) as xs:string
|
RESOLVE_QNAME
fn:resolve-QName($qname as xs:string?, $element as element()) as xs:QName?
|
RESOLVE_URI
fn:resolve-uri($relative as xs:string?) as xs:anyURI?
|
SEC_FROM_DT
fn:seconds-from-dateTime($arg as xs:dateTime?) as xs:decimal?
|
SEC_FROM_DUR
fn:seconds-from-duration($arg as xs:duration?) as xs:decimal?
|
SEC_FROM_TIME
fn:seconds-from-time($arg as xs:time?) as xs:decimal?
|
STARTS_WITH
fn:starts-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
|
STATIC_BASE_URI
fn:static-base-uri() as xs:anyURI?
|
STR2CODEPNT
fn:string-to-codepoints($arg as xs:string?) as xs:integer*
|
STRING
fn:string() as xs:string
|
STRJOIN
fn:string-join($arg1 as xs:string*, $arg2 as xs:string) as xs:string
|
STRLEN
fn:string-length() as xs:integer
|
SUB_DATES
op:subtract-dates($arg1 as xs:date, $arg2 as xs:date) as xs:dayTimeDuration?
|
SUB_DT
op:subtract-dateTimes( $arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:dayTimeDuration?
|
SUB_DTD
op:subtract-dayTimeDurations( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as
xs:dayTimeDuration
|
SUB_DTD_FROM_DATE
op:subtract-dayTimeDuration-from-date( $arg1 as xs:date, $arg2 as xs:dayTimeDuration) as xs:date
|
SUB_DTD_FROM_DT
op:subtract-dayTimeDuration-from-dateTime( $arg1 as xs:dateTime, $arg2 as xs:dayTimeDuration) as
xs:dateTime
|
SUB_DTD_FROM_TIME
op:subtract-dayTimeDuration-from-time( $arg1 as xs:time, $arg2 as xs:dayTimeDuration) as xs:time
|
SUB_TIMES
op:subtract-times($arg1 as xs:time, $arg2 as xs:time) as xs:dayTimeDuration
|
SUB_YMD
op:subtract-yearMonthDurations( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as
xs:yearMonthDuration
|
SUB_YMD_FROM_DATE
op:subtract-yearMonthDuration-from-date( $arg1 as xs:date, $arg2 as xs:yearMonthDuration) as
xs:date
|
SUB_YMD_FROM_DT
op:subtract-yearMonthDuration-from-dateTime( $arg1 as xs:dateTime, $arg2 as xs:yearMonthDuration)
as xs:dateTime
|
SUBSTR
fn:substring( $sourceString as xs:string?, $startingLoc as xs:double) as xs:string
|
SUBSTR_AFTER
fn:substring-after($arg1 as xs:string?, $arg2 as xs:string?) as xs:string
|
SUBSTR_BEFORE
fn:substring-before($arg1 as xs:string?, $arg2 as xs:string?) as xs:string
|
SUM
fn:sum($arg as xs:anyAtomicType*) as xs:anyAtomicType
|
T_EQ
op:time-equal($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
|
T_GT
op:time-greater-than($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
|
T_LT
op:time-less-than($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
|
TO
op:to($firstval as xs:integer, $lastval as xs:integer) as xs:integer
|
TOKENIZE
fn:tokenize($input as xs:string?, $pattern as xs:string) as xs:string*
|
TRANSLATE
fn:translate( $arg as xs:string?, $mapString as xs:string, $transString as xs:string) as xs:string
|
TRUE
fn:true() as xs:boolean
|
TZ_FROM_DATE
fn:timezone-from-date($arg as xs:date?) as xs:dayTimeDuration?
|
TZ_FROM_DT
fn:timezone-from-dateTime($arg as xs:dateTime?) as xs:dayTimeDuration?
|
TZ_FROM_TIME
fn:timezone-from-time($arg as xs:time?) as xs:dayTimeDuration?
|
UP_CASE
fn:upper-case($arg as xs:string?) as xs:string
|
YEAR_FROM_DATE
fn:year-from-date($arg as xs:date?) as xs:integer?
|
YEAR_FROM_DT
fn:year-from-dateTime($arg as xs:dateTime?) as xs:integer?
|
YEAR_FROM_DUR
fn:years-from-duration($arg as xs:duration?) as xs:integer?
|
YMD_GT
op:yearMonthDuration-greater-than( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as
xs:boolean
|
YMD_LT
op:yearMonthDuration-less-than( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as
xs:boolean
|
Modifier and Type | Method and Description |
---|---|
static FuncDef |
fromString(String paramName)
Public method to easy retrieve the Function-Class for a name.
|
Class<? extends AbsFunction> |
getFunc() |
int |
getMax() |
int |
getMin() |
String |
getReturnType() |
static FuncDef |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static FuncDef[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final FuncDef BOOLEAN
fn:boolean($arg as item()*) as xs:boolean
Computes the effective boolean value of the sequence $arg. See Section 2.4.3 Effective Boolean ValueXP
public static final FuncDef COUNT
fn:count($arg as item()*) as xs:integer
Returns the number of items in the value of $arg.
public static final FuncDef SUM
fn:sum($arg as xs:anyAtomicType*) as xs:anyAtomicType
fn:sum( $arg as xs:anyAtomicType*, $zero as xs:anyAtomicType?) as xs:anyAtomicType?
MINReturns a value obtained by adding together the values in $arg. If $zero is not specified, then the value returned for an empty sequence is the xs:integer value 0. If $zero is specified, then the value returned for an empty sequence is $zero.
public static final FuncDef AVG
fn:avg($arg as xs:anyAtomicType*) as xs:anyAtomicType?
Returns the average of the values in the input sequence $arg, that is, the sum of the values divided by the number of values.
public static final FuncDef MAX
fn:max($arg as xs:anyAtomicType*) as xs:anyAtomicType?
fn:max($arg as xs:anyAtomicType*, $collation as string) as xs:anyAtomicType?
Selects an item from the input sequence $arg whose value is greater than or equal to the value of every other item in the input sequence. If there are two or more such items, then the specific item whose value is returned is �implementation dependent�.
public static final FuncDef MIN
fn:min($arg as xs:anyAtomicType*) as xs:anyAtomicType?
fn:min($arg as xs:anyAtomicType*, $collation as string) as xs:anyAtomicType?
selects an item from the input sequence $arg whose value is less than or equal to the value of every other item in the input sequence. If there are two or more such items, then the specific item whose value is returned is �implementation dependent�.
public static final FuncDef NOT
fn:not($arg as item()*) as xs:boolean
$arg is first reduced to an effective boolean value by applying the fn:boolean() function. Returns true if the effective boolean value is false, and false if the effective boolean value is true.;
public static final FuncDef STRING
fn:string() as xs:string
fn:string($arg as item()?) as xs:string
Returns the value of $arg represented as a xs:string. If no argument is supplied, the context item (.) is used as the default argument. The behavior of the function if the argument is omitted is exactly the same as if the context item had been passed as the argument.
public static final FuncDef POSITION
fn:position with no argument
fn:position with xs:integer
Returns the context position from the dynamic contextas xs:intege.r
public static final FuncDef NODE_NAME
fn:node-name($arg as node()?) as xs:QName?
Returns an expanded-QName for node kinds that can have names. For other kinds of nodes it returns the empty sequence. If $arg is the empty sequence, the empty sequence is returned.public static final FuncDef NILLED
fn:nilled : fn:nilled($arg as node()?) as xs:boolean?
Returns an xs:boolean indicating whether the argument node is "nilled". If the argument is not an element node, returns the empty sequence. If the argument is the empty sequence, returns the empty sequence.public static final FuncDef DATA
fn:data($arg as item()*) as xs:anyAtomicType*
fn:data takes a sequence of items and returns a sequence of atomic values.
public static final FuncDef BASE_URI
fn:base-uri() as xs:anyURI?
fn:base-uri($arg as node()?) as xs:anyURI?
Returns the value of the base-uri URI property for $arg as defined by the accessor function dm:base-uri() for that kind of node in Section 5.2 base-uri AccessorDM.
public static final FuncDef DOC_URI
fn:document-uri($arg as node()?) as xs:anyURI?
Returns the value of the document-uri property for $arg as defined by the dm:document-uri accessor function defined in Section 6.1.2 AccessorsDM.
public static final FuncDef N_EQ
op:numeric-equal($arg1 as numeric, $arg2 as numeric) as xs:boolean
Returns true if and only if the value of $arg1 is equal to the value of $arg2.
This function backs up the "eq", "ne", "le" and "ge" operators on numeric values.
public static final FuncDef N_LT
op:numeric-less-than($arg1 as numeric, $arg2 as numeric) as xs:boolean
Returns true if and only if $arg1 is less than $arg2.
This function backs up the "lt" and "le" operators on numeric values.
public static final FuncDef N_GT
op:numeric-greater-than($arg1 as numeric, $arg2 as numeric) as xs:boolean
Returns true if and only if $arg1 is greater than $arg2. F
public static final FuncDef CODEPNT2STR
fn:codepoints-to-string($arg as xs:integer*) as xs:string
Creates an xs:string from a sequence of [The Unicode Standard] code points. Returns the zero-length string if $arg is the empty sequence. If any of the code points in $arg is not a legal XML character, an error is raised [err:FOCH0001].
public static final FuncDef STR2CODEPNT
fn:string-to-codepoints($arg as xs:string?) as xs:integer*
Returns the sequence of [The Unicode Standard] code points that constitute an xs:string. If $arg is a zero-length string or the empty sequence, the empty sequence is returned.
public static final FuncDef COMP
fn:compare($comparand1 as xs:string?, $comparand2 as xs:string?) as xs:integer?
fn:compare( $comparand1 as xs:string?, $comparand2 as xs:string?, $collation as xs:string) as xs:integer?
Returns -1, 0, or 1, depending on whether the value of the $comparand1 is respectively less than, equal to, or greater than the value of $comparand2, according to the rules of the collation that is used.
public static final FuncDef CODEPNT_EQ
fn:codepoint-equal( $comparand1 as xs:string?, $comparand2 as xs:string?) as xs:boolean?
Returns true or false depending on whether the value of $comparand1 is equal to the value of $comparand2, according to the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint).
public static final FuncDef CONCAT
fn:concat( $arg1 as xs:anyAtomicType?, $arg2 as xs:anyAtomicType?, ... ) as xs:string
Accepts two or more xs:anyAtomicType arguments and casts them to xs:string. Returns the xs:string that is the concatenation of the values of its arguments after conversion. If any of the arguments is the empty sequence, the argument is treated as the zero-length string.
public static final FuncDef STRJOIN
fn:string-join($arg1 as xs:string*, $arg2 as xs:string) as xs:string
Returns a xs:string created by concatenating the members of the $arg1 sequence using $arg2 as a separator. If the value of $arg2 is the zero-length string, then the members of $arg1 are concatenated without a separator.
public static final FuncDef SUBSTR
fn:substring( $sourceString as xs:string?, $startingLoc as xs:double) as xs:string
fn:substring( $sourceString as xs:string?, $startingLoc as xs:double, $length as xs:double) as xs:string
Returns the portion of the value of $sourceString beginning at the position indicated by the value of $startingLoc and continuing for the number of characters indicated by the value of $length. The characters returned do not extend beyond $sourceString. If $startingLoc is zero or negative, only those characters in positions greater than zero are returned.
public static final FuncDef STRLEN
fn:string-length() as xs:integer
fn:string-length($arg as xs:string?) as xs:integer
Returns an xs:integer equal to the length in characters of the value of $arg.
public static final FuncDef NORM_SPACE
fn:normalize-space() as xs:string
fn:normalize-space($arg as xs:string?) as xs:string
Returns the value of $arg with whitespace normalized by stripping leading and trailing whitespace and replacing sequences of one or more than one whitespace character with a single space, #x20.
public static final FuncDef NORM_UNI
fn:normalize-unicode($arg as xs:string?) as xs:string
fn:normalize-unicode( $arg as xs:string?, $normalizationForm as xs:string) as xs:string
Returns the value of $arg normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm. The effective value of the $normalizationForm is computed by removing leading and trailing blanks, if present, and converting to upper case.
public static final FuncDef UP_CASE
fn:upper-case($arg as xs:string?) as xs:string
Returns the value of $arg after translating every character to its upper-case correspondent as defined in the appropriate case mappings section in the Unicode standard [The Unicode Standard]. For versions of Unicode beginning with the 2.1.8 update, only locale-insensitive case mappings should be applied. Beginning with version 3.2.0 (and likely future versions) of Unicode, precise mappings are described in default case operations, which are full case mappings in the absence of tailoring for particular languages and environments. Every lower-case character that does not have an upper-case correspondent, as well as every upper-case character, is included in the returned value in its original form.
public static final FuncDef LOW_CASE
fn:lower-case($arg as xs:string?) as xs:string
Returns the value of $arg after translating every character to its lower-case correspondent as defined in the appropriate case mappings section in the Unicode standard [The Unicode Standard]. For versions of Unicode beginning with the 2.1.8 update, only locale-insensitive case mappings should be applied. Beginning with version 3.2.0 (and likely future versions) of Unicode, precise mappings are described in default case operations, which are full case mappings in the absence of tailoring for particular languages and environments. Every upper-case character that does not have a lower-case correspondent, as well as every lower-case character, is included in the returned value in its original form.
public static final FuncDef TRANSLATE
fn:translate( $arg as xs:string?, $mapString as xs:string, $transString as xs:string) as xs:string
Returns the value of $arg modified so that every character in the value of $arg that occurs at some position N in the value of $mapString has been replaced by the character that occurs at position N in the value of $transString.
public static final FuncDef ENCODE_URI
fn:encode-for-uri($uri-part as xs:string?) as xs:string
This function encodes reserved characters in an xs:string that is intended to be used in the path segment of a URI. It is invertible but not idempotent. This function applies the URI escaping rules defined in section 2 of [RFC 3986] to the xs:string supplied as $uri-part. The effect of the function is to escape reserved characters. Each such character in the string is replaced with its percent-encoded form as described in [RFC 3986].
public static final FuncDef IRI2URI
fn:iri-to-uri($iri as xs:string?) as xs:string
This function converts an xs:string containing an IRI into a URI according to the rules spelled out in Section 3.1 of [RFC 3987]. It is idempotent but not invertible.
public static final FuncDef ESCAPE_HTML_URI
fn:escape-html-uri($uri as xs:string?) as xs:string
This function escapes all characters except printable characters of the US-ASCII coded character set, specifically the octets ranging from 32 to 126 (decimal). The effect of the function is to escape a URI in the manner html user agents handle attribute values that expect URIs. Each character in $uri to be escaped is replaced by an escape sequence, which is formed by encoding the character as a sequence of octets in UTF-8, and then representing each of these octets in the form %HH, where HH is the hexadecimal representation of the octet. This function must always generate hexadecimal values using the upper-case letters A-F.public static final FuncDef CONTAINS
fn:contains($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
fn:contains( $arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:boolean
Returns an xs:boolean indicating whether or not the value of $arg1 contains (at the beginning, at the end, or anywhere within) at least one sequence of collation units that provides a minimal match to the collation units in the value of $arg2, according to the collation that is used.public static final FuncDef STARTS_WITH
fn:starts-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
fn:starts-with( $arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:boolean
Returns an xs:boolean indicating whether or not the value of $arg1 starts with a sequence of collation units that provides a minimal match to the collation units of $arg2 according to the collation that is used.
public static final FuncDef ENDS_WITH
fn:ends-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
fn:ends-with( $arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:boolean
>Returns an xs:boolean indicating whether or not the value of $arg1 ends with a sequence of collation units that provides a minimal match to the collation units of $arg2 according to the collation that is used.public static final FuncDef SUBSTR_BEFORE
fn:substring-before($arg1 as xs:string?, $arg2 as xs:string?) as xs:string
fn:substring-before( $arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:string
Returns the substring of the value of $arg1 that precedes in the value of $arg1 the first occurrence of a sequence of collation units that provides a minimal match to the collation units of $arg2 according to the collation that is used.
public static final FuncDef SUBSTR_AFTER
fn:substring-after($arg1 as xs:string?, $arg2 as xs:string?) as xs:string
fn:substring-after( $arg1 as xs:string?, $arg2 as xs:string?, $collation as xs:string) as xs:string
Returns the substring of the value of $arg1 that follows in the value of $arg1 the first occurrence of a sequence of collation units that provides a minimal match to the collation units of $arg2 according to the collation that is used.
public static final FuncDef MATCH
fn:matches($input as xs:string?, $pattern as xs:string) as xs:boolean
fn:matches( $input as xs:string?, $pattern as xs:string, $flags as xs:string) as xs:boolean
The function returns true if $input matches the regular expression supplied as $pattern as influenced by the value of $flags, if present; otherwise, it returns false.
public static final FuncDef REPLACE
fn:replace( $input as xs:string?, $pattern as xs:string, $replacement as xs:string) as xs:string
fn:replace( $input as xs:string?, $pattern as xs:string, $replacement as xs:string, $flags as xs:string) as xs:string
The function returns the xs:string that is obtained by replacing each non-overlapping substring of $input that matches the given $pattern with an occurrence of the $replacement string.
public static final FuncDef TOKENIZE
fn:tokenize($input as xs:string?, $pattern as xs:string) as xs:string*
fn:tokenize( $input as xs:string?, $pattern as xs:string, $flags as xs:string) as xs:string*
This function breaks the $input string into a sequence of strings, treating any substring that matches $pattern as a separator. The separators themselves are not returned.
public static final FuncDef RESOLVE_URI
fn:resolve-uri($relative as xs:string?) as xs:anyURI?
fn:resolve-uri($relative as xs:string?, $base as xs:string) as xs:anyURI?
The purpose of this function is to enable a relative URI to be resolved against an absolute URI.
public static final FuncDef TRUE
fn:true() as xs:boolean
Returns the xs:boolean value true. Equivalent to xs:boolean("1").public static final FuncDef FALSE
fn:false() as xs:boolean
Returns the xs:boolean value false. Equivalent to xs:boolean("0").public static final FuncDef B_EQ
op:boolean-equal($value1 as xs:boolean, $value2 as xs:boolean) as xs:boolean
Returns true if both arguments are true or if both arguments are false. Returns false if one of the arguments is true and the other argument is false.public static final FuncDef B_LT
op:boolean-less-than($arg1 as xs:boolean, $arg2 as xs:boolean) as xs:boolean
Returns true if $arg1 is false and $arg2 is true. Otherwise, returns false.
public static final FuncDef B_GT
op:boolean-greater-than($arg1 as xs:boolean, $arg2 as xs:boolean) as xs:boolean
Returns true if $arg1 is true and $arg2 is false. Otherwise, returns false.
public static final FuncDef YMD_LT
op:yearMonthDuration-less-than( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as xs:boolean
Returns true if and only if $arg1 is less than $arg2. Returns false otherwise.
public static final FuncDef YMD_GT
op:yearMonthDuration-greater-than( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as xs:boolean
Returns true if and only if $arg1 is greater than $arg2. Returns false otherwise.
public static final FuncDef DTD_LT
op:dayTimeDuration-less-than( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as xs:boolean
Returns true if and only if $arg1 is less than $arg2. Returns false otherwise.
public static final FuncDef DTD_GT
op:dayTimeDuration-greater-than( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as xs:boolean
Returns true if and only if $arg1 is greater than $arg2. Returns false otherwise.
public static final FuncDef DUR_EQ
op:duration-equal($arg1 as xs:duration, $arg2 as xs:duration) as xs:boolean
Returns true if and only if the xs:yearMonthDuration and the xs:dayTimeDuration components of $arg1 and $arg2 compare equal respectively. Returns false otherwise.
public static final FuncDef DT_EQ
op:dateTime-equal($arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
Returns true if and only if the value of $arg1 is equal to the value of $arg2 according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime values with timezones. Returns false otherwise.
public static final FuncDef DT_LT
op:dateTime-less-than($arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
Returns true if and only if the value of $arg1 is less than the value of $arg2 according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime values with timezones. Returns false otherwise.
public static final FuncDef DT_GT
op:dateTime-greater-than( $arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:boolean
Returns true if and only if the value of $arg1 is greater than the value of $arg2 according to the algorithm defined in section 3.2.7.4 of [XML Schema Part 2: Datatypes Second Edition] "Order relation on dateTime" for xs:dateTime values with timezones. Returns false otherwise.
public static final FuncDef DA_EQ
op:date-equal($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
Returns true if and only if the starting instant of $arg1 is equal to starting instant of $arg2. Returns false otherwise.
public static final FuncDef DA_LT
op:date-less-than($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
Returns true if and only if the starting instant of $arg1 is less than the starting instant of $arg2. Returns false otherwise.
public static final FuncDef DA_GT
op:date-greater-than($arg1 as xs:date, $arg2 as xs:date) as xs:boolean
Returns true if and only if the starting instant of $arg1 is greater than the starting instant of $arg2. Returns false otherwise.
public static final FuncDef T_EQ
op:time-equal($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
Returns true if and only if the value of $arg1 converted to an xs:dateTime using the date components from the reference xs:dateTime is equal to the value of $arg2 converted to an xs:dateTime using the date components from the same reference xs:dateTime. Returns false otherwise.
public static final FuncDef T_LT
op:time-less-than($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
Returns true if and only if the value of $arg1 converted to an xs:dateTime using the date components from the reference xs:dateTime is less than the normalized value of $arg2 converted to an xs:dateTime using the date components from the same reference xs:dateTime. Returns false otherwise.
public static final FuncDef T_GT
op:time-greater-than($arg1 as xs:time, $arg2 as xs:time) as xs:boolean
Returns true if and only if the value of $arg1 converted to an xs:dateTime using the date components from the reference xs:dateTime is greater than the value of $arg2 converted to an xs:dateTime using the date components from the same reference xs:dateTime. Returns false otherwise.
public static final FuncDef GYM_EQ
op:gYearMonth-equal( $arg1 as xs:gYearMonth, $arg2 as xs:gYearMonth) as xs:boolean
Returns true if and only if the xs:dateTimes representing the starting instants of $arg1 and $arg2 compare equal. The starting instants of $arg1 and $arg2 are calculated by adding the missing components of $arg1 and $arg2 from the xs:dateTime template xxxx-xx-ddT00:00:00 where dd represents the last day of the month component in $arg1 or $arg2. Returns false otherwise.
public static final FuncDef GY_EQ
op:gYear-equal($arg1 as xs:gYear, $arg2 as xs:gYear) as xs:boolean
Returns true if and only if the xs:dateTimes representing the starting instants of $arg1 and $arg2 compare equal. The starting instants of $arg1 and $arg2 are calculated by adding the missing components of $arg1 and $arg2 from a xs:dateTime template such as xxxx-01-01T00:00:00. Returns false otherwise.
public static final FuncDef GMD_EQ
op:gMonthDay-equal($arg1 as xs:gMonthDay, $arg2 as xs:gMonthDay) as xs:boolean
Returns true if and only if the xs:dateTimes representing the starting instants of equivalent occurrences of $arg1 and $arg2 compare equal. The starting instants of equivalent occurrences of $arg1 and $arg2 are calculated by adding the missing components of $arg1 and $arg2 from an xs:dateTime template such as 1972-xx-xxT00:00:00. Returns false otherwise.
public static final FuncDef GM_EQ
op:gMonth-equal($arg1 as xs:gMonth, $arg2 as xs:gMonth) as xs:boolean
Returns true if and only if the xs:dateTimes representing the starting instants of equivalent occurrences of $arg1 and $arg2 compare equal. The starting instants of equivalent occurrences of $arg1 and $arg2 are calculated by adding the missing components of $arg1 and $arg2 from an xs:dateTime template such as 1972-xx-ddT00:00:00 where dd represents the last day of the month component in $arg1 or $arg2. Returns false otherwise.
public static final FuncDef GD_EQ
op:gDay-equal($arg1 as xs:gDay, $arg2 as xs:gDay) as xs:boolean
Returns true if and only if the xs:dateTimes representing the starting instants of equivalent occurrences of $arg1 and $arg2 compare equal. The starting instants of equivalent occurrences of $arg1 and $arg2 are calculated by adding the missing components of $arg1 and $arg2 from an xs:dateTime template such as 1972-12-xxT00:00:00. Returns false otherwise.
public static final FuncDef MON_FROM_DUR
fn:months-from-duration($arg as xs:duration?) as xs:integer?
Returns an xs:integer representing the months component in the value of $arg. The result is obtained by casting $arg to an xs:yearMonthDuration (see 17.1.4 Casting to duration types) and then computing the months component as described in 10.3.1.3 Canonical representation.
public static final FuncDef YEAR_FROM_DUR
fn:years-from-duration($arg as xs:duration?) as xs:integer?
Returns an xs:integer representing the years component in the value of $arg. The result is obtained by casting $arg to an xs:yearMonthDuration (see 17.1.4 Casting to duration types) and then computing the years component as described in 10.3.1.3 Canonical representation.
public static final FuncDef DAYS_FROM_DUR
fn:days-from-duration($arg as xs:duration?) as xs:integer?
Returns an xs:integer representing the days component in the value of $arg. The result is obtained by casting $arg to an xs:dayTimeDuration (see 17.1.4 Casting to duration types) and then computing the days component as described in 10.3.2.3 Canonical representation.
public static final FuncDef HOURS_FROM_DUR
fn:hours-from-duration($arg as xs:duration?) as xs:integer?
Returns an xs:integer representing the hours component in the value of $arg. The result is obtained by casting $arg to an xs:dayTimeDuration (see 17.1.4 Casting to duration types) and then computing the hours component as described in 10.3.2.3 Canonical representation.
public static final FuncDef MIN_FROM_DUR
fn:minutes-from-duration($arg as xs:duration?) as xs:integer?
Returns an xs:integer representing the minutes component in the value of $arg. The result is obtained by casting $arg to an xs:dayTimeDuration (see 17.1.4 Casting to duration types) and then computing the minutes component as described in 10.3.2.3 Canonical representation.
public static final FuncDef SEC_FROM_DUR
fn:seconds-from-duration($arg as xs:duration?) as xs:decimal?
Returns an xs:decimal representing the seconds component in the value of $arg. The result is obtained by casting $arg to an xs:dayTimeDuration (see 17.1.4 Casting to duration types) and then computing the seconds component as described in 10.3.2.3 Canonical representation.
public static final FuncDef YEAR_FROM_DT
fn:year-from-dateTime($arg as xs:dateTime?) as xs:integer?
Returns an xs:integer representing the year component in the localized value of $arg. The result may be negative.
public static final FuncDef MON_FROM_DT
fn:month-from-dateTime($arg as xs:dateTime?) as xs:integer?
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
public static final FuncDef DAY_FROM_DT
fn:day-from-dateTime($arg as xs:dateTime?) as xs:integer?
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
public static final FuncDef HOURS_FROM_DT
fn:hours-from-dateTime($arg as xs:dateTime?) as xs:integer?
Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg.
public static final FuncDef MIN_FROM_DT
fn:minutes-from-dateTime($arg as xs:dateTime?) as xs:integer?
Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg.
public static final FuncDef SEC_FROM_DT
fn:seconds-from-dateTime($arg as xs:dateTime?) as xs:decimal?
Returns an xs:decimal value greater than or equal to zero and less than 60, representing the seconds and fractional seconds in the localized value of $arg.
public static final FuncDef TZ_FROM_DT
fn:timezone-from-dateTime($arg as xs:dateTime?) as xs:dayTimeDuration?
Returns the timezone component of $arg if any. If $arg has a timezone component, then the result is an xs:dayTimeDuration that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
public static final FuncDef YEAR_FROM_DATE
fn:year-from-date($arg as xs:date?) as xs:integer?
Returns an xs:integer representing the year in the localized value of $arg. The value may be negative.
public static final FuncDef MON_FROM_DATE
fn:month-from-date($arg as xs:date?) as xs:integer?
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
public static final FuncDef DAY_FROM_DATE
fn:day-from-date($arg as xs:date?) as xs:integer?
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
public static final FuncDef TZ_FROM_DATE
fn:timezone-from-date($arg as xs:date?) as xs:dayTimeDuration?
Returns the timezone component of $arg if any. If $arg has a timezone component, then the result is an xs:dayTimeDuration that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
public static final FuncDef HOURS_FROM_TIME
fn:hours-from-time($arg as xs:time?) as xs:integer?
Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
public static final FuncDef MIN_FROM_TIME
fn:minutes-from-time($arg as xs:time?) as xs:integer?
Returns an xs:integer value between 0 and 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
public static final FuncDef SEC_FROM_TIME
fn:seconds-from-time($arg as xs:time?) as xs:decimal?
Returns an xs:decimal value greater than or equal to zero and less than 60, representing the seconds and fractional seconds in the localized value of $arg.
public static final FuncDef TZ_FROM_TIME
fn:timezone-from-time($arg as xs:time?) as xs:dayTimeDuration?
Returns the timezone component of $arg if any. If $arg has a timezone component, then the result is an xs:dayTimeDuration that indicates deviation from UTC; its value may range from +14:00 to -14:00 hours, both inclusive. Otherwise, the result is the empty sequence.
public static final FuncDef ADD_YMD
op:add-yearMonthDurations( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as xs:yearMonthDuration
Returns the result of adding the value of $arg1 to the value of $arg2. Backs up the "+" operator on xs:yearMonthDuration values.
public static final FuncDef SUB_YMD
op:subtract-yearMonthDurations( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as xs:yearMonthDuration
Returns the result of subtracting the value of $arg2 from the value of $arg1. Backs up the "-" operator on xs:yearMonthDuration values.
public static final FuncDef MUL_YMD
op:multiply-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as xs:double) as xs:yearMonthDuration
Returns the result of multiplying the value of $arg1 by $arg2. The result is rounded to the nearest month. For a value v, 0 <= v < 0.5 rounds to 0; 0.5 <= v < 1.0 rounds to 1.
public static final FuncDef DIV_YMD
op:divide-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as xs:double) as xs:yearMonthDuration
Returns the result of dividing the value of $arg1 by $arg2. The result is rounded to the nearest month. For a value v, 0 <= v < 0.5 rounds to 0; 0.5 <= v < 1.0 rounds to 1.
public static final FuncDef DIV_YMD_BY_YMD
op:divide-yearMonthDuration-by-yearMonthDuration( $arg1 as xs:yearMonthDuration, $arg2 as xs:yearMonthDuration) as xs:decimal
Returns the result of dividing the value of $arg1 by $arg2. Since the values of both operands are integers, the semantics of the division is identical to /**
op:numeric-divide with xs:integer operands.
public static final FuncDef ADD_DTD
op:add-dayTimeDurations( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as xs:dayTimeDuration
Returns the result of adding the value of $arg1 to the value of $arg2. Backs up the "+" operator on xs:dayTimeDuration values.
public static final FuncDef SUB_DTD
op:subtract-dayTimeDurations( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as xs:dayTimeDuration
Returns the result of subtracting the value of $arg2 from the value of $arg1. Backs up the "-" operator on xs:dayTimeDuration values.
public static final FuncDef MUL_DTD
op:multiply-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as xs:double) as xs:dayTimeDuration
Returns the result of multiplying the value of $arg1 by $arg2.
public static final FuncDef DIV_DTD
op:divide-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as xs:double) as xs:dayTimeDuration
Returns the result of dividing the value of $arg1 by $arg2.
public static final FuncDef DIV_DTD_BY_DTD
op:divide-dayTimeDuration-by-dayTimeDuration( $arg1 as xs:dayTimeDuration, $arg2 as xs:dayTimeDuration) as xs:decimal
Returns the result of dividing the value of $arg1 by $arg2. Since the values of both operands are decimals, the semantics of the division is identical to op:numeric-divide with xs:decimal operands.
public static final FuncDef ADJUST_DT2TZ
fn:adjust-dateTime-to-timezone($arg as xs:dateTime?) as xs:dateTime?
fn:adjust-dateTime-to-timezone( $arg as xs:dateTime?, $timezone as xs:dayTimeDuration?) as xs:dateTime?
Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all. If $timezone is the empty sequence, returns an xs:dateTime without a timezone. Otherwise, returns an xs:dateTime with a timezone.
public static final FuncDef ADJUST_DATE2TZ
fn:adjust-date-to-timezone($arg as xs:date?) as xs:date?
fn:adjust-date-to-timezone( $arg as xs:date?, $timezone as xs:dayTimeDuration?) as xs:date?
Adjusts an xs:date value to a specific timezone, or to no timezone at all. If $timezone is the empty sequence, returns an xs:date without a timezone. Otherwise, returns an xs:date with a timezone. For purposes of timezone adjustment, an xs:date is treated as an xs:dateTime with time 00:00:00.
public static final FuncDef ADJUST_TIME2TZ
fn:adjust-time-to-timezone($arg as xs:time?) as xs:time?
fn:adjust-time-to-timezone( $arg as xs:time?, $timezone as xs:dayTimeDuration?) as xs:time?
Adjusts an xs:time value to a specific timezone, or to no timezone at all. If $timezone is the empty sequence, returns an xs:time without a timezone. Otherwise, returns an xs:time with a timezone.
public static final FuncDef SUB_DT
op:subtract-dateTimes( $arg1 as xs:dateTime, $arg2 as xs:dateTime) as xs:dayTimeDuration?
Returns the xs:dayTimeDuration that corresponds to the difference between the normalized value of $arg1 and the normalized value of $arg2. If either $arg1 or $arg2 do not contain an explicit timezone then, for the purpose of the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context ComponentsXP.) is assumed to be present as part of the value.
public static final FuncDef SUB_DATES
op:subtract-dates($arg1 as xs:date, $arg2 as xs:date) as xs:dayTimeDuration?
Returns the xs:dayTimeDuration that corresponds to the difference between the starting instant of $arg1 and the the starting instant of $arg2. If either $arg1 or $arg2 do not contain an explicit timezone then, for the purpose of the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context ComponentsXP.) is assumed to be present as part of the value.
public static final FuncDef SUB_TIMES
op:subtract-times($arg1 as xs:time, $arg2 as xs:time) as xs:dayTimeDuration
Returns the xs:dayTimeDuration that corresponds to the difference between the value of $arg1 converted to an xs:dateTime using the date components from the reference xs:dateTime and the value of $arg2 converted to an xs:dateTime using the date components from the same reference xs:dateTime . If either $arg1 or $arg2 do not contain an explicit timezone then, for the purpose of the operation, the implicit timezone provided by the dynamic context (See Section C.2 Dynamic Context ComponentsXP.) is assumed to be present as part of the value.
public static final FuncDef ADD_YMD2DT
op:add-yearMonthDuration-to-dateTime( $arg1 as xs:dateTime, $arg2 as xs:yearMonthDuration) as xs:dateTime
Returns the xs:dateTime computed by adding $arg2 to the value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2 is negative, then the result xs:dateTime precedes $arg1.
public static final FuncDef ADD_DTD2DT
op:add-dayTimeDuration-to-dateTime( $arg1 as xs:dateTime, $arg2 as xs:dayTimeDuration) as xs:dateTime
Returns the xs:dateTime computed by adding $arg2 to the value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2 is negative, then the result xs:dateTime precedes $arg1.
public static final FuncDef SUB_YMD_FROM_DT
op:subtract-yearMonthDuration-from-dateTime( $arg1 as xs:dateTime, $arg2 as xs:yearMonthDuration) as xs:dateTime
Returns the xs:dateTime computed by negating $arg2 and adding the result to the value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2 is negative, then the xs:dateTime returned follows $arg1.
public static final FuncDef SUB_DTD_FROM_DT
op:subtract-dayTimeDuration-from-dateTime( $arg1 as xs:dateTime, $arg2 as xs:dayTimeDuration) as xs:dateTime
Returns the xs:dateTime computed by negating $arg2 and adding the result to the value of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] disregarding the rule about leap seconds. If $arg2 is negative, then the xs:dateTime returned follows $arg1.
public static final FuncDef ADD_YMD2DATE
op:add-yearMonthDuration-to-date( $arg1 as xs:date, $arg2 as xs:yearMonthDuration) as xs:date
Returns the xs:date computed by adding $arg2 to the starting instant of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime. If $arg2 is negative, then the xs:date returned precedes $arg1.
public static final FuncDef ADD_DTD2DATE
op:add-dayTimeDuration-to-date( $arg1 as xs:date, $arg2 as xs:dayTimeDuration) as xs:date
Returns the xs:date computed by adding $arg2 to the starting instant of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime. If $arg2 is negative, then the xs:date returned precedes $arg1.
public static final FuncDef SUB_YMD_FROM_DATE
op:subtract-yearMonthDuration-from-date( $arg1 as xs:date, $arg2 as xs:yearMonthDuration) as xs:date
Returns the xs:date computed by negating $arg2 and adding the result to the starting instant of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime. If $arg2 is positive, then the xs:date returned precedes $arg1.
public static final FuncDef SUB_DTD_FROM_DATE
op:subtract-dayTimeDuration-from-date( $arg1 as xs:date, $arg2 as xs:dayTimeDuration) as xs:date
Returns the xs:date computed by negating $arg2 and adding the result to the starting instant of $arg1 using the algorithm described in Appendix E of [XML Schema Part 2: Datatypes Second Edition] and discarding the time components from the resulting xs:dateTime. If $arg2 is positive, then the xs:date returned precedes $arg1.
public static final FuncDef ADD_DTD2TIME
op:add-dayTimeDuration-to-time( $arg1 as xs:time, $arg2 as xs:dayTimeDuration) as xs:time
First, the days component in the canonical lexical representation of $arg2 is set to zero (0) and the value of the resulting xs:dayTimeDuration is calculated. Alternatively, the value of $arg2 modulus 86,400 is used as the second argument. This value is added to the value of $arg1 converted to an xs:dateTime using a reference date such as 1972-12-31 and the time components of the result returned. Note that the xs:time returned may occur in a following or preceding day and may be less than $arg1.
public static final FuncDef SUB_DTD_FROM_TIME
op:subtract-dayTimeDuration-from-time( $arg1 as xs:time, $arg2 as xs:dayTimeDuration) as xs:time
The result is calculated by first setting the day component in the canonical lexical representation of $arg2 to zero (0) and calculating the value of the resulting xs:dayTimeDuration. Alternatively, the value of $arg2 modulus 86,400 is used as the second argument. This value is subtracted from the value of $arg1 converted to an xs:dateTime using a reference date such as 1972-12-31 and the time components of the result are returned. Note that the xs:time returned may occur in a preceding or following day and may be greater than $arg1.
public static final FuncDef RESOLVE_QNAME
fn:resolve-QName($qname as xs:string?, $element as element()) as xs:QName?
Returns an xs:QName value (that is, an expanded-QName) by taking an xs:string that has the lexical form of an xs:QName (a string in the form "prefix:local-name" or "local-name") and resolving it using the in-scope namespaces for a given element.
public static final FuncDef QNAME
fn:QName($argumentsURI as xs:string?, $argumentsQName as xs:string) as xs:QName
Returns an xs:QName with the namespace URI given in $argumentsURI. If $argumentsURI is the zero-length string or the empty sequence, it represents "no namespace"; in this case, if the value of $argumentsQName contains a colon (:), an error is raised [err:FOCA0002]. The prefix (or absence of a prefix) in $argumentsQName is retained in the returned xs:QName value. The local name in the result is taken from the local part of $argumentsQName.
public static final FuncDef QNAME_EQ
op:QName-equal($arg1 as xs:QName, $arg2 as xs:QName) as xs:boolean
Returns true if the namespace URIs of $arg1 and $arg2 are equal and the local names of $arg1 and $arg2 are identical based on the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint). Otherwise, returns false. Two namespace URIs are considered equal if they are either both absent or both present and identical based on the Unicode code point collation. The prefix mParts of $arg1 and $arg2, if any, are ignored.
public static final FuncDef NS_URI_FROM_QNAME
fn:namespace-uri-from-QName($arg as xs:QName?) as xs:anyURI?
Returns the namespace URI for $arg as an xs:string. If $arg is the empty sequence, the empty sequence is returned. If $arg is in no namespace, the zero-length string is returned.
public static final FuncDef NS_URI4PREF
fn:namespace-uri-for-prefix( $prefix as xs:string?, $element as element()) as xs:anyURI?
Returns the namespace URI of one of the in-scope namespaces for $element, identified by its namespace prefix.
public static final FuncDef IN_SCOPE_PREF
fn:in-scope-prefixes($element as element()) as xs:string
Returns the prefixes of the in-scope namespaces for $element. For namespaces that have a prefix, it returns the prefix as an xs:NCName. For the default namespace, which has no prefix, it returns the zero-length string.
public static final FuncDef HEXBIN_EQ
op:hexBinary-equal( $value1 as xs:hexBinary, $value2 as xs:hexBinary) as xs:boolean
Returns true if $value1 and $value2 are of the same length, measured in binary octets, and contain the same octets in the same order. Otherwise, returns false.
public static final FuncDef BASE64BIN_EQ
op:base64Binary-equal( $value1 as xs:base64Binary, $value2 as xs:base64Binary) as xs:boolean
Returns true if $value1 and $value2 are of the same length, measured in binary octets, and contain the same octets in the same order. Otherwise, returns false.
public static final FuncDef NOTATION_EQ
op:NOTATION-equal($arg1 as xs:NOTATION, $arg2 as xs:NOTATION) as xs:boolean
Returns true if the namespace URIs of $arg1 and $arg2 are equal and the local names of $arg1 and $arg2 are identical based on the Unicode code point collation: http://www.w3.org/2005/xpath-functions/collation/codepoint. Otherwise, returns false. Two namespace URIs are considered equal if they are either both absent or both present and identical based on the Unicode code point collation. The prefix mParts of $arg1 and $arg2, if any, are ignored.
public static final FuncDef NAME
fn:name() as xs:string
fn:name($arg as node()?) as xs:string
Returns the name of a node, as an xs:string that is either the zero-length string, or has the lexical form of an xs:QName.
public static final FuncDef LOC_NAME
fn:local-name() as xs:string
fn:local-name($arg as node()?) as xs:string
Returns the local part of the name of $arg as an xs:string that will either be the zero-length string or will have the lexical form of an xs:NCName.
public static final FuncDef LOC_NAME_FROM_QNAME
fn:local-name-from-QName($arg as xs:QName?) as xs:NCName?
Returns an xs:NCName representing the local part of $arg. If $arg is the empty sequence, returns the empty sequence.
public static final FuncDef NS_URI
fn:namespace-uri() as xs:anyURI
fn:namespace-uri($arg as node()?) as xs:anyURI
Returns the namespace URI of the xs:QName of $arg.
public static final FuncDef NUMBER
fn:number() as xs:double fn:number($arg as xs:anyAtomicType?) as xs:double.
Returns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double
public static final FuncDef LANG
fn:lang($testlang as xs:string?) as xs:boolean
fn:lang($testlang as xs:string?, $node as node()) as xs:boolean
This function tests whether the language of $node, or the context item if the second argument is omitted, as specified by xml:lang attributes is the same as, or is a sublanguage of, the language specified by $testlang. The behavior of the function if the second argument is omitted is exactly the same as if the context item (.) had been passed as the second argument. The language of the argument node, or the context item if the second argument is omitted, is determined by the value of the xml:lang attribute on the node, or, if the node has no such attribute, by the value of the xml:lang attribute on the nearest ancestor of the node that has an xml:lang attribute. If there is no such ancestor, then the function returns false
public static final FuncDef IS_SAME_NODE
op:is-same-node($argumentseter1 as node(), $argumentseter2 as node()) as xs:boolean
If the node identified by the value of $argumentseter1 is the same node as the node identified by the value of $argumentseter2 (that is, the two nodes have the same identity), then the function returns true; otherwise, the function returns false. This function backs up the "is" operator on nodes.
public static final FuncDef NODE_BEFORE
op:node-before($argumentseter1 as node(), $argumentseter2 as node()) as xs:boolean
If the node identified by the value of $argumentseter1 occurs in document order before the node identified by the value of $argumentseter2, this function returns true; otherwise, it returns false. The rules determining the order of nodes within a single document and in different documents can be found in Section 2.4 Document OrderDM. This function backs up the "<<" operator.
public static final FuncDef NODE_AFTER
op:node-after($argumentseter1 as node(), $argumentseter2 as node()) as xs:boolean
If the node identified by the value of $argumentseter1 occurs in document order after the node identified by the value of $argumentseter2, this function returns true; otherwise, it returns false. The rules determining the order of nodes within a single document and in different documents can be found in Section 2.4 Document OrderDM. This function backs up the ">>" operator.
public static final FuncDef INDEX_OF
fn:index-of( $seqarguments as xs:anyAtomicType*, $srcharguments as xs:anyAtomicType) as xs:integer*
fn:index-of( $seqarguments as xs:anyAtomicType*, $srcharguments as xs:anyAtomicType, $collation as xs:string) as xs:integer*
Returns a sequence of positive integers giving the positions within the sequence $seqarguments of items that are equal to $srcharguments.
public static final FuncDef EMPTY
fn:empty($arg as item()*) as xs:boolean
If the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false.
public static final FuncDef EXISTES
fn:exists($arg as item()*) as xs:boolean
If the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false.
public static final FuncDef DIST_VALUES
fn:distinct-values($arg as xs:anyAtomicType*) as xs:anyAtomicType
fn:distinct-values( $arg as xs:anyAtomicType*, $collation as xs:string) as xs:anyAtomicType*
Returns the sequence that results from removing from $arg all but one of a set of values that are eq to one other. Values of type xs:untypedAtomic are compared as if they were of type xs:string. Values that cannot be compared, i.e. the eq operator is not defined for their types, are considered to be distinct. The order in which the sequence of values is returned is �implementation dependent�.
public static final FuncDef DEEP_EQ
fn:deep-equal($argumentseter1 as item()*, $argumentseter2 as item()*) as xs:boolean
fn:deep-equal( $argumentseter1 as item()*, $argumentseter2 as item()*, $collation as string) as xs:boolean
This function assesses whether two sequences are deep-equal to each other. To be deep-equal, they must contain items that are pairwise deep-equal; and for two items to be deep-equal, they must either be atomic values that compare equal, or nodes of the same kind, with the same name, whose children are deep-equal. This is defined in more detail below. The $collation argument identifies a collation which is used at all levels of recursion when strings are compared (but not when names are compared), according to the rules in 7.3.1 Collations.
public static final FuncDef TO
op:to($firstval as xs:integer, $lastval as xs:integer) as xs:integer
Returns the sequence containing every xs:integer whose value is between the value of $firstval (inclusive) and the value of $lastval (inclusive), in monotonic order. If the value of the first operand is greater than the value of the second, the empty sequence is returned. If the values of the two operands are equal, a sequence containing a single xs:integer equal to the value is returned.
public static final FuncDef DOC_AVAILABLE
fn:doc-available($uri as xs:string?) as xs:boolean
If fn:doc($uri) returns a document node, this function returns true. If $uri is not a valid xs:anyURI, an error is raised [err:FODC0005]. Otherwise, this function returns false.
public static final FuncDef POS
fn:position() as xs:integer
Returns the context position from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) If the context item is undefined, an error is raised: [err:XPDY0002]XP.
public static final FuncDef LAST
fn:last() as xs:integer
Returns the context size from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) If the context item is undefined, an error is raised: [err:XPDY0002]XP.
public static final FuncDef CURRENT_DT
fn:current-dateTime() as xs:dateTime
Returns the current dateTime (with timezone) from the dynamic context. (See Section C.2 Dynamic Context ComponentsXP.) This is an xs:dateTime that is current at some time during the evaluation of a query or transformation in which fn:current-dateTime() is executed. This function is �stable�. The precise instant during the query or transformation represented by the value of fn:current-dateTime() is �implementation dependent�.
public static final FuncDef CURRENT_DATE
fn:current-date() as xs:date
Returns xs:date(fn:current-dateTime()). This is an xs:date (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-date() is executed. This function is �stable�. The precise instant during the query or transformation represented by the value of fn:current-date() is �implementation dependent�.
public static final FuncDef CURRENT_TIME
fn:current-time() as xs:time
Returns xs:time(fn:current-dateTime()). This is an xs:time (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-time() is executed. This function is �stable�. The precise instant during the query or transformation represented by the value of fn:current-time() is �implementation dependent�.
public static final FuncDef IMPLICIT_TZ
fn:implicit-timezone() as xs:dayTimeDuration
Returns the value of the implicit timezone property from the dynamic context. Components of the dynamic context are discussed in Section C.2 Dynamic Context ComponentsXP.
public static final FuncDef DEFAULT_COLL
fn:default-collation() as xs:string
Returns the value of the default collation property from the static context. Components of the static context are discussed in Section C.1 Static Context ComponentsXP.
public static final FuncDef STATIC_BASE_URI
fn:static-base-uri() as xs:anyURI?
Returns the value of the Base URI property from the static context. If the Base URI property is undefined, the empty sequence is returned. Components of the static context are discussed in Section C.1 Static Context ComponentsXP .
public static FuncDef[] values()
for (FuncDef c : FuncDef.values()) System.out.println(c);
public static FuncDef valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant
with the specified nameNullPointerException
- if the argument is nullpublic Class<? extends AbsFunction> getFunc()
public int getMin()
public int getMax()
public String getReturnType()
Copyright © 2013. All Rights Reserved.