com.marklogic.client.expression.XdmpExpr 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.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.XsIntegerVal;
import com.marklogic.client.type.XsLongVal;
import com.marklogic.client.type.XsQNameVal;
import com.marklogic.client.type.XsStringSeqVal;
import com.marklogic.client.type.XsStringVal;
import com.marklogic.client.type.XsUnsignedIntVal;
import com.marklogic.client.type.XsUnsignedLongVal;
import com.marklogic.client.type.ServerExpression;
// IMPORTANT: Do not edit. This file is generated.
/**
* Builds expressions to call functions in the xdmp server library for a row
* pipeline.
*/
public interface XdmpExpr {
/**
* Add two 64-bit integer values, discarding overflow.
*
*
*
* Provides a client interface to the xdmp:add64 server function.
* @param x The first value. (of xs:unsignedLong)
* @param y The second value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression add64(ServerExpression x, ServerExpression y);
/**
* AND two 64-bit integer values.
*
*
*
* Provides a client interface to the xdmp:and64 server function.
* @param x The first value. (of xs:unsignedLong)
* @param y The second value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression and64(ServerExpression x, ServerExpression y);
/**
* Converts base64-encoded string to plaintext.
*
*
*
* Provides a client interface to the xdmp:base64-decode server function.
* @param encoded Encoded text to be decoded. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression base64Decode(ServerExpression encoded);
/**
* Converts plaintext into base64-encoded string.
*
*
*
* Provides a client interface to the xdmp:base64-encode server function.
* @param plaintext Plaintext to be encoded. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression base64Encode(ServerExpression plaintext);
/**
* Returns true if a value is castable. This is similar to the "castable as" XQuery predicate, except that the type is determined at runtime.
*
* Provides a client interface to the xdmp:castable-as server function.
* @param namespaceUri The namespace URI of the type. (of xs:string)
* @param localName The local-name of the type. (of xs:string)
* @param item The item to be cast. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression castableAs(ServerExpression namespaceUri, String localName, ServerExpression item);
/**
* Returns true if a value is castable. This is similar to the "castable as" XQuery predicate, except that the type is determined at runtime.
*
*
*
* Provides a client interface to the xdmp:castable-as server function.
* @param namespaceUri The namespace URI of the type. (of xs:string)
* @param localName The local-name of the type. (of xs:string)
* @param item The item to be cast. (of item)
* @return a server expression with the xs:boolean server data type
*/
public ServerExpression castableAs(ServerExpression namespaceUri, ServerExpression localName, ServerExpression item);
/**
* Calculates the password hash for the given password and salt.
*
* Provides a client interface to the xdmp:crypt server function.
* @param password String to be hashed. (of xs:string)
* @param salt Salt to avoid 1:1 mapping from passwords to hashes. Only the first 8 characters of the salt are significant; any characters beyond the eighth are ignored. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression crypt(ServerExpression password, String salt);
/**
* Calculates the password hash for the given password and salt.
*
*
*
* Provides a client interface to the xdmp:crypt server function.
* @param password String to be hashed. (of xs:string)
* @param salt Salt to avoid 1:1 mapping from passwords to hashes. Only the first 8 characters of the salt are significant; any characters beyond the eighth are ignored. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression crypt(ServerExpression password, ServerExpression salt);
/**
* Calculates the password hash for the given plain-text password.
*
*
*
* Provides a client interface to the xdmp:crypt2 server function.
* @param password String to be hashed. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression crypt2(ServerExpression password);
/**
* Returns a string representing the dayname value in the localized value of arg.
*
*
*
* Provides a client interface to the xdmp:dayname-from-date server function.
* @param arg The date whose dayname value will be returned. (of xs:date)
* @return a server expression with the xs:string server data type
*/
public ServerExpression daynameFromDate(ServerExpression arg);
/**
* Invertible function that decodes characters an NCName produced by xdmp:encode-for-NCName. Given the NCName produced by xdmp:encode-for-NCName this function returns the original string.
*
*
*
* Provides a client interface to the xdmp:decode-from-NCName server function.
* @param name A string representing an NCName. This string must have been the result of a previous call to xdmp:decode-from-NCName or undefined results will occur. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression decodeFromNCName(ServerExpression name);
/**
* Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
*
*
*
* Provides a client interface to the xdmp:describe server function.
* @param item The item sequence whose description is returned. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression describe(ServerExpression item);
/**
* Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
*
* Provides a client interface to the xdmp:describe server function.
* @param item The item sequence whose description is returned. (of item)
* @param maxSequenceLength Represents the maximum number of items per sequence to print. The default is 3. (of xs:unsignedInt)
* @return a server expression with the xs:string server data type
*/
public ServerExpression describe(ServerExpression item, ServerExpression maxSequenceLength);
/**
* Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
*
* Provides a client interface to the xdmp:describe server function.
* @param item The item sequence whose description is returned. (of item)
* @param maxSequenceLength Represents the maximum number of items per sequence to print. The default is 3. (of xs:unsignedInt)
* @param maxItemLength Represents the maximum number of characters per item to print. The default is 64. The minimum is 8. (of xs:unsignedInt)
* @return a server expression with the xs:string server data type
*/
public ServerExpression describe(ServerExpression item, ServerExpression maxSequenceLength, ServerExpression maxItemLength);
/**
* Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
*
*
*
* Provides a client interface to the xdmp:diacritic-less server function.
* @param string The string to convert. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression diacriticLess(ServerExpression string);
/**
* Returns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed").
*
*
*
* Provides a client interface to the xdmp:element-content-type server function.
* @param element An element node. (of element-node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression elementContentType(ServerExpression element);
/**
* Invertible function that escapes characters required to be part of an NCName. This is useful when translating names from other representations such as JSON to XML. Given any string, the result is always a valid NCName. Providing all names are passed through this function the result is distinct NCNames so the results can be used for searching as well as name generation. The inverse function is xdmp:decode-from-NCName.
*
*
*
* Provides a client interface to the xdmp:encode-for-NCName server function.
* @param name A string which is used as an NCName (such as the localname for an element or attribute). (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression encodeForNCName(ServerExpression name);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
*
*
* Provides a client interface to the xdmp:format-number server function.
* @param value The given numeric $value that needs to be formatted. (of xs:numeric)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language, String letterValue);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression letterValue);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language, String letterValue, String ordchar);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression letterValue, ServerExpression ordchar);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language, String letterValue, String ordchar, String zeroPadding);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression letterValue, ServerExpression ordchar, ServerExpression zeroPadding);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSeparator Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here "," is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language, String letterValue, String ordchar, String zeroPadding, String groupingSeparator);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSeparator Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here "," is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression letterValue, ServerExpression ordchar, ServerExpression zeroPadding, ServerExpression groupingSeparator);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSeparator Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here "," is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSize Represents size of the group, i.e. the number of digits before after which grouping separator is inserted. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:integer)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, String picture, String language, String letterValue, String ordchar, String zeroPadding, String groupingSeparator, long groupingSize);
/**
* Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
*
* Provides a client interface to the xdmp: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 numeric $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. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting. (of xs:string)
* @param language The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param letterValue Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param ordchar If $ordchar is "yes" then ordinal numbering is attempted. If this is any other string, including an empty string, then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param zeroPadding Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSeparator Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here "," is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:string)
* @param groupingSize Represents size of the group, i.e. the number of digits before after which grouping separator is inserted. An empty sequence must be passed in even if a user doesn't want to specify this argument. (of xs:integer)
* @return a server expression with the xs:string server data type
*/
public ServerExpression formatNumber(ServerExpression value, ServerExpression picture, ServerExpression language, ServerExpression letterValue, ServerExpression ordchar, ServerExpression zeroPadding, ServerExpression groupingSeparator, ServerExpression groupingSize);
/**
* Atomizes a JSON node, returning a JSON value.
*
*
*
* Provides a client interface to the xdmp:from-json server function.
* @param arg A node of kind object-node(), array-node(), text(), number-node(), boolean-node(), null-node(), or document-node(). (of node)
* @return a server expression with the item server data type
*/
public ServerExpression fromJson(ServerExpression arg);
/**
* Returns the name of the current user.
*
*
*
* Provides a client interface to the xdmp:get-current-user server function.
* @return a server expression with the xs:string server data type
*/
public ServerExpression getCurrentUser();
/**
* Returns the 32-bit hash of a string.
*
*
*
* Provides a client interface to the xdmp:hash32 server function.
* @param string The string to be hashed. (of xs:string)
* @return a server expression with the xs:unsignedInt server data type
*/
public ServerExpression hash32(ServerExpression string);
/**
* Returns the 64-bit hash of a string.
*
*
*
* Provides a client interface to the xdmp:hash64 server function.
* @param string The string to be hashed. (of xs:string)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression hash64(ServerExpression string);
/**
* Parses a hexadecimal string, returning an integer.
*
*
*
* Provides a client interface to the xdmp:hex-to-integer server function.
* @param hex The hexadecimal string. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression hexToInteger(ServerExpression hex);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
*
*
*
* Provides a client interface to the xdmp:hmac-md5 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacMd5(ServerExpression secretkey, ServerExpression message);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-md5 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacMd5(ServerExpression secretkey, ServerExpression message, String encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-md5 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacMd5(ServerExpression secretkey, ServerExpression message, ServerExpression encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
*
*
*
* Provides a client interface to the xdmp:hmac-sha1 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha1(ServerExpression secretkey, ServerExpression message);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha1 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha1(ServerExpression secretkey, ServerExpression message, String encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha1 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha1(ServerExpression secretkey, ServerExpression message, ServerExpression encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
*
*
*
* Provides a client interface to the xdmp:hmac-sha256 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha256(ServerExpression secretkey, ServerExpression message);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha256 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha256(ServerExpression secretkey, ServerExpression message, String encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha256 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha256(ServerExpression secretkey, ServerExpression message, ServerExpression encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
*
*
*
* Provides a client interface to the xdmp:hmac-sha512 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha512(ServerExpression secretkey, ServerExpression message);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha512 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha512(ServerExpression secretkey, ServerExpression message, String encoding);
/**
* Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
*
* Provides a client interface to the xdmp:hmac-sha512 server function.
* @param secretkey The secret key. Must be xs:string or a binary node. (of item)
* @param message Message to be authenticated. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression hmacSha512(ServerExpression secretkey, ServerExpression message, ServerExpression encoding);
/**
* Returns the string where the first letter of each token has been uppercased.
*
*
*
* Provides a client interface to the xdmp:initcap server function.
* @param string The string to modify. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression initcap(ServerExpression string);
/**
* Returns a hexadecimal representation of an integer.
*
*
*
* Provides a client interface to the xdmp:integer-to-hex server function.
* @param val The integer value. (of xs:integer)
* @return a server expression with the xs:string server data type
*/
public ServerExpression integerToHex(ServerExpression val);
/**
* Returns an octal representation of an integer.
*
*
*
* Provides a client interface to the xdmp:integer-to-octal server function.
* @param val The integer value. (of xs:integer)
* @return a server expression with the xs:string server data type
*/
public ServerExpression integerToOctal(ServerExpression val);
/**
* Construct a context-independent string from a QName. This string is of the form "{namespaceURI}localname" and is suitable for use as a map key.
*
*
*
* Provides a client interface to the xdmp:key-from-QName server function.
* @param name The QName to compute a key for. (of xs:QName)
* @return a server expression with the xs:string server data type
*/
public ServerExpression keyFromQName(ServerExpression name);
/**
* Left-shift a 64-bit integer value.
*
* Provides a client interface to the xdmp:lshift64 server function.
* @param x The value to shift. (of xs:unsignedLong)
* @param y The left shift to perform. This value may be negative. (of xs:long)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression lshift64(ServerExpression x, long y);
/**
* Left-shift a 64-bit integer value.
*
*
*
* Provides a client interface to the xdmp:lshift64 server function.
* @param x The value to shift. (of xs:unsignedLong)
* @param y The left shift to perform. This value may be negative. (of xs:long)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression lshift64(ServerExpression x, ServerExpression y);
/**
* Calculates the md5 hash of the given argument.
*
*
*
* Provides a client interface to the xdmp:md5 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression md5(ServerExpression data);
/**
* Calculates the md5 hash of the given argument.
*
* Provides a client interface to the xdmp:md5 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression md5(ServerExpression data, String encoding);
/**
* Calculates the md5 hash of the given argument.
*
* Provides a client interface to the xdmp:md5 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression md5(ServerExpression data, ServerExpression encoding);
/**
* Returns month name, calculated from the localized value of arg.
*
*
*
* Provides a client interface to the xdmp:month-name-from-date server function.
* @param arg The date whose month-name will be returned. (of xs:date)
* @return a server expression with the xs:string server data type
*/
public ServerExpression monthNameFromDate(ServerExpression arg);
/**
* Multiply two 64-bit integer values, discarding overflow.
*
*
*
* Provides a client interface to the xdmp:mul64 server function.
* @param x The first value. (of xs:unsignedLong)
* @param y The second value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression mul64(ServerExpression x, ServerExpression y);
/**
* Returns any collections for the node's document in the database. If the specified node does not come from a document in a database, then xdmp:node-collections returns an empty sequence.
*
*
*
* Provides a client interface to the xdmp:node-collections server function.
* @param node The node whose collections are to be returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression nodeCollections(ServerExpression node);
/**
* Returns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".
*
*
*
* Provides a client interface to the xdmp:node-kind server function.
* @param node The node whose kind is to be returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression nodeKind(ServerExpression node);
/**
* Returns the metadata value of a given node.
*
*
*
* Provides a client interface to the xdmp:node-metadata server function.
* @param node The node whose metadata are to be returned. (of node)
* @return a server expression with the map:map server data type
*/
public ServerExpression nodeMetadata(ServerExpression node);
/**
* Returns the metadata value of a node for a particular key.
*
* Provides a client interface to the xdmp:node-metadata-value server function.
* @param node The node whose metadata are to be returned. (of node)
* @param keyName Name of the key for the metadata. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression nodeMetadataValue(ServerExpression node, String keyName);
/**
* Returns the metadata value of a node for a particular key.
*
*
*
* Provides a client interface to the xdmp:node-metadata-value server function.
* @param node The node whose metadata are to be returned. (of node)
* @param keyName Name of the key for the metadata. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression nodeMetadataValue(ServerExpression node, ServerExpression keyName);
/**
* Returns the permissions to a node's document.
*
*
*
* Provides a client interface to the xdmp:node-permissions server function.
* @param node The node. (of node)
* @return a server expression with the item server data type
*/
public ServerExpression nodePermissions(ServerExpression node);
/**
* Returns the permissions to a node's document.
*
* Provides a client interface to the xdmp:node-permissions server function.
* @param node The node. (of node)
* @param outputKind The output kind. It can be either "elements" or "objects". With "elements", the built-in returns a sequence of XML elements. With "objects", the built-in returns a sequence of map:map. The default is "elements". (of xs:string)
* @return a server expression with the item server data type
*/
public ServerExpression nodePermissions(ServerExpression node, String outputKind);
/**
* Returns the permissions to a node's document.
*
* Provides a client interface to the xdmp:node-permissions server function.
* @param node The node. (of node)
* @param outputKind The output kind. It can be either "elements" or "objects". With "elements", the built-in returns a sequence of XML elements. With "objects", the built-in returns a sequence of map:map. The default is "elements". (of xs:string)
* @return a server expression with the item server data type
*/
public ServerExpression nodePermissions(ServerExpression node, ServerExpression outputKind);
/**
* Returns the document-uri property of the parameter or its ancestor.
*
*
*
* Provides a client interface to the xdmp:node-uri server function.
* @param node The node whose URI is returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression nodeUri(ServerExpression node);
/**
* NOT a 64-bit integer value.
*
*
*
* Provides a client interface to the xdmp:not64 server function.
* @param x The input value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression not64(ServerExpression x);
/**
* Parses an octal string, returning an integer.
*
*
*
* Provides a client interface to the xdmp:octal-to-integer server function.
* @param octal The octal string. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression octalToInteger(ServerExpression octal);
/**
* OR two 64-bit integer values.
*
*
*
* Provides a client interface to the xdmp:or64 server function.
* @param x The first value. (of xs:unsignedLong)
* @param y The second value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression or64(ServerExpression x, ServerExpression y);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, String value);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
*
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, ServerExpression value);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, String value, String language);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, ServerExpression value, ServerExpression language);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, String value, String language, String calendar);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, ServerExpression value, ServerExpression language, ServerExpression calendar);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, String value, String language, String calendar, String country);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-dateTime server function.
* @param picture The desired string representation of the given $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. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ----------------------------------- 'Y' year(absolute value) 'M' month in year 'D' day in month 'd' day in year 'F' day of week 'W' week in year 'w' week in month 'H' hour in day 'h' hour in half-day 'P' am/pm marker 'm' minute in hour 's' second in minute 'f' fractional seconds 'Z' timezone as a time offset from UTC for example PST 'z' timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value representing the dateTime value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseDateTime(ServerExpression picture, ServerExpression value, ServerExpression language, ServerExpression calendar, ServerExpression country);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, String value);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
*
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, ServerExpression value);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, String value, String language);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, ServerExpression value, ServerExpression language);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, String value, String language, String calendar);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, ServerExpression value, ServerExpression language, ServerExpression calendar);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, String value, String language, String calendar, String country);
/**
* Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
*
* Provides a client interface to the xdmp:parse-yymmdd server function.
* @param picture The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols: Symbol Description ---------------------------- "y" year(absolute value) "M" month in year "d" day in month "D" day in year "E" day of week "w" week in year "W" week in month "H" hour in day "K" hour in half-day "a" am/pm marker "s" second in minute "S" fractional seconds "Z" timezone as a time offset from UTC for example PST "ZZZZ" timezone as an offset using GMT, for example GMT+1 (of xs:string)
* @param value The given string $value that needs to be formatted. (of xs:string)
* @param language The language used in string representation of the date, time or dateTime value. (of xs:string)
* @param calendar This argument is reserved for future use. The only calendar supported at this point is "Gregorian" or "AD". (of xs:string)
* @param country $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value. (of xs:string)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression parseYymmdd(ServerExpression picture, ServerExpression value, ServerExpression language, ServerExpression calendar, ServerExpression country);
/**
* Returns a string whose value corresponds to the path of the node.
*
*
*
* Provides a client interface to the xdmp:path server function.
* @param node The node whose path is returned. (of node)
* @return a server expression with the xs:string server data type
*/
public ServerExpression path(ServerExpression node);
/**
* Returns a string whose value corresponds to the path of the node.
*
* Provides a client interface to the xdmp:path server function.
* @param node The node whose path is returned. (of node)
* @param includeDocument If true, then the path is presented with a leading doc(..)/.., otherwise the path is presented as /... (of xs:boolean)
* @return a server expression with the xs:string server data type
*/
public ServerExpression path(ServerExpression node, boolean includeDocument);
/**
* Returns a string whose value corresponds to the path of the node.
*
* Provides a client interface to the xdmp:path server function.
* @param node The node whose path is returned. (of node)
* @param includeDocument If true, then the path is presented with a leading doc(..)/.., otherwise the path is presented as /... (of xs:boolean)
* @return a server expression with the xs:string server data type
*/
public ServerExpression path(ServerExpression node, ServerExpression includeDocument);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the xdmp:position server function.
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param target The string from which to test. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression position(ServerExpression test, String target);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
*
*
* Provides a client interface to the xdmp:position server function.
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param target The string from which to test. (of xs:string)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression position(ServerExpression test, ServerExpression target);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the xdmp:position server function.
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param target The string from which to test. (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 position(ServerExpression test, String target, String collation);
/**
* Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
*
* Provides a client interface to the xdmp:position server function.
* @param test The string to test for existence in the second parameter. (of xs:string)
* @param target The string from which to test. (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 position(ServerExpression test, ServerExpression target, ServerExpression collation);
/**
* Construct a QName from a string of the form "{namespaceURI}localname". This function is useful for constructing Clark notation parameters for the xdmp:xslt-eval and xdmp:xslt-invoke functions.
*
*
*
* Provides a client interface to the xdmp:QName-from-key server function.
* @param key The string from which to construct a QName. (of xs:string)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression QNameFromKey(ServerExpression key);
/**
* Returns an integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
*
*
*
* Provides a client interface to the xdmp:quarter-from-date server function.
* @param arg The date whose quarter component will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression quarterFromDate(ServerExpression arg);
/**
* Returns a random unsigned integer between 0 and a number up to 64 bits long.
*
*
*
* Provides a client interface to the xdmp:random server function.
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression random();
/**
* Returns a random unsigned integer between 0 and a number up to 64 bits long.
*
* Provides a client interface to the xdmp:random server function.
* @param max The optional maximum value (inclusive). (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression random(ServerExpression max);
/**
* 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 xdmp: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 xdmp: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);
/**
* Right-shift a 64-bit integer value.
*
* Provides a client interface to the xdmp:rshift64 server function.
* @param x The value to shift. (of xs:unsignedLong)
* @param y The right shift to perform. This value may be negative. (of xs:long)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression rshift64(ServerExpression x, long y);
/**
* Right-shift a 64-bit integer value.
*
*
*
* Provides a client interface to the xdmp:rshift64 server function.
* @param x The value to shift. (of xs:unsignedLong)
* @param y The right shift to perform. This value may be negative. (of xs:long)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression rshift64(ServerExpression x, ServerExpression y);
/**
* Calculates the SHA1 hash of the given argument.
*
*
*
* Provides a client interface to the xdmp:sha1 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha1(ServerExpression data);
/**
* Calculates the SHA1 hash of the given argument.
*
* Provides a client interface to the xdmp:sha1 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha1(ServerExpression data, String encoding);
/**
* Calculates the SHA1 hash of the given argument.
*
* Provides a client interface to the xdmp:sha1 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha1(ServerExpression data, ServerExpression encoding);
/**
* Calculates the SHA256 hash of the given argument.
*
*
*
* Provides a client interface to the xdmp:sha256 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha256(ServerExpression data);
/**
* Calculates the SHA256 hash of the given argument.
*
* Provides a client interface to the xdmp:sha256 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha256(ServerExpression data, String encoding);
/**
* Calculates the SHA256 hash of the given argument.
*
* Provides a client interface to the xdmp:sha256 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha256(ServerExpression data, ServerExpression encoding);
/**
* Calculates the SHA384 hash of the given argument.
*
*
*
* Provides a client interface to the xdmp:sha384 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha384(ServerExpression data);
/**
* Calculates the SHA384 hash of the given argument.
*
* Provides a client interface to the xdmp:sha384 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha384(ServerExpression data, String encoding);
/**
* Calculates the SHA384 hash of the given argument.
*
* Provides a client interface to the xdmp:sha384 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha384(ServerExpression data, ServerExpression encoding);
/**
* Calculates the SHA512 hash of the given argument.
*
*
*
* Provides a client interface to the xdmp:sha512 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha512(ServerExpression data);
/**
* Calculates the SHA512 hash of the given argument.
*
* Provides a client interface to the xdmp:sha512 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha512(ServerExpression data, String encoding);
/**
* Calculates the SHA512 hash of the given argument.
*
* Provides a client interface to the xdmp:sha512 server function.
* @param data Data to be hashed. Must be xs:string or a binary node. (of item)
* @param encoding Encoding format for the output string, must be "hex" for hexadecimal or "base64". Default is "hex". (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression sha512(ServerExpression data, ServerExpression encoding);
/**
* Combines an initial hash with a subsequent hash.
*
*
*
* Provides a client interface to the xdmp:step64 server function.
* @param initial An initial hash. (of xs:unsignedLong)
* @param step A step hash to be combined with the initial hash. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression step64(ServerExpression initial, ServerExpression step);
/**
* Formats a dateTime value using POSIX strftime. This function uses the POSIX strftime system call in the way it is implemented on each platform. For other XQuery functions that have more functionality (for example, for things like timezones), use one or more if the various XQuery or XSLT standard functions such as fn:format-dateTime .
*
* Provides a client interface to the xdmp:strftime server function.
* @param format The strftime format string. (of xs:string)
* @param value The dateTime value. (of xs:dateTime)
* @return a server expression with the xs:string server data type
*/
public ServerExpression strftime(ServerExpression format, String value);
/**
* Formats a dateTime value using POSIX strftime. This function uses the POSIX strftime system call in the way it is implemented on each platform. For other XQuery functions that have more functionality (for example, for things like timezones), use one or more if the various XQuery or XSLT standard functions such as fn:format-dateTime .
*
*
*
* Provides a client interface to the xdmp:strftime server function.
* @param format The strftime format string. (of xs:string)
* @param value The dateTime value. (of xs:dateTime)
* @return a server expression with the xs:string server data type
*/
public ServerExpression strftime(ServerExpression format, ServerExpression value);
/**
* Converts a 64 bit timestamp value to an xs:dateTime.
*
*
*
* Provides a client interface to the xdmp:timestamp-to-wallclock server function.
* @param timestamp The timestamp. (of xs:unsignedLong)
* @return a server expression with the xs:dateTime server data type
*/
public ServerExpression timestampToWallclock(ServerExpression timestamp);
/**
* Constructs a JSON document.
*
*
*
* Provides a client interface to the xdmp:to-json server function.
* @param item A sequence of items from which the JSON document is to be constructed. The item sequence from which the JSON document is constructed. (of item)
* @return a server expression with the node server data type
*/
public ServerExpression toJson(ServerExpression item);
/**
* Returns the name of the simple type of the atomic value argument as an xs:QName.
*
*
*
* Provides a client interface to the xdmp:type server function.
* @param value The value to return the type of. (of xs:anyAtomicType)
* @return a server expression with the xs:QName server data type
*/
public ServerExpression type(ServerExpression value);
/**
* Parses a string as XML, returning one or more document nodes.
*
*
*
* Provides a client interface to the xdmp:unquote server function.
* @param arg Input to be unquoted. (of xs:string)
* @return a server expression with the document-node server data type
*/
public ServerExpression unquote(ServerExpression arg);
/**
* Parses a string as XML, returning one or more document nodes.
*
* Provides a client interface to the xdmp:unquote server function.
* @param arg Input to be unquoted. (of xs:string)
* @param defaultNamespace Default namespace for nodes in the first parameter. (of xs:string)
* @return a server expression with the document-node server data type
*/
public ServerExpression unquote(ServerExpression arg, String defaultNamespace);
/**
* Parses a string as XML, returning one or more document nodes.
*
* Provides a client interface to the xdmp:unquote server function.
* @param arg Input to be unquoted. (of xs:string)
* @param defaultNamespace Default namespace for nodes in the first parameter. (of xs:string)
* @return a server expression with the document-node server data type
*/
public ServerExpression unquote(ServerExpression arg, ServerExpression defaultNamespace);
/**
* Parses a string as XML, returning one or more document nodes.
*
* Provides a client interface to the xdmp:unquote server function.
* @param arg Input to be unquoted. (of xs:string)
* @param defaultNamespace Default namespace for nodes in the first parameter. (of xs:string)
* @param options The options for getting this document. The default value is (). Options include: "repair-full" Specifies that malformed XML content be repaired. XML content with multiple top-level elements will be parsed as multiple documents. This option has no effect on binary or text documents. "repair-none" Specifies that malformed XML content be rejected. XML content will be parsed as a single document, so a maximum of one document node will be returned. This option has no effect on binary or text documents. "format-text" Specifies to get the document as a text document, regardless of the URI specified. "format-binary" Specifies to get the document as a binary document, regardless of the URI specified. "format-xml" Specifies to get the document as an XML document, regardless of the URI specified. "format-json" Specifies to get the document as a JSON document, regardless of the URI specified. "default-language=xx" If the root element node specified in the first parameter does not already have an xml:lang attribute, the language to specify in an xml:lang attribute on the root element node. If default-language is not specified, then nothing is added to the root element node. Some examples are default-language=en and default-language=fr. (of xs:string)
* @return a server expression with the document-node server data type
*/
public ServerExpression unquote(ServerExpression arg, String defaultNamespace, String options);
/**
* Parses a string as XML, returning one or more document nodes.
*
* Provides a client interface to the xdmp:unquote server function.
* @param arg Input to be unquoted. (of xs:string)
* @param defaultNamespace Default namespace for nodes in the first parameter. (of xs:string)
* @param options The options for getting this document. The default value is (). Options include: "repair-full" Specifies that malformed XML content be repaired. XML content with multiple top-level elements will be parsed as multiple documents. This option has no effect on binary or text documents. "repair-none" Specifies that malformed XML content be rejected. XML content will be parsed as a single document, so a maximum of one document node will be returned. This option has no effect on binary or text documents. "format-text" Specifies to get the document as a text document, regardless of the URI specified. "format-binary" Specifies to get the document as a binary document, regardless of the URI specified. "format-xml" Specifies to get the document as an XML document, regardless of the URI specified. "format-json" Specifies to get the document as a JSON document, regardless of the URI specified. "default-language=xx" If the root element node specified in the first parameter does not already have an xml:lang attribute, the language to specify in an xml:lang attribute on the root element node. If default-language is not specified, then nothing is added to the root element node. Some examples are default-language=en and default-language=fr. (of xs:string)
* @return a server expression with the document-node server data type
*/
public ServerExpression unquote(ServerExpression arg, ServerExpression defaultNamespace, ServerExpression options);
/**
* Returns the content type of the given URI as matched in the mimetypes configuration. xdmp:content-type continues to work too.
*
*
*
* Provides a client interface to the xdmp:uri-content-type server function.
* @param uri The document URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression uriContentType(ServerExpression uri);
/**
* Returns the format of the given URI as matched in the mimetypes configuration.
*
*
*
* Provides a client interface to the xdmp:uri-format server function.
* @param uri The document URI. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression uriFormat(ServerExpression uri);
/**
* Converts URL-encoded string to plaintext. This decodes the string created with xdmp:url-encode.
*
*
*
* Provides a client interface to the xdmp:url-decode server function.
* @param encoded Encoded text to be decoded. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression urlDecode(ServerExpression encoded);
/**
* Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
*
*
*
* Provides a client interface to the xdmp:url-encode server function.
* @param plaintext Plaintext to be encoded. (of xs:string)
* @return a server expression with the xs:string server data type
*/
public ServerExpression urlEncode(ServerExpression plaintext);
/**
* Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
*
* Provides a client interface to the xdmp:url-encode server function.
* @param plaintext Plaintext to be encoded. (of xs:string)
* @param noSpacePlus True to encode space as "%20" instead of "+". (of xs:boolean)
* @return a server expression with the xs:string server data type
*/
public ServerExpression urlEncode(ServerExpression plaintext, boolean noSpacePlus);
/**
* Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
*
* Provides a client interface to the xdmp:url-encode server function.
* @param plaintext Plaintext to be encoded. (of xs:string)
* @param noSpacePlus True to encode space as "%20" instead of "+". (of xs:boolean)
* @return a server expression with the xs:string server data type
*/
public ServerExpression urlEncode(ServerExpression plaintext, ServerExpression noSpacePlus);
/**
* Converts an xs:dateTime to a 64 bit timestamp value.
*
*
*
* Provides a client interface to the xdmp:wallclock-to-timestamp server function.
* @param timestamp The xs:datetime value. (of xs:dateTime)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression wallclockToTimestamp(ServerExpression timestamp);
/**
* Returns an integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
*
*
*
* Provides a client interface to the xdmp:week-from-date server function.
* @param arg The date whose weeks of the year will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression weekFromDate(ServerExpression arg);
/**
* Returns an integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of arg. Monday is the first weekday value (value of 1), and Sunday is the last (value of 7).
*
*
*
* Provides a client interface to the xdmp:weekday-from-date server function.
* @param arg The date whose weekday value will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression weekdayFromDate(ServerExpression arg);
/**
* XOR two 64-bit integer values.
*
*
*
* Provides a client interface to the xdmp:xor64 server function.
* @param x The first value. (of xs:unsignedLong)
* @param y The second value. (of xs:unsignedLong)
* @return a server expression with the xs:unsignedLong server data type
*/
public ServerExpression xor64(ServerExpression x, ServerExpression y);
/**
* Returns an integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
*
*
*
* Provides a client interface to the xdmp:yearday-from-date server function.
* @param arg The date whose days of the year will be returned. (of xs:date)
* @return a server expression with the xs:integer server data type
*/
public ServerExpression yeardayFromDate(ServerExpression arg);
}