Skip to main content

Interface: SparqlDataProviderSettings

Dataset-schema specific settings for SparqlDataProvider.

Properties​

PropertyTypeDescription

classInfoQuery?

string

SELECT query to retrieve data for each class in a set.

Parametrized variables:

  • ${ids} VALUES clause content with class IRIs
  • ${schemaLabelProperty} schemaLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages

Expected output bindings:

  • ?class
  • ?label (optional)
  • ?instcount (optional)

classTreeQuery?

string

SELECT query to retrieve class tree.

Parametrized variables:

  • ${schemaLabelProperty} schemaLabelProperty property from the settings

Expected output bindings:

  • ?class
  • ?label (optional)
  • ?parent (optional)
  • ?instcount (optional)

dataLabelProperty

string

Property path for querying instance data labels (elements, links).

defaultPrefix

string

Default prefix to be used in every query.

elementInfoQuery

string

CONSTRUCT query to retrieve data for each element (types, labels, properties).

Parametrized variables:

  • ${ids} VALUES clause content with element IRIs
  • ${dataLabelProperty} dataLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages
  • ${valueLanguageFilter} property value filter based on filterOnlyLanguages
  • ${propertyConfigurations}

Expected output format for triples:

  • ?inst <urn:reactodia:sparql:type> ?class element has type
  • ?inst <urn:reactodia:sparql:label> ?label element has label
  • ?inst ?propType ?propValue element has value for a datatype property

filterAdditionalRestriction

string

SPARQL query pattern for additional filtering on elements within the lookup query.

filterElementInfoPattern

string

SPARQL pattern which describes how to fetch elements info similar to elementInfoQuery but within the lookup query.

Parametrized variables:

  • ${dataLabelProperty} dataLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages

filterOnlyLanguages?

readonly string[]

Set of language tags to provide a FILTER for labels and other literal values.

filterRefElementLinkPattern

string

SPARQL query pattern to restrict lookup results in case when DataProviderLookupParams.refElementLinkId is not specified.

Available bindings:

  • ?link link type
  • ?direction link direction, either "in" or "out"

filterTypePattern

string

SPARQL query pattern to retrieve transitive type sets for elements.

Expected output bindings:

  • ?inst element IRI
  • ?class element type (there may be multiple or transitive types for an element)

fullTextSearch

FullTextSearchSettings

Lookup by text settings.

imageQueryPattern

string

Query pattern to retrieve image URL for an element.

Expected bindings:

  • ?inst element IRI
  • ?linkType image property IRI
  • ?image result image URL

linkConfigurations

LinkConfiguration[]

"Virtual" links configurations to translate a SPARQL pattern as a link.

linkTypesInfoQuery?

string

SELECT query to retrieve data for each link type in a set.

Parametrized variables:

  • ${ids} VALUES clause content with link type IRIs
  • ${schemaLabelProperty} schemaLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages

Expected output bindings:

  • ?link
  • ?label (optional)
  • ?instcount (optional)

linkTypesOfQuery

string

SELECT query to retrieve incoming/outgoing link types from specified element with statistics.

If ?direction binding is returned, it would be possible to avoid statistics query when inexactCount mode is requested in DataProvider.connectedLinkStats.

Parametrized variables:

  • ${elementIri}
  • ${linkConfigurations}

Expected bindings:

  • ?link
  • ?direction (optional) - expected values: "in", "out".

linkTypesPattern?

string

Overridable part of linkTypesQuery with same output bindings.

Parametrized variables: none

linkTypesQuery?

string

SELECT query to retrieve initial link types.

Parametrized variables:

  • ${linkTypesPattern} linkTypesPattern property from the settings
  • ${schemaLabelProperty} schemaLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages

Expected output bindings:

  • ?link
  • ?label (optional)
  • ?instcount (optional)

linkTypesStatisticsQuery

string

SELECT query to retrieve statistics of incoming/outgoing link types for specified element.

Parametrized variables:

  • ${linkId}
  • ${elementIri}
  • ${linkConfigurationOut}
  • ${linkConfigurationIn}
  • ${navigateElementFilterOut} (optional; for blank node support only)
  • ${navigateElementFilterIn} (optional; for blank node support only)

Expected bindings:

  • ?link link type
  • ?inCount incoming links count
  • ?outCount outgoing links count

linksInfoQuery

string

SELECT query to retrieve links between specified sourceIris and targetIris sets of entities.

For backwards compatibility, ${ids} placeholder variable with combined set of entities can be used; in that case incremental link querying will be disabled.

Parametrized variables:

  • ${sourceIris} VALUES clause content with source entity IRIs
  • ${targetIris} VALUES clause content with target entity IRIs
  • ${ids} VALUES clause content with all entity IRIs (for compatibility)
  • ${propLanguageFilter} property value filter based on filterOnlyLanguages
  • ${linkConfigurations}

Expected output bindings:

  • ?type link type
  • ?source link source
  • ?target link target
  • ?propType (optional) link property type
  • ?propValue (optional) link property value

openWorldLinks?

boolean

Allows data provider to find links other than specified in linkConfigurations when linkConfigurations has at least one value set.

Default

false

openWorldProperties?

boolean

Allows data provider to find element properties other than specified in propertyConfigurations when propertyConfigurations has at least one value set.

Default

false

propertyConfigurations

PropertyConfiguration[]

"Virtual" property configurations to translate a SPARQL pattern as an element property.

propertyInfoQuery?

string

SELECT query to retrieve data for each datatype property in a set.

Parametrized variables:

  • ${ids} VALUES clause content with datatype property IRIs
  • ${schemaLabelProperty} schemaLabelProperty property from the settings
  • ${labelLanguageFilter} label filter based on filterOnlyLanguages

Expected output bindings:

  • ?property
  • ?label (optional)

schemaLabelProperty

string

Property path for querying schema labels in schema (classes, link types, properties).