Difference between revisions of "Conversion Module"

From BaseX Documentation
Jump to navigation Jump to search
(18 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
=Conventions=
 
=Conventions=
  
All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/convert</nowiki></code> namespace, which is statically bound to the {{Code|convert}} prefix.<br/>
+
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/convert</nowiki></code> namespace, which is statically bound to the {{Code|convert}} prefix.<br/>
All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
 
  
 
=Strings=
 
=Strings=
Line 16: Line 15:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specifed binary data (xs:base64Binary, xs:hexBinary) to a string:
+
|Converts the specifed {{Code|$bytes}} ({{Code|xs:base64Binary}}, {{Code|xs:hexBinary}}) to a string:
 
* The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
 
* The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
 
* By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
 
* By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXCO0001|#Errors}} The input is an invalid XML string, or the wrong encoding has been specified.<br/>{{Error|BXCO0002|#Errors}} The specified encoding is invalid or not supported.
+
|{{Error|string|#Errors}} The input is an invalid XML string, or the wrong encoding has been specified.<br/>{{Error|BXCO0002|#Errors}} The specified encoding is invalid or not supported.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 33: Line 32:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:string-to-base64|$input as xs:string|xs:base64Binary}}<br/>{{Func|convert:string-to-base64|$input as xs:string, $encoding as xs:string|xs:base64Binary}}
+
|{{Func|convert:string-to-base64|$string as xs:string|xs:base64Binary}}<br/>{{Func|convert:string-to-base64|$string as xs:string, $encoding as xs:string|xs:base64Binary}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified string to a {{Code|xs:base64Binary}} item. If the default encoding is chosen, conversion will be cheap, as both {{Code|xs:string}} and {{Code|xs:base64Binary}} items are internally represented as byte arrays.<br/>The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
+
|Converts the specified {{Code|$string}} to an {{Code|xs:base64Binary}} item. If the default encoding is chosen, conversion will be cheap, as strings and binaries are both internally represented as byte arrays.<br/>The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXCO0001|#Errors}} The input cannot be represented in the specified encoding.<br/>{{Error|BXCO0002|#Errors}} The specified encoding is invalid or not supported.
+
|{{Error|binary|#Errors}} The input cannot be represented in the specified encoding.<br/>{{Error|encoding|#Errors}} The specified encoding is invalid or not supported.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 51: Line 50:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:string-to-hex|$input as xs:string|xs:hexBinary}}<br/>{{Func|convert:string-to-hex|$input as xs:string, $encoding as xs:string|xs:hexBinary}}
+
|{{Func|convert:string-to-hex|$string as xs:string|xs:hexBinary}}<br/>{{Func|convert:string-to-hex|$string as xs:string, $encoding as xs:string|xs:hexBinary}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified string to a {{Code|xs:hexBinary}} item. If the default encoding is chosen, conversion will be cheap, as both {{Code|xs:string}} and {{Code|xs:hexBinary}} items are internally represented as byte arrays.<br/>The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
+
|Converts the specified {{Code|$string}} to an {{Code|xs:hexBinary}} item. If the default encoding is chosen, conversion will be cheap, as strings and binaries are both internally represented as byte arrays.<br/>The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXCO0001|#Errors}} The input cannot be represented in the specified encoding.<br/>{{Error|BXCO0002|#Errors}} The specified encoding is invalid or not supported.
+
|{{Error|binary|#Errors}} The input cannot be represented in the specified encoding.<br/>{{Error|encoding|#Errors}} The specified encoding is invalid or not supported.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 66: Line 65:
 
=Binary Data=
 
=Binary Data=
  
==convert:bytes-to-base64==
+
==convert:integers-to-base64==
  
{{Mark|Updated with Version 8.7}}: Argument type relaxed from {{Code|xs:byte}} to {{Code|xs:integer}}.
+
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|convert:integers-to-base64|$integers as xs:integer*|xs:base64Binary}}
 +
|-
 +
| '''Summary'''
 +
|Converts the specified {{Code|$integers}} to an item of type {{Code|xs:base64Binary}}:
 +
* Only the first 8 bits of the supplied integers will be considered.
 +
* Conversion of byte sequences is particularly cheap, as items of binary type are internally represented as byte arrays.
 +
|}
 +
 
 +
==convert:integers-to-hex==
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:bytes-to-base64|$input as xs:integer*|xs:base64Binary}}
+
|{{Func|convert:integers-to-hex|$integers as xs:integer*|xs:hexBinary}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified integer sequence to a {{Code|xs:base64Binary}} item. Conversion of byte sequences is particularly cheap, as {{Code|xs:base64Binary}} items are internally represented as byte arrays.
+
|Converts the specified {{Code|$integers}} to an item of type {{Code|xs:hexBinary}}:
|-
+
* Only the first 8 bits of the supplied integers will be considered.
| '''Errors'''
+
* Conversion of byte sequences is particularly cheap, as items of binary type are internally represented as byte arrays.
|{{Error|BXCO0001|#Errors}} The input cannot be represented in the specified encoding.<br/>{{Error|BXCO0002|#Errors}} The specified encoding is invalid or not supported.
 
 
|}
 
|}
  
==convert:bytes-to-hex==
+
==convert:binary-to-integers==
 
 
{{Mark|Updated with Version 8.7}}: Argument type relaxed from {{Code|xs:byte}} to {{Code|xs:integer}}.
 
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:bytes-to-hex|$input as xs:integer*|xs:hexBinary}}
+
|{{Func|convert:binary-to-integer|$binary as xs:anyAtomicType|xs:integer*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified integer sequence to a {{Code|xs:hexBinary}} item. Conversion of byte sequences is particularly cheap, as {{Code|xs:hexBinary}} items are internally represented as byte arrays.
+
|Returns the specified {{Code|$binary}} ({{Code|xs:base64Binary}}, {{Code|xs:hexBinary}}) as a sequence of unsigned integers (octets).
 +
|-
 +
| '''Examples'''
 +
|
 +
* <code>convert:binary-to-integer(xs:hexBinary('FF'))</code> yields {{Code|255}}.
 
|}
 
|}
  
Line 100: Line 111:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:binary-to-bytes|$bin as xs:anyAtomicType|xs:byte*}}
+
|{{Func|convert:binary-to-bytes|$binary as xs:anyAtomicType|xs:byte*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns the specified binary data (xs:base64Binary, xs:hexBinary) as a sequence of bytes.
+
|Returns the specified {{Code|$binary}} ({{Code|xs:base64Binary}}, {{Code|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'''
 
| '''Examples'''
Line 118: Line 129:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:integer-to-base|$num as xs:integer, $base as xs:integer|xs:string}}<br />
+
|{{Func|convert:integer-to-base|$number as xs:integer, $base as xs:integer|xs:string}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts {{Code|$num}} to base {{Code|$base}}, interpreting it as a 64-bit unsigned integer.<br />The first {{Code|$base}} elements of the sequence {{Code|'0',..,'9','a',..,'z'}} are used as digits.<br />Valid bases are {{Code|2, .., 36}}.<br />
+
|Converts {{Code|$number}} to a string, using the specified {{Code|$base}}, interpreting it as a 64-bit unsigned integer.<br />The first base elements of the sequence {{Code|'0',..,'9','a',..,'z'}} are used as digits.<br />Valid bases are {{Code|2, .., 36}}.<br />
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXCO0004|#Errors}} The specified base is not in the range 2-36.
+
|{{Error|base|#Errors}} The specified base is not in the range 2-36.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 137: Line 148:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:integer-from-base|$str as xs:string, $base as xs:integer|xs:integer}}<br />
+
|{{Func|convert:integer-from-base|$string as xs:string, $base as xs:integer|xs:integer}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Decodes an {{Code|xs:integer}} from {{Code|$str}}, assuming that it's encoded in base {{Code|$base}}.<br /> The first {{Code|$base}} elements of the sequence {{Code|'0',..,'9','a',..,'z'}} are allowed as digits, case doesn't matter. <br />Valid bases are 2 - 36.<br /> If {{Code|$str}} contains more than 64 bits of information, the result is truncated arbitarily.
+
|Decodes an integer from {{Code|$string}}, using the specified {{Code|$base}}.<br /> The first base elements of the sequence {{Code|'0',..,'9','a',..,'z'}} are allowed as digits; case does not matter. <br />Valid bases are 2 - 36.<br /> If the supplied string contains more than 64 bits of information, the result will be truncated.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXCO0004|#Errors}} The specified base is not in the range 2-36.<br/>{{Error|BXCO0005|#Errors}} The specified digit is not valid for the given range.
+
|{{Error|base|#Errors}} The specified base is not in the range 2-36.<br/>{{Error|integer|#Errors}} The specified digit is not valid for the given range.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 160: Line 171:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:integer-to-dateTime|$ms as xs:integer|xs:dateTime}}<br />
+
|{{Func|convert:integer-to-dateTime|$milliseconds as xs:integer|xs:dateTime}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified number of milliseconds since 1 Jan 1970 to an item of type xs:dateTime.<br />
+
|Converts the specified number of {{Code|$milliseconds}} since 1 Jan 1970 to an item of type xs:dateTime.<br />
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 180: Line 191:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified item of type xs:dateTime to the number of milliseconds since 1 Jan 1970.<br />
+
|Converts the specified {{Code|$dateTime}} item to the number of milliseconds since 1 Jan 1970.<br />
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 192: Line 203:
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|convert:integer-to-dayTime|$ms as xs:integer|xs:dayTimeDuration}}<br />
+
|{{Func|convert:integer-to-dayTime|$milliseconds as xs:integer|xs:dayTimeDuration}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified number of milliseconds to an item of type xs:dayTimeDuration.<br />
+
|Converts the specified number of {{Code|$milliseconds}} to an item of type xs:dayTimeDuration.<br />
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 210: Line 221:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Converts the specified item of type xs:dayTimeDuration to milliseconds represented by an integer.<br />
+
|Converts the specified {{Code|$dayTime}} duration to milliseconds represented by an integer.<br />
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 223: Line 234:
 
| Description
 
| Description
 
|-
 
|-
|{{Code|BXCO0001}}
+
|{{Code|base}}
|The input is an invalid XML string, or the wrong encoding has been specified.
+
|The specified base is not in the range 2-36.
|-
 
|{{Code|BXCO0002}}
 
|The specified encoding is invalid or not supported.
 
 
|-
 
|-
|{{Code|BXCO0003}}
+
|{{Code|binary}}
|The specified base is not in the range 2-36.
+
|The input cannot be converted to a binary representation.
 
|-
 
|-
|{{Code|BXCO0004}}
+
|{{Code|encoding}}
 
|The specified encoding is invalid or not supported.
 
|The specified encoding is invalid or not supported.
 
|-
 
|-
|{{Code|BXCO0005}}
+
|{{Code|integer}}
 
|The specified digit is not valid for the given range.
 
|The specified digit is not valid for the given range.
 +
|-
 +
|{{Code|string}}
 +
|The input is an invalid XML string, or the wrong encoding has been specified.
 
|}
 
|}
  
 
=Changelog=
 
=Changelog=
  
;Version 8.7
+
;Version 9.0
 
 
* Updated: [[#convert:bytes-to-base64|convert:bytes-to-base64]], [[#convert:bytes-to-hex|convert:bytes-to-hex]]: Argument type relaxed from {{Code|xs:byte}} to {{Code|xs:integer}}.
 
  
 +
* Added: [[#convert:binary-to-integers|convert:binary-to-integers]].
 +
* Updated: [[#convert:integers-to-base64|convert:integers-to-base64]], [[#convert:integers-to-hex|convert:integers-to-hex]]: Renamed from {{Code|convert:bytes-to-base64}}; argument type relaxed from {{Code|xs:byte}} to {{Code|xs:integer}}.
 +
* Updated: error codes updated; errors now use the module namespace
  
 
;Version 8.5
 
;Version 8.5

Revision as of 11:15, 8 June 2018

This XQuery Module contains functions to convert data between different formats.

Conventions

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

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
convert:binary-to-string($bytes as xs:anyAtomicType, $encoding as xs:string, $fallback as xs:boolean) as xs:string
Summary Converts the specifed $bytes (xs:base64Binary, xs:hexBinary) to a string:
  • The UTF-8 default encoding can be overwritten with the optional $encoding argument.
  • By default, invalid characters will be rejected. If $fallback is set to true, these characters will be replaced with the Unicode replacement character FFFD (�).
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:binary-to-string(xs:hexBinary('48656c6c6f576f726c64')) yields HelloWorld.

convert:string-to-base64

Signatures convert:string-to-base64($string as xs:string) as xs:base64Binary
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
  • string(convert:string-to-base64('HelloWorld')) yields SGVsbG9Xb3JsZA==.

convert:string-to-hex

Signatures convert:string-to-hex($string as xs:string) as xs:hexBinary
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
  • string(convert:string-to-hex('HelloWorld')) yields 48656C6C6F576F726C64.

Binary Data

convert:integers-to-base64

Signatures convert:integers-to-base64($integers as xs:integer*) as xs:base64Binary
Summary Converts the specified $integers to an item of type xs:base64Binary:
  • Only the first 8 bits of the supplied integers will be considered.
  • Conversion of byte sequences is particularly cheap, as items of binary type are internally represented as byte arrays.

convert:integers-to-hex

Signatures convert:integers-to-hex($integers as xs:integer*) as xs:hexBinary
Summary Converts the specified $integers to an item of type xs:hexBinary:
  • Only the first 8 bits of the supplied integers will be considered.
  • Conversion of byte sequences is particularly cheap, as items of binary type are internally represented as byte arrays.

convert:binary-to-integers

Signatures convert:binary-to-integer($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-integer(xs:hexBinary('FF')) yields 255.

convert:binary-to-bytes

Signatures 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
  • convert:binary-to-bytes(xs:base64Binary('QmFzZVggaXMgY29vbA==')) yields the sequence (66, 97, 115, 101, 88, 32, 105, 115, 32, 99, 111, 111, 108).
  • convert:binary-to-bytes(xs:hexBinary("4261736558")) yields the sequence (66 97 115 101 88).

Numbers

convert:integer-to-base

Signatures 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-to-base(-1, 16) yields 'ffffffffffffffff'.
  • convert:integer-to-base(22, 5) yields '42'.

convert:integer-from-base

Signatures 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
  • convert:integer-from-base('ffffffffffffffff', 16) yields -1.
  • convert:integer-from-base('CAFEBABE', 16) yields 3405691582.
  • convert:integer-from-base('42', 5) yields 22.
  • convert:integer-from-base(convert:integer-to-base(123, 7), 7) yields 123.

Dates and Durations

convert:integer-to-dateTime

Signatures 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:integer-to-dateTime(0) yields 1970-01-01T00:00:00Z.
  • convert:integer-to-dateTime(1234567890123) yields 2009-02-13T23:31:30.123Z.
  • convert:integer-to-dateTime(prof:current-ms()) returns the current miliseconds in the xs:dateTime format.

convert:dateTime-to-integer

Signatures 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:dateTime-to-integer(xs:dateTime('1970-01-01T00:00:00Z')) yields 0.

convert:integer-to-dayTime

Signatures 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:integer-to-dayTime(1234) yields PT1.234S.

convert:dayTime-to-integer

Signatures convert:dayTime-to-integer($dayTime as xs:dayTimeDuration) as xs:integer
Summary Converts the specified $dayTime duration to milliseconds represented by an integer.
Examples
  • convert:dayTime-to-integer(xs:dayTimeDuration('PT1S')) yields 1000.

Errors

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.
string The input is an invalid XML string, or the wrong encoding has been specified.

Changelog

Version 9.0
Version 8.5
Version 7.5

The module was introduced with Version 7.3. Some of the functions have been adopted from the obsolete Utility Module.