Difference between revisions of "Developing with Eclipse"
(Created page with "<h2>Installation</h2> <h3>Eclipse Integration</h3> <p>BaseX is being developed with the Eclipse environment. Some style guidelines are integrated in the sources of BaseX; t...") |
|||
Line 118: | Line 118: | ||
</dependency> | </dependency> | ||
</code> | </code> | ||
+ | [[Category:Wikify]] |
Revision as of 12:52, 10 December 2010
Contents
Installation
Eclipse Integration
BaseX is being developed with the Eclipse environment. Some style guidelines are integrated in the sources of BaseX; they are being embedded as soon as you open the project.
The <a href="http://subclipse.tigris.org/">Subclipse Plugin</a> is needed to check out the latest sources from our repository. Next, we recommend to use the <a href="http://m2eclipse.sonatype.org/">m2eclipse</a> plugin to add Maven support to Eclipse. Some additional guidelines are defined via Checkstyle and can be integrated with the <a href="http://eclipse-cs.sourceforge.net/">eclipse-cs</a> plugin.
To checkout BaseX, do the following:
- File » Import
- SVN » Check out Projects from SVN
- Use the repository <a href="https://svn.uni-konstanz.de/dbis/basex">https://svn.uni-konstanz.de/dbis/basex</a> and click "Browse"
- Choose the project you like:
- <a href="https://svn.uni-konstanz.de/dbis/basex/trunk/basex/">basex</a> is the main project
- <a href="https://svn.uni-konstanz.de/dbis/basex/trunk/api/">api</a> contains the BaseX APIs (XQJ, XMLDB and bindings in other languages)
- <a href="https://svn.uni-konstanz.de/dbis/basex/trunk/examples/">examples</a> demonstrates some use cases for BaseX
- Click Finish
Run BaseX with Eclipse
- Press Run » Run…
- Create a new "Java Application" launch configuration
- Select "basex" as "Project"
- Choose a "Main class" (e.g.,
org.basex.BaseXWin
for the graphical user interface) - Launch the project via "Run"
Compile & Run BaseX
If the standalone version of <a href="http://maven.apache.org/">Maven</a>
is installed, you can run mvn compile
in the project directory
to compile BaseX.
Type in java -cp target/classes/org.basex.BaseX
to run BaseX.
You can launch the following classes, which are all placed in the
org.basex
main package:
BaseX | console mode | |
BaseXServer | server instance, waiting for requests | |
BaseXClient | console mode, interacting with the server | |
BaseXWin | graphical user interface |
Moreover, try -h
to have a look at the available command-line options.
For example, you can evaluate XQuery expressions or process database commands without
entering the console.
Integration
As BaseX is offered in a Maven repository, you can easily embed it in your own projects.
In order to use the BaseX Maven Artifacts, add the following lines to your
pom.xml
file:
<repositories>
<repository>
<id>dbis-ukn</id>
<name>DBIS Maven Repository</name>
<url>http://www.inf.uni-konstanz.de/dbis/basex/maven</url>
</repository>
</repositories>
BaseX Artifact
<dependency>
<groupId>org.basex</groupId>
<artifactId>basex</artifactId>
<version>6.2.4</version>
</dependency>
BaseX API Artifact
...including the <a href="http://jcp.org/en/jsr/detail?id=225" title="XQJ">XQJ</a> and <a href="http://sourceforge.net/projects/xmldb-org/">XML:DB</a> API:
<dependency>
<groupId>org.basex</groupId>
<artifactId>basex-api</artifactId>
<version>6.2.4</version>
</dependency>