Changes

Currently, there are two variants alternatives how to use BaseX in oXygen:

* Resources in BaseX [[databases]] can be opened and modified.* XPath/XQuery 1.0 expressions can be run by the [[Query|query processor]] of BaseX.* '''Note:''' BaseX itself is a highly compliant XQuery 3.1 processor. The restriction to XQuery 1.0 arises from the XQJ Interface which is used to establish the connection between oXygen and BaseX. We strongly encourage you to use the [[Graphical_User_Interface#Text_Editor|XML editor]] integrated into the BaseX GUI to edit and query your XML data!<br/><br/>

===Preparations=== * First, start the BaseX [[WebDAV]] service.

===Configuration=== # Go to menu ''Options'' → ''Preferences'' → ''Data Sources''# In Download one of the Connections panel, click the ''New'' button ({{Code|+}})# Enter "BaseX-WebDAV" as connection name# Select "WebDAV" in the Data Source combo box# Fill in the appropriate connection details. Below, the default values are shown:#* Set the URL to <code><nowiki>[http://localhost:8984basex.org/webdav</nowiki></code>download BaseX distributions].#* Set the user name to <code>admin</code>Start BaseX (see [[Startup]]).#* Set the password to <code>admin</code>Create a BaseX database, if necessary (see [[Databases]]).# Now press ''OK'', and your Data Source is ready for useStart the BaseX [[WebDAV]] service.

* Choose # In oXygen, go to menu ''Options'' → ''FilePreferences'' → ''Open URLData Sources''.# In the Connections panel (in the lower half of the screen), click the ''New'' button ({{Code|+}}).# Enter "BaseX WebDAV" as connection name.''# Select "WebDAV (S)FTP" in the Data Source dropdown box.# Fill in the appropriate connection details as follows:#* Set the WebDAV/FTP URL to <code><brnowiki>http:/>[[File/localhost:Webdav-oxygen01.png]]8984/webdav<br/nowiki><br/code>.#* Enter Set the corresponding user name and to <code>admin</code>.#* Set the password (if needed), the URL of the BaseX to <code>admin</code>.#: [[File:Oxygen-WebDAV Server-1.png]]# Now press ''OK'', and your Data Source is ready for use. You can then click "Browse"access your database file(s) via the Data Source Explorer: ''Window'' → ''Show View'' → ''Data Source Explorer''.<br/> [[File:WebdavOxygen-WebDAV-oxygen022.png]]

==One-Time Setup== ===Preparations===  # Download one of the complete [http://basex.org/download BaseX distributions] (ZIP, EXE), if necessary.# Start BaseX (see [[Startup]]). '''Note:''' Charles Foster's XQJ implementation provides a default (client/server) and a local driver. If you want to use the first flavor, you need to start a [[Startup#BaseX Server|BaseX Server]] instance. ===Configure Data Source=== # In oXygen, select ''Options'' → ''Preferences'' → ''Data Sources''.# In the Data Sources panel, add a new data source using the ''New'' button ({{Code|+}}).# Enter "BaseX" as name and select ''XQuery API for Java(XQJ)'' from the ''Type'' dropdown box.# Add the following JAR files (downloaded in Preparations procedure) with the ''Add Files'' Button. The versions of the JAR files may differ.#* {{Code|basex/lib/xqj-api-1.0.jar}}#* {{Code|basex/lib/xqj2-0.2.0.jar}}#* {{Code|basex/lib/basex-xqj-9.0.jar}}#* {{Code|basex/BaseX.jar}}, if you want to use BaseX embedded# Under "Driver class", choose the preferred driver class:#* Embedded: {{Code|net.xqj.basex.BaseXXQDataSource}}#* Client/server: {{Code|net.xqj.basex.local.BaseXXQDataSource}}# Click ''OK''. ===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}}# Click ''OK'' to complete the connection configuration.# Click ''OK'' again to close the Preferences dialog. ===Configure New Transformation Scenario=== # Select ''Window'' → ''Show View'' → ''Transformation Scenarios''.# In the ''Transformation Scenarios'' panel, click {{Code|+}} and select ''XQuery transformation'' in the lower part of the dropdown list.# Enter a name for your transformation, e.g. "BaseX" like in the screenshot below.# 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 following function from the BaseX [[Database_Module|Database Module]] in your ''XQuery URL'' file:#: [[File:Oxygen-query-example.png]]#* 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.

===Data Source=== # Start oXygen and go to ''Options'' → ''Preferences'' → ''Data Sources''# Add a new Data Source with the ''New'' button ({{Code|+}})# Enter "BaseX-XQJ" as connection name and choose ''XQuery API for Java (XQJ)'' as type# Add the following JAR files above with the ''Add'' Button[[File: {{Code|xqj-api-1.0.jar}}, {{Code|xqj2-0.2.0.jar}} and {{Code|basexOxygen-xqjWebDAV-1.3.0.jar}} (the versions of the JAR file may differ). If you add the BaseX library as well {{Code|basex7.9.jar}}, you can also use the local XQJ driver.# Unter "Driver class", choose the default or the local XQJ driver ({{Code|net.xqj.basex.BaseXXQDataSource}} vs. {{Code|net.xqj.basex.local.BaseXXQDataSource}}).# Press ''OK''png]]

==ConnectionExecute Query==# Press ''New'' ({{Code|+}}) in the Connection Panel below. # Enter Name "BaseX" and select "BaseX-XQJ" in the Data Source box. # If you use the default driver, you need to enter connection details:#* Port: {{Code|1984}}#* Server name: {{Code|localhost}}#* User: {{Code|admin}}#* Password: {{Code|admin}}# Now press ''OK'', and your connection is ready.

==Usage==The After the one-time setup steps are complete, you can execute your query execution works as follows: # Configure a using the new transformation scenario in ''Window'' → ''Show View'' → ''Transformation Scenarios''.# Choose Start the transformation by clicking the red Run button (''XQuery TransformationApply associated scenarios'' tree entry.# Press the <code>plus</code> sign to add a new scenario. # Enter a Name and an optional XML and XQuery URL (e.g. your query document/file).# Choose "BaseX" as Transformer from in the combo box. # Press ''OK''Transformation Scenarios window, and while your scenario is ready. Now you can start the transformation, e.g. by clicking on the red ''Play'' buttonselected. # The results should be immediately occur displayed in the result panel.--[[User:CG|CG]] 14:45, 29 January 2015 (CET)