Difference between revisions of "Conversion Module"
Jump to navigation
Jump to search
m (Text replace - "\[\[Category:XQuery\]\]" to "") |
|||
Line 23: | Line 23: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:binary-to-string(xs:hexBinary('48656c6c6f576f726c64'))}} | + | * {{Code|convert:binary-to-string(xs:hexBinary('48656c6c6f576f726c64'))}} yields {{Code|HelloWorld}}. |
|} | |} | ||
Line 41: | Line 41: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:string-to-base64('HelloWorld')}} | + | * {{Code|string(convert:string-to-base64('HelloWorld'))}} yields <code>SGVsbG9Xb3JsZA==</code>. |
|} | |} | ||
Line 59: | Line 59: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:string-to-hex('HelloWorld')}} | + | * {{Code|string(convert:string-to-hex('HelloWorld'))}} yields {{Code|48656C6C6F576F726C64}}. |
|} | |} | ||
Line 79: | Line 79: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:string-to-base64('HelloWorld')}} | + | * {{Code|string(convert:string-to-base64('HelloWorld'))}} yields <code>SGVsbG9Xb3JsZA==</code>. |
|} | |} | ||
Line 105: | Line 105: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code>convert:binary-to-bytes(xs:base64Binary('QmFzZVggaXMgY29vbA=='))</code> | + | * <code>convert:binary-to-bytes(xs:base64Binary('QmFzZVggaXMgY29vbA=='))</code> yields the sequence {{Code|(66, 97, 115, 101, 88, 32, 105, 115, 32, 99, 111, 111, 108)}}. |
− | * {{Code|convert:binary-to-bytes(xs:hexBinary("4261736558"))}} | + | * {{Code|convert:binary-to-bytes(xs:hexBinary("4261736558"))}} yields the sequence {{Code|(66 97 115 101 88)}}. |
|} | |} | ||
Line 126: | Line 126: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:integer-to-base(-1, 16)}} | + | * {{Code|convert:integer-to-base(-1, 16)}} yields {{Code|'ffffffffffffffff'}}. |
− | * {{Code|convert:integer-to-base(22, 5)}} | + | * {{Code|convert:integer-to-base(22, 5)}} yields {{Code|'42'}}. |
|} | |} | ||
Line 145: | Line 145: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:integer-from-base('ffffffffffffffff', 16)}} | + | * {{Code|convert:integer-from-base('ffffffffffffffff', 16)}} yields {{Code|-1}}. |
− | * {{Code|convert:integer-from-base('CAFEBABE', 16)}} | + | * {{Code|convert:integer-from-base('CAFEBABE', 16)}} yields {{Code|3405691582}}. |
− | * {{Code|convert:integer-from-base('42', 5)}} | + | * {{Code|convert:integer-from-base('42', 5)}} yields {{Code|22}}. |
− | * {{Code|convert:integer-from-base(convert:integer-to-base(123, 7), 7)}} | + | * {{Code|convert:integer-from-base(convert:integer-to-base(123, 7), 7)}} yields {{Code|123}}. |
|} | |} | ||
Line 165: | Line 165: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:integer-to-dateTime(0)}} | + | * {{Code|convert:integer-to-dateTime(0)}} yields {{Code|1970-01-01T00:00:00Z}}. |
− | * {{Code|convert:integer-to-dateTime(1234567890123)}} | + | * {{Code|convert:integer-to-dateTime(1234567890123)}} yields {{Code|2009-02-13T23:31:30.123Z}}. |
|} | |} | ||
Line 181: | Line 181: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:dateTime-to-integer(xs:dateTime('1970-01-01T00:00:00Z'))}} | + | * {{Code|convert:dateTime-to-integer(xs:dateTime('1970-01-01T00:00:00Z'))}} yields {{Code|0}}. |
|} | |} | ||
Line 196: | Line 196: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:integer-to-dayTime(1234)}} | + | * {{Code|convert:integer-to-dayTime(1234)}} yields {{Code|PT1.234S}}. |
|} | |} | ||
Line 211: | Line 211: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|convert:dayTime-to-integer(xs:dayTimeDuration('PT1S'))}} | + | * {{Code|convert:dayTime-to-integer(xs:dayTimeDuration('PT1S'))}} yields {{Code|1000}}. |
|} | |} | ||
Revision as of 11:29, 22 May 2016
This XQuery Module contains functions to convert data between different formats.
Conventions
All functions in this module are assigned to the http://basex.org/modules/convert
namespace, which is statically bound to the convert
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Strings
convert:binary-to-string
Signatures | convert:binary-to-string($bytes as xs:anyAtomicType) as xs:string convert:binary-to-string($bytes as xs:anyAtomicType, $encoding as xs:string) as xs:string
|
Summary | Converts the specifed binary data (xs:base64Binary, xs:hexBinary) to a string. The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input is an invalid XML string, or the wrong encoding has been specified. Invalid XML characters will be ignored if the CHECKSTRINGS option is turned off.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:string-to-base64
Signatures | convert:string-to-base64($input as xs:string) as xs:base64Binary convert:string-to-base64($input as xs:string, $encoding as xs:string) as xs:base64Binary
|
Summary | Converts the specified string to a xs:base64Binary item. If the default encoding is chosen, conversion will be cheap, as both xs:string and xs:base64Binary items are internally represented as byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:string-to-hex
Signatures | convert:string-to-hex($input as xs:string) as xs:hexBinary convert:string-to-hex($input as xs:string, $encoding as xs:string) as xs:hexBinary
|
Summary | Converts the specified string to a xs:hexBinary item. If the default encoding is chosen, conversion will be cheap, as both xs:string and xs:hexBinary items are internally represented as byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
Binary Data
convert:bytes-to-base64
Signatures | convert:bytes-to-base64($input as xs:byte*) as xs:base64Binary
|
Summary | Converts the specified byte sequence to a xs:base64Binary item. Conversion is cheap, as xs:base64Binary items are internally represented as byte arrays.
|
Errors | BXCO0001 : The input cannot be represented in the specified encoding.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:bytes-to-hex
Signatures | convert:bytes-to-hex($input as xs:byte*) as xs:hexBinary
|
Summary | Converts the specified byte sequence to a xs:hexBinary item. Conversion is cheap, as xs:hexBinary items are internally represented as byte arrays.
|
convert:binary-to-bytes
Signatures | convert:binary-to-bytes($bin as xs:anyAtomicType) as xs:byte*
|
Summary | Returns the specified binary data (xs:base64Binary, xs:hexBinary) as a sequence of bytes. |
Examples |
|
Numbers
convert:integer-to-base
Signatures | convert:integer-to-base($num as xs:integer, $base as xs:integer) as xs:string |
Summary | Converts $num to base $base , interpreting it as a 64-bit unsigned integer.The first $base elements of the sequence '0',..,'9','a',..,'z' are used as digits.Valid bases are 2, .., 36 . |
Errors | BXCO0004 : The specified base is not in the range 2-36.
|
Examples |
|
convert:integer-from-base
Signatures | convert:integer-from-base($str as xs:string, $base as xs:integer) as xs:integer |
Summary | Decodes an xs:integer from $str , assuming that it's encoded in base $base .The first $base elements of the sequence '0',..,'9','a',..,'z' are allowed as digits, case doesn't matter. Valid bases are 2 - 36. If $str contains more than 64 bits of information, the result is truncated arbitarily.
|
Errors | BXCO0004 : The specified base is not in the range 2-36.BXCO0005 : The specified digit is not valid for the given range.
|
Examples |
|
Dates and Durations
convert:integer-to-dateTime
Signatures | convert:integer-to-dateTime($ms as xs:integer) as xs:dateTime |
Summary | Converts the specified number of milliseconds since 1 Jan 1970 to an item of type xs:dateTime. |
Examples |
|
convert:dateTime-to-integer
Signatures | convert:dateTime-to-integer($dateTime as xs:dateTime) as xs:integer |
Summary | Converts the specified item of type xs:dateTime to the number of milliseconds since 1 Jan 1970. |
Examples |
|
convert:integer-to-dayTime
Signatures | convert:integer-to-dayTime($ms as xs:integer) as xs:dayTimeDuration |
Summary | Converts the specified number of milliseconds to an item of type xs:dayTimeDuration. |
Examples |
|
convert:dayTime-to-integer
Signatures | convert:dayTime-to-integer($dayTime as xs:dayTimeDuration) as xs:integer |
Summary | Converts the specified item of type xs:dayTimeDuration to milliseconds represented by an integer. |
Examples |
|
Errors
Code | Description |
---|---|
BXCO0001
|
The input is an invalid XML string, or the wrong encoding has been specified. |
BXCO0002
|
The specified encoding is invalid or not supported. |
BXCO0003
|
The specified base is not in the range 2-36. |
BXCO0004
|
The specified encoding is invalid or not supported. |
BXCO0005
|
The specified digit is not valid for the given range. |
Changelog
- Version 7.5
- Added:
convert:integer-to-dateTime
,convert:dateTime-to-integer
,convert:integer-to-dayTime
,convert:dayTime-to-integer
The module was introduced with Version 7.3. Some of the functions have been adopted from the obsolete Utility Module.