Difference between revisions of "Developing with Eclipse"
| Line 1: | Line 1: | ||
==Installation== | ==Installation== | ||
| − | === | + | ===Prerequisites=== |
| − | + | * BaseX is being developed with the [http:www.eclipse.org Eclipse] environment. Some style | |
| − | guidelines are integrated in the sources of BaseX; | + | guidelines are integrated in the sources of BaseX; they are being embedded as soon as you open the project. |
| − | they are being embedded as soon as you open the project. | + | * The [http://subclipse.tigris.org Subclipse Plugin] is needed to check out the latest sources from [[Subversion_Repository|our repository]]. |
| + | * To work with packages other than the main project, the [http://m2eclipse.sonatype.org m2eclipse] plugin is required to add [[Maven]] support to Eclipse. | ||
| + | * Additional coding guidelines are defined via Checkstyle and can be integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin. | ||
| + | |||
| + | ===Check Out=== | ||
| − | + | To checkout BaseX, do the following: | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
# ''File'' → ''Import'' | # ''File'' → ''Import'' | ||
Revision as of 19:45, 10 February 2011
Contents
Installation
Prerequisites
- BaseX is being developed with the [http:www.eclipse.org 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.
- To work with packages other than the main project, the m2eclipse plugin is required to add Maven support to Eclipse.
- Additional coding guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin.
Check Out
To checkout BaseX, do the following:
- File → Import
- SVN → Check out Projects from SVN
- Enter https://svn.uni-konstanz.de/dbis/basex/trunk as repository
- Choose the project you like:
- Click Finish
Run BaseX with 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
Compile & Run BaseX
If the standalone version of Maven
is installed, you can run mvn compile in the project directory
to compile BaseX.
Should you wish to create / package your own jars you can do so by running mvn package.
By adding the flag -DskipTests=true you can skip running the JUnit-tests.
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.
