Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
If a module has been placed in the repository (see below), there is no need to specify the location. The following example calls a function from the FunctX modulein the repository:
URI Name Version DirectoryType Path ----------------------------------------------------------------- <nowiki>http://www.functx.com</nowiki> 1.0 EXPath http-www.functx.com-1.0 1 package(s).
In case If you want to extend BaseX package an EXPath archive with a Java archivecode, some additional requirements have to be fulfilled:
If Importing XQuery modules that are located in the resulting path has no file suffix, it may point to either an XQuery module or repository is just as fast as importing any other modules. Modules that are imported several times in a Java archiveproject will only be compiled once.The following examples show some rewritings:
* {{Code|<nowiki>http://basexImported Java archives will be dynamically added to the classpath and unregistered after query execution. This requires some constant overhead and may lead to unexpected effects in scenarios with highly concurrent read operations.org/modules/hello/World</nowiki>}} → If you want to get optimal performance, it is recommendable to move your JAR files into the {{Code|org/basex/modules/hellolib/Worldcustom}}* {{Code|<nowiki>http://wwwdirectory of BaseX.exampleThis way, the archive will be added to the classpath if BaseX is started.com</nowiki>}} → {{Code|com/example/www/index}}* {{Code|If you have installed a/little/example}} → {{Code[[#Combined|a/little/example}}* {{Code|a:b:c}} → {{Code|a/b/c}}Combined Package]], you can simply keep your XQuery module in the repository, and the Java classes will be automatically detected.
* Added: [[#Packaging|Packaging]], [[#URI Rewriting|URI Rewriting]]
→Accessing Modules
=Introduction=
One of the reasons why things that makes languages such as Java or Perl have been so successful is the vast amount availability of external libraries that are available to developers.As XQuery comes with only 150 pre-defined functions, which cannot meet all requirements, there is some need for additional library modules exist – such as [http://www.functx.com/ FunctX] – that which extend the language with new features.
BaseX offers the following mechanisms to make external modules accessible to the XQuery processor:
# The default internal [[#Packaging|Packaging]] mechanism will install single XQuery and Java JAR modules in the repository.
# The [[#EXPath Packaging|EXPath Packaging]] system provides a generic mechanism for adding XQuery modules to query processors. A package is defined as a {{Code|.xar}} archive, which encapsulates one or more extension libraries.
==Accessing Modules==
Library modules can be imported with the {{Code|import module}} statement,followed by a freely choosable prefix and the namespace of the target module.The specified location may be absolute or relative; in the latter case, it is resolvedagainst the location (i.e., ''static base URI'') of the calling module.Import module statements must be placed at the beginning of a module:
'''Main Module''' <code>[http://files.basex.org/modules/org/basex/modules/Hello/HelloUniverse.xq HelloUniversehello-universe.xq]</code>:
<pre class="brush:xquery">
import module namespace m = 'http://basex.org/modules/Hellohello' at 'HelloWorldhello-world.xqm';
m:hello("Universe")
</pre>
'''Library Module''' <code>[http://files.basex.org/modules/org/basex/modules/Hello/HelloWorld.xqm HelloWorldhello-world.xqm]</code> (in the same directory):
<pre class="brush:xquery">
</pre>
If no location is supplied, modules will be looked up in the repository. Repository modules are stored in a directory named {{Code|BaseXRepo}} or the {{Code|repo}}directory, which resides in your [[Configuration#Home Directory|home directory]]. XQuery modules can be manually copied to the repository directory or installed and deleted via [[#Commands|commands]].
<pre class="brush:xquery">
=Commands=
There are various ways to handle organize your packages:
* Execute BaseX REPO commands (listed below)
* Use the GUI (''Options'' → ''Packages'')
You can even manually add and remove packages in the repository directory; all changes will automatically be detected by the query processorBaseX.
==Installation==
==Listing==
All currently installed packages can be listed with {{Command|REPO LIST}}. It will return the The names of all packagesare listed, along with their version, their package type, and the directory in which they are installedrepository path:
==Removal==
A package can be deleted with {{Command|REPO DELETE}} and an additional argument, containing its name or the name suffixed with a hyphen and the package version:
REPO DELETE <nowiki>http://www.functx.com</nowiki> ...or...
REPO DELETE <nowiki>http://www.functx.com-1.0</nowiki>
==XQuery==
If an XQuery file is specified as input for the install command, it will be parsed as XQuery library module. If parsing was successfulthe file can successfully be parsed, the module URI will be [[Java Bindings#URI Rewriting|rewritten]] to a file path and attached with the {{Code|.xqm}} file suffix, and the original file will possibly be renamed and copied to that path into the repository.
'''Example:'''
==Java==
For general notes in on importing Java classes, please read the Java Bindings article on [[Java Bindings#Module_Imports|Module Imports]].
Java archives (JARs) may contain one or more class files. One of them will be chosen as main class, which must be specified in a {{Code|Main-Class}} entry in the manifest file ({{Code|META-INF/MANIFEST.MF}}). This fully qualified Java class name will be rewritten to a file path by replacing the dots with slashes and attaching the {{Code|.jar}} file suffix, and the original file will be renamed and copied to that path into the repository.
If the class will be importedin the prolog of the XQuery module, an instance of it will be created, and its public functions can then be addressed from XQuery. A class may extend the {{Code|QueryModule}} class to get access to the current query context and to be enriched by some helpful annotations (see [[Java_Bindings#Context-AwarenessAnnotations|Context-AwarenessAnnotations]]).
'''Example:'''
</pre>
After having installed the module, all of the following URIs can be used in XQuery to import this module or call its functions (see [[Java Bindings#URI Rewriting|URI Rewriting]] for more information):
<nowiki>http://basex.org/modules/Hello</nowiki>
org/basex/modules/Hello
org.basex.modules.Hello
===Additional Libraries===
A Java class may depend on additional libraries. The dependencies can be resolved by creating a fat JAR file, i.e., extracting all files of the library archives and producing a single, flat JAR package.
Another solution is to copy the libraries into a {{Code|lib}} directory of the JAR package. If the package will be installed, the additional library archives will be extracted and copied to a hidden sub-directory in the repository. If the package will be deleted, the hidden sub-directory will be removed as well.
; Examplary contents of {{Code|Image.jar}}
lib/
Images.jar
META-INF/
MANIFEST.MF
org/basex/modules/
Image.class
; Directory structure of the repository directory after installing the package
org/basex/modules/
Image.class
.Images/
Images.jar
==Combined==
It makes sense to combine the advantages of XQuery and Java packages:
* Instead of directly calling Java code, a wrapper module can be provided. This module contains functions that invoke the Java functions.
* These functions can be strictly typed. This reduces the danger of erroneous or unexpected conversions between XQuery and Java code.
* In addition, the entry functions can have properly maintained XQuery comments.
XQuery and Java can be combined as follows:
* First, a JAR package is created (as described above).
* A new XQuery wrapper module is created, which is named identically to the Java main class.
* The URL of the {{Code|import module}} statement in the wrapper module must start with the {{Code|java:}} prefix.
* The finalized XQuery module must be copied into the JAR file, and placed in the same directory as the Java main class.
If the resulting JAR file is installed, the embedded XQuery module will be extracted, and will be called first if the module will be imported.
; Main Module {{Code|hello-universe.xq}}:
<pre class="brush:xquery">
import module namespace m = 'http://basex.org/modules/Hello';
m:hello("Universe")
</pre>
; Wrapper Module {{Code|Hello.xqm}}:
<pre class="brush:xquery">
module namespace hello = 'http://basex.org/modules/Hello';
(: Import JAR file :)
import module namespace java = 'java:org.basex.modules.Hello';
(:~
: Say hello to someone.
: @param $world the one to be greeted
: @return welcome string
:)
declare function hello:hello(
$world as xs:string
) as xs:string {
java:hello($world)
};
</pre>
; Java class {{Code|Hello.java}}:
<pre class="brush:java">
package org.basex.modules;
public class Hello {
public String hello(final String world) {
return "Hello " + world;
}
}
</pre>
If the JAR file is installed, {{Code|Combined}} will be displayed as type:
REPO INSTALL http://files.basex.org/modules/org/basex/modules/Hello.jar
REPO LIST
Name Version Type Path
-----------------------------------------------------------------------
org.basex.modules.Hello - Combined org/basex/modules/Hello.xqm
=EXPath Packaging=
==Java==
* Apart from the package descriptor <code>expath-pkg.xml</code>, the package has to contain a descriptor file at its root, defining the included jars and the binary names of their public classes. It must be named <code>basex.xml</code> and must conform to the following structure:
On our [http://files.basex.org/modules/ file server], you can find some example libraries packaged as XML archives (xar files). You can use them to try our packaging API or just as a reference for creating your own packages.
=URI RewritingPerformance= If a module is looked up in the repository, the namespace URI is rewritten to a local file path: # 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.
=Changelog=
;Version 89.20
* Added: [[#URI RewritingCombined|URI RewritingCombined]]XQuery and Java packages* Added: support for URNs[[#Additional Libraries|Additional Libraries]]
;Version 7.2.1
* Updated: [[#Installation|Installation]]: existing packages will be replaced without raising an error
* Updated: [[#Removal|Removal]]: remove specific version of a package
;Version 7.1
