Class: SparqlDataProvider

Provides graph data by requesting it from a SPARQL endpoint.

Implements

• DataProvider

Constructors

new SparqlDataProvider()

new SparqlDataProvider(options, settings): SparqlDataProvider

Parameters

Parameter	Type	Default value
options	SparqlDataProviderOptions	undefined
settings	SparqlDataProviderSettings	OwlStatsSettings

Returns

SparqlDataProvider

Defined in

data/sparql/sparqlDataProvider.ts:175

Properties

Property	Modifier	Type	Description
factory	readonly	DataFactory	Returns an RDF term factory to create RDF terms for identifiers and property values.

Methods

connectedLinkStats()

connectedLinkStats(params): Promise<DataProviderLinkCount[]>

Gets connected link types of an element for exploration.

Parameters

Parameter	Type
params	object
params.elementId	ElementIri
params.inexactCount?	boolean
params.signal?	AbortSignal

Returns

Promise<DataProviderLinkCount[]>

Implementation of

DataProvider.connectedLinkStats

Defined in

data/sparql/sparqlDataProvider.ts:588

---

elementTypes()

elementTypes(params): Promise<Map<ElementTypeIri, ElementTypeModel>>

Gets the data for the specified element types.

Parameters

Parameter	Type
params	object
params.classIds	readonly ElementTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<ElementTypeIri, ElementTypeModel>>

Implementation of

DataProvider.elementTypes

Defined in

data/sparql/sparqlDataProvider.ts:297

---

elements()

elements(params): Promise<Map<ElementIri, ElementModel>>

Gets the data for the specified elements.

Parameters

Parameter	Type
params	object
params.elementIds	readonly ElementIri[]
params.signal?	AbortSignal

Returns

Promise<Map<ElementIri, ElementModel>>

Implementation of

DataProvider.elements

Defined in

data/sparql/sparqlDataProvider.ts:387

---

executeSparqlConstruct()

executeSparqlConstruct(query, options?): Promise<Quad[]>

Executes arbitrary SPARQL CONSTRUCT query and returns the result RDF graph.

Parameters

Parameter	Type
query	string
options?	object
options.signal?	AbortSignal

Returns

Promise<Quad[]>

Defined in

data/sparql/sparqlDataProvider.ts:808

---

executeSparqlSelect()

executeSparqlSelect<Binding>(query, options?): Promise<SparqlResponse<Binding>>

Executes arbitrary SPARQL SELECT query and returns the result tuples.

Type Parameters

Type Parameter
Binding

Parameters

Parameter	Type
query	string
options?	object
options.signal?	AbortSignal

Returns

Promise<SparqlResponse<Binding>>

Defined in

data/sparql/sparqlDataProvider.ts:789

---

knownElementTypes()

knownElementTypes(params): Promise<ElementTypeGraph>

Gets the structure and data for all known element types.

Parameters

Parameter	Type
params	object
params.signal?	AbortSignal

Returns

Promise<ElementTypeGraph>

Implementation of

DataProvider.knownElementTypes

Defined in

data/sparql/sparqlDataProvider.ts:242

---

knownLinkTypes()

knownLinkTypes(params): Promise<LinkTypeModel[]>

Gets the data and statistics for all known link types.

Parameters

Parameter	Type
params	object
params.signal?	AbortSignal

Returns

Promise<LinkTypeModel[]>

Implementation of

DataProvider.knownLinkTypes

Defined in

data/sparql/sparqlDataProvider.ts:361

---

linkTypes()

linkTypes(params): Promise<Map<LinkTypeIri, LinkTypeModel>>

Gets the data for the specified link types.

Parameters

Parameter	Type
params	object
params.linkTypeIds	readonly LinkTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<LinkTypeIri, LinkTypeModel>>

Implementation of

DataProvider.linkTypes

Defined in

data/sparql/sparqlDataProvider.ts:329

---

links()

links(params): Promise<LinkModel[]>

Get all links between two specified sets of entities (bipartite graph links).

To get all links between all entities in the set, it is possible to pass the same set to both primary and secondary sets of elements.

Parameters

Parameter	Type
params	object
params.linkTypeIds?	readonly LinkTypeIri[]
params.primary	readonly ElementIri[]
params.secondary	readonly ElementIri[]
params.signal?	AbortSignal

Returns

Promise<LinkModel[]>

Implementation of

DataProvider.links

Defined in

data/sparql/sparqlDataProvider.ts:464

---

lookup()

lookup(baseParams): Promise<DataProviderLookupItem[]>

Looks up elements with different filters:

• by an element type via elementTypeId;
• by a connected element via refElementId, refElementLinkId and linkDirection;
• by a text lookup via text;

Filters can be combined to produce an intersection of the results.

Parameters

Parameter	Type
baseParams	DataProviderLookupParams

Returns

Promise<DataProviderLookupItem[]>

Implementation of

DataProvider.lookup

Defined in

data/sparql/sparqlDataProvider.ts:682

---

propertyTypes()

propertyTypes(params): Promise<Map<PropertyTypeIri, PropertyTypeModel>>

Gets the data for the specified property types.

Parameters

Parameter	Type
params	object
params.propertyIds	readonly PropertyTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<PropertyTypeIri, PropertyTypeModel>>

Implementation of

DataProvider.propertyTypes

Defined in

data/sparql/sparqlDataProvider.ts:265