DEPRECATED Marklogic Sesame API for using MarkLogic with the Sesame RDF Framework
Java HTML Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.travis
gradle/wrapper
marklogic-sesame-examples
marklogic-sesame-functionaltests
marklogic-sesame-performance
marklogic-sesame
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

DEPRECATION NOTICE

marklogic-sesame has been deprecated. The sesame library, on which this project was based, has been retired and replaced by a new one called rdf4j.
A corresponding project called marklogic-rdf4j has been released to track the development of this newer semantics API.

https://github.com/marklogic/marklogic-rdf4j

To upgrade, use your dependency management system to replace marklogic-sesame with marklogic-rdf4j. Your Java code will have to be modified, because the package names in rdf4j are all new. However, aside from changing import statement, you are unlikely to have to update your applications.

marklogic-sesame-repository v1.0.2.1

Introduction

The MarkLogic Sesame API is a Sesame 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 Sesame API supports Sesame v2.8.10.

Setup MarkLogic

Ensure MarkLogic 8.0-6 or greater is installed and running. To use marklogic-sesame applications you will need access to a running MarkLogic server.

Usage

Quick Start

The MarkLogic Sesame API is available via Maven Central.

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

dependencies {
    compile group: 'com.marklogic', name: 'marklogic-sesame-repository', version: '1.0.2.1'

For maven projects, include in your pom.xml:

<dependency>
    <groupId>com.marklogic</groupId>
    <artifactId>marklogic-sesame-repository</artifactId>
    <version>1.0.2.1</version>
</dependency>

Build and Use from develop branch

This section describes how to build and test MarkLogic Sesame API from develop branch.

Setup MarkLogic Java API Client (optional)

marklogic-sesame-repository depends on MarkLogic Java API Client v3.0-6 and should pull down this version from maven central.

To optionally build marklogic-sesame-repository 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. 3. edit marklogic-sesame/build.gradle to use that snapshot

    compile('com.marklogic:java-client-api:3.0.6') {
        exclude(group: 'org.slf4j')
        exclude(group: 'ch.qos.logback')
    }

Setup and Test MarkLogic Sesame API

marklogic-sesame-repository depends on MarkLogic v8.0-6 or greater installed and running;

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

You should be able to test MarkLogic Sesame repository by running:

gradle :marklogic-sesame:test

Build and Deploy

Build and deploy a local maven marklogic-sesame-repository snapshot by runnning;

gradle :marklogic-sesame:install

optionally you can build the jar without running tests.

gradle build -x test

and copy resultant build/lib/marklogic-sesame-1.0.2.1.jar.

Examples

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

Javadocs

Latest javadocs are here

You may generate javadocs by running;

gradle :marklogic-sesame: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-sesame-repository 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 Sesame 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