Class: ConceptApiProvider

Constructor

new ConceptApiProvider()

Source: providers/concept-api-provider.js, line 32

Extends

BaseProvider

Members

(readonly) has :Object

A dictionary with functionality of the registry (e.g. registry.has.schemes).

Type:

Object

Inherited From: BaseProvider#has
Source: providers/base-provider.js, line 93

languages :Array.<string>

A list of RFC 3066 language tags in lowercase in order of priority.

Type:

Array.<string>

Inherited From: BaseProvider#languages
Source: providers/base-provider.js, line 100

Methods

(async) deleteMappings(config) → {Array.<Object>}

DELETEs multiple mappings. Do not override in subclass!

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mappings`	Array	array of mapping objects

Inherited From: BaseProvider#deleteMappings
Source: providers/base-provider.js, line 621

Returns:

array of results (true if successful); in case of failure, consult the _errors property on the array at the index of the failed request

Type:: Array.<Object>

(async) getAncestors(config) → {Array.<Object>}

Returns ancestor concepts for a concept.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concept`	Object	concept object

Source: providers/concept-api-provider.js, line 291

Returns:

array of JSKOS concept objects

Type:: Array.<Object>

getCancelTokenSource() → {Object}

Returns a source for a axios cancel token.

Inherited From: BaseProvider#getCancelTokenSource
Source: providers/base-provider.js, line 392

Returns:

axios cancel token source

Type:: Object

(async) getConcepts(config) → {Array.<Object>}

Returns details for a list of concepts.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concepts`	Array.<Object>	list of concept objects to load

Source: providers/concept-api-provider.js, line 231

Returns:

array of JSKOS concept objects

Type:: Array.<Object>

(async) getNarrower(config) → {Array.<Object>}

Returns narrower concepts for a concept.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`concept`	Object	concept object

Source: providers/concept-api-provider.js, line 263

Returns:

array of JSKOS concept objects

Type:: Array.<Object>

(async) getSchemes(config) → {Array.<Object>}

Returns all concept schemes.

Parameters:

Name	Type	Description
`config`	Object

Source: providers/concept-api-provider.js, line 162

Returns:

array of JSKOS concept scheme objects

Type:: Array.<Object>

(async) getTop(config) → {Array.<Object>}

Returns top concepts for a concept scheme.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`scheme`	Object	concept scheme object

Source: providers/concept-api-provider.js, line 196

Returns:

array of JSKOS concept objects

Type:: Array.<Object>

(async) getTypes(config) → {Array.<Object>}

Returns a list of types.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Description
`scheme`	Object	<optional>	concept scheme to load types for

Source: providers/concept-api-provider.js, line 436

Returns:

array of JSKOS type objects

Type:: Array.<Object>

(async) init() → {Promise}

Load data about registry via the status endpoint.

Inherited From: BaseProvider#init
Source: providers/base-provider.js, line 329

Returns:

Promise that resolves when initialization is complete.

Type:: Promise

isAuthorizedFor(options) → {boolean}

Returns whether a user is authorized for a certain request.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Description
`type`	string		type of item (e.g. mappings)
`action`	string		action to be performed (read/create/update/delete)
`user`	Object		user object
`crossUser`	boolean	<optional>	whether the request is a crossUser request (i.e. updading/deleting another user's item)

Inherited From: BaseProvider#isAuthorizedFor
Source: providers/base-provider.js, line 438

Returns:

Type:: boolean

(async) postMappings(config) → {Array.<Object>}

POSTs multiple mappings. Do not override in subclass!

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Description
`mappings`	Array	array of mapping objects

Inherited From: BaseProvider#postMappings
Source: providers/base-provider.js, line 602

Returns:

array of created mapping objects; in case of failure, consult the _errors property on the array at the index of the failed request

Type:: Array.<Object>

(async) search(config) → {Array}

Returns search results in JSKOS 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 (default might be overridden by registry)
`offset`	number	<optional>	0	offset
`types`	Array.<string>	<optional>	[]	list of type URIs

Source: providers/concept-api-provider.js, line 348

Returns:

result in JSKOS Format

Type:: Array

setAuth(options)

Sets authentication credentials.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`key`	string	public key of login-server instance the user is authorized for
`bearerToken`	string	token that is sent with each request

Inherited From: BaseProvider#setAuth
Source: providers/base-provider.js, line 403

setRetryConfig(config)

Sets retry configuration.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`methods`	Array.<string>	<optional>	["get", "head", "options"]	HTTP methods to retry (lowercase)
`statusCodes`	Array.<number>	<optional>	[401, 403]	status codes to retry
`count`	number	<optional>	3	maximum number of retries
`delay`	number \| function	<optional>	300*count	a delay in ms or a function that takes the number of current retries and returns a delay in ms

Inherited From: BaseProvider#setRetryConfig
Source: providers/base-provider.js, line 417

(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 (default might be overridden by registry)
`use`	string	<optional>	notation,label	which fields to search ("notation", "label" or "notation,label")
`types`	Array.<string>	<optional>	[]	list of type URIs
`sort`	string	<optional>	score	sorting parameter

Source: providers/concept-api-provider.js, line 324

Returns:

result in OpenSearch Suggest Format

Type:: Array

supportsScheme(scheme) → {boolean}

Returns a boolean whether a certain target scheme is supported or not.

Parameters:

Name	Type	Description
`scheme`	Object

Inherited From: BaseProvider#supportsScheme
Source: providers/base-provider.js, line 483

Returns:

Type:: boolean

(async) vocSearch(config) → {Array}

Returns concept scheme search results in JSKOS Format.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`search`	string			search string
`limit`	number	<optional>	100	maximum number of search results (default might be overridden by registry)
`offset`	number	<optional>	0	offset

Source: providers/concept-api-provider.js, line 390

Returns:

result in JSKOS Format

Type:: Array

(async) vocSuggest(config) → {Array}

Returns concept scheme suggestion result in OpenSearch Suggest Format.

Parameters:

Name Type Description

config

Object

Properties

Name	Type	Attributes	Default	Description
`search`	string			search string
`limit`	number	<optional>	100	maximum number of search results (default might be overridden by registry)
`use`	string	<optional>	notation,label	which fields to search ("notation", "label" or "notation,label")
`sort`	string	<optional>	score	sorting parameter

Source: providers/concept-api-provider.js, line 369

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 server

Source: providers/concept-api-provider.js, line 110

Returns:

provider configuration

Type:: Object