/** * Dataset-schema specific settings for SPARQL data provider. */ export interface SparqlDataProviderSettings { /** * Default prefix to be used in every query. */ defaultPrefix: string; /** * Property path for querying schema labels in schema (classes, link types, properties). */ schemaLabelProperty: string; /** * Property path for querying instance data labels (elements, links). */ dataLabelProperty: string; /** * Full-text search settings. */ fullTextSearch: FullTextSearchSettings; /** * SELECT query to retreive class tree. * * Parametrized variables: * - `${schemaLabelProperty}` `schemaLabelProperty` property from the settings * * Expected output bindings: * - `?class` * - `?label` (optional) * - `?parent` (optional) * - `?instcount` (optional) */ classTreeQuery?: 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 * * Expected output bindings: * - `?class` * - `?label` (optional) * - `?instcount` (optional) */ classInfoQuery?: string; /** * SELECT query to retrieve initial link types. * * Parametrized variables: * - `${linkTypesPattern}` `linkTypesPattern` property from the settings * - `${schemaLabelProperty}` `schemaLabelProperty` property from the settings * * Expected output bindings: * - `?link` * - `?label` (optional) * - `?instcount` (optional) */ linkTypesQuery?: string; /** * Overridable part of `linkTypesQuery` with same output bindings. * * Parametrized variables: none */ linkTypesPattern?: 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 * * Expected output bindings: * - `?link` * - `?label` (optional) * - `?instcount` (optional) */ linkTypesInfoQuery?: 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 * * Expected output bindings: * - `?property` * - `?label` (optional) */ propertyInfoQuery?: 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 * - `${propertyConfigurations}` * * Expected output format for triples: * - `?inst rdf:type ?class` element has type * - `?inst rdfs:label ?label` element has label * - `?inst ?property ?value` element has value for a datatype property */ elementInfoQuery: string; /** * SELECT query to retrieve all links between specified elements. * * Parametrized variables: * - `${ids}` VALUES clause content with element IRIs * - `${linkConfigurations}` * * Expected output bindings: * - `?type` link type * - `?source` link source * - `?target` link target * - `?propType` (optional) link property type * - `?propValue` (optional) link property value */ linksInfoQuery: string; /** * Query pattern to retrieve image URL for an element. * * Expected bindings: * - `?inst` element IRI * - `?linkType` image property IRI * - `?image` result image URL */ imageQueryPattern: string; /** * SELECT query to retrieve incoming/outgoing link types from specified element with statistics. * * Parametrized variables: * - `${elementIri}` * - `${linkConfigurations}` * * Expected bindings: * - `?link` * - `?label` (optional) * - `?instcount` (optional) */ linkTypesOfQuery: 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 */ linkTypesStatisticsQuery: string; /** * when fetching all links from element, we could specify additional filter */ filterRefElementLinkPattern: 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) */ filterTypePattern: string; /** * how to fetch elements info when fetching data. */ filterElementInfoPattern: string; /** * imposes additional filtering on elements within filter */ filterAdditionalRestriction: string; /** * Abstract links configuration - one could abstract a property path as a link on the diagram. */ linkConfigurations: LinkConfiguration[]; /** * (Experimental) Allows data provider to find links other than specified in `linkConfigurations` * when `linkConfigurations` has at least one value set. * * @default false */ openWorldLinks?: boolean; /** * Abstract property configuration similar to abstract link configuration. Not type-specific yet. */ propertyConfigurations: PropertyConfiguration[]; /** * (Experimental) Allows data provider to find element properties other than specified in * `propertyConfigurations` when `propertyConfigurations` has at least one value set. * * @default false */ openWorldProperties?: boolean; } /** * Full text search settings, * developer could use anything from search extensions of triplestore to regular expressions match * See wikidata and dbpedia examples for reusing full text search capabilities of Blazegraph and Virtuozo */ export interface FullTextSearchSettings { /** * Prefixes to use in full text search queries. */ prefix: string; /** * SPARQL query pattern to search/restrict results by text token. * * Mutually exclusive with `queryPatternPerWord` — set exactly one of * the two. * * Parametrized variables: * - `${text}` text token, as typed by the user (may contain multiple words) * - `${dataLabelProperty}` `dataLabelProperty` property from the settings * * Expected bindings: * - `?inst` link type * - `?score` numerical score for ordering search results by relevance * - `?extractedLabel` (optional; if `extractLabel` is enabled) */ queryPattern?: string; /** * SPARQL query pattern applied once per whitespace-separated word in the * search text (the resulting patterns are concatenated with an implicit * AND), for full-text search syntaxes that only accept a single word per * triple — e.g. QLever's `ql:has-word` magic property. Mutually exclusive * with `queryPattern` — set exactly one of the two. * * Parametrized variables: * - `${word}` a single word from the search text (SPARQL-string-escaped) * - `${dataLabelProperty}` `dataLabelProperty` property from the settings * * Expected bindings: same as `queryPattern`, except `?score` only needs to * be bound once overall (the generated query does this once after all the * per-word patterns, not per word — repeated `BIND` of the same variable * in one scope is invalid SPARQL). */ queryPatternPerWord?: string; /** * When enabled, adds SPARQL patterns to try to extract label from IRI and * makes it available as `?extractedLabel` binding in `queryPattern`. */ extractLabel?: boolean; /** * run type filter first? */ elementFirst?: boolean; } /** * Link abstraction configuration. */ export interface LinkConfiguration { /** * IRI of the "virtual" link */ id: string; /** * Optional domain constraint for source element of the link. * If specified checks RDF type of source element to match one from this set. */ domain?: readonly string[]; /** * SPARQL predicate or pattern connecting source element to target element. * * Expected bindings (if it is a pattern): * - `?source` source element * - `?target` target element * * @example * Direct configuration: `ex:relatedToOther` * * Pattern configuration: ` * ?source ex:hasAddress ?addr . * ?addr ex:hasCountry ?target . * OPTIONAL { * BIND(ex:addressType as ?propType) * ?addr ex:addressType ?propValue * } * ` */ path: string; /** * Additional SPARQL patterns can be used for getting properties of the link. * * Expected bindings * - `?source` source element * - `?target` target element * - `?propType` link property type * - `?propValue` link property value */ properties?: string; } /** * Specifies property abstraction configuration */ export interface PropertyConfiguration { /** * IRI of the "virtual" link */ id: string; /** * Optional domain constraint for source element of the property. * If specified checks RDF type of source element to match one from this set. */ domain?: readonly string[]; /** * SPARQL predicate or pattern connecting source element to property value. * * Expected bindings (if it is a pattern): * - `?inst` source element * - `?value` property value * * @example * Direct configuration: `ex:firstName` * * Pattern configuration: ` * ?inst ex:hasAddress ?addr . * ?addr ex:hasApartmentNumber ?value * ` */ path: string; } export const RDFSettings: SparqlDataProviderSettings = { linkConfigurations: [], openWorldLinks: false, propertyConfigurations: [], openWorldProperties: false, linksInfoQuery: `SELECT ?source ?type ?target WHERE { \${linkConfigurations} VALUES (?source) {\${ids}} VALUES (?target) {\${ids}} }`, defaultPrefix: "", schemaLabelProperty: "rdfs:label", dataLabelProperty: "rdfs:label", fullTextSearch: { prefix: "", queryPattern: ``, elementFirst: false, }, classTreeQuery: ``, classInfoQuery: `SELECT ?class ?label ?instcount WHERE { VALUES(?class) {\${ids}} OPTIONAL { ?class \${schemaLabelProperty} ?label } BIND("" as ?instcount) }`, linkTypesQuery: `SELECT DISTINCT ?link ?instcount ?label WHERE { \${linkTypesPattern} OPTIONAL { ?link \${schemaLabelProperty} ?label } }`, linkTypesPattern: ``, linkTypesInfoQuery: `SELECT ?link ?label WHERE { VALUES(?link) {\${ids}} OPTIONAL { ?link \${schemaLabelProperty} ?label } }`, propertyInfoQuery: `SELECT ?property ?label WHERE { VALUES(?property) {\${ids}} OPTIONAL { ?property \${schemaLabelProperty} ?label } }`, elementInfoQuery: ``, imageQueryPattern: ``, linkTypesOfQuery: ``, linkTypesStatisticsQuery: ``, filterRefElementLinkPattern: "", filterTypePattern: ``, filterAdditionalRestriction: ``, filterElementInfoPattern: ``, }; const WikidataSettingsOverride: Partial = { defaultPrefix: `PREFIX rdfs: PREFIX rdf: PREFIX wdt: PREFIX wd: PREFIX owl: `, schemaLabelProperty: "rdfs:label", dataLabelProperty: "rdfs:label", fullTextSearch: { prefix: "PREFIX bds: " + "\n", queryPattern: ` ?inst rdfs:label ?searchLabel. SERVICE bds:search { ?searchLabel bds:search "\${text}*" ; bds:minRelevance '0.5' ; bds:matchAllTerms 'true' . } BIND(IF(STRLEN(?strInst) > 33, 0-(SUBSTR(?strInst, 33)), -10000) as ?score) `, }, classTreeQuery: ` SELECT distinct ?class ?label ?parent WHERE { ?class rdfs:label ?label. { ?class wdt:P279 wd:Q35120. } UNION { ?parent wdt:P279 wd:Q35120. ?class wdt:P279 ?parent. } UNION { ?parent wdt:P279/wdt:P279 wd:Q35120. ?class wdt:P279 ?parent. } } `, // todo: think more, maybe add a limit here? linkTypesPattern: `?link wdt:P279* wd:Q18616576. BIND(0 as ?instcount) `, elementInfoQuery: ` CONSTRUCT { ?inst rdf:type ?class . ?inst rdfs:label ?label . ?inst ?propType ?propValue. } WHERE { VALUES (?inst) {\${ids}} OPTIONAL { ?inst wdt:P31 ?class } OPTIONAL {?inst rdfs:label ?label} OPTIONAL { \${propertyConfigurations} FILTER (isLiteral(?propValue)) } } `, imageQueryPattern: ` { ?inst ?linkType ?fullImage } union { ?inst wdt:P163/wdt:P18 ?fullImage } BIND(CONCAT("https://commons.wikimedia.org/w/thumb.php?f=", STRAFTER(STR(?fullImage), "Special:FilePath/"), "&w=200") AS ?image)`, linkTypesOfQuery: ` SELECT DISTINCT ?link WHERE { \${linkConfigurations} ?claim ?link . } `, linkTypesStatisticsQuery: ` SELECT (\${linkId} as ?link) (COUNT(?outObject) AS ?outCount) (COUNT(?inObject) AS ?inCount) WHERE { { { SELECT DISTINCT ?outObject WHERE { \${linkConfigurationOut} FILTER(ISIRI(?outObject)) ?outObject ?someprop ?someobj. } LIMIT 101 } } UNION { { SELECT DISTINCT ?inObject WHERE { \${linkConfigurationIn} FILTER(ISIRI(?inObject)) ?inObject ?someprop ?someobj. } LIMIT 101 } } } `, filterRefElementLinkPattern: "?claim ?link .", filterTypePattern: `?inst wdt:P31 ?instType. ?instType wdt:P279* ?class`, filterAdditionalRestriction: `FILTER ISIRI(?inst) BIND(STR(?inst) as ?strInst) FILTER exists {?inst ?someprop ?someobj} `, filterElementInfoPattern: `OPTIONAL {?inst wdt:P31 ?foundClass} BIND (coalesce(?foundClass, owl:Thing) as ?class) OPTIONAL {?inst rdfs:label ?label} `, }; export const WikidataSettings: SparqlDataProviderSettings = { ...RDFSettings, ...WikidataSettingsOverride, }; export const OWLRDFSSettingsOverride: Partial = { defaultPrefix: `PREFIX rdfs: PREFIX rdf: PREFIX owl: `, schemaLabelProperty: "rdfs:label", dataLabelProperty: "rdfs:label", fullTextSearch: { prefix: "", queryPattern: ` OPTIONAL {?inst \${dataLabelProperty} ?search1} FILTER regex(COALESCE(str(?search1), str(?extractedLabel)), "\${text}", "i") BIND(0 as ?score) `, extractLabel: true, }, classTreeQuery: ` SELECT ?class ?label ?parent WHERE { { ?class a rdfs:Class } UNION { ?class a owl:Class } FILTER ISIRI(?class) OPTIONAL {?class rdfs:label ?label} OPTIONAL {?class rdfs:subClassOf ?parent. FILTER ISIRI(?parent)} } `, // todo: think more, maybe add a limit here? linkTypesPattern: `{ ?link a rdf:Property } UNION { ?link a owl:ObjectProperty } BIND('' as ?instcount) `, elementInfoQuery: ` CONSTRUCT { ?inst rdf:type ?class . ?inst rdfs:label ?label . ?inst ?propType ?propValue. } WHERE { VALUES (?inst) {\${ids}} OPTIONAL { ?inst a ?class } OPTIONAL {?inst \${dataLabelProperty} ?label} OPTIONAL { \${propertyConfigurations} FILTER (isLiteral(?propValue)) } } `, imageQueryPattern: `{ ?inst ?linkType ?image } UNION { [] ?linkType ?inst. BIND(?inst as ?image) }`, linkTypesOfQuery: ` SELECT DISTINCT ?link WHERE { \${linkConfigurations} } `, linkTypesStatisticsQuery: ` SELECT ?link ?outCount ?inCount WHERE { { SELECT (\${linkId} as ?link) (count(?outObject) as ?outCount) WHERE { \${linkConfigurationOut} \${navigateElementFilterOut} } LIMIT 101 } { SELECT (\${linkId} as ?link) (count(?inObject) as ?inCount) WHERE { \${linkConfigurationIn} \${navigateElementFilterIn} } LIMIT 101 } } `, filterRefElementLinkPattern: "", filterTypePattern: `?inst a ?instType. ?instType rdfs:subClassOf* ?class`, filterElementInfoPattern: `OPTIONAL {?inst rdf:type ?foundClass} BIND (coalesce(?foundClass, owl:Thing) as ?class) OPTIONAL {?inst \${dataLabelProperty} ?label}`, filterAdditionalRestriction: "", }; export const OWLRDFSSettings: SparqlDataProviderSettings = { ...RDFSettings, ...OWLRDFSSettingsOverride, }; const OWLStatsOverride: Partial = { classTreeQuery: ` SELECT ?class ?instcount ?label ?parent WHERE { {SELECT ?class (count(?inst) as ?instcount) WHERE { ?inst rdf:type ?class. FILTER ISIRI(?class) } GROUP BY ?class } UNION { ?class rdf:type rdfs:Class } UNION { ?class rdf:type owl:Class } OPTIONAL {?class rdfs:label ?label} OPTIONAL {?class rdfs:subClassOf ?parent. FILTER ISIRI(?parent)} } `, }; export const OWLStatsSettings: SparqlDataProviderSettings = { ...OWLRDFSSettings, ...OWLStatsOverride, }; const DBPediaOverride: Partial = { fullTextSearch: { prefix: "PREFIX dbo: \n", queryPattern: ` ?inst rdfs:label ?searchLabel. ?searchLabel bif:contains "\${text}". ?inst dbo:wikiPageID ?origScore . BIND(0-?origScore as ?score) `, }, classTreeQuery: ` SELECT distinct ?class ?label ?parent WHERE { ?class rdfs:label ?label. OPTIONAL {?class rdfs:subClassOf ?parent} ?root rdfs:subClassOf owl:Thing. ?class rdfs:subClassOf? | rdfs:subClassOf/rdfs:subClassOf ?root } `, elementInfoQuery: ` CONSTRUCT { ?inst rdf:type ?class . ?inst rdfs:label ?label . ?inst ?propType ?propValue. } WHERE { VALUES (?inst) {\${ids}} ?inst a ?class . ?inst rdfs:label ?label . FILTER (!contains(str(?class), 'http://dbpedia.org/class/yago')) OPTIONAL { \${propertyConfigurations} FILTER (isLiteral(?propValue)) } } `, filterTypePattern: `?inst a ?instType. ?instType rdfs:subClassOf* ?class`, filterElementInfoPattern: ` OPTIONAL {?inst rdf:type ?foundClass. FILTER (!contains(str(?foundClass), 'http://dbpedia.org/class/yago'))} BIND (coalesce(?foundClass, owl:Thing) as ?class) OPTIONAL {?inst \${dataLabelProperty} ?label}`, imageQueryPattern: ` { ?inst ?linkType ?fullImage } UNION { [] ?linkType ?inst. BIND(?inst as ?fullImage) } BIND(CONCAT("https://commons.wikimedia.org/w/thumb.php?f=", STRAFTER(STR(?fullImage), "Special:FilePath/"), "&w=200") AS ?image) `, }; export const DBPediaSettings: SparqlDataProviderSettings = { ...OWLRDFSSettings, ...DBPediaOverride, }; const QLeverOverride: Partial = { fullTextSearch: { prefix: "PREFIX ql: \n", // QLever's `ql:has-word` magic property only matches a single word per // triple (case-insensitively); multiple words need one triple each, // ANDed together, hence `queryPatternPerWord` instead of `queryPattern`. queryPatternPerWord: ` ?inst \${dataLabelProperty} ?searchLabel . ?searchLabel ql:has-word "\${word}" . `, }, }; export const QLeverSettings: SparqlDataProviderSettings = { ...OWLRDFSSettings, ...QLeverOverride, };