Difference between revisions of "Integrating oXygen"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
This tutorial is part of the [[Getting Started]] Section. | This tutorial is part of the [[Getting Started]] Section. | ||
| − | It describes how to | + | It describes how to access BaseX from the [http://www.oxygenxml.com oXygen XML Editor]. |
| − | + | Currently, there are two variants how to use BaseX in oXygen: | |
| − | + | ||
| − | + | * Resources in [[database|databases]] can be opened and modified. | |
| − | + | * XPath/XQuery expressions can be run by the [[Query|query processor]] of BaseX. | |
| − | == | + | |
| + | ==Access Database Resources== | ||
| + | |||
| + | # Start the [[WebDAV]] service first, which will allow you to access all resources via the client/server architecture. | ||
| + | * Choose ''File'' → ''Open URL...''.<br/> | ||
| + | [[File:Webdav-oxygen01.png]]<br/><br/> | ||
| + | * Enter the corresponding user name and password (if needed), the URL of the BaseX WebDAV Server, and then click "Browse".<br/> | ||
| + | [[File:Oxygen02.png]] | ||
| − | + | ==Perform Queries== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Data Source=== | ===Data Source=== | ||
# Start oXygen and go to ''Options'' → ''Preferences'' → ''Data Sources''. | # Start oXygen and go to ''Options'' → ''Preferences'' → ''Data Sources''. | ||
# Add a new Data Source with the ''New'' button. | # Add a new Data Source with the ''New'' button. | ||
| − | # Enter Name "BaseX" and choose ''XQuery API for Java(XQJ)'' as type. | + | # Enter Name "BaseX" and choose ''XQuery API for Java (XQJ)'' as type. |
# Add the three JAR files with the ''Add'' Button. | # Add the three JAR files with the ''Add'' Button. | ||
# Now press ''OK'', and your Data Source is ready. | # Now press ''OK'', and your Data Source is ready. | ||
| Line 26: | Line 28: | ||
# Now press ''OK'', and your connection is ready. | # Now press ''OK'', and your connection is ready. | ||
| − | ==Usage== | + | ===Usage=== |
The query execution works as follows: | The query execution works as follows: | ||
Revision as of 13:22, 12 October 2011
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.
Access Database Resources
- Start the WebDAV service first, which will allow you to access all resources via the client/server architecture.
- Choose File → Open URL....
- Enter the corresponding user name and password (if needed), the URL of the BaseX WebDAV Server, and then click "Browse".
Perform Queries
Data Source
- Start oXygen and go to Options → Preferences → Data Sources.
- Add a new Data Source with the New button.
- Enter Name "BaseX" and choose XQuery API for Java (XQJ) as type.
- Add the three JAR files with the Add Button.
- Now press OK, and your Data Source is ready.
Connection
- Now press New in the Connection Panel (located in Data Sources).
- Enter Name "BaseXConnection" and select "BaseX" in the Data Source box.
- Now press OK, and your connection is ready.
Usage
The query execution works as follows:
- Configure a new transformation scenario in Window → Show View → Transformation Scenarios.
- Press the
plussign to add a new scenario. - Enter a Name, XML URL (your xml file or leave it empty) and the XQuery URL (your query file).
- Choose "BaseXConnection" in the combo box.
- Press OK, and your scenario is ready. Now you can start the transformation.
- The results should immediately occur in the result panel.
