Integrating oXygen

This tutorial describes how to use the BaseX XQuery Processor to execute queries in the oXygen XML Editor. You can access the existing databases from BaseX within oXygen and work with the results as XML.

Required Downloads

1. basex.jar: Main code
2. basex-api.jar: Implementation of the XQJ API
3. xqj-api.jar: XQuery for Java (Interface)
4. oXygen XML Editor: Install the oXygen XML Editor on your computer

Setting up

Data Source

1. Start oXygen and go to Options → Preferences → Data Sources.
2. Add a new Data Source with the New button.
3. Enter Name "BaseX" and choose XQuery API for Java(XQJ) as type.
4. Add the three JAR files with the Add Button.
5. Now press OK, and your Data Source is ready.

Connection

1. Now press New in the Connection Panel (located in Data Sources).
2. Enter Name "BaseXConnection" and select "BaseX" in the Data Source box.
3. Now press OK, and your connection is ready.

Usage

The query execution works as follows:

1. Configure a new transformation scenario in Window → Show View → Transformation Scenarios.
2. Press the plus sign to add a new scenario.
3. Enter a Name, XML URL (your xml file or leave it empty) and the XQuery URL (your query file).
4. Choose "BaseXConnection" in the combo box.
5. Press OK, and your scenario is ready. Now you can start the transformation.
6. The results should immediately occur in the result panel.