https://github.com/bcdh/cql-module

Corpus Query Language Module for eXist-db
https://github.com/bcdh/cql-module

Last synced: 2 months ago
JSON representation

Corpus Query Language Module for eXist-db

• Host: GitHub
• URL: https://github.com/bcdh/cql-module
• Owner: BCDH
• License: gpl-2.0
• Created: 2016-09-02T00:47:25.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-11-22T15:31:13.000Z (about 1 year ago)
• Last Synced: 2024-04-24T12:26:46.761Z (9 months ago)
• Language: Java
• Size: 39.1 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Corpus Query Language module for eXist-db

[![Build Status](https://github.com/BCDH/cql-module/actions/workflows/ci.yml/badge.svg)](https://github.com/BCDH/cql-module/actions/workflows/ci.yml)

[![Java 8+](https://img.shields.io/badge/java-8+-blue.svg)](http://java.oracle.com)

[![License](https://img.shields.io/badge/license-GPL%202-blue.svg)](https://www.gnu.org/licenses/gpl-2.0.html)

[![Download](https://img.shields.io/badge/download-version%201.3.0-ff69b4.svg)](http://search.maven.org/remotecontent?filepath=org/humanistika/exist/module/cql-module/1.3.0/cql-module-1.3.0-exist.jar)

This is an XQuery Function Extension Module for eXist-db. The module provides a CQL (Corpus Query Language) to XML parser based on [exquery/corpusql-parser](https://github.com/exquery/corpusql-parser).

## Compiling

Requirements: Java 8, Maven 3.

1. `git clone https://github.com/bcdh/cql-module.git`

2. `cd cql-module`

3. `mvn package`

## Installation into eXist-db

You can install the module into eXist-db in either one of two ways:

1. As an EXPath Package (.xar file)

2. Directly as a XQuery Java Extension Module (.jar file)

### EXPath Package Installation into eXist-db (.xar)

1. If you have compiled yourself (see above), you can take the `cql-module/target/cql-module-1.4.0-SNAPSHOT.xar` file and upload it via eXist's EXPath Package Manager app in its Dashboard

2. Otherwise, the latest release version will also be available from the eXist's EXPath Package Manager app in its Dashboard

### Direct Installation into eXist-db (.jar)

1. If you have compiled yourself (see above), copy `cql-module/target/cql-module-1.4.0-SNAPSHOT-exist.jar` to `$EXIST_HOME/lib`, or download `cql-module-1.3.0-exist.jar` from Maven Central to `$EXIST_HOME/lib`

2. Edit `$EXIST_HOME/etc/conf.xml` and add the following to the ``:

    ```xml

    

    ```

3. Edit `$EXIST_HOME/etc/startup.xml` and add the following to the ``:

```xml

      

        org.humanistika.exist.module

        cql-module

        1.4.0-SNAPSHOT 

        cql-module-1.4.0-SNAPSHOT-exist.jar 

      

```

4. Restart eXist-db

## Usage

The module exports a single function for use in your XQuery(s), for example:

```xquery

xquery version "3.1";

import module namespace cql = "http://humanistika.org/ns/exist/module/cql";

cql:parse("[lemma='bob' & ana='x']")

```

would produce the output:

```xml

    

        

            bob

            x

        

    

```

For further examples of the XML that will be produced see [CorpusQLXMLVisitorTest](https://github.com/BCDH/cql-module/blob/master/src/test/java/org/humanistika/exist/module/cqlmodule/CorpusQLXMLVisitorTest.java#L42)