Difference between revisions of "Java Bindings"

From BaseX Documentation
Jump to navigation Jump to search
Line 6: Line 6:
 
namespaces; the namespace URI must be of the form {{Mono|java:fully.qualified.ClassName}}.
 
namespaces; the namespace URI must be of the form {{Mono|java:fully.qualified.ClassName}}.
  
The following example uses Java’s <code>Math</code> class and returns the cosine of an angle:  
+
The following example uses Java’s {{Mono|Math}} class and returns the cosine of an angle.
 +
The {{Mono|cos()}} method can be directly called, as it is a {{Mono|static}} method:
 +
 
 
<pre class="brush:xquery">declare namespace math = "java:java.lang.Math";
 
<pre class="brush:xquery">declare namespace math = "java:java.lang.Math";
 
math:cos(xs:double(0))
 
math:cos(xs:double(0))
 
</pre>
 
</pre>
  
'''Please Note''': To directly call a method it has to be set as <code>'''static'''</code> in your java code.
+
The next example writes 256 bytes to the file {{Mono|output.txt}}.
+
First, a new {{Mono|FileWriter}} instance is created: by calling the
The next example writes 256 bytes to the file <code>output.txt</code>.
+
{{Mono|new()}} function, the class constructor is invoked. Instance
To call the <code>write</code> method of the FileWriter class,
+
methods are called by passing on the resulting Java object as
you have to pass a class instance as first argument:
+
first argument:
 +
 
 
<pre class="brush:xquery">declare namespace fw = &quot;java:java.io.FileWriter&quot;;
 
<pre class="brush:xquery">declare namespace fw = &quot;java:java.io.FileWriter&quot;;
   
+
  let $file := fw:new('output.txt')
let $file := fw:new('output.txt')
 
 
return (
 
return (
 
   for $i in 0 to 255
 
   for $i in 0 to 255
Line 26: Line 28:
 
</pre>
 
</pre>
  
Note that we recommend to use XQuery expressions and functions whenever possible,
+
In general, we recommend everyone to use XQuery expressions and functions whenever possible,
as Java code cannot be pre-compiled by BaseX, and will most probably be evaluated
+
as Java code cannot be pre-compiled, and will often be evaluated slower than optimized
slower than pure XQuery code.
+
XQuery code. Next, Java code can only be executed with [[User_Management|admin permissions]].
Next, [[User_Management|admin permissions]] are required to execute Java code.  
 
  
 
[[Category:XQuery]]
 
[[Category:XQuery]]
 
[[Category:API]]
 
[[Category:API]]

Revision as of 18:33, 28 January 2012

This article is part of the Query Portal. It shows how to call Java code from XQuery.

The Java Binding query feature is an extensibility mechanism which enables developers to directly access Java variables and execute code from XQuery. Java classes are identified by namespaces; the namespace URI must be of the form java:fully.qualified.ClassName.

The following example uses Java’s Math class and returns the cosine of an angle. The cos() method can be directly called, as it is a static method:

declare namespace math = "java:java.lang.Math";
math:cos(xs:double(0))

The next example writes 256 bytes to the file output.txt. First, a new FileWriter instance is created: by calling the new() function, the class constructor is invoked. Instance methods are called by passing on the resulting Java object as first argument:

declare namespace fw = "java:java.io.FileWriter";
 let $file := fw:new('output.txt')
return (
  for $i in 0 to 255
  return fw:write($file, xs:int($i)),
  fw:close($file)
)

In general, we recommend everyone to use XQuery expressions and functions whenever possible, as Java code cannot be pre-compiled, and will often be evaluated slower than optimized XQuery code. Next, Java code can only be executed with admin permissions.