ont-app.vocabulary.core — ont-app/vocabulary 0.5.0

clj

Defines utilities and a set of namespaces for commonly used linked data constructs, metadata of which specifies RDF namespaces, prefixes and other details.

*alias-map* cljs

A map :={alias ns-name, ...}. Where alias is a symbol ns-name is a symbol naming an ns in the current lexical env NOTE: Informs cljc-ns-aliases in cljs space.

as-calendar clj

(as-calendar date)

Returns an instance of java.util.GregorianCalendar given date (JVM only).

• Where
  • date is a java.util.Date, the standard value of clojure #inst
• NOTE: this lets you .get things like the java.util.Calendar/YEAR.

as-kwi clj/s multimethod

Returns keyword identifier for an instance of Resource.

• Signature: [this] -> kwi.
• Where:
  • this is an instance of Resource
  • kwi conforms to :voc/kwi-spec

as-qname clj/s multimethod

Returns a qname/CURIE for instance of Resource.

• Signature: [this] -> qname
• Where
  • this is an instance of Resource
  • qname conforms to :voc/qname-spec

as-uri-string clj/s multimethod

Returns URI string for instance of Resource.

• Signature: [this] -> uri-string
• Where
  • this is a Resource
  • uri-string conforms to :voc/uri-str-spec

clear-caches! clj/s

(clear-caches!)

Side-effects: resets all caches in voc/ to nil. NOTE: call this when you may have imported new namespace metadata

cljc-find-ns clj/s

(cljc-find-ns ns')

Returns ns-name-or-obj for ns', or nil. Where

• ns-name-or-obj may either be a namespace (in clj) or the name of a namespace (in cljs)
• ns' is a symbol which may name a namespace. NOTE: Implementations involving cljs must use cljs-put/get-ns-meta to declare ns metadata.

cljc-ns-aliases clj/s

(cljc-ns-aliases)

Returns {alias ns, ...}. Where

• alias is a symbol
• ns is its associated ns in the current lexical environment. NOTE: cljs will require explicit maintenance of alias-map This is really only necessary if you're importing a package as some symbol other than the preferred prefix.

cljc-resolve clj/s

(cljc-resolve sym)

Returns the resolved sym, if possible.

• Where
  • sym is a symbol, typically acquired from a string value in a DSTR tag.
• NOTE:
  • Resolving symbols is not straightforward under cljs, and I have yet to need to do so in anger, so for now under cljs the symbol will be returned unchanged until actual use cases present themselves.

cljs-ns-metadata cljs

Stores cljs ns pseudo-metadata. Namespaces in cljs are not proper objects, and there is no metadata available at runtime. This atom stores 'pseudo-metadata' declared with cljc-put-ns-metadata and accessed with cljc-get-metadata. Clj just uses the metadata regime for its ns's

config clj/s

A configuration map for ont-app/vocabulary. Typical keys are

• ::operative-resource-context (optional) a keyword naming the operative resource type context, which informs the resource-type-dispatch function. Resource type contexts should be declared in a taxonomy rooted in ::voc/resource-type-context. Left unspecified, it will be set automatically to the most specific descendant of ::voc/resource-type-context.
  • See also most-specific-resource-type-context
• inferred-operative-resource-context. This will be created automatically in the absence of ::operative-resource-context
• ::special-uri-str-re is a regex matching valid URI strings not specified in ordinary-uri-str-re.
  • default: :~ ^(arn:).*

default-config clj/s

The default value of voc/config.

disambiguate-prefix-ns clj/s multimethod

Signature: [kw namespaces] -> winning-ns.

• Where
  • kw is a namespaced keyword
  • namespaces is a set containing a plurality of namespaces associated with prefix = (namespace kw)
  • winning-ns is the member of namespaces appropriate to kw

get-ns-meta clj/s

(get-ns-meta)

(get-ns-meta ns')

Returns metadata assigned to ns named ns'. Where

• ns' names a namespace or a 'dummy' namespace whose sole purpose is to hold metadata.
• metadata := {key value, ...}
• key is a keyword containing vocabulary metadata, e.g. :vann/preferredNamespacePrefix

kw-string clj/s multimethod

Signature: [this] -> a string to be used as part of a minted kwi.

• where
  • this is some object
• Dispatched on (type this)

mint-kwi clj/s multimethod

Signature: [head-kwi & args] -> cononical-kwi, dispatched on mint-kw-dispatch. Where

• canonical-kwi is a KWI minted systematically based on its arguments.
• head-kwi initiates the KWI (typically the name of an existing class in some model).
• args := [property value, ...], .s.t. the named value is uniquely distinguished. E.g: The default method simply joins arguments on _ as follows: (mint-kwi :myNs/MyClass :myNs/prop1 'foo' :myNs/prop2 'bar) -> :myNs/MyClass_prop1_foo_prop2_bar, but overriding methods will be dispatched on head Compiled arguments are rendered as their hashes.

mint-kwi-dispatch clj/s

(mint-kwi-dispatch head-kwi & _args)

Returns head-kwi as dispatch-key for the mint-kwi method. Where: head-kwi is the first argument dispatch-key is a keyword

most-specific-resource-context clj/s

(most-specific-resource-context parent-context)

Returns the ::resource-type-context which has no descendents. Raises an error if this is not unique.

namespace-re clj/s

(namespace-re)

Returns a regex to recognize strings matching a URI for an ns declared with LOD metadata.

• Side-effect: manages namespace-re-cache
• NOTE: Groups for namespace and name.
  • i.e. (re-matches (namespace-re) uri-string) -> [uri-string namespace name]

namespace-to-ns clj/s

(namespace-to-ns)

Returns {namespace ns, ...} for each ns with :vann/preferredNamespaceUri declaration.

• Where
  • namespace is the URI suitable for for an RDF prefix declaration
  • ns is either a clojure ns (clj) or a symbol naming a clojure ns (cljs).

ns-to-namespace clj/s

(ns-to-namespace ns')

Returns iri for ns.

• Where
  • ns' is an instance of clojure.lang.Namespace (in clj) or a symbol-name for ns (cljs)
  • iri is an iri declared with :vann/preferredNamespaceUri in the metadata for ns', or nil

ns-to-prefix clj/s

(ns-to-prefix ns')

Returns the prefix associated with ns'.

• Where
  • ns' is a clojure namespace, which may have :vann/preferredNamespacePrefix declaration in its metadata.

operative-resource-context clj/s

(operative-resource-context)

The resource context on which to dispatch the resource-type multimethod.

ordinary-uri-str-re clj/s

A regex matching a commonly occurring standard URI string. Arbitrarily chosen from https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml.

preferred-child-resource-context clj/s multimethod

Signature: [parent children'] -> preferred child or error.

• Distpatched on parent
• Where
  • parent is the resource context from which each child is derived
  • children' := #{child, ...}
  • child is derived from parent in the global heirarchy.
• NOTE: this is necessary to infer the single most-specific resource type context for a given application in cases where the taxonomy of contexts has multiple branches.

prefix-to-namespace-uri clj/s

(prefix-to-namespace-uri prefix)

Returns namespace URI associated with prefix.

• Where:
  • prefix is a string declared for ns with vann/preferredNamespacePrefix
  • namespace is a string declared for some ns with vann/preferredNamespaceUri

prefix-to-ns clj/s

(prefix-to-ns)

Returns {prefix ns, ...}.

• Where
  • prefix is declared in metadata for some ns with :vann/preferredNamespacePrefix
  • ns is an instance of clojure.lang.ns available within the lexical context in which the call was made.

prefixes-for clj/s

(prefixes-for sparql-string)

(prefixes-for prefix-fn content-string)

Returns [prefix-string...] for each prefix identified in content-string.

• Where

  • content-string is a string of SPARQL, typically without prefixes

  • prefix-string := PREFIX prefix: namespace

  • prefix is a prefix defined for namespace in metadata of some ns with :vann/preferredNamespacePrefix

  • namespace is a namespace defined in the metadata for some ns with :vann/preferredNamespaceUri

prepend-prefix-declarations clj/s

(prepend-prefix-declarations content-string)

(prepend-prefix-declarations prefixes-for-fn content-string)

Returns content-string, prepended with appropriate PREFIX decls.

• Where
  • content-string is a string of SPARQL or Turtle/n3, typically without prefixes.
    • default is SPARQL
  • prefixes-for := fn [content-string] -> prefixes-string.
    • in practice this would only be needed for turtle-prefixes-for

put-ns-meta! clj/s≠

clj

(put-ns-meta! m)

(put-ns-meta! ns' m)

cljs

(put-ns-meta! _m)

(put-ns-meta! ns' m)

Side-effect: ensures that subsequent calls to (cljc-get-ns-meta ns' return m. Where

• ns' is an ns (clj only) or the name of a namespace, possibly declared for the sole purpose of holding vocabulary metadata (e.g. rdf, foaf, etc)
• m := {key value, ...}, metadata (clj) or 'pseudo-metadata' (cljs)
• key is a keyword containing vocabulary metadata, e.g. ::vann/preferredNamespacePrefix NOTE: In cljs, ns's are not available at runtime, so the metadata is stored in an atom called 'voc/cljs-ns-metadata' See also declarations for ont-app.vocabulary.rdf, ont-app.vocabulary.foaf, etc. for examples of namespaces declared solely to hold vocabulary metadata.

register-resource-type-context! clj/s

(register-resource-type-context! child parent)

Side-effects: Derives child from parent and clears (@context ::voc/operative-resource-context).

• Where
  • child names a resource type context on which methods may be dispatched.
  • parent names a resource type context on which methods may be dispatched.

resource-type clj/s multimethod

Signature [this] -> resource-type, dispatched on resource-type-dispatch.

• Where
  • this is something renderable as a URI, KWI, qname, or some other resource ID.
  • resource-type names a resource type on which as-uri-string, as-kwi, as-qname, resource= and perhaps other methods might be dispatched.

resource-type-dispatch clj/s

(resource-type-dispatch this)

Returns [type-context (type this)].

• Where
  • this is something which we may want to render as a URI or related construct.
  • type-context is a keyword naming a context to which dispatch methods are keyed. It is the value of (operative-resource-context)
    • defaults to (most-specific-resource-context ::voc/resource-type-context)

resource= clj/s multimethod

Truthy when two different resource identifiers refer to the same resource.

• Signature: [this that] -> truthy
• Where
  • this is a Resource
  • that is a Resource

sparql-prefix-declaration clj/s

(sparql-prefix-declaration prefix)

Returns PREFIX prefix: <uri>.

• Where
  • prefix is a prefix in the metadata
  • uri is the uri string associated with prefix in the metadata

sparql-prefixes-for clj/s

(sparql-prefixes-for sparql-string)

Gets SPARQL prefixes from sparql-string.

tag clj/s multimethod

Signature [obj & maybe tag-spec] -> dstr.

• Where
  • obj is something to be tagged
  • tag-spec is a resource, or (@lstr/default-tags (type obj))
  • dstr :~ #voc/dstr obj^^tag
  • tag := (as-kwi tag-spec)

tag-dispatch clj/s

(tag-dispatch obj)

(tag-dispatch _obj tag-spec)

Returns tag for obj with optional tag-spec.

• Where
  • obj is something to be tagged
  • tag-spec is a resource, or (@dstr/default-tags (type obj))
  • tag := (as-kwi tag-spec)
• NOTE: this is the dispatch value for the tag method

turtle-prefixes-for clj/s

(turtle-prefixes-for ttl-string)

Gets Turtle prefixes from ttl-string.

untag clj/s multimethod

Signature: [dstr & maybe on-not-found-fn?].

• returns: clojure value appropriate to (as-kwi tag)
• Where
  • dstr :~ #voc/dstr obj^^tag
  • on-not-found-fn := fn [dstr] -> clojure value or error.
    • Default is error-on-no-untag-found.

untag-dispatch clj/s

(untag-dispatch dstr & _)

Returns (as-kwi tag) for dstr.

• Where
  • dstr :~ #voc/dstr obj^^tag
  • tag := (as-qname tag-spec)

uri-str-for clj/s multimethod

Deprecated. Use Resource protocol and as-uri-string instead.