Difference between revisions of "Developing with Eclipse"
Line 19: | Line 19: | ||
<p>To checkout BaseX, do the following:</p> | <p>To checkout BaseX, do the following:</p> | ||
− | #''File'' → ''Import'' | + | # ''File'' → ''Import'' |
− | #''SVN'' → ''Check out Projects from SVN'' | + | # ''SVN'' → ''Check out Projects from SVN'' |
− | # | + | # Enter [https://svn.uni-konstanz.de/dbis/basex https://svn.uni-konstanz.de/dbis/basex] as repository |
− | #Choose the project you like:<br/> | + | # Choose the project you like:<br/> |
− | ##[https://svn.uni-konstanz.de/dbis/basex/trunk/basex basex] is the main project | + | ## [https://svn.uni-konstanz.de/dbis/basex/trunk/basex basex] is the main project |
− | ##[https://svn.uni-konstanz.de/dbis/basex/trunk/api api] contains the BaseX APIs (XQJ, XMLDB and bindings in other languages) | + | ## [https://svn.uni-konstanz.de/dbis/basex/trunk/api api] contains the BaseX APIs (XQJ, XMLDB and bindings in other languages) |
− | ##[https://svn.uni-konstanz.de/dbis/basex/trunk/examples examples] demonstrates some use cases for BaseX | + | ## [https://svn.uni-konstanz.de/dbis/basex/trunk/examples examples] demonstrates some use cases for BaseX |
− | #Click ''Finish'' | + | # Click ''Finish'' |
===Run BaseX with Eclipse=== | ===Run BaseX with Eclipse=== |
Revision as of 19:38, 10 February 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:
- File → Import
- SVN → Check out Projects from SVN
- Enter https://svn.uni-konstanz.de/dbis/basex 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.BaseXGUI
for 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.