MarkLogic 12 Product Documentation
entity:skos-dictionary

entity:skos-dictionary(
   $graph as xs:string,
   [$lang as xs:string],
   [$options as xs:string*]
) as cts:entity-dictionary

Summary

Construct an entity dictionary from a SKOS ontology loaded into the database as triples. The mapping from a SKOS ontology is as follows:

Parameters
graph	The URI of the graph containing the triples of the ontology.
lang	If labels occur in more than one language, use the ones in this language. Default: "en".
options	Options with which you can control the behavior of the entity dictionary. You can specify the following options. It is strongly recommended that you use the default option settings. `"case-sensitive"` or `"case-insensitive"`: Perform case-sensitive or case-insensitive matching of entities labels. Specify one or the other. Default: `"case-sensitive"`. `"remove-overlaps"` or `"allow-overlaps"`: Either eliminate entities with the overlapping labels or allow them. Specify one or the other. Default: `"allow-overlaps"`. `"whole-words"` or `"partial-words"`: Either require matches to align with token boundaries, or allow matches to fall within token boundaries. Specify one or the other. Default: `"whole-words"`.

Usage Notes

To take advantage of caching, insert dictionaries into the database once they have been created. Dictionaries formed from large ontologies can be quite expensive to construct. Do not insert SKOS dictionaries using the graph URI as this will interfere with use of that graph.

For best results it is strongly recommended you construct ontologies using skos:ConceptScheme with explicit skos:inScheme properties.

The following list describes the mapping from a SKOS ontology to entity dictionary entries. NOTE: The "skos" prefix here is shorthand for the namespace "http://www.w3.org/2004/02/skos/core#".

Each skos:Concept becomes an entity.
Each skos:ConceptScheme provides an entity type.
The concept's IRI becomes the entity's ID.
The concept's skos:prefLabel becomes the entity's normalized text.
The concept's skos:prefLabel plus any additional labels (skos:altLabel, skos:hiddenLabel) become entity text that will be used to match.
If the concept is in a skos:ConceptScheme then that scheme will provide the entity type; otherwise the graph URI will be used as the entity type.
The rdfs:label or dc:title of the concept scheme is used as the entity type, if one is available; otherwise, the IRI of the concept scheme is used.
A concept C is considered in a scheme S if any of the following conditions (expressed as triples) are met:
- C skos:inScheme S
- S skos:hasTopConcept C
- S skos:hasTopConcept C2 AND C2 skos:narrowerTransitive C
- C skos:topConceptOf S
- C skos:broaderTransitive C2 AND C2 skos:topConceptOf S
skos:broaderTransitive will be inferred from skos:broader if needed. skos:narrowerTransitive will be inferred from skos:narrower if needed.

If this function cannot derive an entity dictionary entries from the graph, MarkLogic throws the exception XDMP-EMPTYEDICT.

Example

import module namespace entity="http://marklogic.com/entity"
  at "/MarkLogic/entity.xqy";

entity:dictionary-insert("/ontology/people",
  entity:skos-dictionary("http://example.com/people"))

MarkLogic 12 Product Documentationentity:skos-dictionary

Summary

Usage Notes

See Also

Example

MarkLogic 12 Product Documentation
entity:skos-dictionary