com.marklogic.client.expression.FnExpr Maven / Gradle / Ivy
Show all versions of marklogic-client-api Show documentation
/*
* Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
*/
package com.marklogic.client.expression;
import com.marklogic.client.type.XsAnyAtomicTypeSeqVal;
import com.marklogic.client.type.XsAnyAtomicTypeVal;
import com.marklogic.client.type.XsAnyURIVal;
import com.marklogic.client.type.XsBooleanVal;
import com.marklogic.client.type.XsDateTimeVal;
import com.marklogic.client.type.XsDateVal;
import com.marklogic.client.type.XsDayTimeDurationVal;
import com.marklogic.client.type.XsDecimalVal;
import com.marklogic.client.type.XsDoubleVal;
import com.marklogic.client.type.XsDurationVal;
import com.marklogic.client.type.XsIntegerSeqVal;
import com.marklogic.client.type.XsIntegerVal;
import com.marklogic.client.type.XsQNameVal;
import com.marklogic.client.type.XsStringSeqVal;
import com.marklogic.client.type.XsStringVal;
import com.marklogic.client.type.XsTimeVal;
import com.marklogic.client.type.ServerExpression;
// IMPORTANT: Do not edit. This file is generated.
/**
* Builds expressions to call functions in the fn server library for a row
* pipeline.
*/
public interface FnExpr {
/**
* Returns the absolute value of arg. If arg is negative returns -arg otherwise returns arg. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
*
*
* Provides a client interface to the fn:abs server function.
* @param arg A numeric value. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression abs(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:adjust-date-to-timezone server function.
* @param arg The date to adjust to the new timezone. (of xs:date)
* @return a server expression with the xs:date server data type
*/
public ServerExpression adjustDateToTimezone(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:adjust-date-to-timezone server function.
* @param arg The date to adjust to the new timezone. (of xs:date)
* @param timezone The new timezone for the date. (of xs:dayTimeDuration)
* @return a server expression with the xs:date server data type
*/
public ServerExpression adjustDateToTimezone(ServerExpression arg, String timezone);
/**
* 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.
*
* Provides a client interface to the fn:adjust-date-to-timezone server function.
* @param arg The date to adjust to the new timezone. (of xs:date)
* @param timezone The new timezone for the date. (of xs:dayTimeDuration)
* @return a server expression with the xs:date server data type
*/
public ServerExpression adjustDateToTimezone(ServerExpression arg, ServerExpression timezone);
/**
* 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.
*
*
*
* Provides a client interface to the fn:adjust-dateTime-to-timezone server function.
* @param arg The dateTime to adjust to the new timezone. (of xs:dateTime)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression adjustDateTimeToTimezone(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:adjust-dateTime-to-timezone server function.
* @param arg The dateTime to adjust to the new timezone. (of xs:dateTime)
* @param timezone The new timezone for the dateTime. (of xs:dayTimeDuration)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression adjustDateTimeToTimezone(ServerExpression arg, String timezone);
/**
* 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.
*
* Provides a client interface to the fn:adjust-dateTime-to-timezone server function.
* @param arg The dateTime to adjust to the new timezone. (of xs:dateTime)
* @param timezone The new timezone for the dateTime. (of xs:dayTimeDuration)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression adjustDateTimeToTimezone(ServerExpression arg, ServerExpression timezone);
/**
* 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.
*
*
*
* Provides a client interface to the fn:adjust-time-to-timezone server function.
* @param arg The time to adjust to the new timezone. (of xs:time)
* @return a server expression with the xs:time server data type
*/
public ServerExpression adjustTimeToTimezone(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:adjust-time-to-timezone server function.
* @param arg The time to adjust to the new timezone. (of xs:time)
* @param timezone The new timezone for the date. (of xs:dayTimeDuration)
* @return a server expression with the xs:time server data type
*/
public ServerExpression adjustTimeToTimezone(ServerExpression arg, String timezone);
/**
* 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.
*
* Provides a client interface to the fn:adjust-time-to-timezone server function.
* @param arg The time to adjust to the new timezone. (of xs:time)
* @param timezone The new timezone for the date. (of xs:dayTimeDuration)
* @return a server expression with the xs:time server data type
*/
public ServerExpression adjustTimeToTimezone(ServerExpression arg, ServerExpression timezone);
/**
* The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
*
* Provides a client interface to the fn:analyze-string server function.
* @param in The string to start with. (of xs:string)
* @param regex The regular expression pattern to match. (of xs:string)
* @return a server expression with the element-node server data type
*/
public ServerExpression analyzeString(String in, String regex);
/**
* The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
*
*
*
* Provides a client interface to the fn:analyze-string server function.
* @param in The string to start with. (of xs:string)
* @param regex The regular expression pattern to match. (of xs:string)
* @return a server expression with the element-node server data type
*/
public ServerExpression analyzeString(ServerExpression in, ServerExpression regex);
/**
* The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
*
* Provides a client interface to the fn:analyze-string server function.
* @param in The string to start with. (of xs:string)
* @param regex The regular expression pattern to match. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the element-node server data type
*/
public ServerExpression analyzeString(String in, String regex, String flags);
/**
* The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
*
* Provides a client interface to the fn:analyze-string server function.
* @param in The string to start with. (of xs:string)
* @param regex The regular expression pattern to match. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the element-node server data type
*/
public ServerExpression analyzeString(ServerExpression in, ServerExpression regex, ServerExpression flags);
/**
* Returns the average of the values in the input sequence arg, that is, the sum of the values divided by the number of values.
*
*
*
* Provides a client interface to the fn:avg server function.
* @param arg The sequence of values to average. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression avg(ServerExpression arg);
/**
* Returns the value of the base-uri property for the specified node. If the node is part of a document and does not have a base-uri attribute explicitly set, fn:base-uri typically returns the URI of the document in which the node resides.
*
*
*
* Provides a client interface to the fn:base-uri server function.
* @param arg The node whose base-uri is to be returned. (of node)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression baseUri(ServerExpression arg);
/**
* Computes the effective boolean value of the sequence arg. See Section 2.4.3 Effective Boolean Value[XP].
*
*
*
* Provides a client interface to the fn:boolean server function.
* @param arg A sequence of items. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression booleanExpr(ServerExpression arg);
/**
* Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of arg. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
*
*
* Provides a client interface to the fn:ceiling server function.
* @param arg A numeric value. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression ceiling(ServerExpression arg);
/**
* Returns true if the specified parameters are the same Unicode code point, otherwise returns false. The codepoints are compared according to the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint).
*
* Provides a client interface to the fn:codepoint-equal server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression codepointEqual(ServerExpression comparand1, String comparand2);
/**
* Returns true if the specified parameters are the same Unicode code point, otherwise returns false. The codepoints are compared according to the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint).
*
*
*
* Provides a client interface to the fn:codepoint-equal server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression codepointEqual(ServerExpression comparand1, ServerExpression comparand2);
/**
* Creates an xs:string from a sequence of Unicode 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.
*
*
*
* Provides a client interface to the fn:codepoints-to-string server function.
* @param arg A sequence of Unicode code points. (of xs:integer)
* @return a server expression with the xs:string server data type
*/
public ServerExpression codepointsToString(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:compare server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression compare(ServerExpression comparand1, String comparand2);
/**
* 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.
*
*
*
* Provides a client interface to the fn:compare server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression compare(ServerExpression comparand1, ServerExpression comparand2);
/**
* 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.
*
* Provides a client interface to the fn:compare server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression compare(ServerExpression comparand1, String comparand2, String collation);
/**
* 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.
*
* Provides a client interface to the fn:compare server function.
* @param comparand1 A string to be compared. (of xs:string)
* @param comparand2 A string to be compared. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression compare(ServerExpression comparand1, ServerExpression comparand2, ServerExpression collation);
/**
* Returns the xs:string that is the concatenation of the values of the specified parameters. Accepts two or more xs:anyAtomicType arguments and casts them to xs:string. If any of the parameters is the empty sequence, the parameter is treated as the zero-length string.
*
*
*
* Provides a client interface to the fn:concat server function.
* @param parameter1 A value. (of xs:anyAtomicType)
* @return a server expression with the xs:string server data type
*/
public ServerExpression concat(ServerExpression... parameter1);
/**
* Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:contains server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test for existence in the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression contains(ServerExpression parameter1, String parameter2);
/**
* Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
*
*
*
* Provides a client interface to the fn:contains server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test for existence in the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression contains(ServerExpression parameter1, ServerExpression parameter2);
/**
* Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:contains server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test for existence in the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression contains(ServerExpression parameter1, String parameter2, String collation);
/**
* Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:contains server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test for existence in the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression contains(ServerExpression parameter1, ServerExpression parameter2, ServerExpression collation);
/**
* Returns the number of items in the value of arg.
*
*
*
* Provides a client interface to the fn:count server function.
* @param arg The sequence of items to count. (of item)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression count(ServerExpression arg);
/**
* Returns the number of items in the value of arg.
*
* Provides a client interface to the fn:count server function.
* @param arg The sequence of items to count. (of item)
* @param maximum The maximum value of the count to return. MarkLogic Server will stop count when the $maximum value is reached and return the $maximum value. This is an extension to the W3C standard fn:count function. (of xs:double)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression count(ServerExpression arg, double maximum);
/**
* Returns the number of items in the value of arg.
*
* Provides a client interface to the fn:count server function.
* @param arg The sequence of items to count. (of item)
* @param maximum The maximum value of the count to return. MarkLogic Server will stop count when the $maximum value is reached and return the $maximum value. This is an extension to the W3C standard fn:count function. (of xs:double)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression count(ServerExpression arg, ServerExpression maximum);
/**
* 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*.
*
*
*
* Provides a client interface to the fn:current-date server function.
* @return a server expression with the xs:date server data type
*/
public ServerExpression currentDate();
/**
* Returns the current dateTime value (with timezone) from the dynamic context. (See Section C.2 Dynamic Context Components[XP].) 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*.
*
*
*
* Provides a client interface to the fn:current-dateTime server function.
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression currentDateTime();
/**
* 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*.
*
*
*
* Provides a client interface to the fn:current-time server function.
* @return a server expression with the xs:time server data type
*/
public ServerExpression currentTime();
/**
* Returns an xs:dateTime value created by combining an xs:date and an xs:time.
*
* Provides a client interface to the fn:dateTime server function.
* @param arg1 The date to be combined with the time argument. (of xs:date)
* @param arg2 The time to be combined with the date argument. (of xs:time)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression dateTime(ServerExpression arg1, String arg2);
/**
* Returns an xs:dateTime value created by combining an xs:date and an xs:time.
*
*
*
* Provides a client interface to the fn:dateTime server function.
* @param arg1 The date to be combined with the time argument. (of xs:date)
* @param arg2 The time to be combined with the date argument. (of xs:time)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression dateTime(ServerExpression arg1, ServerExpression arg2);
/**
* Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:day-from-date server function.
* @param arg The date whose day component will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression dayFromDate(ServerExpression arg);
/**
* Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:day-from-dateTime server function.
* @param arg The dateTime whose day component will be returned. (of xs:dateTime)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression dayFromDateTime(ServerExpression arg);
/**
* Returns an xs:integer representing the days component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:days-from-duration server function.
* @param arg The duration whose day component will be returned. (of xs:duration)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression daysFromDuration(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:deep-equal server function.
* @param parameter1 The first sequence of items, each item should be an atomic value or node. (of item)
* @param parameter2 The sequence of items to compare to the first sequence of items, again each item should be an atomic value or node. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression deepEqual(ServerExpression parameter1, ServerExpression parameter2);
/**
* 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.
*
* Provides a client interface to the fn:deep-equal server function.
* @param parameter1 The first sequence of items, each item should be an atomic value or node. (of item)
* @param parameter2 The sequence of items to compare to the first sequence of items, again each item should be an atomic value or node. (of item)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression deepEqual(ServerExpression parameter1, ServerExpression parameter2, String collation);
/**
* 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.
*
* Provides a client interface to the fn:deep-equal server function.
* @param parameter1 The first sequence of items, each item should be an atomic value or node. (of item)
* @param parameter2 The sequence of items to compare to the first sequence of items, again each item should be an atomic value or node. (of item)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression deepEqual(ServerExpression parameter1, ServerExpression parameter2, ServerExpression collation);
/**
* 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 Components[XP].
*
*
*
* Provides a client interface to the fn:default-collation server function.
* @return a server expression with the xs:string server data type
*/
public ServerExpression defaultCollation();
/**
* Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other. Values that cannot be compared, i.e. the eq operator is not defined for their types, are considered to be distinct. Values of type xs:untypedAtomic are compared as if they were of type xs:string. The order in which the sequence of values is returned is implementation dependent.
*
*
*
* Provides a client interface to the fn:distinct-values server function.
* @param arg A sequence of items. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression distinctValues(ServerExpression arg);
/**
* Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other. Values that cannot be compared, i.e. the eq operator is not defined for their types, are considered to be distinct. Values of type xs:untypedAtomic are compared as if they were of type xs:string. The order in which the sequence of values is returned is implementation dependent.
*
* Provides a client interface to the fn:distinct-values server function.
* @param arg A sequence of items. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression distinctValues(ServerExpression arg, String collation);
/**
* Returns the sequence that results from removing from arg all but one of a set of values that are eq to one other. Values that cannot be compared, i.e. the eq operator is not defined for their types, are considered to be distinct. Values of type xs:untypedAtomic are compared as if they were of type xs:string. The order in which the sequence of values is returned is implementation dependent.
*
* Provides a client interface to the fn:distinct-values server function.
* @param arg A sequence of items. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression distinctValues(ServerExpression arg, ServerExpression collation);
/**
* Returns the value of the document-uri property for the specified node. If the node is a document node, then the value returned is the URI of the document. If the node is not a document node, then fn:document-uri returns the empty sequence.
*
*
*
* Provides a client interface to the fn:document-uri server function.
* @param arg The node whose document-uri is to be returned. (of node)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression documentUri(ServerExpression arg);
/**
* If the value of arg is the empty sequence, the function returns true; otherwise, the function returns false.
*
*
*
* Provides a client interface to the fn:empty server function.
* @param arg A sequence to test. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression empty(ServerExpression arg);
/**
* Invertible function that escapes characters required to be escaped inside path segments of URIs.
*
*
*
* Provides a client interface to the fn:encode-for-uri server function.
* @param uriPart A string representing an unescaped URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression encodeForUri(ServerExpression uriPart);
/**
* Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:ends-with server function.
* @param parameter1 The parameter from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the end of the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression endsWith(ServerExpression parameter1, String parameter2);
/**
* Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
*
*
*
* Provides a client interface to the fn:ends-with server function.
* @param parameter1 The parameter from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the end of the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression endsWith(ServerExpression parameter1, ServerExpression parameter2);
/**
* Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:ends-with server function.
* @param parameter1 The parameter from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the end of the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression endsWith(ServerExpression parameter1, String parameter2, String collation);
/**
* Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:ends-with server function.
* @param parameter1 The parameter from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the end of the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression endsWith(ServerExpression parameter1, ServerExpression parameter2, ServerExpression collation);
/**
* %-escapes everything except printable ASCII characters.
*
*
*
* Provides a client interface to the fn:escape-html-uri server function.
* @param uriPart A string representing an unescaped URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression escapeHtmlUri(ServerExpression uriPart);
/**
* If the value of arg is not the empty sequence, the function returns true; otherwise, the function returns false.
*
*
*
* Provides a client interface to the fn:exists server function.
* @param arg A sequence to test. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression exists(ServerExpression arg);
/**
* Returns the xs:boolean value false. Equivalent to xs:boolean("0").
*
*
*
* Provides a client interface to the fn:false server function.
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression falseExpr();
/**
* Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of arg. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
*
*
* Provides a client interface to the fn:floor server function.
* @param arg A numeric value. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression floor(ServerExpression arg);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, String picture);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
*
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, ServerExpression picture);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, String picture, String language);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, ServerExpression picture, ServerExpression language);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, String picture, String language, String calendar);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, String picture, String language, String calendar, String country);
/**
* Returns a formatted date value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-date server function.
* @param value The given date $value that needs to be formatted. (of xs:date)
* @param picture The desired string representation of the given date $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the date $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDate(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar, ServerExpression country);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, String picture);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
*
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, ServerExpression picture);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, String picture, String language);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, ServerExpression picture, ServerExpression language);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, String picture, String language, String calendar);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, String picture, String language, String calendar, String country);
/**
* Returns a formatted dateTime value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-dateTime server function.
* @param value The given dateTime $value that needs to be formatted. (of xs:dateTime)
* @param picture The desired string representation of the given dateTime $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the dateTime $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatDateTime(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar, ServerExpression country);
/**
* Returns a formatted string representation of value argument based on the supplied picture. An optional decimal format name may also be supplied for interpretation of the picture string. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-number server function.
* @param value The given numeric $value that needs to be formatted. (of xs:numeric)
* @param picture The desired string representation of the given number $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the format-number picture string, see http://www.w3.org/TR/xslt20/#function-format-number. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture);
/**
* Returns a formatted string representation of value argument based on the supplied picture. An optional decimal format name may also be supplied for interpretation of the picture string. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
*
*
* Provides a client interface to the fn:format-number server function.
* @param value The given numeric $value that needs to be formatted. (of xs:numeric)
* @param picture The desired string representation of the given number $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the format-number picture string, see http://www.w3.org/TR/xslt20/#function-format-number. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture);
/**
* Returns a formatted string representation of value argument based on the supplied picture. An optional decimal format name may also be supplied for interpretation of the picture string. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-number server function.
* @param value The given numeric $value that needs to be formatted. (of xs:numeric)
* @param picture The desired string representation of the given number $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the format-number picture string, see http://www.w3.org/TR/xslt20/#function-format-number. (of xs:string)
* @param decimalFormatName Represents a named instruction. It is used to assign values to the variables mentioned above based on the picture string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String decimalFormatName);
/**
* Returns a formatted string representation of value argument based on the supplied picture. An optional decimal format name may also be supplied for interpretation of the picture string. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-number server function.
* @param value The given numeric $value that needs to be formatted. (of xs:numeric)
* @param picture The desired string representation of the given number $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the format-number picture string, see http://www.w3.org/TR/xslt20/#function-format-number. (of xs:string)
* @param decimalFormatName Represents a named instruction. It is used to assign values to the variables mentioned above based on the picture string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression decimalFormatName);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, String picture);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
*
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, ServerExpression picture);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, String picture, String language);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, ServerExpression picture, ServerExpression language);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, String picture, String language, String calendar);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, String picture, String language, String calendar, String country);
/**
* Returns a formatted time value based on the picture argument. This is an XSLT function, and it is available in XSLT, XQuery 1.0-ml, and Server-Side JavaScript.
*
* Provides a client interface to the fn:format-time server function.
* @param value The given time $value that needs to be formatted. (of xs:time)
* @param picture The desired string representation of the given time $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. (of xs:string)
* @param language The desired language for string representation of the time $value. (of xs:string)
* @param calendar The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used the specification to take into account country specific string representation. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatTime(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression calendar, ServerExpression country);
/**
* Returns a string that uniquely identifies a given node.
*
*
*
* Provides a client interface to the fn:generate-id server function.
* @param node The node whose ID will be generated. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression generateId(ServerExpression node);
/**
* Returns the first item in a sequence. For more details, see XPath 3.0 Functions and Operators.
*
*
*
* Provides a client interface to the fn:head server function.
* @param seq A sequence of items. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression head(ServerExpression seq);
/**
* Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:hours-from-dateTime server function.
* @param arg The dateTime whose hours component will be returned. (of xs:dateTime)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression hoursFromDateTime(ServerExpression arg);
/**
* Returns an xs:integer representing the hours component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:hours-from-duration server function.
* @param arg The duration whose hour component will be returned. (of xs:duration)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression hoursFromDuration(ServerExpression arg);
/**
* Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:hours-from-time server function.
* @param arg The time whose hours component will be returned. (of xs:time)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression hoursFromTime(ServerExpression arg);
/**
* 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 Components[XP].
*
*
*
* Provides a client interface to the fn:implicit-timezone server function.
* @return a server expression with the xs:dayTimeDuration server data type
*/
public ServerExpression implicitTimezone();
/**
* 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.
*
*
*
* Provides a client interface to the fn:in-scope-prefixes server function.
* @param element The element whose in-scope prefixes will be returned. (of element-node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression inScopePrefixes(ServerExpression element);
/**
* Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
*
* Provides a client interface to the fn:index-of server function.
* @param seqParam A sequence of values. (of xs:anyAtomicType)
* @param srchParam A value to find on the list. (of xs:anyAtomicType)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression indexOf(ServerExpression seqParam, String srchParam);
/**
* Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
*
*
*
* Provides a client interface to the fn:index-of server function.
* @param seqParam A sequence of values. (of xs:anyAtomicType)
* @param srchParam A value to find on the list. (of xs:anyAtomicType)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression indexOf(ServerExpression seqParam, ServerExpression srchParam);
/**
* Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
*
* Provides a client interface to the fn:index-of server function.
* @param seqParam A sequence of values. (of xs:anyAtomicType)
* @param srchParam A value to find on the list. (of xs:anyAtomicType)
* @param collationLiteral A collation identifier. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression indexOf(ServerExpression seqParam, String srchParam, String collationLiteral);
/**
* Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
*
* Provides a client interface to the fn:index-of server function.
* @param seqParam A sequence of values. (of xs:anyAtomicType)
* @param srchParam A value to find on the list. (of xs:anyAtomicType)
* @param collationLiteral A collation identifier. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression indexOf(ServerExpression seqParam, ServerExpression srchParam, ServerExpression collationLiteral);
/**
* 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. (The value of target is not affected by the sequence construction.)
*
* Provides a client interface to the fn:insert-before server function.
* @param target The sequence of items into which new items will be inserted. (of item)
* @param position The position in the target sequence at which the new items will be added. (of xs:integer)
* @param inserts The items to insert into the target sequence. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression insertBefore(ServerExpression target, long position, ServerExpression inserts);
/**
* 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. (The value of target is not affected by the sequence construction.)
*
*
*
* Provides a client interface to the fn:insert-before server function.
* @param target The sequence of items into which new items will be inserted. (of item)
* @param position The position in the target sequence at which the new items will be added. (of xs:integer)
* @param inserts The items to insert into the target sequence. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression insertBefore(ServerExpression target, ServerExpression position, ServerExpression inserts);
/**
* Idempotent function that escapes non-URI characters.
*
*
*
* Provides a client interface to the fn:iri-to-uri server function.
* @param uriPart A string representing an unescaped URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression iriToUri(ServerExpression uriPart);
/**
* 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. The language of the argument node, or the context node 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
*
*
*
* Provides a client interface to the fn:lang server function.
* @param testlang The language against which to test the node. (of xs:string)
* @param node The node to test. (of node)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression lang(ServerExpression testlang, ServerExpression node);
/**
* 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.
*
*
*
* Provides a client interface to the fn:local-name server function.
* @param arg The node whose local name is to be returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression localName(ServerExpression arg);
/**
* Returns an xs:NCName representing the local part of arg. If arg is the empty sequence, returns the empty sequence.
*
*
*
* Provides a client interface to the fn:local-name-from-QName server function.
* @param arg A qualified name. (of xs:QName)
* @return a server expression with the xs:NCName server data type
*/
public ServerExpression localNameFromQName(ServerExpression arg);
/**
* Returns the specified string converting all of the characters to lower-case characters. If a character does not have a corresponding lower-case character, then the original character is returned. The lower-case characters are determined using the Unicode Case Mappings.
*
*
*
* Provides a client interface to the fn:lower-case server function.
* @param string The string to convert. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression lowerCase(ServerExpression string);
/**
* Returns true if the specified input matches the specified pattern, otherwise returns false.
*
* Provides a client interface to the fn:matches server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The regular expression to match. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression matches(ServerExpression input, String pattern);
/**
* Returns true if the specified input matches the specified pattern, otherwise returns false.
*
*
*
* Provides a client interface to the fn:matches server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The regular expression to match. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression matches(ServerExpression input, ServerExpression pattern);
/**
* Returns true if the specified input matches the specified pattern, otherwise returns false.
*
* Provides a client interface to the fn:matches server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The regular expression to match. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression matches(ServerExpression input, String pattern, String flags);
/**
* Returns true if the specified input matches the specified pattern, otherwise returns false.
*
* Provides a client interface to the fn:matches server function.
* @param input The input from which to match. (of xs:string)
* @param pattern The regular expression to match. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression matches(ServerExpression input, ServerExpression pattern, ServerExpression flags);
/**
* 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.
*
*
*
* Provides a client interface to the fn:max server function.
* @param arg The sequence of values whose maximum will be returned. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression max(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:max server function.
* @param arg The sequence of values whose maximum will be returned. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression max(ServerExpression arg, String collation);
/**
* 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.
*
* Provides a client interface to the fn:max server function.
* @param arg The sequence of values whose maximum will be returned. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression max(ServerExpression arg, ServerExpression collation);
/**
* 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.
*
*
*
* Provides a client interface to the fn:min server function.
* @param arg The sequence of values whose minimum will be returned. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression min(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:min server function.
* @param arg The sequence of values whose minimum will be returned. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression min(ServerExpression arg, String collation);
/**
* 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.
*
* Provides a client interface to the fn:min server function.
* @param arg The sequence of values whose minimum will be returned. (of xs:anyAtomicType)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression min(ServerExpression arg, ServerExpression collation);
/**
* Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:minutes-from-dateTime server function.
* @param arg The dateTime whose minutes component will be returned. (of xs:dateTime)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression minutesFromDateTime(ServerExpression arg);
/**
* Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:minutes-from-duration server function.
* @param arg The duration whose minute component will be returned. (of xs:duration)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression minutesFromDuration(ServerExpression arg);
/**
* Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:minutes-from-time server function.
* @param arg The time whose minutes component will be returned. (of xs:time)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression minutesFromTime(ServerExpression arg);
/**
* Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:month-from-date server function.
* @param arg The date whose month component will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression monthFromDate(ServerExpression arg);
/**
* Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
*
*
*
* Provides a client interface to the fn:month-from-dateTime server function.
* @param arg The dateTime whose month component will be returned. (of xs:dateTime)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression monthFromDateTime(ServerExpression arg);
/**
* Returns an xs:integer representing the months component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:months-from-duration server function.
* @param arg The duration whose month component will be returned. (of xs:duration)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression monthsFromDuration(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:name server function.
* @param arg The node whose name is to be returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression name(ServerExpression arg);
/**
* Returns the namespace URI of the xs:QName of the node specified by arg.
*
*
*
* Provides a client interface to the fn:namespace-uri server function.
* @param arg The node whose namespace URI is to be returned. (of node)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression namespaceUri(ServerExpression arg);
/**
* Returns the namespace URI of one of the in-scope namespaces for element, identified by its namespace prefix.
*
*
*
* Provides a client interface to the fn:namespace-uri-for-prefix server function.
* @param prefix A namespace prefix to look up. (of xs:string)
* @param element An element node providing namespace context. (of element-node)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression namespaceUriForPrefix(ServerExpression prefix, ServerExpression element);
/**
* 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.
*
*
*
* Provides a client interface to the fn:namespace-uri-from-QName server function.
* @param arg A qualified name. (of xs:QName)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression namespaceUriFromQName(ServerExpression arg);
/**
* Summary: 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. For element nodes, true() is returned if the element is nilled, otherwise false().
*
*
*
* Provides a client interface to the fn:nilled server function.
* @param arg The node to test for nilled status. (of node)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression nilled(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:node-name server function.
* @param arg The node whose name is to be returned. (of node)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression nodeName(ServerExpression arg);
/**
* Returns the specified string with normalized whitespace, which strips off any leading or trailing whitespace and replaces any other sequences of more than one whitespace characters with a single space character (#x20).
*
*
*
* Provides a client interface to the fn:normalize-space server function.
* @param input The string from which to normalize whitespace. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression normalizeSpace(ServerExpression input);
/**
* Return the argument 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.
*
*
*
* Provides a client interface to the fn:normalize-unicode server function.
* @param arg The string to normalize. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression normalizeUnicode(ServerExpression arg);
/**
* Return the argument 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.
*
* Provides a client interface to the fn:normalize-unicode server function.
* @param arg The string to normalize. (of xs:string)
* @param normalizationForm The form under which to normalize the specified string: NFC, NFD, NFKC, or NFKD. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression normalizeUnicode(ServerExpression arg, String normalizationForm);
/**
* Return the argument 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.
*
* Provides a client interface to the fn:normalize-unicode server function.
* @param arg The string to normalize. (of xs:string)
* @param normalizationForm The form under which to normalize the specified string: NFC, NFD, NFKC, or NFKD. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression normalizeUnicode(ServerExpression arg, ServerExpression normalizationForm);
/**
* Returns true if the effective boolean value is false, and false if the effective boolean value is true. The arg parameter is first reduced to an effective boolean value by applying the fn:boolean function.
*
*
*
* Provides a client interface to the fn:not server function.
* @param arg The expression to negate. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression not(ServerExpression arg);
/**
* Returns the value indicated by arg or, if arg is not specified, the context item after atomization, converted to an xs:double. If arg is the empty sequence or if arg or the context item cannot be converted to an xs:double, the xs:double value NaN is returned. If the context item is undefined an error is raised: [err:XPDY0002].
*
*
*
* Provides a client interface to the fn:number server function.
* @param arg The value to be returned as an xs:double value. (of item)
* @return a server expression with the xs:double server data type
*/
public ServerExpression number(ServerExpression arg);
/**
* Returns an xs:NCName representing the prefix of arg. The empty sequence is returned if arg is the empty sequence or if the value of arg contains no prefix.
*
*
*
* Provides a client interface to the fn:prefix-from-QName server function.
* @param arg A qualified name. (of xs:QName)
* @return a server expression with the xs:NCName server data type
*/
public ServerExpression prefixFromQName(ServerExpression arg);
/**
* Returns an xs:QName with the namespace URI given in paramURI. If paramURI is the zero-length string or the empty sequence, it represents "no namespace"; in this case, if the value of paramQName contains a colon (:), an error is raised [err:FOCA0002]. The prefix (or absence of a prefix) in paramQName is retained in the returned xs:QName value. The local name in the result is taken from the local part of paramQName.
*
* Provides a client interface to the fn:QName server function.
* @param paramURI A namespace URI, as a string. (of xs:string)
* @param paramQName A lexical qualified name (xs:QName), a string of the form "prefix:localname" or "localname". (of xs:string)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression QName(ServerExpression paramURI, String paramQName);
/**
* Returns an xs:QName with the namespace URI given in paramURI. If paramURI is the zero-length string or the empty sequence, it represents "no namespace"; in this case, if the value of paramQName contains a colon (:), an error is raised [err:FOCA0002]. The prefix (or absence of a prefix) in paramQName is retained in the returned xs:QName value. The local name in the result is taken from the local part of paramQName.
*
*
*
* Provides a client interface to the fn:QName server function.
* @param paramURI A namespace URI, as a string. (of xs:string)
* @param paramQName A lexical qualified name (xs:QName), a string of the form "prefix:localname" or "localname". (of xs:string)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression QName(ServerExpression paramURI, ServerExpression paramQName);
/**
* Returns a new sequence constructed from the value of target with the item at the position specified by the value of position removed.
*
* Provides a client interface to the fn:remove server function.
* @param target The sequence of items from which items will be removed. (of item)
* @param position The position in the target sequence from which the items will be removed. (of xs:integer)
* @return a server expression with the item server data type
*/
public ServerExpression remove(ServerExpression target, long position);
/**
* Returns a new sequence constructed from the value of target with the item at the position specified by the value of position removed.
*
*
*
* Provides a client interface to the fn:remove server function.
* @param target The sequence of items from which items will be removed. (of item)
* @param position The position in the target sequence from which the items will be removed. (of xs:integer)
* @return a server expression with the item server data type
*/
public ServerExpression remove(ServerExpression target, ServerExpression position);
/**
* Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
*
* Provides a client interface to the fn:replace server function.
* @param input The string to start with. (of xs:string)
* @param pattern The regular expression pattern to match. If the pattern does not match the $input string, the function will return the $input string unchanged. (of xs:string)
* @param replacement The regular expression pattern to replace the $pattern with. It can also be a capture expression (for more details, see http://www.w3.org/TR/xpath-functions/#func-replace). (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression replace(ServerExpression input, String pattern, String replacement);
/**
* Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
*
*
*
* Provides a client interface to the fn:replace server function.
* @param input The string to start with. (of xs:string)
* @param pattern The regular expression pattern to match. If the pattern does not match the $input string, the function will return the $input string unchanged. (of xs:string)
* @param replacement The regular expression pattern to replace the $pattern with. It can also be a capture expression (for more details, see http://www.w3.org/TR/xpath-functions/#func-replace). (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression replace(ServerExpression input, ServerExpression pattern, ServerExpression replacement);
/**
* Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
*
* Provides a client interface to the fn:replace server function.
* @param input The string to start with. (of xs:string)
* @param pattern The regular expression pattern to match. If the pattern does not match the $input string, the function will return the $input string unchanged. (of xs:string)
* @param replacement The regular expression pattern to replace the $pattern with. It can also be a capture expression (for more details, see http://www.w3.org/TR/xpath-functions/#func-replace). (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression replace(ServerExpression input, String pattern, String replacement, String flags);
/**
* Returns a string constructed by replacing the specified pattern on the input string with the specified replacement string.
*
* Provides a client interface to the fn:replace server function.
* @param input The string to start with. (of xs:string)
* @param pattern The regular expression pattern to match. If the pattern does not match the $input string, the function will return the $input string unchanged. (of xs:string)
* @param replacement The regular expression pattern to replace the $pattern with. It can also be a capture expression (for more details, see http://www.w3.org/TR/xpath-functions/#func-replace). (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression replace(ServerExpression input, ServerExpression pattern, ServerExpression replacement, ServerExpression flags);
/**
* 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.
*
*
*
* Provides a client interface to the fn:resolve-QName server function.
* @param qname A string of the form "prefix:local-name". (of xs:string)
* @param element An element providing the in-scope namespaces to use to resolve the qualified name. (of element-node)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression resolveQName(ServerExpression qname, ServerExpression element);
/**
* Resolves a relative URI against an absolute URI. If base is specified, the URI is resolved relative to that base. If base is not specified, the base is set to the base-uri property from the static context, if the property exists; if it does not exist, an error is thrown.
*
* Provides a client interface to the fn:resolve-uri server function.
* @param relative A URI reference to resolve against the base. (of xs:string)
* @param base An absolute URI to use as the base of the resolution. (of xs:string)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression resolveUri(ServerExpression relative, String base);
/**
* Resolves a relative URI against an absolute URI. If base is specified, the URI is resolved relative to that base. If base is not specified, the base is set to the base-uri property from the static context, if the property exists; if it does not exist, an error is thrown.
*
*
*
* Provides a client interface to the fn:resolve-uri server function.
* @param relative A URI reference to resolve against the base. (of xs:string)
* @param base An absolute URI to use as the base of the resolution. (of xs:string)
* @return a server expression with the xs:anyURI server data type
*/
public ServerExpression resolveUri(ServerExpression relative, ServerExpression base);
/**
* Reverses the order of items in a sequence. If $arg is the empty sequence, the empty sequence is returned.
*
*
*
* Provides a client interface to the fn:reverse server function.
* @param target The sequence of items to be reversed. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression reverse(ServerExpression target);
/**
* Returns the root of the tree to which arg belongs. This will usually, but not necessarily, be a document node.
*
*
*
* Provides a client interface to the fn:root server function.
* @param arg The node whose root node will be returned. (of node)
* @return a server expression with the node server data type
*/
public ServerExpression root(ServerExpression arg);
/**
* Returns the number with no fractional part that is closest to the argument. If there are two such numbers, then the one that is closest to positive infinity is returned. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
*
*
* Provides a client interface to the fn:round server function.
* @param arg A numeric value to round. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression round(ServerExpression arg);
/**
* 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. If two such values are equally near (e.g. if the fractional part in arg is exactly .500...), returns the one whose least significant digit is even. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
*
*
* Provides a client interface to the fn:round-half-to-even server function.
* @param arg A numeric value to round. (of xs:numeric)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression roundHalfToEven(ServerExpression arg);
/**
* 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. If two such values are equally near (e.g. if the fractional part in arg is exactly .500...), returns the one whose least significant digit is even. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
* Provides a client interface to the fn:round-half-to-even server function.
* @param arg A numeric value to round. (of xs:numeric)
* @param precision The precision to which to round the value. (of xs:integer)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression roundHalfToEven(ServerExpression arg, long precision);
/**
* 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. If two such values are equally near (e.g. if the fractional part in arg is exactly .500...), returns the one whose least significant digit is even. If type of arg is one of the four numeric types xs:float, xs:double, xs:decimal or xs:integer the type of the result is the same as the type of arg. If the type of arg is a type derived from one of the numeric types, the result is an instance of the base numeric type.
*
* Provides a client interface to the fn:round-half-to-even server function.
* @param arg A numeric value to round. (of xs:numeric)
* @param precision The precision to which to round the value. (of xs:integer)
* @return a server expression with the xs:numeric server data type
*/
public ServerExpression roundHalfToEven(ServerExpression arg, ServerExpression precision);
/**
* Returns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of arg. Note that the value can be greater than 60 seconds to accommodate occasional leap seconds used to keep human time synchronized with the rotation of the planet.
*
*
*
* Provides a client interface to the fn:seconds-from-dateTime server function.
* @param arg The dateTime whose seconds component will be returned. (of xs:dateTime)
* @return a server expression with the xs:decimal server data type
*/
public ServerExpression secondsFromDateTime(ServerExpression arg);
/**
* Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:seconds-from-duration server function.
* @param arg The duration whose minute component will be returned. (of xs:duration)
* @return a server expression with the xs:decimal server data type
*/
public ServerExpression secondsFromDuration(ServerExpression arg);
/**
* Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of arg. Note that the value can be greater than 60 seconds to accommodate occasional leap seconds used to keep human time synchronized with the rotation of the planet.
*
*
*
* Provides a client interface to the fn:seconds-from-time server function.
* @param arg The time whose seconds component will be returned. (of xs:time)
* @return a server expression with the xs:decimal server data type
*/
public ServerExpression secondsFromTime(ServerExpression arg);
/**
* Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:starts-with server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the beginning of the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression startsWith(ServerExpression parameter1, String parameter2);
/**
* Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
*
*
*
* Provides a client interface to the fn:starts-with server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the beginning of the first parameter. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression startsWith(ServerExpression parameter1, ServerExpression parameter2);
/**
* Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:starts-with server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the beginning of the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression startsWith(ServerExpression parameter1, String parameter2, String collation);
/**
* Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
*
* Provides a client interface to the fn:starts-with server function.
* @param parameter1 The string from which to test. (of xs:string)
* @param parameter2 The string to test whether it is at the beginning of the first parameter. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression startsWith(ServerExpression parameter1, ServerExpression parameter2, ServerExpression collation);
/**
* Returns the value of arg represented as an xs:string. If no argument is supplied, this function returns the string value of the context item (.).
*
*
*
* Provides a client interface to the fn:string server function.
* @param arg The item to be rendered as a string. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression string(ServerExpression arg);
/**
* Returns an xs:string created by concatenating the members of the parameter1 sequence using parameter2 as a separator. If the value of $arg2 is the zero-length string, then the members of parameter1 are concatenated without a separator.
*
* Provides a client interface to the fn:string-join server function.
* @param parameter1 A sequence of strings. (of xs:string)
* @param parameter2 A separator string to concatenate between the items in $parameter1. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression stringJoin(ServerExpression parameter1, String parameter2);
/**
* Returns an xs:string created by concatenating the members of the parameter1 sequence using parameter2 as a separator. If the value of $arg2 is the zero-length string, then the members of parameter1 are concatenated without a separator.
*
*
*
* Provides a client interface to the fn:string-join server function.
* @param parameter1 A sequence of strings. (of xs:string)
* @param parameter2 A separator string to concatenate between the items in $parameter1. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression stringJoin(ServerExpression parameter1, ServerExpression parameter2);
/**
* Returns an integer representing the length of the specified string. The length is 1-based, so a string that is one character long returns a value of 1.
*
*
*
* Provides a client interface to the fn:string-length server function.
* @param sourceString The string to calculate the length. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression stringLength(ServerExpression sourceString);
/**
* Returns the sequence of Unicode code points that constitute an xs:string. If arg is a zero-length string or the empty sequence, the empty sequence is returned.
*
*
*
* Provides a client interface to the fn:string-to-codepoints server function.
* @param arg A string. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression stringToCodepoints(ServerExpression arg);
/**
* 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.
*
* Provides a client interface to the fn:subsequence server function.
* @param sourceSeq The sequence of items from which a subsequence will be selected. (of item)
* @param startingLoc The starting position of the start of the subsequence. (of xs:numeric)
* @return a server expression with the item server data type
*/
public ServerExpression subsequence(ServerExpression sourceSeq, double startingLoc);
/**
* 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.
*
*
*
* Provides a client interface to the fn:subsequence server function.
* @param sourceSeq The sequence of items from which a subsequence will be selected. (of item)
* @param startingLoc The starting position of the start of the subsequence. (of xs:numeric)
* @return a server expression with the item server data type
*/
public ServerExpression subsequence(ServerExpression sourceSeq, ServerExpression startingLoc);
/**
* 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.
*
* Provides a client interface to the fn:subsequence server function.
* @param sourceSeq The sequence of items from which a subsequence will be selected. (of item)
* @param startingLoc The starting position of the start of the subsequence. (of xs:numeric)
* @param length The length of the subsequence. (of xs:numeric)
* @return a server expression with the item server data type
*/
public ServerExpression subsequence(ServerExpression sourceSeq, double startingLoc, double length);
/**
* 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.
*
* Provides a client interface to the fn:subsequence server function.
* @param sourceSeq The sequence of items from which a subsequence will be selected. (of item)
* @param startingLoc The starting position of the start of the subsequence. (of xs:numeric)
* @param length The length of the subsequence. (of xs:numeric)
* @return a server expression with the item server data type
*/
public ServerExpression subsequence(ServerExpression sourceSeq, ServerExpression startingLoc, ServerExpression length);
/**
* Returns a substring starting from the startingLoc and continuing for length characters.
*
* Provides a client interface to the fn:substring server function.
* @param sourceString The string from which to create a substring. (of xs:string)
* @param startingLoc The number of characters from the start of the $sourceString. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substring(ServerExpression sourceString, double startingLoc);
/**
* Returns a substring starting from the startingLoc and continuing for length characters.
*
*
*
* Provides a client interface to the fn:substring server function.
* @param sourceString The string from which to create a substring. (of xs:string)
* @param startingLoc The number of characters from the start of the $sourceString. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substring(ServerExpression sourceString, ServerExpression startingLoc);
/**
* Returns a substring starting from the startingLoc and continuing for length characters.
*
* Provides a client interface to the fn:substring server function.
* @param sourceString The string from which to create a substring. (of xs:string)
* @param startingLoc The number of characters from the start of the $sourceString. (of xs:numeric)
* @param length The number of characters beyond the $startingLoc. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substring(ServerExpression sourceString, double startingLoc, double length);
/**
* Returns a substring starting from the startingLoc and continuing for length characters.
*
* Provides a client interface to the fn:substring server function.
* @param sourceString The string from which to create a substring. (of xs:string)
* @param startingLoc The number of characters from the start of the $sourceString. (of xs:numeric)
* @param length The number of characters beyond the $startingLoc. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substring(ServerExpression sourceString, ServerExpression startingLoc, ServerExpression length);
/**
* Returns the substring created by taking all of the input characters that occur after the specified after characters.
*
* Provides a client interface to the fn:substring-after server function.
* @param input The string from which to create the substring. (of xs:string)
* @param after The string after which the substring is created. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringAfter(ServerExpression input, String after);
/**
* Returns the substring created by taking all of the input characters that occur after the specified after characters.
*
*
*
* Provides a client interface to the fn:substring-after server function.
* @param input The string from which to create the substring. (of xs:string)
* @param after The string after which the substring is created. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringAfter(ServerExpression input, ServerExpression after);
/**
* Returns the substring created by taking all of the input characters that occur after the specified after characters.
*
* Provides a client interface to the fn:substring-after server function.
* @param input The string from which to create the substring. (of xs:string)
* @param after The string after which the substring is created. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringAfter(ServerExpression input, String after, String collation);
/**
* Returns the substring created by taking all of the input characters that occur after the specified after characters.
*
* Provides a client interface to the fn:substring-after server function.
* @param input The string from which to create the substring. (of xs:string)
* @param after The string after which the substring is created. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringAfter(ServerExpression input, ServerExpression after, ServerExpression collation);
/**
* Returns the substring created by taking all of the input characters that occur before the specified before characters.
*
* Provides a client interface to the fn:substring-before server function.
* @param input The string from which to create the substring. (of xs:string)
* @param before The string before which the substring is created. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringBefore(ServerExpression input, String before);
/**
* Returns the substring created by taking all of the input characters that occur before the specified before characters.
*
*
*
* Provides a client interface to the fn:substring-before server function.
* @param input The string from which to create the substring. (of xs:string)
* @param before The string before which the substring is created. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringBefore(ServerExpression input, ServerExpression before);
/**
* Returns the substring created by taking all of the input characters that occur before the specified before characters.
*
* Provides a client interface to the fn:substring-before server function.
* @param input The string from which to create the substring. (of xs:string)
* @param before The string before which the substring is created. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringBefore(ServerExpression input, String before, String collation);
/**
* Returns the substring created by taking all of the input characters that occur before the specified before characters.
*
* Provides a client interface to the fn:substring-before server function.
* @param input The string from which to create the substring. (of xs:string)
* @param before The string before which the substring is created. (of xs:string)
* @param collation The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer's Guide. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression substringBefore(ServerExpression input, ServerExpression before, ServerExpression collation);
/**
* Returns 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.
*
*
*
* Provides a client interface to the fn:sum server function.
* @param arg The sequence of values to be summed. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression sum(ServerExpression arg);
/**
* Returns 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.
*
* Provides a client interface to the fn:sum server function.
* @param arg The sequence of values to be summed. (of xs:anyAtomicType)
* @param zero The value to return as zero if the input sequence is the empty sequence. This parameter is not available in the 0.9-ml XQuery dialect. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression sum(ServerExpression arg, String zero);
/**
* Returns 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.
*
* Provides a client interface to the fn:sum server function.
* @param arg The sequence of values to be summed. (of xs:anyAtomicType)
* @param zero The value to return as zero if the input sequence is the empty sequence. This parameter is not available in the 0.9-ml XQuery dialect. (of xs:anyAtomicType)
* @return a server expression with the xs:anyAtomicType server data type
*/
public ServerExpression sum(ServerExpression arg, ServerExpression zero);
/**
* Returns all but the first item in a sequence. For more details, see XPath 3.0 Functions and Operators.
*
*
*
* Provides a client interface to the fn:tail server function.
* @param seq The function value. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression tail(ServerExpression seq);
/**
* 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.
*
*
*
* Provides a client interface to the fn:timezone-from-date server function.
* @param arg The date whose timezone component will be returned. (of xs:date)
* @return a server expression with the xs:dayTimeDuration server data type
*/
public ServerExpression timezoneFromDate(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:timezone-from-dateTime server function.
* @param arg The dateTime whose timezone component will be returned. (of xs:dateTime)
* @return a server expression with the xs:dayTimeDuration server data type
*/
public ServerExpression timezoneFromDateTime(ServerExpression arg);
/**
* 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.
*
*
*
* Provides a client interface to the fn:timezone-from-time server function.
* @param arg The time whose timezone component will be returned. (of xs:time)
* @return a server expression with the xs:dayTimeDuration server data type
*/
public ServerExpression timezoneFromTime(ServerExpression arg);
/**
* Returns a sequence of strings constructed by breaking the specified input into substrings separated by the specified pattern. The specified pattern is not returned as part of the returned items.
*
* Provides a client interface to the fn:tokenize server function.
* @param input The string to tokenize. (of xs:string)
* @param pattern The regular expression pattern from which to separate the tokens. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression tokenize(ServerExpression input, String pattern);
/**
* Returns a sequence of strings constructed by breaking the specified input into substrings separated by the specified pattern. The specified pattern is not returned as part of the returned items.
*
*
*
* Provides a client interface to the fn:tokenize server function.
* @param input The string to tokenize. (of xs:string)
* @param pattern The regular expression pattern from which to separate the tokens. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression tokenize(ServerExpression input, ServerExpression pattern);
/**
* Returns a sequence of strings constructed by breaking the specified input into substrings separated by the specified pattern. The specified pattern is not returned as part of the returned items.
*
* Provides a client interface to the fn:tokenize server function.
* @param input The string to tokenize. (of xs:string)
* @param pattern The regular expression pattern from which to separate the tokens. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression tokenize(ServerExpression input, String pattern, String flags);
/**
* Returns a sequence of strings constructed by breaking the specified input into substrings separated by the specified pattern. The specified pattern is not returned as part of the returned items.
*
* Provides a client interface to the fn:tokenize server function.
* @param input The string to tokenize. (of xs:string)
* @param pattern The regular expression pattern from which to separate the tokens. (of xs:string)
* @param flags The flag representing how to interpret the regular expression. One of "s", "m", "i", or "x", as defined in http://www.w3.org/TR/xpath-functions/#flags. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression tokenize(ServerExpression input, ServerExpression pattern, ServerExpression flags);
/**
* Returns a string where every character in src that occurs in some position in the mapString is translated into the transString character in the corresponding location of the mapString character.
*
* Provides a client interface to the fn:translate server function.
* @param src The string to translate characters. (of xs:string)
* @param mapString The string representing characters to be translated. (of xs:string)
* @param transString The string representing the characters to which the $mapString characters are translated. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression translate(ServerExpression src, String mapString, String transString);
/**
* Returns a string where every character in src that occurs in some position in the mapString is translated into the transString character in the corresponding location of the mapString character.
*
*
*
* Provides a client interface to the fn:translate server function.
* @param src The string to translate characters. (of xs:string)
* @param mapString The string representing characters to be translated. (of xs:string)
* @param transString The string representing the characters to which the $mapString characters are translated. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression translate(ServerExpression src, ServerExpression mapString, ServerExpression transString);
/**
* Returns the xs:boolean value true. Equivalent to xs:boolean("1").
*
*
*
* Provides a client interface to the fn:true server function.
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression trueExpr();
/**
* Returns the items of sourceSeq in an implementation dependent order.
*
*
*
* Provides a client interface to the fn:unordered server function.
* @param sourceSeq The sequence of items. (of item)
* @return a server expression with the item server data type
*/
public ServerExpression unordered(ServerExpression sourceSeq);
/**
* Returns the specified string converting all of the characters to upper-case characters. If a character does not have a corresponding upper-case character, then the original character is returned. The upper-case characters are determined using the Unicode Case Mappings.
*
*
*
* Provides a client interface to the fn:upper-case server function.
* @param string The string to upper-case. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression upperCase(ServerExpression string);
/**
* Returns an xs:integer representing the year component in the localized value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:year-from-date server function.
* @param arg The date whose year component will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression yearFromDate(ServerExpression arg);
/**
* Returns an xs:integer representing the year component in the localized value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:year-from-dateTime server function.
* @param arg The dateTime whose year component will be returned. (of xs:dateTime)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression yearFromDateTime(ServerExpression arg);
/**
* Returns an xs:integer representing the years component in the canonical lexical representation of the value of arg. The result may be negative.
*
*
*
* Provides a client interface to the fn:years-from-duration server function.
* @param arg The duration whose year component will be returned. (of xs:duration)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression yearsFromDuration(ServerExpression arg);
}