Difference between revisions of "Developing with Eclipse"
(Removed the eclipse marketplace image) |
|||
(27 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
This page is part of the [[Developer Section]]. It describes how to get the BaseX sources compiled and running on your system. | 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 [[ | + | |
+ | Another article in the documentation describes how to use BaseX as a [[Integrating Eclipse|query processor in Eclipse]]. | ||
==Prerequisites== | ==Prerequisites== | ||
− | + | BaseX is developed with the Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The [https://www.eclipse.org/downloads/ Eclipse IDE for Java Developers] includes the EGit plugin (for [[Git]]) and the m2e plugin (for [[Maven]]). | |
− | |||
− | |||
− | |||
− | |||
− | + | Other Eclipse plugins we use are: | |
+ | |||
+ | {| class="wikitable" | ||
+ | |- valign="top" | ||
+ | ! Name | ||
+ | ! Description | ||
+ | ! Update URL | ||
+ | ! Eclipse Marketplace | ||
+ | |- | ||
+ | | [http://eclipse-cs.sourceforge.net eclipse-cs] | ||
+ | | Enforces Checkstyle coding standards. | ||
+ | | <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code> | ||
+ | | [http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150 install] | ||
+ | |- | ||
+ | | [http://findbugs.sourceforge.net FindBugs] | ||
+ | | Analyze project at byte code level | ||
+ | | <code><nowiki>http://findbugs.cs.umd.edu/eclipse</nowiki></code> | ||
+ | | [http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=1099 install] | ||
+ | |- | ||
+ | | [http://www.ucdetector.org/ UCDetector] | ||
+ | | Unnecessary code detector | ||
+ | | <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code> | ||
+ | | [http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=661 install] | ||
+ | |- | ||
+ | | [http://www.eclemma.org/ EclEmma] | ||
+ | | Code coverage tool. | ||
+ | | <code><nowiki>http://update.eclemma.org/</nowiki></code> | ||
+ | | [http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=264 install] | ||
+ | |} | ||
==Check Out== | ==Check Out== | ||
− | + | Our [[Git|Git Tutorial]] explains how BaseX can be checked out from the [https://github.com/BaseXdb/basex 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: | ||
+ | # {{Code|basex-core}} is the main project | ||
+ | # {{Code|basex-api}} contains the BaseX APIs (XML:DB, bindings in other languages) and HTTP Services ([[REST]], [[RESTXQ]], [[WebDAV]]) | ||
+ | # {{Code|basex-examples}} includes some examples code for BaseX | ||
+ | # {{Code|basex-tests}} contains several unit and stress tests | ||
− | + | If the "Problems" View contains errors or warnings, you may need to switch to Java 7 (''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== | ==Start in Eclipse== | ||
Line 28: | Line 55: | ||
# Choose a "Main class" (e.g., <code>org.basex.BaseXGUI</code> for the graphical user interface) | # Choose a "Main class" (e.g., <code>org.basex.BaseXGUI</code> for the graphical user interface) | ||
# Launch the project via ''Run'' | # 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 [http://www.jetbrains.com/idea IntelliJ IDEA]. | ||
+ | |||
[[Category:Developer]] | [[Category:Developer]] |
Revision as of 12:51, 29 February 2016
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 environment (other IDEs like IntelliJ IDEA can be used as well). The Eclipse IDE for Java Developers includes the EGit plugin (for Git) and the m2e plugin (for Maven).
Other Eclipse plugins we use are:
Name | Description | Update URL | Eclipse Marketplace |
---|---|---|---|
eclipse-cs | Enforces Checkstyle coding standards. | http://eclipse-cs.sf.net/update/
|
install |
FindBugs | Analyze project at byte code level | http://findbugs.cs.umd.edu/eclipse
|
install |
UCDetector | Unnecessary code detector | http://ucdetector.sourceforge.net/update
|
install |
EclEmma | Code coverage tool. | http://update.eclemma.org/
|
install |
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 contains errors or warnings, you may need to switch to Java 7 (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.