Difference between revisions of "Developing with Eclipse"

From BaseX Documentation
Jump to navigation Jump to search
Line 6: Line 6:
 
* Additional coding guidelines are defined via Checkstyle and can be integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin.
 
* Additional coding guidelines are defined via Checkstyle and can be integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] plugin.
 
* Other Eclipse plugins we frequently use are [http://findbugs.sourceforge.net/ FindBugs] to analyze Java byte code, and [http://wiki.eclipse.org/Core_Tools Core Tools] to find unreferenced members.
 
* Other Eclipse plugins we frequently use are [http://findbugs.sourceforge.net/ FindBugs] to analyze Java byte code, and [http://wiki.eclipse.org/Core_Tools Core Tools] to find unreferenced members.
 +
 +
You may as well use the standalone version of [[Maven]] to compile and run the project.
  
 
==Check Out==
 
==Check Out==
Line 23: Line 25:
 
#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''
 
==Using Maven==
 
 
If the standalone version of [http://maven.apache.org Maven] is installed,
 
you can run<code> mvn compile </code>in the project directory to compile BaseX.
 
 
Should you wish to create / package your own jars you can do so by running <code>mvn package</code>.
 
By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit-tests.
 
 
Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.
 
 
You can launch the following classes, which are all placed in the
 
<code>org.basex</code> main package:
 
 
;[[Startup_Options#BaseX_Standalone|BaseX]]
 
: standalone (embedded) mode
 
;[[Startup_Options#BaseX_Server|BaseXServer]]
 
: server instance, waiting for requests
 
;[[Startup_Options#BaseX_Client|BaseXClient]]
 
: client instance, interacting with the server
 
;[[Startup_Options#BaseX_GUI|BaseXGUI]]
 
:graphical user interface
 
 
Moreover, try <code>-h</code> 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.
 
  
 
[[Category:Developer]]
 
[[Category:Developer]]

Revision as of 05:14, 22 September 2011

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.
  • For additional comfort and to work with packages other than the main project, the m2eclipse plugin is required, which 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, and Core Tools to find unreferenced members.

You may as well use the standalone version of Maven to compile and run the project.

Check Out

To get some help on how to check out BaseX and its sub projects from GitHub (https://github.com/BaseXdb), please have a look at our GIT Tutorial.

The following packages are available:

  1. basex is the main project
  2. basex-api contains the BaseX APIs (REST, WebDAV, XQJ, XMLDB, and bindings in other languages)
  3. basex-examples demonstrates some use cases for BaseX
  4. basex-tests contains several coorectness and stress tests

Start

  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