- command line functionality
- pom: download dependency jars to lib
- pom: main class
- cosmas: #IN/#OV options
6 files changed
tree: 2fc6d070d464264bb26c9f7616ff30ffcda41fc7
  1. src/
  2. .classpath
  3. .project
  4. LICENSE
  5. pom.xml
  6. README.md
README.md

Koral v1.0

Koral is a library designed for the translation of different corpus query languages to KoralQuery, a JSON-LD-based protocol for the representation of linguistic queries.

As of v1.0, the following corpus query languages (QLs) are supported:

Code Example

You can use the main class QuerySerializer to translate and serialize queries for you. The following code snippet illustrates this. Valid QL identifiers are cosmas', annis', poliqarp', poliqarpplus' and `cqp'.

import de.ids_mannheim.korap.query.serialize.QuerySerialzer;
QuerySerializer qs = new QuerySerializer();
qs.setQuery("This is a poliqarp query.", "poliqarp");
System.out.println(qs.toJSON());

This will print out a JSON-LD string with you Koralized query. There is also a command line version. After installation, simply run

java -jar target/Koral-1.0.jar [query] [queryLanguage]
'''

## Motivation

Koral and KoralQuery have been designed and developed within the [KorAP Project][http://korap.ids-mannheim.de/].
Through Koral, linguists can use the KorAP query engine with the QL of their 
preference. As the KorAP backend only sees the incoming KoralQuery,
new QLs can be supported by KorAP without having to change a single line of
code in the backend.

## Installation

Installation is straightforward:

git clone https://github.com/korap/Koral [install-dir] cd [install-dir] mvn install '''

License

Koral is published under the Perl [Artistic License][http://opensource.org/licenses/artistic-license-2.0]. See also the attached LICENSE.