Changes

Jump to navigation Jump to search
2,969 bytes added ,  16:04, 19 July 2021
Please bear in mind that the execution of Java code may cause side effects that conflict with the functional nature of XQuery, or may introduce new security risks to your project.
 
{{Mark|Updated with Version 9.6:}}
* With the middle dot notation, three adjacent dots can be used to specify array types.
* The path to the standard package {{Code|java.lang.}} can now be omitted.
* Java objects are now wrapped into function items.
* Results of constructor calls are always returned as function item.
* A new option {{Option|WRAPJAVA}} was added to control how Java values are converted to XQuery.
* The Mapping rules were refined and unified. The most important changes:
** {{Code|array(*)}} type added.
** {{Code|xs:integer}} values are converted to {{Code|long}} values.
** {{Code|xs:unsignedShort}} values are converted to {{Code|char}} values.
* All error messages were revised and improved.
=Identification=
# The last path segment of the URI is capitalized and rewritten to [https://en.wikipedia.org/wiki/CamelCase CamelCase].
The normalization steps are skipped if the URI is prefixed with {{Code|java:}}. The path to the standard package {{Code|java.lang.}} can be omitted:
* <code><nowiki>http://basex.org/modules/meta-data</nowiki></code> → <code>org.basex.modules.MetaData</code>
* <code>java:java.lang.String</code> → <code>java.lang.String</code>
* <code>StringBuilder</code> → <code>java.lang.StringBuilder</code>
==Functions and Variables==
Java constructors, functions and variables can be referenced and evaluated by the existing XQuery function syntax:
* The namespace of the function name identifies the Java class.
* The local part of the name, which is rewritten to camel case, identifies a variable or function of that class.
* The middle dot character <code>[https://www.fileformat.info/info/unicode/char/b7/index.htm ·]</code> (<code>&amp;#xB7;</code>, a valid character in XQuery names, but not in Java) can be used to append exact Java parameter types to the function name. Class types must be referenced by their full path. Three adjacent dots can be used to address an array argument.
{| class="wikitable"
|- valign="top"
! TypeAddressed code
! XQuery
! Java
|- valign="top"
| Variable
| <code>Q{java.lang.Integer}MIN_VALUE()</code>| <code>[https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html#MAX_VALUE Integer.MIN_VALUE]</code>
|- valign="top"
| Function
| <code>Q{java.lang.Object}hash-code($object)</code>| <code>[https://docsobject.oracle.comhashCode()</javase/8/docs/api/java/lang/Object.html#hashCodecode>|- valign="top"| Function with argument| <code>Q{String}split·String·int($string, ';', xs:int(3)) object</code>| <code>string.hashCodesplit(";", 3)]</code>
|- valign="top"
| Function Constructor with typesarray argument| <code>Q{java.lang.String}split·javanew·byte..lang.String·int($string, ';', xs:inthexBinary(3'414243'))</code>| <code>[https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#split-java.lang.new String-int- string.split(";"new byte[] { 41, 42, 343 })]</code>
|}
As XQuery and Java have different type systems, XQuery arguments are must be converted to equivalent Java values, and the result of a Java function is converted back to an XQuery value (see [[#Data Types|Data Types]]).
If the Java function you want to address is not detected, you may need to cast your values to the target type. For example, if a Java function expects a primitive {{Code|int}} value, you will need to convert your XQuery integers to {{Code|xs:int}}.
=Namespace Declarations=
In the following example, Java’s the Java {{Code|Math}} class is referenced. When executed, the query returns the cosine of an angle by calling the static method {{Code|cos()}}, and the value of π by addressing the static variable via {{Code|PI()}}:
<syntaxhighlight lang="xquery">
</syntaxhighlight>
With the [[XQuery 3.0#Expanded QNames|Expanded QName]] notation of XQuery 3.0,the namespace can directly be embedded in the function call:
<syntaxhighlight lang="xquery">
<syntaxhighlight lang="xquery">
declare namespace fw = "'java:java.io.FileWriter"';
let $file := fw:new('output.txt')
return (
<syntaxhighlight lang="xquery">
declare namespace br = 'java:java.io.BufferedReader';declare namespace fr = 'java:java.io.FileReader';
declare option db:checkstrings 'false';
(: write file :)
file:write-binary('00.bin', xs:hexBinary('00')),
(: read file :)let $br := br:new(fr:new('00.bin'))return ( br:readLine($br), br:close($br))</syntaxhighlight> The option can also be specified via a pragma: <syntaxhighlight lang="xquery">(# db:checkstrings #) { br:new(fr:new('00.bin')) ! (br:readLine(.), br:close(.))}
</syntaxhighlight>
==Data Types==
 
{{Mark|Updated with Version 9.6:}}
* New option {{Option|WRAPJAVA}}.
* {{Code|array(*)}} type added.
* {{Code|xs:integer}} values are converted to {{Code|long}} values.
* {{Code|xs:unsignedShort}} values are converted to {{Code|char}} values.
===Conversion to Java===
===Conversion to XQuery===
The conversion back By default, Java values with the most common types (as shown in the second and third column of the table) are converted to XQuery can be controlled values. All other values are returned as ''Java items'', which are function items with the {{Option|WRAPJAVA}} optiona wrapped Java value. The following values exist:results of constructor calls are always returned as Java items.
* {{Code|some}} (The conversion of the default): wrapped Java values with the most common types are converted value to XQuery, as shown in the second and third column of the table.* {{Code|none}}: The conversion is enforcedby invoking the function item: Additional to the default conversions, values of type Values in {{Code|Iterator}} and {{Code|Iterable}} instances (including Lists, Sets and Collections) are converted to sequencesitems, and maps are converted to XQuery maps. If no conversion is possible, an error is raised. With {{Function|Conversion|convert:from- <syntaxhighlight lang="xquery">declare namespace Scanner = 'java:java}}, the conversion of a wrapped Java object can be enforced.util.Scanner';* {{Code|all}}let $scanner := Scanner:new("A B C") => Scanner: All values useDelimiter(" ")return $scanner(excluding those inheriting the internal type {{Code|org.basex.query.value.Value}}) are returned as wrapped Java objects. The wrapped objects can be passed on to other Java functions without intermediate conversions.</syntaxhighlight>
The option can be specified via If no conversion is defined, a pragma. In the following examplestring is returned, resulting from the result of the first function – a char array – is wrapped and passed on to a {{Code|CharBuffertoString()}} functionmethod of the object. This method is also called is the string representation of a Java item is requested:
<syntaxhighlight lang="xquery">
(: returns the string representations of a HashMap and an ArrayList instance :)
'Map: ' || Q{java.util.HashMap}new(),
string(Q{java:java.util.ArrayList}new())
</syntaxhighlight>
 
The conversion can be further controlled with the {{Option|WRAPJAVA}} option. The following values exist:
 
{| class="wikitable"
|- valign="top"
! Value
! Description
|- valign="top"
| {{Code|some}}
| The default: Java values of the most common types are converted, others are wrapped into Java items.
|- valign="top"
| {{Code|none}}
| All Java values are converted. If no conversion is defined, a string is returned, resulting from the {{Code|toString()}} method.
|- valign="top"
| {{Code|all}}
| Java values are wrapped into Java items (excluding those inheriting the internal type {{Code|org.basex.query.value.Value}}).
|- valign="top"
| {{Code|instance}}
| If the method of a class instance was called, the Java value is ignored and the instance is wrapped into a Java item. Otherwise, the Java value is returned.
|- valign="top"
| {{Code|void}}
| Java values are ignored, and an empty sequence is returned instead.
|}
 
In the following example, the result of the first function – a char array – is wrapped and passed on to a {{Code|CharBuffer}} function. Without the option, the single-value array would be converted to an {{Code|xs:unsignedShort}} item and the second function call would fail:
 
<syntaxhighlight lang="xquery">
(: Without the pragma, the result of toChars would be converted to an xs:unsignedShort item, and the second function call would fail :)
 
(# db:wrapjava all #) {
Q{java.lang.Character}toChars(xs:int(33))
=> Q{java.nio.CharBuffer}wrap()
}
</syntaxhighlight>
Without The next example demonstrates a use case for the {{Code|instance}} option: <syntaxhighlight lang="xquery">(: Thanks to the pragma, the singlefunction calls can be chained :) declare namespace set = 'java:java.util.HashSet';let $set := (# db:wrapjava instance #) { set:new() => set:add('1') => set:add('2')}return $set()</syntaxhighlight> The {{Code|void}} option is helpful if side-value array effecting methods return values that do not contribute to the final result: <syntaxhighlight lang="xquery">(: Without the pragma, 100 booleans would be converted returned by the FLWOR expression :) declare namespace set = 'java:java.util.HashSet';let $set := set:new()return ( (# db:wrapjava void #) { for $i in 1 to an 100 return set:add($set, $i) }, $set())</syntaxhighlight> The irrelevant results could also be swallowed with {{CodeFunction|Profiling|xsprof:unsignedShortvoid}} item and the second function call would fail.
{| class="wikitable"
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu