[![Javadocs](http://www.javadoc.io/badge/org.corpus-tools/graphannis.svg)](http://www.javadoc.io/doc/org.corpus-tools/graphannis) ![Automated tests](https://github.com/korpling/graphANNIS-java/workflows/Automated%20tests/badge.svg)

# graphANNIS Java Bindings

GraphANNIS is a library for corpus linguistic queries and these are the Java bindings to **graphANNIS
								core library version 2.4.0**.

## How to compile

You can compile the Java project with Maven (http://maven.apache.org/)
```
mvn install
```

This will automatically download the the graphANNIS binaries to the `target/native/<platform>` folder, where platform is one of the following:

| Operating system       | `<platform>`  |
|------------------------|---------------|
| Linux (64 bit)         | linux-x86-64  |
| MacOS X (64 bit)       | darwin        |
| Windows (64 bit)       | win32-x86-64  |

You can change the `core.version` property in the `pom.xml` to use a different released version of graphANNIS.

To compile graphANNIS on your own (e.g. for using a non-released version)

- Clone the graphANNIS library  from https://github.com/korpling/graphANNIS/
- Follow the [graphANNIS compile instructions](https://github.com/korpling/graphANNIS#how-to-compile)
- Copy the resulting shared library file `<graphANNIS-repo>/target/release/libgraphannis.so` (`libgraphannis.dylib` under MacOS X and `graphannis.dll` under Windows) into the `target/native/<platform>` folder.

### Creating a P2 repository

For easier integration of graphANNIS into Eclipse RCP projects like Hexatomic, it is possible to create a P2 repository with the graphANNIS bundles (and its dependencies).
Execute

```bash
mvn p2:site
```

to create a local P2 repository in `target/repository`. You can serve this locally with Jetty using

```bash
mvn jetty:run -Djetty.http.port=9999
```

and access it at http://localhost:9999/site/. You can choose another port, e.g. to avoid conflicts with other local P2 repositories.

## Release process

1. Check the changelog (`CHANGELOG.md`): note the last release version number and which kind of changes have been made since the last release. Determine if this is a major, minor or patch release according to [semantic versioning](https://semver.org/). 
2. **Create a release** using Maven.  The command will ask you for the new version number use the most appropriate with respect to the previous version number and the changes made.
```
mvn release:clean release:prepare release:perform
```
This will update versions, the changelog, our citation file (`CITATION.cff`) and the contents of the `THIRD-PARTY` folder.

CI will automatically create a P2 repository in the gh-pages branch in under the sub-folder `p2/<short-version>`, e.g. https://korpling.github.io/graphannis-java/p2/v0.22/. 

## Author(s)

* Thomas Krause (thomas.krause@hu-berlin.de)