Difference between revisions of "Developing with Eclipse"

From BaseX Documentation
Jump to navigation Jump to search
Line 9: Line 9:
 
* The (included) [http://www.eclipse.org/m2e m2e] plugin provides [[Maven]] support.
 
* The (included) [http://www.eclipse.org/m2e m2e] plugin provides [[Maven]] support.
 
* Additional coding guidelines are defined via Checkstyle and can be integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin. The Update URL is {{Code|http://eclipse-cs.sf.net/update/}}.
 
* Additional coding guidelines are defined via Checkstyle and can be integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin. The Update URL is {{Code|http://eclipse-cs.sf.net/update/}}.
* Other Eclipse plugins we frequently use are:
+
* Other Eclipse plugins we frequently use are
** [http://findbugs.sourceforge.net/ FindBugs] to analyze Java byte code (Update URL: {{Code|http://findbugs.cs.umd.edu/eclipse}},
+
** [http://findbugs.sourceforge.net/ FindBugs] to analyze Java byte code (Update URL: <nowiki><code>http://findbugs.cs.umd.edu/eclipse</code></nowiki>),
** [http://www.eclipse.org/eclipse/platform-core/downloads.php Core Tools] to find unreferenced members (Update URL: {{Code|http://eclipse.org/eclipse/platform-core/updates}}, and
+
** [http://www.eclipse.org/eclipse/platform-core/downloads.php Core Tools] to find unreferenced members (Update URL: <nowiki><code>http://eclipse.org/eclipse/platform-core/updates</code></nowiki>, and
** the code coverage tool [http://www.eclemma.org/ EclEmma] (Update URL: {{Code|http://update.eclemma.org/}}.
+
** the code coverage tool [http://www.eclemma.org/ EclEmma] (Update URL: <nowiki><code>http://update.eclemma.org/</code></nowiki>).
  
 
==Check Out==
 
==Check Out==

Revision as of 14:07, 28 July 2014

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 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 http://eclipse-cs.sf.net/update/.
  • 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>).

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:

  1. basex-core is the main project
  2. basex-api contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services (REST, RESTXQ, WebDAV)
  3. basex-examples includes some examples code for BaseX
  4. basex-tests contains several unit and stress tests

If the problems view shows a list of warning, you may need to switch to Java 6 (WindowsPreferencesInstalled 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

  1. Press RunRun…
  2. Create a new "Java Application" launch configuration
  3. Select "basex" as "Project"
  4. Choose a "Main class" (e.g., org.basex.BaseXGUI for the graphical user interface)
  5. 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.