Class: SkohubProvider

SkohubProvider

SkoHub Vocabs

SkoHub Vocabs is a static site generator that provides HTML/JSON versions of vocabularies as static files.

Example vocabulary (configured below): https://w3id.org/class/esc/scheme

It is important that a dereferenceable scheme URI is used. When configured via BARTOC in the API field, "http://bartoc.org/api-type/skohub" needs to be given as the type and the aforementioned dereferenceable scheme URI needs to be given as the URL.

See also: https://github.com/gbv/cocoda-sdk/issues/29

{
 "uri": "http://coli-conc.gbv.de/registry/skohub.io",
 "provider": "Skohub",
 "schemes": [
   {
     "uri": "https://w3id.org/class/esc/scheme",
   }
 ]
}

Constructor

new SkohubProvider()

Source: providers/skohub-provider.js, line 41

Methods

(async) search(config) → {Array}

Returns concept search results.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`search`	string			search string
`scheme`	Object	<optional>		concept scheme to search in
`limit`	number	<optional>	100	maximum number of search results

Source: providers/skohub-provider.js, line 247

Returns:

array of JSKOS concept objects

Type:: Array

(async) suggest(config) → {Array}

Returns suggestion result in OpenSearch Suggest Format.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`search`	string			search string
`scheme`	Object	<optional>		concept scheme to search in
`limit`	number	<optional>	100	maximum number of search results

Source: providers/skohub-provider.js, line 309

Returns:

result in OpenSearch Suggest Format

Type:: Array

(static) _registryConfigForBartocApiConfig(options) → {Object}

Used by registryForScheme (see src/lib/CocodaSDK.js) to determine a provider config for a concept schceme.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`url`	Object	API URL for BARTOC instance
`scheme`	Object	scheme for which the config is requested

Source: providers/skohub-provider.js, line 79

Returns:

provider configuration

Type:: Object