marklogic-rdf4j

marklogic-rdf4j v1.0.0

Introduction

The markLogic-rdf4j API is a RDF4J Repository implementation exposing MarkLogic semantic features.

• Transactions: Fully compliant ACID transactions.
• Variable bindings: Set a binding(s) name, language tag, and value.
• Inference (ruleset configuration): Enable inference rulesets .
• Combination of SPARQL with MarkLogic document query: Constrain SPARQL query with MarkLogic queries.
• Optimized pagination of SPARQL result sets: Efficient paging of results.
• Permissions: Manage permissions on triples.

Before you start

The markLogic-rd4j API supports RDF4J v2.2.1.

Setup MarkLogic

Ensure MarkLogic 9.0-2 or greater is installed and running. To use marklogic-rdf4j applications you will need access to a running MarkLogic server.

Usage

Quick Start

The markLogic-rdf4j API is available via Maven Central.

For gradle projects, include the following dependency in your build.gradle:

dependencies {
    compile group: 'com.marklogic', name: 'marklogic-rdf4j', version: '1.0.0'
}

For maven projects, include in your pom.xml:

<dependency>
    <groupId>com.marklogic</groupId>
    <artifactId>marklogic-rdf4j</artifactId>
    <version>1.0.0</version>
</dependency>

Build and Use from develop branch

This section describes how to build and test marklogic-rdf4j API from develop branch.

Setup MarkLogic Java API Client (optional)

marklogic-rdf4j depends on MarkLogic Java API Client v4.0-1 and should pull down this version from maven central.

To optionally build marklogic-rdf4j with develop branch version of MarkLogic Java API Client:

1. Clone or download MarkLogic Java API client develop branch.
2. Build and deploy Java API client to local maven repo.

mvn -Dmaven.test.skip=true -Dmaven.javadoc.skip=true deploy

Verify that Java API client has been deployed to your local maven repo.

1. Edit marklogic-RDF4J/build.gradle to use that snapshot

    compile('com.marklogic:marklogic-client-api:5.0-SNAPSHOT') 

Setup and Test markLogic-rdf4j API

marklogic-rdf4j depends on MarkLogic v9.0-2 or greater installed and running;

1. Clone or download marklogic-rdf4j develop branch.
2. Review marklogic-rdf4j/gradle.properties which defines test deployment settings.
3. Run gradle target that provisions MarkLogic with everything required (database,REST server,etc.).

gradle marklogic-rdf4j:mlDeploy

You should be able to test marklogic-rdf4j repository by running:

gradle marklogic-rdf4j:test

Build and Deploy

Build and deploy a local maven marklogic-rdf4j snapshot by running;

gradle marklogic-rdf4j:install

optionally you can build the jar without running tests.

gradle build -x test

and copy resultant build/lib/marklogic-rdf4j-1.0.0.jar.

Examples

The marklogic-rdf4j-examples folder contains a sample project that demonstrates usage of marklogic-rdf4j.

Javadocs

Latest javadocs are here

You may generate javadocs by running;

gradle marklogic-rdf4j:javadoc

Contributing

Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully considered, though we cannot promise a specific resolution or timeframe for any request.

Learn how to contribute.

Support

The marklogic-rdf4j is maintained by MarkLogic Engineering and distributed under the Apache 2.0 license. In addition, MarkLogic provides technical support for release tags of the MarkLogic RDF4J API to licensed customers under the terms outlined in the Support Handbook. For more information or to sign up for support, visit help.marklogic.com.

License

Apache License v2.0