Integrating oXygen

From BaseX Documentation

This tutorial is part of the Getting Started Section. It describes how to access BaseX from the oXygen XML Editor. Currently, there are two variants how to use BaseX in oXygen:

• Resources in databases can be opened and modified.
• XPath/XQuery expressions can be run by the query processor of BaseX.
  
  

Contents 1 Access Database Resources 1.1 Preparations 1.2 Configuration 2 Perform Queries 2.1 Preparations 2.2 Data Source 2.3 Connection 2.4 Usage

[edit] Access Database Resources

[edit] Preparations

• Start the WebDAV service first, which will allow you to access all resources via the client/server architecture

[edit] Configuration

1. Go to menu Options → Preferences → Data Sources
2. In the Connections panel, click the New button
3. Enter "BaseX-WebDAV" as connection name
4. Select "WebDAV" in the Data Source combo box
5. Fill in the appropriate connection details. Below, the default values are shown:
   • Set the URL to http://localhost:8984/webdav
   • Set the user name to admin
   • Set the password to admin
6. Now press OK, and your Data Source is ready for use

You can also directly open single files as follows:

• Choose File → Open URL....
  

• Enter the corresponding user name and password (if needed), the URL of the BaseX WebDAV Server, and then click "Browse".
  

[edit] Perform Queries

[edit] Preparations

1. Download one of the complete BaseX distributions (ZIP, EXE)
2. Start a BaseX Server instance

[edit] Data Source

1. Start oXygen and go to Options → Preferences → Data Sources
2. Add a new Data Source with the New button
3. Enter "BaseX-XQJ" as connection name and choose XQuery API for Java (XQJ) as type
4. Add the following JAR files above with the Add Button: xqj-api-1.0.jar, xqj2-0.1.0.jar and basex-xqj-1.2.3.jar (the version names of the JAR file may differ)
5. Now press OK, and your Data Source is ready for use

[edit] Connection

1. Now press New in the Connection Panel below.
2. Enter Name "BaseX" and select "BaseX-XQJ" in the Data Source box.
3. Enter the following connection details (or modify them when necessary):
   • Port: 1984
   • serverName: localhost
   • user: admin
   • password: admin
4. Now press OK, and your connection is ready.

[edit] Usage

The query execution works as follows:

1. Configure a new transformation scenario in Window → Show View → Transformation Scenarios.
2. Choose the XQuery Transformation tree entry.
3. Press the plus sign to add a new scenario.
4. Enter a Name and an optional XML and XQuery URL (e.g. your query document/file).
5. Choose "BaseX" as Transformer from the combo box.
6. Press OK, and your scenario is ready. Now you can start the transformation, e.g. by clicking on the red Play button.
7. The results should immediately occur in the result panel.