Developing with Eclipse
This page is part of the Developer Section. It describes how to get the BaseX sources compiled and running on your system.
Another article in the documentation describes how to use BaseX as a query processor in Eclipse.
- BaseX is developed with the Eclipse IDE for Java Developers (other IDEs like IntelliJ IDEA can be used as well).
- The (included) EGit plugin allows you to use Git within Eclipse.
- The (included) m2e plugin provides Maven support.
- Additional coding guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin. The Update URL is
- Other Eclipse plugins we frequently use are
- FindBugs to analyze Java byte code (Update URL: <code>http://findbugs.cs.umd.edu/eclipse</code>),
- Core Tools to find unreferenced members (Update URL: <code>http://eclipse.org/eclipse/platform-core/updates</code>, and
- the code coverage tool EclEmma (Update URL: <code>http://update.eclemma.org/</code>).
The basex repository contains the following sub-directories:
basex-coreis the main project
basex-apicontains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)
basex-examplesincludes some examples code for BaseX
basex-testscontains several unit and stress tests
If the problems view shows a list of warning, you may need to switch to Java 6 (Windows → Preferences → Installed JREs).
With the Maven plugin from Eclipse, it sometimes requires several attempts to get all dependencies updated. This loop can be avoided if the sources are precompiled via Maven on command-line.
Start in Eclipse
- Press Run → Run…
- Create a new "Java Application" launch configuration
- Select "basex" as "Project"
- Choose a "Main class" (e.g.,
org.basex.BaseXGUIfor the graphical user interface)
- Launch the project via Run