Difference between revisions of "Developing with Eclipse"
m (moved Eclipse to Developing with Eclipse) |
|
(No difference)
|
Revision as of 10:21, 19 October 2013
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.
Prerequisites
- BaseX is being developed with the Eclipse environment. Other IDEs are used as well in our community, but are not supported by our team.
- The EGit plugin can be used to check out the latest sources from our repository within Eclipse.
- The m2eclipse plugin is required to work with packages other than the main project; it adds Maven support to Eclipse.
- Additional coding guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin.
- Other Eclipse plugins we frequently use are FindBugs to analyze Java byte code, Core Tools to find unreferenced members, and the code coverage tool EclEmma.
Check Out
Our Git Tutorial explains how BaseX can be checked out from the GitHub Repository and embedded in Eclipse with EGit. The article also demonstrates how git can be used on command-line.
The basex repository contains the following sub-directories:
basex-core
is the main projectbasex-api
contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)basex-examples
includes some examples code for BaseXbasex-tests
contains 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.BaseXGUI
for the graphical user interface) - Launch the project via Run
Alternative
You may as well use the standalone version of Maven to compile and run the project, use other IDEs such as IntelliJ IDEA.