Difference between revisions of "Developing with Eclipse"

From BaseX Documentation
Jump to navigation Jump to search
(Changed from refactored BaseXWin to BaseXGui, added packaging info)
Line 32: Line 32:
 
#Create a new "Java Application" launch configuration  
 
#Create a new "Java Application" launch configuration  
 
#Select "basex" as "Project"  
 
#Select "basex" as "Project"  
#Choose a "Main class" (e.g., <code>org.basex.BaseXWin</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"
 
   
 
   
Line 39: Line 39:
 
<p>If the standalone version of [http://maven.apache.org Maven]  
 
<p>If the standalone version of [http://maven.apache.org Maven]  
 
is installed, you can run<code> mvn compile </code>in the project directory
 
is installed, you can run<code> mvn compile </code>in the project directory
to compile BaseX.</p>  
+
to compile BaseX.
 +
Should you wish to create / package your own jar's 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>  
 
   
 
   
 
   <p>Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.</p>  
 
   <p>Type in<code> java -cp target/classes/org.basex.BaseX </code>to run BaseX.</p>  
Line 58: Line 60:
 
   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.</p>
 +
 
[[Category:Developer]]
 
[[Category:Developer]]

Revision as of 22:59, 19 January 2011

Installation

Eclipse Integration

BaseX is being developed with the 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. Next, we recommend to use the m2eclipse plugin to add Maven support to Eclipse. Some additional guidelines are defined via Checkstyle and can be integrated with the eclipse-cs plugin.

To checkout BaseX, do the following:

  1. File » Import
  2. SVN » Check out Projects from SVN
  3. Use the repository https://svn.uni-konstanz.de/dbis/basex and click "Browse"
  4. Choose the project you like:
    1. basex is the main project
    2. api contains the BaseX APIs (XQJ, XMLDB and bindings in other languages)
    3. examples demonstrates some use cases for BaseX
  5. Click Finish

Run BaseX with Eclipse

  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"

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 jar's 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.