Difference between revisions of "Developing with Eclipse"
Line 1: | Line 1: | ||
− | + | ==Installation== | |
− | + | ===Eclipse Integration=== | |
<p>BaseX is being developed with the Eclipse environment. Some style | <p>BaseX is being developed with the Eclipse environment. Some style | ||
Line 7: | Line 7: | ||
they are being embedded as soon as you open the project.</p> | they are being embedded as soon as you open the project.</p> | ||
− | <p>The | + | <p>The [http://subclipse.tigris.org Subclipse Plugin] is needed |
to check out the latest sources from our repository. | to check out the latest sources from our repository. | ||
Next, we recommend to use the | Next, we recommend to use the | ||
− | + | [http://m2eclipse.sonatype.org m2eclipse] plugin | |
to add Maven support to Eclipse. | to add Maven support to Eclipse. | ||
Some additional guidelines are defined via Checkstyle and can be | Some additional guidelines are defined via Checkstyle and can be | ||
− | integrated with the | + | integrated with the [http://eclipse-cs.sourceforge.net eclipse-cs] |
plugin. | plugin. | ||
</p> | </p> | ||
Line 19: | Line 19: | ||
<p>To checkout BaseX, do the following:</p> | <p>To checkout BaseX, do the following:</p> | ||
− | + | #File » Import | |
− | + | #SVN » Check out Projects from SVN | |
− | + | #Use the repository [https://svn.uni-konstanz.de/dbis/basex https://svn.uni-konstanz.de/dbis/basex] and click "Browse" | |
− | + | #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/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 | |
− | + | #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., <code>org.basex.BaseXWin</code> for the graphical user interface) | ||
+ | #Launch the project via "Run" | ||
− | + | ===Compile & Run BaseX=== | |
− | + | <p>If the standalone version of [http://maven.apache.org Maven] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <p>If the standalone version of | ||
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.</p> | ||
Line 55: | Line 44: | ||
<p>You can launch the following classes, which are all placed in the | <p>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:</p> |
− | + | ||
− | + | ;BaseX | |
− | + | : console mode | |
− | + | ;BaseXServer | |
− | + | : server instance, waiting for requests | |
− | + | ;BaseXClient | |
− | + | : console mode, interacting with the server | |
− | + | ;BaseXGUI | |
− | + | :graphical user interface | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<p>Moreover, try <code>-h</code> to have a look at the available command-line options. | <p>Moreover, try <code>-h</code> to have a look at the available command-line options. | ||
Line 84: | Line 59: | ||
entering the console.</p> | entering the console.</p> | ||
− | + | ==Integration== | |
<p>As BaseX is offered in a Maven repository, you can easily embed it in your own projects. | <p>As BaseX is offered in a Maven repository, you can easily embed it in your own projects. | ||
In order to use the BaseX Maven Artifacts, add the following lines to your | In order to use the BaseX Maven Artifacts, add the following lines to your | ||
<code>pom.xml</code> file:</p> | <code>pom.xml</code> file:</p> | ||
− | < | + | <pre class="brush:xml"><repositories> |
− | <repositories> | ||
<repository> | <repository> | ||
<id>dbis-ukn</id> | <id>dbis-ukn</id> | ||
Line 96: | Line 70: | ||
<url>http://www.inf.uni-konstanz.de/dbis/basex/maven</url> | <url>http://www.inf.uni-konstanz.de/dbis/basex/maven</url> | ||
</repository> | </repository> | ||
− | </repositories> | + | </repositories></pre> |
− | </ | ||
− | + | ===BaseX Artifact=== | |
− | < | + | <pre class="brush:xml"><dependency> |
− | <dependency> | ||
<groupId>org.basex</groupId> | <groupId>org.basex</groupId> | ||
<artifactId>basex</artifactId> | <artifactId>basex</artifactId> | ||
<version>6.2.4</version> | <version>6.2.4</version> | ||
− | </dependency> | + | </dependency></pre> |
− | </ | ||
− | + | ===BaseX API Artifact=== | |
− | <p>...including the | + | <p>...including the [http://jcp.org/en/jsr/detail?id=225 XQJ] and |
− | + | [http://sourceforge.net/projects/xmldb-org XML:DB] API:</p> | |
− | < | + | <pre class="brush:xml"><dependency> |
− | <dependency> | ||
<groupId>org.basex</groupId> | <groupId>org.basex</groupId> | ||
<artifactId>basex-api</artifactId> | <artifactId>basex-api</artifactId> | ||
<version>6.2.4</version> | <version>6.2.4</version> | ||
− | </dependency> | + | </dependency></pre> |
− | </ | ||
− |
Revision as of 19:14, 12 December 2010
Contents
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
- Use the repository https://svn.uni-konstanz.de/dbis/basex and click "Browse"
- 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.BaseXWin
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.
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.
Integration
As BaseX is offered in a Maven repository, you can easily embed it in your own projects.
In order to use the BaseX Maven Artifacts, add the following lines to your
pom.xml
file:
<repositories> <repository> <id>dbis-ukn</id> <name>DBIS Maven Repository</name> <url>http://www.inf.uni-konstanz.de/dbis/basex/maven</url> </repository> </repositories>
BaseX Artifact
<dependency> <groupId>org.basex</groupId> <artifactId>basex</artifactId> <version>6.2.4</version> </dependency>
BaseX API Artifact
...including the XQJ and XML:DB API:
<dependency> <groupId>org.basex</groupId> <artifactId>basex-api</artifactId> <version>6.2.4</version> </dependency>