Developing with Eclipse

From BaseX Documentation
Revision as of 23:07, 12 December 2010 by Michael (talk | contribs) (→‎Eclipse Integration: added link to repository info page)
Jump to navigation Jump to search

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 Subclipse Plugin is needed to check out the latest sources from our repository. Next, we recommend to use the m2eclipse plugin to add Maven support to Eclipse. Some additional guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin.

To checkout BaseX, do the following:

  1. File » Import
  2. SVN » Check out Projects from SVN
  3. Use the repository https://svn.uni-konstanz.de/dbis/basex and click "Browse"
  4. Choose the project you like:
    1. basex is the main project
    2. api contains the BaseX APIs (XQJ, XMLDB and bindings in other languages)
    3. examples demonstrates some use cases for BaseX
  5. Click Finish

Run BaseX with Eclipse

  1. Press Run » Run…
  2. Create a new "Java Application" launch configuration
  3. Select "basex" as "Project"
  4. Choose a "Main class" (e.g., org.basex.BaseXWin for the graphical user interface)
  5. Launch the project via "Run"

Compile & Run BaseX

If the standalone version of Maven 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
BaseXGUI
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 XQJ and XML:DB API:

<dependency>
  <groupId>org.basex</groupId>
  <artifactId>basex-api</artifactId>
  <version>6.2.4</version>
</dependency>