Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
{{Mark|Updated with Version 8.4}}: A Java class is identified by a namespace URI. The original URI is rewritten as follows:
A Java variable is retrievedconstructors, functions and variables can be referenced and a Java function is invoked, evaluated by a usual the existing XQuery function call. syntax: * The namespace of its QName the function name identifies the Java class, and the .* The local partof 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>&#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.
Note that Java code cannot The option can also be pre-compiledspecified via a pragma: <syntaxhighlight lang="xquery">(# db:checkstrings #) { br:new(fr:new('00.bin')) ! (br:readLine(.), and will as such be evaluated slower than optimized XQuery codebr:close(.))}</syntaxhighlight>
The following, In the (side-effecting ) example returns below, a HashSet instance is created, values are added, and the number size of distinct values added to a hash the set (the boolean values is returned by . As {{Code|set:add()}} will be swallowed)returns boolean values, {{Function|Profiling|prof:void}} is used to swallow the values:
Java classes can be coupled more closely to the BaseX core library.If a class inherits the abstract [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryModule.java QueryModule] class, the two variables [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryContext.java queryContext] and [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/StaticContext.java staticContext] get available, which provide access to the global and static context of a query. Additionally, the default The internal properties of functions can be changed assigned via annotations:
The [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryResource.java QueryResource] interface can be implemented to enforce finalizing operations, such as In the closing of opened connections or resources in a module. Its {{Code|close()}} method will be called after a query has been fully evaluated. The following XQuery code invokes two Java methods. The first Java function retrieves , information from the static query contextis returned by the first function, and the second one throws a query exceptionis raised by the second function:
By default, a Java function will The {{Code|@Updating}} annotation can be executed in parallel with other code. However, if a applied to mark Java function performs sensitive functions that perform write or update operations, it is advisable to explicitly lock the code. This can be realized via locking annotations:
</pre>
→Functions and Variables
The Java Binding feature is an extensibility mechanism which enables developers
to directly access Java variables and execute code from XQuery. Addressed Java code must either be contained in the Java classpath, or it must be located in the [[Repository]].
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=
==Classes==
# The [[Repository#URI_RewritingURI Rewriting|URI Rewriting]] steps are applied to the URI.
# Slashes in the resulting URI are replaced with dots.
# The last path segment of the URI is capitalized and rewritten to [https://en.wikipedia.org/wiki/CamelCase camel caseCamelCase].
The normalization steps are skipped if the URI is prefixed with {{Code|java:}}. See The path to the following examplesstandard 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==
{| class="wikitable"
|- valign="top"
! TypeAddressed code
! XQuery
! Java
|- valign="top"
| Variable
| <code>Q{java.lang.Integer}MIN_VALUE()</code>| <code>Integer#.MIN_VALUE</code>
|- valign="top"
| Function
| <code>Q{java.lang.Object}hash-code($object)</code>| <code>Object#object.hashCode()</code>|- valign="top"| Function with argument| <code>Q{String}split·String·int($string, ';', xs:int(3))</code>| <code>string.split(";", 3)</code>|- valign="top"| Constructor with array argument| <code>Q{String}new·byte...(xs:hexBinary('414243'))</code>| <code>new String(new byte[] { 41, 42, 43 })</code>
|}
As values in XQuery and Java are of have different typesystems, function XQuery arguments and results must be mapped. The supported mappings are provided converted to equivalent Java values, and the result of a Java function is converted back to an XQuery value (see [[#Data TyesTypes|at the endData Types]] of this article). 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()}}:
<pre classsyntaxhighlight lang="brush:xquery">
declare namespace math = "java:java.lang.Math";
math:cos(xs:double(0)), math:PI()
</presyntaxhighlight>
With the [[XQuery 3.0#Expanded QNames|Expanded QName]] notation of XQuery 3.0,the namespace can directly be embedded in the function call:
<pre classsyntaxhighlight lang="brush:xquery">
Q{java:java.lang.Math}cos(xs:double(0))
</presyntaxhighlight>
The constructor of a class can be invoked by calling the virtual function {{Code|new()}}. Instance methods can then called by passing on the resulting Java object as first argument. In the following example, 256 bytes are written to the file {{Code|output.txt}}. First, a new {{Code|FileWriter}} instance is created, and its {{Code|write()}} function is called in the next step:
<pre classsyntaxhighlight lang="brush:xquery">declare namespace fw = "'java:java.io.FileWriter"';
let $file := fw:new('output.txt')
return (
fw:close($file)
)
</presyntaxhighlight>
If the result of a Java call contains invalid XML characters, it will be rejected. The validity check can be disabled by setting the [[Options#CHECKSTRINGS{{Option|CHECKSTRINGS]] option }} to false. The following query writes In the example below, a file with a single {{Code|00-}} byteis written, which and this file will then be successfully read accessed by via Java functions:
<pre classsyntaxhighlight lang="brush: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))</presyntaxhighlight>
=Module Imports=
A Java code classes can also be integrated instantiated by ''importing'' classes them as modules. a module: A new instance of the addressed class is createdwill be constructed, which can then be accessed referenced in the query body.
<pre classsyntaxhighlight lang="brush:xquery">import module namespace set = "java:java.util.HashSet";
prof:void(
for $s in ("one", "two", "one")
),
set:size()
</presyntaxhighlight> The execution of imported classes is more efficient than the execution of instances that have been created via {{Code|new()}}. In turn, no arguments can be supplied in the import statement, and the construction will only be successful if the class can be instantiated without arguments. =Integration= Java classes can be coupled more closely to BaseX. If a class inherits the abstract [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryModule.java QueryModule] class, the two variables [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryContext.java queryContext] and [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/StaticContext.java staticContext] get available, which provide access to the global and static context of a query.
The advantages [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryResource.java QueryResource] interface can be implemented to enforce finalizing operations, such as the closing of this approach is that imported code is executed faster than instances created at runtime via opened connections or resources in a module. Its {{Code|newclose()}}. A drawback is that no arguments can method will be passed on to called after the class constructor. As a consequence, the import only works if the class provides a constructor with no argumentsXQuery expression has been fully evaluated.
=Context-Awareness=Annotations==
* Java functions can only be executed by users with [[User_Management|Admin permissions]]. You may can annotate a function with {{Code|@Requires(<Permission>)}} to also make it accessible to users with less fewer privileges.* Java code is treated as ''non-deterministic'', as its behavior cannot be predicted by the XQuery processor. You may annotate a function as {{Code|@Deterministic}} if you know that it will have no side-effects and will always yield the same result.
* Java code is treated as ''context-independent''. If a function accesses the query context, it should be annotated as {{Code|@ContextDependent}}
* Java code is treated as ''focus-independent''. If a function accesses the current context item, position or size, it should be annotated as {{Code|@FocusDependent}}
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace context = 'org.basex.examples.query.ContextModule';
context:user()
},
try { element to-int { try { context:to-int('abc') }} catch basex:error { catch * element error { 'Error in line', $err:line-number description }
}
</presyntaxhighlight>
The imported Java class is shown below:
<pre classsyntaxhighlight lang="brush:java">
package org.basex.examples.query;
public class ContextModule extends QueryModule implements QueryResource {
/**
* Returns the name of the logged -in user. * @return userstring
*/
@Requires(Permission.NONE)
/**
* Converts the specified string to an integer.
* @param value string representationto be converted * @return resulting integer
* @throws QueryException query exception
*/
return Integer.parseInt(value);
} catch(NumberFormatException ex) {
throw new QueryException(ex.getMessage()"Integer conversion failed: " + value);
}
}
@Override
public void close() {
// see description abovedefined in QueryResource interface, will be called after query evaluation
}
}
</presyntaxhighlight>
The result will look as follows:
<pre classsyntaxhighlight lang="brush:xml">
<user>admin</admin>
<to-interror>Error in line 6Integer conversion failed: abc</to-interror></presyntaxhighlight>
Please visit the XQuery 3.0 specification if you want to get more insight into
[httphttps://www.w3.org/TR/xpath-functions-3031/#properties-of-functions function properties].
=Locking=Updates==
<pre classsyntaxhighlight lang="brush:java"> @Lock(write = { "HEAVYIO" })Updating public void writebackup() {
// ...
}
</syntaxhighlight>
An XQuery expression will be handled as an [[XQuery Update#Updating Expressions|updating expression]] if it calls an updating Java function. In contrast to XQuery update operations, the Java code will immediately be executed, but the result will be cached as if {{Function|Update|update:output}} was called.
The annotation is particularly helpful if combined with a lock annotation. ==Locking== By default, a Java function will be executed in parallel with other code. If a Java function performs sensitive operations, it is advisable to explicitly lock the code. ===Java Locks=== Java provides a handful of mechanism to control the execution of code. The concurrent execution of functions can be avoided with the {{Code|synchronized}} keyword. For more complex scenarios, the Lock, Semaphore and Atomic classes can be brought into play. ===XQuery Locks=== If you want to synchronize the execution of your code with BaseX locks, you can take advantage of the {{Code|@Lock}} annotation: <syntaxhighlight lang="java"> @Lock(read = { "HEAVYIO" })
public void read() {
// ...
}
@Updating @Lock("HEAVYIO") public void write() { // ... }</syntaxhighlight> If an XQuery expression is run which calls the Java invokes {{Code|write()}} function, every any other query that calls {{Code|write()}} or {{Code|read()}} needs to wait for the query to be finished. If a query calls the The {{Code|read()}} function, only those can be run in parallel; whereas queries are will be queued that call if {{Code|write()}}is called. More details on concurrent querying can be found in the article on [[Transaction Management]]. ==Data Types== ===Conversion to Java=== Before Java code is executed, because this the arguments are converted to Java values, depending on the addressed function or constructor parameters. The accepted Java types and the original XQuery types are depicted in the second and first column of the table below. ===Conversion to XQuery=== By default, Java values with the most common types (as shown in the second and third column of the table) are converted to XQuery values. All other values are returned as ''Java items'', which are function items with a wrapped Java value. The results of constructor calls are always returned as Java items. The conversion of the wrapped Java value to XQuery is enforced by invoking the function item: Values in {{Code|Iterator}} and {{Code|Iterable}} instances (Lists, Sets and Collections) are converted to items, and maps are converted to XQuery maps: <syntaxhighlight lang="xquery">declare namespace Scanner = 'java:java.util.Scanner';let $scanner := Scanner:new("A B C") => Scanner:useDelimiter(" ")return $scanner()</syntaxhighlight> If no conversion is defined, a string is only annotated returned, resulting from the {{Code|toString()}} method 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|readtoString()}} method.|- valign="top"| {{Code|all}}| Java values are wrapped into Java items (excluding those inheriting the internal type {{Code|org.basex.query.value.Value}} lock). More details |- 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 parallel query execution 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{Character}toChars(xs:int(33)) => Q{java.nio.CharBuffer}wrap()}</syntaxhighlight> The next example demonstrates a use case for the {{Code|instance}} option: <syntaxhighlight lang="xquery">(: Thanks to the pragma, the function calls can be found 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-effecting methods return values that do not contribute to the final result: <syntaxhighlight lang="xquery">(: Without the pragma, 100 booleans would be returned by the FLWOR expression :) declare namespace set = 'java:java.util.HashSet';let $set := set:new()return ( (# db:wrapjava void #) { for $i in the article on 1 to 100 return set:add($set, $i) }, $set())</syntaxhighlight> The irrelevant results could also be swallowed with {{Function|Profiling|prof:void}}. {| class="wikitable"|- valign="top"! XQuery input! Expected or returned Java type! XQuery output|- valign="top"| <code>item()*</code> (no conversion)| <code>org.basex.query.value.Value</code>| <code>item()*</code> (no conversion)|- valign="top"| <code>empty-sequence()</code>| <code>null</code>| <code>empty-sequence()</code>|- valign="top"| <code>xs:string</code>, <code>xs:untypedAtomic</code>| <code>String</code>| <code>xs:string</code>|- valign="top"| <code>xs:unsignedShort</code>| <code>char</code>, <code>Character</code>| <code>xs:unsignedShort</code>|- valign="top"| <code>xs:boolean</code>| <code>boolean</code>, <code>Boolean</code>| <code>xs:boolean</code>|- valign="top"| <code>xs:byte</code>| <code>byte</code>, <code>Byte</code>| <code>xs:byte</code>|- valign="top"| <code>xs:short</code>| <code>short</code>, <code>Short</code>| <code>xs:short</code>|- valign="top"| <code>xs:int</code>| <code>int</code>, <code>Integer</code>| <code>xs:int</code>|- valign="top"| <code>xs:integer</code>, <code>xs:long</code>| <code>long</code>, <code>Long</code>| <code>xs:integer</code>|- valign="top"| <code>xs:unsignedLong</code>| <code>java.math.BigInteger</code>| <code>xs:unsignedLong</code> (lossy)|- valign="top"| <code>xs:decimal</code>| <code>java.math.BigDecimal</code>| <code>xs:decimal</code>|- valign="top"| <code>xs:float</code>| <code>float</code>, <code>Float</code>| <code>xs:float</code>|- valign="top"| <code>xs:double</code>| <code>double</code>, <code>Double</code>| <code>xs:double</code>|- valign="top"| <code>xs:QName</code>| <code>javax.xml.namespace.QName</code>| <code>xs:QName</code>|- valign="top"| <code>xs:anyURI</code>| <code>java.net.URI</code>, <code>java.net.URL</code>| <code>xs:anyURI</code>|- valign="top"| <code>xs:date</code>| <code>javax.xml.datatype.XMLGregorianCalendar</code>| <code>xs:date</code>|- valign="top"| <code>xs:duration</code>| <code>javax.xml.datatype.Duration</code>| <code>xs:duration</code>|- valign="top"| <code>node()</code>| <code>org.w3c.dom.Node</code>| <code>node()</code>|- valign="top"| <code>array(xs:boolean)</code>| <code>boolean[]</code>| <code>xs:boolean*</code>|- valign="top"| <code>array(xs:string)</code>| <code>String[]</code>| <code>xs:string*</code>|- valign="top"| <code>array(xs:unsignedShort)</code>| <code>char[]</code>| <code>xs:unsignedShort*</code>|- valign="top"| <code>array(xs:short)</code>| <code>short[]</code>| <code>xs:short*</code>|- valign="top"| <code>array(xs:int)</code>| <code>int[]</code>| <code>xs:int*</code>|- valign="top"| <code>array(xs:integer)</code>, <code>array(xs:long)</code>| <code>long[]</code>| <code>xs:integer*</code>|- valign="top"| <code>array(xs:float)</code>| <code>float[]</code>| <code>xs:float*</code>|- valign="top"| <code>array(xs:double)</code>| <code>double[Transaction Management]</code>| <code>xs:double*</code>|- valign="top"| <code>Object[]</code> (others)| <code>item()*</code>| <code>array(*)</code> (others)|- valign="top"| <code>map(*)</code>| java.util.HashMap| <code>Wrapped Java object</code>|} ==URI Rewriting== Before a Java class or module is accessed, its namespace URI will be normalized: # If the URI is a URL:## colons will be replaced with slashes,## in the URI authority, the order of all substrings separated by dots is reversed, and## dots in the authority and the path are replaced by slashes. If no path exists, a single slash is appended.# Otherwise, if the URI is a URN, colons will be replaced with slashes.# Characters other than letters, dots and slashes will be replaced with dashes.# If the resulting string ends with a slash, the {{Code|index}} string is appended. If the resulting path has no file suffix, it may point to either an XQuery module or a Java archive: * {{Code|<nowiki>http://basex.org/modules/hello/World</nowiki>}} → {{Code|org/basex/modules/hello/World}}* {{Code|<nowiki>http://www.example.com</nowiki>}} → {{Code|com/example/www/index}}* {{Code|a/little/example}} → {{Code|a/little/example}}* {{Code|a:b:c}} → {{Code|a/b/c}}
=Changelog=
; Version 9.6
* Updated: {{Anchor|Data Types}}: {{Code|array(*)}} type added; {{Code|xs:integer}} are converted to {{Code|long}} values.
; Version 9.4
* Added: Annotation for [[#Updates|updating functions]].
* Updated: Single annotation for read and write locks.
; Version 8.4
* Updated: Rewriting rules
;Version 8.2* UpdatesAdded: [[#URI Rewriting rules|URI Rewriting]]: support for URNs
; Version 8.0
* Added: {{Code|QueryResource}} interface, called after a query has been fully evaluated.
; Version 7.8
* Added: Java locking annotations
* Updated: {{Code|context}} variable has been split into {{Code|queryContext}} and {{Code|staticContext}}.
; Version 7.2.1
* Added: import of Java modules, context awareness
* Added: [[Category:XQuery#Packaging|Packaging]], [[Category:API#URI Rewriting|URI Rewriting]]
