Difference between revisions of "Developing with Eclipse"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
−
==Installation==
+
==Prerequisites==
−
 
−
===Prerequisites===
 
 
   
 
   
 
* BaseX is being developed with the [http:www.eclipse.org Eclipse] environment. Some style
 
* BaseX is being developed with the [http:www.eclipse.org Eclipse] environment. Some style
Line 9: Line 7:
 
* 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.
  
−
===Check Out===
+
==Checkout==
 
   
 
   
 
To checkout BaseX, do the following:
 
To checkout BaseX, do the following:
Line 23: Line 21:
 
# Click ''Finish''
 
# Click ''Finish''
  
−
===Run BaseX with Eclipse===  
+
==Start==
 
#Press ''Run'' → ''Run…''
 
#Press ''Run'' → ''Run…''
 
#Create a new "Java Application" launch configuration  
 
#Create a new "Java Application" launch configuration  
Line 30: Line 28:
 
#Launch the project via ''Run''
 
#Launch the project via ''Run''
  
−
===Compile & Run BaseX===  
+
==Using Maven==
 
   
 
   
−
<p>If the standalone version of [http://maven.apache.org Maven]  
+
If the standalone version of [http://maven.apache.org Maven] is installed,
−
is installed, you can run<code> mvn compile </code>in the project directory
+
you can run<code> mvn compile </code>in the project directory to compile BaseX.
−
to compile BaseX.
+
 
−
Should you wish to create / package your own jars you can do so by running <code>mvn package</code>.
+
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.</p>
+
By adding the flag <code>-DskipTests=true</code> you can skip running the JUnit-tests.
 
   
 
   
−
  <p>Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.</p>
+
Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.
 
   
 
   
−
  <p>You can launch the following classes, which are all placed in the
+
You can launch the following classes, which are all placed in the
−
<code>org.basex</code> main package:</p>
+
<code>org.basex</code> main package:
  
−
;[[Console|BaseX]]
+
;[[Startup_Options#BaseX_Standalone|BaseX]]
−
: console mode
+
: standalone mode
−
;[[Server Tutorial|BaseXServer]]
+
;[[Startup_Options#BaseX_Server|BaseXServer]]
 
: server instance, waiting for requests
 
: server instance, waiting for requests
−
;[[Server Tutorial|BaseXClient]]
+
;[[Startup_Options#BaseX_Client|BaseXClient]]
−
: console mode, interacting with the server
+
: client instance, interacting with the server
−
;[[GUI Tutorial|BaseXGUI]]
+
;[[Startup_Options#BaseX_GUI|BaseXGUI]]
−
:graphical user interface  
+
:graphical user interface
 
   
 
   
−
  <p>Moreover, try <code>-h</code> to have a look at the available command-line options.
+
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
+
For example, you can evaluate XQuery expressions or process database commands without
−
  entering the console.</p>
+
entering the console.
  
 
[[Category:Developer]]
 
[[Category:Developer]]

Revision as of 19:49, 10 February 2011

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.

Checkout

To checkout BaseX, do the following:

  1. File → Import
  2. SVN → Check out Projects from SVN
  3. Enter https://svn.uni-konstanz.de/dbis/basex/trunk as repository
  4. Choose the project you like:
    1. basex is the main project
    2. api contains the BaseX APIs (JAX-RX, XQJ, XMLDB, and bindings in other languages)
    3. examples demonstrates some use cases for BaseX
    4. jax-rx represents the JAX-RX Interface
  5. Click Finish

Start

  1. Press Run → Run…
  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

Using Maven

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
standalone mode
BaseXServer
server instance, waiting for requests
BaseXClient
client instance, 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.

Retrieved from "http://docs.basex.org/index.php?title=Developing_with_Eclipse&oldid=2913"