Package org.ucl.xpath.function

Interface Summary
CmpEq Class for compare for equal function.
CmpGt Class for compare for greater than operation.
CmpLt Class for compare for less than operation.
MathDiv Support for Mathematical division.
MathIDiv Support for Mathematical Integer Division.
MathMinus Support for Mathematical Subtraction.
MathMod Support for Mathematical Modular operation.
MathPlus Support for Mathematical Addition.
MathTimes Support for Mathematical Multiplication.
 

Class Summary
Constructor Constructor class for functions.
ConstructorFL Constructor class for the functions library.
FnAbs Returns the absolute value of $arg.
FnAvg Returns the average of the values in the input sequence $arg, that is, the sum of the values divided by the number of values.
FnBaseUri Returns the value of the base-uri property for $arg as defined by the accessor function dm:base-uri() for that kind of node in Section 5.1 base-uri Accessor of the specification.
FnBoolean Computes the effective boolean value of the sequence $arg.
FnCeiling Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of $arg.
FnCodepointsToString Creates an xs:string from a sequence of code points.
FnCompare String comparison function.
FnConcat Sequence concatenation function.
FnContains 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.
FnCount Returns the number of items in the value of $arg.
FnCurrentDate Returns xs:date(fn:current-dateTime()).
FnCurrentDateTime Returns the xs:dateTime (with timezone) from the dynamic context.
FnCurrentTime Returns xs:time(fn:current-dateTime()).
FnData fn:data takes a sequence of items and returns a sequence of atomic values.
FnDayFromDate Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
FnDayFromDateTime Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
FnDaysFromDuration Returns an xs:integer representing the days component in the canonical lexical representation of the value of $arg.
FnDeepEqual The function assesses whether two sequences are deep-equal to each other.
FnDistinctValues Returns the sequence that results from removing from $arg all but one of a set of values that are eq to one other.
FnDoc Retrieves a document using an xs:anyURI supplied as an xs:string.
FnDocumentUri 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.
FnEmpty If the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false.
FnEndsWith 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 M$arg2 according to the collation that is used.
FnError The fn:error function causes the evaluation of the outermost XQuery or transformation to stop.
FnEscapeUri Function to apply URI escaping rules.
FnExactlyOne Returns $arg if it contains exactly one item.
FnExists If the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false.
FnFalse Returns the xs:boolean value false.
FnFloor Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg.
FnFunctionLibrary Maintains a library of core functions and user defined functions.
FnHoursFromDateTime Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg.
FnHoursFromDuration Returns an xs:integer representing the hours component in the canonical lexical representation of the value of $arg.
FnHoursFromTime Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
FnImplicitTimezone Returns the value of the implicit timezone property from the dynamic context.
FnIndexOf Returns a sequence of positive integers giving the positions within the sequence $seqParam of items that are equal to $srchParam.
FnInsertBefore Returns a new sequence constructed from the value of $target with the value of $inserts inserted at the position specified by the value of $position.
FnLang This function tests whether the language of $node, or the context node 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.
FnLast Returns an xs:integer indicating the number of items in the sequence of items currently being processed.
FnLocalName 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.
FnLocalNameFromQName Returns an xs:NCNAME representing the local part of $arg.
FnLowerCase Conversion to lower-case function.
FnMatches 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.
FnMax 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.
FnMin 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.
FnMinutesFromDateTime Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg.
FnMinutesFromDuration Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of $arg.
FnMinutesFromTime Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
FnMonthFromDate Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
FnMonthFromDateTime Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
FnMonthsFromDuration Returns an xs:integer representing the months component in the canonical lexical representation of the value of $arg.
FnName 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.
FnNamespaceUri Returns the namespace URI of the xs:QName of $arg.
FnNamespaceUriFromQName Returns the namespace URI for $arg as an xs:string.
FnNilled Returns an xs:boolean indicating whether the argument node is "nilled".
FnNodeName Returns an expanded-QName for node kinds that can have names.
FnNormalizeSpace Function to normalize whitespace.
FnNot $arg is first reduced to an effective boolean value by applying the fn:boolean() function.
FnNumber Returns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double.
FnOneOrMore Returns $arg if it contains one or more items.
FnPosition Returns an xs:integer indicating the position of the context item within the sequence of items currently being processed.
FnQName Returns an xs:QName with the namespace URI given in $paramURI.
FnRemove Returns a new sequence constructed from the value of $target with the item at the position specified by the value of $position removed.
FnReplace 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.
FnResolveQName 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.
FnReverse Sequence reverse function.
FnRoot Returns the root of the tree to which $arg belongs.
FnRound Returns the number with no fractional part that is closest to the argument.
FnRoundHalfToEven The value returned is the nearest (that is, numerically closest) numeric to $arg that is a multiple of ten to the power of minus $precision.
FnSecondsFromDateTime Returns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of $arg.
FnSecondsFromDuration Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of $arg.
FnSecondsFromTime Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.
FnStartsWith 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.
FnStaticBaseUri Returns the value of the base-uri property from the static context.
FnString Returns the value of $arg represented as a xs:string.
FnStringJoin Function to join strings together.
FnStringLength Function to calculate string length.
FnStringToCodepoints Returns the sequence of code points that constitute an xs:string.
FnSubsequence Returns the contiguous sequence of items in the value of $sourceSeq beginning at the position indicated by the value of $startingLoc and continuing for the number of items indicated by the value of $length.
FnSubstring Function to obtain a substring from a string.
FnSubstringAfter 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.
FnSubstringBefore 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.
FnSum Returns a value obtained by adding together the values in $arg.
FnTimezoneFromDate Returns the timezone component of $arg if any.
FnTimezoneFromDateTime Returns the timezone component of $arg if any.
FnTimezoneFromTime Returns the timezone component of $arg if any.
FnTokenize This function breaks the $input string into a sequence of strings, treating any substring that matches $pattern as a separator.
FnTrace The input $value is returned, unchanged, as the result of the function.
FnTranslate Translation function.
FnTrue Returns the xs:boolean value true.
FnUnordered Returns the items of $sourceSeq in a non-deterministic order.
FnUpperCase Conversion to upper-case function.
FnYearFromDate Returns an xs:integer representing the year in the localized value of $arg.
FnYearFromDateTime Returns an xs:integer representing the year component in the localized value of $arg.
FnYearsFromDuration Returns an xs:integer representing the years component in the canonical lexical representation of the value of $arg.
FnZeroOrOne Returns $arg if it contains zero or one items.
FsConvertOperand Function to convert a sequence of items to a sequence of atomic values.
FsDiv Class for the Division function.
FsEq Class for the Equality function.
FsGe Class for the Greater than or equal to function.
FsGt Class for the Greater than function.
FsIDiv Class for Interger division function.
FsLe Class for Less than or equal to function.
FsLt Class for Less than function.
FsMinus Class for Minus function.
FsMod Class for Modular function.
FsNe Class for Not equal function.
FsPlus Class for Plus function.
FsTimes Class for Multiplication function.
Function Support for functions.
FunctionLibrary Class for Function Library support.
OpExcept Support for Except operation on node types.
OpFunctionLibrary Maintains a library of built-in operators as functions.
OpIntersect Support for Intersect operation.
OpTo Support for To operation.
OpUnion Support for Union operation.
XDTCtrLibrary Data Types control library support.
XSCtrLibrary XML Schema control library support.