Changes

# The [[#EXPath Packaging|EXPath Packaging]] system provides a generic mechanism for adding XQuery modules to query processors. A package is defined as a {{MonoCode|.xar}} archive, which encapsulates one or more extension libraries.

All packages are stored in the ''repository''. The repository is a directory named {{MonoCode|BaseXRepo}} or {{MonoCode|repo}}, which resides in your [[Configuration#Home Directory|home directory]]. BaseX provides three commands for interaction with the package repository: <code>[[Commands#REPO_INSTALL|REPO INSTALL]]</code>, <code>[[Commands#REPO_DELETE|REPO DELETE]]</code>, and <code>[[Commands#REPO_LIST|REPO LIST]]</code>. Packages can also be managed from within XQuery, using the [[Repository Module]].

A module or package can be installed with the {{MonoCode|REPO INSTALL}} command. The path to the file has to be given as a parameter, as the following two examples demonstrate:

If an XQuery file is specified as input for the install command, it will be parsed as XQuery module. If parsing was successful, the module URI will be [[#URI Rewriting|rewritten]] to a file path and attached with the {{MonoCode|.xqm}} file suffix, and the original file will be renamed and copied to that path into the repository.

Installation (the original file will be copied to {{MonoCode|org/basex/modules/Hello.xqm}}):

Suitable JAR archives may contain one or more class files. One of them will be chosen as main class, which must be specified in a {{MonoCode|Main-Class}} entry in the manifest file ({{MonoCode|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 with the {{MonoCode|.jar}} file suffix, and the original file will be renamed and copied to that path into the repository.

The public functions of this class can then be addressed from XQuery, using the class or file path as namespace URI, or an alternative writing that can be [[#URI Rewriting|rewritten]] to the module file path. Moreover, a class may extend the {{MonoCode|QueryModule}} class to get access to the current query context and to be enriched by some helpful annotations (please consult [[Java_Bindings#Context-Awareness|Context Awareness of Java Bindings]] for more information).

Contents of the file {{MonoCode|MANIFEST.mf}} (the whitespaces are obligatory):

Contents of the file {{MonoCode||Hello.java}} (comments removed):

Installation (the file will be copied to {{MonoCode|org/basex/modules/Hello.jar}}):

Apart from the package descriptor, a {{MonoCode|.xar}} archive contains a directory which includes the actual XQuery modules. For example, the [http://www.functx.com/ FunctX XQuery Library] is packaged as follows:

As it can be seen, the class {{MonoCode|Printer}} is declared with its binary name as a namespace prefixed with "java" and the XQuery function is implemented using the [http://docs.basex.org/wiki/Java_Bindings Java Bindings] offered by BaseX.

3. If the resulting string ends with a slash, the {{MonoCode|index}} string is appended.

* {{MonoCode|<nowiki>http://basex.org/modules/hello/World</nowiki> → org/basex/modules/hello/World}}* {{MonoCode|<nowiki>http://www.example.com</nowiki> → com/example/www/index}}* {{MonoCode|a/little/example.xq → a/little/example.xq}}