Liking cljdoc? Tell your friends :D

ont-app/igraph-jena

This is a port of the Jena APIs to the IGraph protocol.

Part of the ont-app library, dedicated to Ontology-driven development.

Usage

Available at .

Require thus:

(ns my-ns
  (:require 
    [ont-app.igraph-jena.core :as jgraph])
  (:import 
    ;; any Jena-specific stuff
    ))

Creating a graph:

Create the graph thus:

With no arguments (returns a Jena default model):

> (def g (jgraph/make-jena-graph))
> (type (:model g))
org.apache.jena.rdf.model.impl.ModelCom
>

We can specify a file

> (def g (jgraph/make-jena-graph (RDFDataMgr/loadModel "/path/to/test-data.ttl"))

Or equivalently use the load-rdf function:

> (def g (jgraph/load-rdf "/path/to/test-data.ttl"))

If we have an existing Jena Model, we can define an IGraph wrapper around it:

> (def g (jgraph/make-jena-graph <existing-jena-model>))

... or if we have a Jena DataSet and the name of a graph (nil for default graph):

> (def g (jgraph/make-jena-graph <existing-dataset> <graph-name-or-nil>))

Member access and manipulation

Then apply the standard methods for IGraph member access, with mutable member manipulation operations add! and subtract!.

For example:

> (g :eg/Thing2)
{:eg/number #{2},
 :rdfs/label #{#voc/lstr "Thing 2@en"},
 :eg/cost #{#voc/dstr "2^^eg:USDollars"},
 :rdf/type #{:eg/Thing}}
> 
> (g :eg/Thing2 :eg/number)
#{2}
>
> (g :eg/Thing2 :eg/number 2)
true
> 
> (add! g [[:eg/Thing3 :rdf/type :eg/Thing]
           [:eg/Thing3 :rdfs/label #voc/lstr"Thing3@en"]
           [:eg/Thing3 :rdf/number 3]])

Set the IGraph docs for more details.

Blank nodes

You may on occasion need to use blank nodes when adding triples.

> (add! g [[:eg/MyClass
            :rdfs/subClassOf :rdf-app/_:my-restriction]
           [:rdf-app/_:my-restriction
            :rdf/type :owl/Restriction
            <yadda> <yadda>
            ]])

Note that the bnode is interned in the rdf-app namespace because it is not round-trippable, and won't be until it is added to the Jena graph and queried for, at which point the triple will look like [:eg/MyClass :rdfs/subClassOf :jena/_:b-12345-and-so-on]. :jena/_:b-12345-and-so-on would then show up in the list of subjects and be queryable within the graph.

Note also that the name portion of bnode KWIs all conform to rdf/bnode-name-re, e.g. "_:yadda-yadda" .

Resource types

This module defines its own resource type context: :ont-app.igraph-jena.core/resource-type-context, derived from :ont-app.rdf.core/resource-type-context.

This context recognizes the following resource types in addition to those specified in :ont-app.rdf.core/resource-type-context and :ont-app.vocabulary.core/resource-type-context.

Resource	maps to resource type
java.lang.String	:jena/BnodeString
clojure.lang.Keyword	:jena/BnodeKwi
org.apache.jena.rdf.model.impl.ResourceImpl	:jena/URI :jena/BNode

:jena/BnodeString represents a bnode round-trippable under Jena
:jena/BnodeKwi represents a KWI for a bnode round-trippable under Jena. It is derived from :rdf-app/BnodeKwi
:jena/URI is a URI represented as a Jena ResourceImpl
:jena/Bnode is a round-trippable bnode represented as a Jena ResourceImpl

Each of these resource types have the usual methods defined. See the ont-app/vocabulary documentation for details.

Typed literals

Instances of org.apache.jena.rdf.model.impl.LiteralImpl are encoded with #voc/dstr tags.

Many such tags have methods defined for voc/untag from which can can derive clojure-native values:

> (voc/untag #voc/dstr "2000-01-01T00:00:00Z^^xsd:dateTime"
#inst "2000-01-01T00:00:00.000-00:00"

Typed literals will be rendered in the graph using their tag unless their (voc/as-kwi datatype) is derived from :jena/UntaggedInGraph, in which case the native clojure representation will be used. Current defaults:

(doseq [to-untag [:transit/json
                  :xsd/dateTime
                  :xsd/double
                  :xsd/int
                  :xsd/integer
                  :xsd/long
                  :xsd/string
                  ]]
  (derive to-untag :jena/UntaggedInGraph))

Given a given graph g, we can also recover the original object thus:

(-> #voc/dstr "PT15S^^xsd:duration"
    (jena/create-object-resource g ) ;; LiteralImpl
    (.getValue)                      ;; org.apache.jena.datatypes.xsd.XSDDuration
    (.getSeconds))
15.0

Support for encoding clojure containers in transit

It is possible to store Clojure data directly in the graph encoded as typed literals in transit format:

(add! g :eg/Thing4 :eg/hasMap {:sub-map {:a "this is a string"}
                               :vector [1 2 3]
                               :set #{:a :b :c}
                               :list '(1 2 3)
                               })

The resulting in-memory graph would look like this:

{
 # ... yadda
 :eg/Thing4
 #:eg{:hasMap
      #{{:sub-map {:a "this is a string"},
         :vector [1 2 3],
         :set #{:c :b :a},
         :list (1 2 3)}}},
 # yadda ...

After a call to write-rdf, the resulting turtle would look like this:

@prefix eg:   <http://rdf.example.com#> .

# ... yadda
eg:Thing4  eg:hasMap  "[\"^ \",\"~:sub-map\",[\"^ \",\"~:a\",\"this is a string\"],\"~:vector\",[1,2,3],\"~:set\",[\"~#set\",[\"~:c\",\"~:b\",\"~:a\"]],\"~:list\",[\"~#list\",[1,2,3]]]"^^<http://rdf.naturallexicon.org/ns/cognitect.transit#json> .
# yadda ...

This is not the most human-readable stuff on earth, but transit has several advantages. One disadvantage is that it's hard to formulate queries in SPARQL that match these values directly. Note also that none of the internals of the transit representation would be available under SPARQL either. You'd need to read the file back into an RDF-based IGraph, or use transit's API to import the contents into the platform of your choice.

You should also be able to roll your own custom transit support for other data structures.

See the corresponding section in the igraph/rdf module for more details.

I/O

The ont-app/rdf module has multimethods defined for I/O. The functions described here are wrappers around those methods.

Loading a file into a new graph

> (load-rdf to-load) -> <new graph>

The to-load argument can be either a string naming an existing file path, a java file, a jar resource or a URL registered in @rdf/resource-catalog.

Reading a file into an existing graph

> (read-rdf g to-read) -> <updated graph>

Again, he to-read argument can be either a string naming an existing file path, a java file, a jar resource or a URL registered in @rdf/resource-catalog.

Writing the contents of a graph to a file

At present only writing to local files is supported.

> (write-with-jena-writer g "/tmp/testing.ttl" :formats/Turtle)

There is also:

(defmethod rdf/write-rdf [JenaGraph :rdf-app/LocalFile :dct/MediaTypeOrExtent]

The supported formats arguments are derived automatically from the ontology graph defined in ont-app.igraph-jena.ont.

This expression will give you the list of available formats:

(descendents :dct/MediaTypeOrExtent)

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

Released under Creative Commons Attribution-ShareAlike 4.0 International license. Under the terms of this license, if you display this logo or derivates thereof, you must include an attribution to the original source, with a link to https://github.com/ont-app, or http://ericdscott.com.

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close