Difference between revisions of "Conversion Module"
Jump to navigation
Jump to search
m (Text replacement - "<br />" to "<br/>") |
(→Keys) |
||
(8 intermediate revisions by the same user not shown) | |||
Line 11: | Line 11: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:binary-to-string( |
+ | $bytes as xs:anyAtomicType, | ||
+ | $encoding as xs:string := (), | ||
+ | $fallback as xs:boolean? := false() | ||
+ | ) as xs:string</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 31: | Line 35: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:string-to-base64( |
+ | $string as xs:string, | ||
+ | $encoding as xs:string := () | ||
+ | ) as xs:base64Binary</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 49: | Line 56: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:string-to-hex( |
+ | $string as xs:string, | ||
+ | $encoding as xs:string := () | ||
+ | ) as xs:hexBinary</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 69: | Line 79: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integers-to-base64( |
+ | $integers as xs:integer* | ||
+ | ) as xs:base64Binary</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 86: | Line 98: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integers-to-hex( |
+ | $integers as xs:integer* | ||
+ | ) as xs:hexBinary</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 99: | Line 113: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:binary-to-integers( |
+ | $binary as xs:anyAtomicType | ||
+ | ) as xs:integer*</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 114: | Line 130: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:binary-to-bytes( |
+ | $binary as xs:anyAtomicType | ||
+ | ) as xs:byte*</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 132: | Line 150: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integer-to-base( |
+ | $number as xs:integer, | ||
+ | $base as xs:integer | ||
+ | ) as xs:string</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 151: | Line 172: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integer-from-base( |
+ | $string as xs:string, | ||
+ | $base as xs:integer | ||
+ | ) as xs:integer</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 174: | Line 198: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integer-to-dateTime( |
+ | $milliseconds as xs:integer | ||
+ | ) as xs:dateTime</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 191: | Line 217: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:dateTime-to-integer( |
+ | $dateTime as xs:dateTime | ||
+ | ) as xs:integer</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 206: | Line 234: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:integer-to-dayTime( |
+ | $milliseconds as xs:integer | ||
+ | ) as xs:dayTimeDuration</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 221: | Line 251: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:dayTime-to-integer( |
+ | $dayTime as xs:dayTimeDuration | ||
+ | ) as xs:integer</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
Line 233: | Line 265: | ||
=Keys= | =Keys= | ||
+ | |||
+ | The key conversion is employed by the [[JSON Module]] and the [[CSV Module]] to encode strings to valid element names and back to the original representation: | ||
+ | |||
+ | * If lax conversion is '''disabled''', invalid characters are replaced with underscores or (when invalid as first character of an element name) prefixed with an underscore. The resulting string may be better readable, but it cannot necessarily be converted back to the original form. | ||
+ | * With lax conversion '''enabled''', a string is encoded to a valid NCName representation: | ||
+ | ** An empty string is converted to a single underscore ({{Code|_}}). | ||
+ | ** Existing underscores are rewritten to two underscores ({{Code|__}}). | ||
+ | ** Characters that are no valid NCName characters are rewritten to an underscore and the character’s four-digit Unicode. For example, the exclamation mark {{Code|?}} is transformed to {{Code|_003f}}. | ||
==convert:encode-key== | ==convert:encode-key== | ||
Line 238: | Line 278: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:encode-key( |
+ | $key as xs:string, | ||
+ | $lax as xs:boolean? := false() | ||
+ | ) as xs:string</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Encodes the specified {{Code|$key}} (with the optional {{Code|$lax}} conversion method) to a valid NCName representation, which can be used to create an element node | + | |Encodes the specified {{Code|$key}} (with the optional {{Code|$lax}} conversion method) to a valid NCName representation, which can be used to create an element node. This encoding is employed by the [[JSON Module]] and the [[CSV Module]]. |
− | |||
− | |||
− | |||
− | |||
− | This encoding is employed by | ||
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
Line 258: | Line 296: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
− | | width='120' | ''' | + | | width='120' | '''Signature''' |
− | | | + | |<pre>convert:decode-key( |
+ | $key as xs:string, | ||
+ | $lax as xs:boolean? := false() | ||
+ | ) as xs:string</pre> | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Decodes the specified {{Code|$key}} (with the optional {{Code|$lax}} conversion method) to the original string representation.<br/>Keys supplied to this function | + | |Decodes the specified {{Code|$key}} (with the optional {{Code|$lax}} conversion method) to the original string representation.<br/>Keys supplied to this function can be element names that have been created by the [[JSON Module]] or [[CSV Module]]. |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' |
Latest revision as of 18:37, 20 June 2023
This XQuery Module contains functions to convert data between different formats.
Contents
Conventions[edit]
All functions and errors in this module are assigned to the http://basex.org/modules/convert
namespace, which is statically bound to the convert
prefix.
Strings[edit]
convert:binary-to-string[edit]
Signature | convert:binary-to-string( $bytes as xs:anyAtomicType, $encoding as xs:string := (), $fallback as xs:boolean? := false() ) as xs:string |
Summary | Converts the specifed $bytes (xs:base64Binary , xs:hexBinary ) to a string:
|
Errors | string : The input is an invalid XML string, or the wrong encoding has been specified.BXCO0002 : The specified encoding is invalid or not supported.
|
Examples |
|
convert:string-to-base64[edit]
Signature | convert:string-to-base64( $string as xs:string, $encoding as xs:string := () ) as xs:base64Binary |
Summary | Converts the specified $string to an xs:base64Binary item. If the default encoding is chosen, conversion will be cheap, as strings and binaries are both internally represented as byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | binary : The input cannot be represented in the specified encoding.encoding : The specified encoding is invalid or not supported.
|
Examples |
|
convert:string-to-hex[edit]
Signature | convert:string-to-hex( $string as xs:string, $encoding as xs:string := () ) as xs:hexBinary |
Summary | Converts the specified $string to an xs:hexBinary item. If the default encoding is chosen, conversion will be cheap, as strings and binaries are both internally represented as byte arrays.The UTF-8 default encoding can be overwritten with the optional $encoding argument.
|
Errors | binary : The input cannot be represented in the specified encoding.encoding : The specified encoding is invalid or not supported.
|
Examples |
|
Binary Data[edit]
convert:integers-to-base64[edit]
Signature | convert:integers-to-base64( $integers as xs:integer* ) as xs:base64Binary |
Summary | Converts the specified $integers to an item of type xs:base64Binary :
|
Examples |
|
convert:integers-to-hex[edit]
Signature | convert:integers-to-hex( $integers as xs:integer* ) as xs:hexBinary |
Summary | Converts the specified $integers to an item of type xs:hexBinary :
|
convert:binary-to-integers[edit]
Signature | convert:binary-to-integers( $binary as xs:anyAtomicType ) as xs:integer* |
Summary | Returns the specified $binary (xs:base64Binary , xs:hexBinary ) as a sequence of unsigned integers (octets).
|
Examples |
|
convert:binary-to-bytes[edit]
Signature | convert:binary-to-bytes( $binary as xs:anyAtomicType ) as xs:byte* |
Summary | Returns the specified $binary (xs:base64Binary , xs:hexBinary ) as a sequence of bytes. The conversion is very cheap and takes no additional memory, as items of binary type are internally represented as byte arrays.
|
Examples |
|
Numbers[edit]
convert:integer-to-base[edit]
Signature | convert:integer-to-base( $number as xs:integer, $base as xs:integer ) as xs:string |
Summary | Converts $number to a string, using the specified $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 | base : The specified base is not in the range 2-36.
|
Examples |
|
convert:integer-from-base[edit]
Signature | convert:integer-from-base( $string as xs:string, $base as xs:integer ) as xs:integer |
Summary | Decodes an integer from $string , using the specified $base .The first base elements of the sequence '0',..,'9','a',..,'z' are allowed as digits; case does not matter. Valid bases are 2 - 36. If the supplied string contains more than 64 bits of information, the result will be truncated. |
Errors | base : The specified base is not in the range 2-36.integer : The specified digit is not valid for the given range.
|
Examples |
|
Dates and Durations[edit]
convert:integer-to-dateTime[edit]
Signature | convert:integer-to-dateTime( $milliseconds 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[edit]
Signature | convert:dateTime-to-integer( $dateTime as xs:dateTime ) as xs:integer |
Summary | Converts the specified $dateTime item to the number of milliseconds since 1 Jan 1970. |
Examples |
|
convert:integer-to-dayTime[edit]
Signature | convert:integer-to-dayTime( $milliseconds 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[edit]
Signature | convert:dayTime-to-integer( $dayTime as xs:dayTimeDuration ) as xs:integer |
Summary | Converts the specified $dayTime duration to milliseconds represented by an integer. |
Examples |
|
Keys[edit]
The key conversion is employed by the JSON Module and the CSV Module to encode strings to valid element names and back to the original representation:
- If lax conversion is disabled, invalid characters are replaced with underscores or (when invalid as first character of an element name) prefixed with an underscore. The resulting string may be better readable, but it cannot necessarily be converted back to the original form.
- With lax conversion enabled, a string is encoded to a valid NCName representation:
- An empty string is converted to a single underscore (
_
). - Existing underscores are rewritten to two underscores (
__
). - Characters that are no valid NCName characters are rewritten to an underscore and the character’s four-digit Unicode. For example, the exclamation mark
?
is transformed to_003f
.
- An empty string is converted to a single underscore (
convert:encode-key[edit]
Signature | convert:encode-key( $key as xs:string, $lax as xs:boolean? := false() ) as xs:string |
Summary | Encodes the specified $key (with the optional $lax conversion method) to a valid NCName representation, which can be used to create an element node. This encoding is employed by the JSON Module and the CSV Module.
|
Examples |
|
convert:decode-key[edit]
Signature | convert:decode-key( $key as xs:string, $lax as xs:boolean? := false() ) as xs:string |
Summary | Decodes the specified $key (with the optional $lax conversion method) to the original string representation.Keys supplied to this function can be element names that have been created by the JSON Module or CSV Module. |
Examples |
|
Errors | key : The specified key cannot be decoded to its original representation.
|
Errors[edit]
Code | Description |
---|---|
base
|
The specified base is not in the range 2-36. |
binary
|
The input cannot be converted to a binary representation. |
encoding
|
The specified encoding is invalid or not supported. |
integer
|
The specified digit is not valid for the given range. |
key
|
The specified key cannot be decoded to its original representation. |
string
|
The input is an invalid XML string, or the wrong encoding has been specified. |
Changelog[edit]
- Version 9.4
- Added:
convert:encode-key
,convert:decode-key
.
- Version 9.0
- Added:
convert:binary-to-integers
. - Updated:
convert:integers-to-base64
,convert:integers-to-hex
: Renamed fromconvert:bytes-to-base64
; argument type relaxed fromxs:byte
toxs:integer
. - Updated: error codes updated; errors now use the module namespace
- Version 8.5
- Updated:
convert:binary-to-string
:$fallback
argument added.
- 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.