Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
Text replacement - "[http://basex.org/" to "[https://basex.org/"
This tutorial is part of the [[Getting Started]] Section.
It describes how to access BaseX from [https://www.eclipse.org Eclipse] via the [https://www.oxygenxml.com/doc/versions/20.1/ug-editorEclipse/topics/introduction.html oXygen XML Editor plugin].
The plugin offers the same features as specified in [Integrating_oXygen[Integrating oXygen]]. However, the way to get there from within Eclipse it a little bit different.
Currently, there are two alternatives how to use BaseX in oXygen:
# Download and install Eclipse. '''Note:''' The current version of the oXygen XML Editor plugin was tested for Eclipse Version 4.8. Please also note that you will require an oXygen license to use the plugin.
# Follow the instructions in the [https://www.oxygenxml.com/doc/versions/20.1/ug-editorEclipse/topics/install-eclipse.html oXygen Manual] to install the plugin.
# In Eclipse, click on the oXygen icon in the upper right upper corner to open the plugin. The XML Project you created during the installation of the plugin should be displayed in the ''Navigator'' panel. In this example, it is called ''BaseXProject''.
#: [[File:oxygen-eclipse-plugin.png]]
===Preparations===
# Download one of the [httphttps://basex.org/download BaseX distributions].
# Start BaseX (see [[Startup]]).
# Create a BaseX database, if necessary (see [[Databases]]).
===Configuration===
'''Note:''' If you have already integrated BaseX into the oXygen XML Editor itself as described in [[Integrating oXygen]], your BaseX WebDAV connection will already be available in the plugin.
# In Eclipse, go to menu ''Eclipse'' → ''Preferences''. In the ''Preferences'' dialog, chose the ''oXygen XML Editor'' item, and then the ''Data Sources'' subitem.
#: [[File:oxygen-eclipse-plugin-webdav-connection.png]]
# Press ''OK'' to close the dialog.
<!--# In the ''Preferences'' dialog, chose the ''oXygen XML Editor'' → ''Network Connection Settings'' → ''HTTP(S)/WebDAV'' subitem. Activate the ''Enable the HTTP/WebDAV protocols'' check box to enable WebDAV support.-->
# Click ''Apply and Close'' to close the ''Preferences'' dialog.
# If prompted, restart Eclipse to activate all changes.
==One-Time Setup==
'''Note:''' If you have already integrated BaseX into the oXygen XML Editor itself as described in [[Integrating oXygen]], your data sources and connections will already be available in the plugin.
===Configuration===
# Click ''OK''.
#: [[File:oxygen-eclipse-plugin-data-source.png]]
===Configure Connection===
# In the Connections section (in the lower half of the Data Source dialog), click ''New'' ({{Code|+}}).
# Enter "BaseX XQJ" as name and select "BaseX" as data source.
# If you use the default driver, enter the following values in the Connection Details section:
#* port: {{Code|1984}}
#* serverName: {{Code|localhost}}
#* user: {{Code|admin}}
#* password: {{Code|admin}}
#: [[File:oxygen-eclipse-plugin-xqj-connection.png]]
# Click ''OK'' to complete the connection configuration.
# Click ''Apply and Close'' to close the ''Preferences'' dialog.
# If prompted, restart Eclipse to activate all changes.
===Configure New Transformation Scenario===
# In Eclipse, choose ''File'' → ''New'' → ''XQuery File''. Enter a filename and click ''Finish''. Enter a query and save the file.
# Select ''Window'' → ''Show View'' → ''Transformation Scenarios''.
# In the ''Transformation Scenarios'' panel on the right-hand side, click {{Code|+}} and select ''XQuery transformation'' in the lower part of the dropdown list.
# Enter a name for your transformation, e.g. "BaseX".
# Specify an optional XML and XQuery URL.
#* If you would like to query the BaseX database you connected to via WebDAV, leave the ''XML URL'' field empty. To access your database, you can use the {{Code|db:open}} function from the BaseX [[Database_Module|Database Module]] in your ''XQuery URL'' file.
#* If you specify an XML document in the ''XML URL'' field, you can query its content using {{Code|.}} (dot operator) in your ''XQuery URL'' file.
# Choose "BaseX XQJ" as Transformer from the combo box.
# Click ''OK'' to complete the scenario configuration.
[[File:oxygen-eclipse-plugin-transformation.png]]
==Execute Query==
After the one-time setup steps are complete, you can execute your query using the new transformation scenario. Start the transformation by clicking the red Run button (''Apply associated scenarios'') in the Transformation Scenarios window, while your scenario is selected. The results should be immediately displayed in the result panel.
