xkos-best-practices-conformance-shapes.ttl

@prefix dc: <http://purl.org/dc/elements/1.1/> .
@prefix dcat: <http://www.w3.org/ns/dcat#> .
@prefix dct: <http://purl.org/dc/terms/> .
@prefix eli: <http://data.europa.eu/eli/ontology#> .
@prefix euvoc: <http://publications.europa.eu/ontology/euvoc#> .
@prefix evoc: <http://eurovoc.europa.eu/schema#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix org: <http://www.w3.org/ns/org#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix prov: <http://www.w3.org/ns/prov#> .
@prefix qb: <http://purl.org/linked-data/cube#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix schema: <http://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
@prefix skosthes: <http://purl.org/iso25964/skos-thes#> .
@prefix skosxl: <http://www.w3.org/2008/05/skos-xl#> .
@prefix xkos: <http://rdf-vocabulary.ddialliance.org/xkos#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<http://rdf-vocabulary.ddialliance.org/xkos#> a owl:Ontology;
  rdfs:label "XKOS Best Practices conformance shapes"@en ;
  rdfs:comment """The XKOS Best Practices shapes are splitted in 2 files : shapes to check for (strict) XKOS conformance,
  and shapes to check for recommended practices. This file provides the rules to check for conformance,
  and as such contains shapes with sh:severity of sh:Violation. Users can use either the strict XKOS conformance rules
  or the strict conformance rules in conjunction with the recommended practices depending on their objective."""@en ;
  skos:scopeNote """The shapes described here use sh:class to encode some ranges, for example to enforce that the value of xkos:belongsTo is a skos:Concept.
    However that type information might not be available in the data graph that is being validated if a reference is made to a 'remote' URI.
    Users of these shapes should then interpret the validation report accordingly and ignore the related messages,
    or comment out these constraints from this file before validation."""@en;
  .
  
# Classification Shape

xkos:ClassificationShape a sh:NodeShape;
  rdfs:label "Classification"@en;
  sh:targetClass skos:ConceptScheme;
  sh:nodeKind sh:IRI;
  sh:order 1;
  sh:property 
    # mandatory
    xkos:P_classification_skosnotation,
    xkos:P_classification_skosprefLabel_en,
    xkos:P_classification_dctissued,
    # recommended
    xkos:P_classification_skosprefLabel_other,
    xkos:P_classification_dcdescription,
    xkos:P_classification_skosscopeNote,
    xkos:P_classification_skoshasTopConcept,
    xkos:P_classification_dctmodified,
    xkos:P_classification_dctcreator,
    xkos:P_classification_schemastartDate,
    xkos:P_classification_schemaendDate,
    xkos:P_classification_xkosbelongsTo,
    xkos:P_classification_xkoslevels,
    xkos:P_classification_xkoscovers,
    xkos:P_classification_xkoscoversExhaustively,
    xkos:P_classification_xkoscoversMutuallyExclusively,
    xkos:P_classification_xkosnumberOfLevels,
    xkos:P_classification_xkosfollows,
    xkos:P_classification_xkossupersedes,
    # optional
    xkos:P_classification_xkosvariant,
    xkos:P_classification_skosscopeNote_other,
    xkos:P_classification_skosaltLabel,
    xkos:P_classification_dctlanguage,
    xkos:P_classification_dctlicense,
    xkos:P_classification_owldeprecated,
    xkos:P_classification_elibased_on
    ;
.

## mandatory properties

xkos:P_classification_skosnotation 
  sh:order 1;
  sh:path skos:notation;
  sh:datatype xsd:string;
  sh:description "The value must be the short name of the classification, with no language tag."@en;
  sh:maxCount 1;
  sh:minCount 1;
  sh:name "short name"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_skosprefLabel_en 
  sh:order 2;
  sh:path skos:prefLabel;
  sh:datatype rdf:langString;
  sh:description "The value must be the complete name of the classification scheme in english."@en;
  sh:name "complete name in english"@en;
  sh:nodeKind sh:Literal;
  sh:qualifiedMaxCount 1;
  sh:qualifiedMinCount 1;
  sh:qualifiedValueShape [
    sh:languageIn ("en")
  ] ;
  sh:severity sh:Violation
  .

xkos:P_classification_dctissued 
  sh:order 3;
  sh:path dct:issued;
  sh:datatype xsd:date;
  sh:description "The value must be the publication date of the classification scheme"@en;
  sh:maxCount 1;
  sh:minCount 1;
  sh:name "date of publication"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .


## recommended properties

xkos:P_classification_skosprefLabel_other 
  sh:order 4;
  sh:path skos:prefLabel;
  sh:datatype rdf:langString;
  sh:description "The value must be the complete name of the classification scheme in another language than english, with a proper language tag."@en;
  sh:name "complete name not in english"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_dcdescription
  sh:order 5;
  sh:path dc:description;
  sh:datatype rdf:langString;
  sh:description "The value must be a short descriptive text about the classification scheme in english."@en;
  sh:name "short description"@en;
  sh:qualifiedMaxCount 1;
  sh:qualifiedValueShape [
    sh:languageIn ("en")
  ] ;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_skosscopeNote 
  sh:order 6;
  sh:path skos:scopeNote;
  sh:description "The explanatory note MUST have a xkos:plainText property which value is a long descriptive text about the classification scheme in English, with a language tag set at ‘@en’"@en;
  sh:name "long description"@en;
  sh:class xkos:ExplanatoryNote;
  sh:nodeKind sh:BlankNodeOrIRI;
  sh:qualifiedMaxCount 1;
  sh:qualifiedValueShape [
    sh:node xkos:ExplanatoryNoteInEnglishShape;
  ] ;
  sh:severity sh:Violation .

xkos:P_classification_skoshasTopConcept 
  sh:order 7;
  sh:path [ sh:alternativePath ( skos:hasTopConcept [ sh:inversePath skos:topConceptOf ] ) ] ;
  sh:class skos:Concept;
  sh:description "Reference to a top-level classification entry of this classification. Top level entries can be indicated either from ConceptScheme to root Concepts, using `skos:hasTopConcept`, or from root Concepts to ConceptScheme, using `skos:topConceptOf`."@en;
  sh:name "top concept"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_dctmodified 
  sh:order 8;
  sh:path dct:modified;
  sh:datatype xsd:date;
  sh:description "The value must be the last modification date of the classification scheme."@en;
  sh:maxCount 1;  
  sh:name "last modification date"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_dctcreator 
  sh:order 9;
  sh:path dct:creator;
  sh:nodeKind sh:IRI;
  sh:description "An agent responsible for creating the classification scheme."@en; 
  sh:name "creator"@en;
  sh:severity sh:Violation .

xkos:P_classification_schemastartDate 
  sh:order 10;
  sh:path schema:startDate;
  sh:description "Begin date of the temporal validity of the classification."@en;
  sh:maxCount 1;
  sh:name "valid from"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_schemaendDate 
  sh:order 11;
  sh:path schema:startDate;
  sh:description "End date of the temporal validity of the classification."@en;
  sh:maxCount 1;
  sh:name "valid until"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_xkosbelongsTo 
  sh:order 12;
  sh:path xkos:belongsTo;
  sh:class skos:Concept;
  sh:description "Connects a major version of a classification to a concept representing the overall classification."@en;
  sh:maxCount 1;
  sh:name "overall classification"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_xkoslevels
  sh:order 13;
  sh:path xkos:levels;
  sh:description "Lists the classification levels represented as an RDF list of ordered levels (instances of xkos:ClassificationLevel)."@en;
  sh:maxCount 1;
  sh:name "classification levels"@en;
  sh:nodeKind sh:BlankNode;
  sh:node [
    sh:property [
      sh:path rdf:rest ;
      sh:minCount 1;
    ] ;
    sh:property [
      sh:path rdf:first ;
      sh:minCount 1;
    ]
  ] ;
  sh:severity sh:Violation .

xkos:P_classification_xkoscovers 
  sh:order 14;
  sh:path xkos:covers;
  sh:class skos:Concept;
  sh:description "The domain covered by the classification or its levels (eg. activities, products, etc.). Subproperties xkos:coversExhaustively and xkos:coversMutuallyExclusively can also be used."@en;
  sh:maxCount 1;  
  sh:name "domain covered"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_xkoscoversExhaustively 
  sh:order 15;
  sh:path xkos:coversExhaustively;
  sh:class skos:Concept;
  sh:description "The domain covered by the classification (exhaustive coverage)."@en;
  sh:maxCount 1;
  sh:name "domain covered exhaustively"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_xkoscoversMutuallyExclusively
  sh:order 16;
  sh:path xkos:coversMutuallyExclusively; 
  sh:class skos:Concept;
  sh:description "The domain covered by the classification (mutually exclusive coverage)."@en;
  sh:maxCount 1;
  sh:name "domain covered mutually exhaustively"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_xkosnumberOfLevels
  sh:order 17;
  sh:path xkos:numberOfLevels;
  sh:datatype xsd:integer;
  sh:description "Depth of a classification (number of hierarchically imbricated levels) ; 1 for a flat classification."@en;
  sh:maxCount 1;
  sh:name "classification depth"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_classification_xkosfollows 
  sh:order 18;
  sh:path xkos:follows;
  sh:class skos:ConceptScheme;
  sh:description "Links major revisions of classifications."@en;
  sh:maxCount 1;
  sh:name "previous major version"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_xkossupersedes
  sh:order 19;
  sh:path xkos:supersedes;
  sh:class skos:ConceptScheme;
  sh:description "Links major revisions of classifications, when the new one obsoletes the old one."@en;
  sh:maxCount 1;
  sh:name "previous major version (obsoleted)"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

## optional properties

xkos:P_classification_xkosvariant
  sh:order 20;
  sh:path xkos:variant;
  sh:class skos:ConceptScheme;
  sh:description "Connects a classification scheme to its variant(s)"@en;  
  sh:name "variant"@en;
  sh:nodeKind sh:IRI;
  sh:severity sh:Violation .

xkos:P_classification_skosscopeNote_other 
 sh:order 21;
 sh:path skos:scopeNote;
 sh:description "Each explanatory note MUST have a xkos:plainText property which value is a long descriptive text about the classification scheme in another langage than english, with the langage tag set appropriately"@en;
 sh:name "long description not in english"@en;
 sh:class xkos:ExplanatoryNote;
 sh:nodeKind sh:BlankNodeOrIRI;
 sh:severity sh:Violation .

xkos:P_classification_skosaltLabel
  sh:order 22;
  sh:path skos:altLabel;
  sh:datatype rdf:langString;
  sh:description "An alternative appelation to refer to the classification scheme."@en;
  sh:name "other name"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_classification_dctlanguage
  sh:order 23;
  sh:path dct:language;
  sh:datatype xsd:language;
  sh:description "Indicates the langage coverage of the classificaiton scheme. Each value must correspond to a possible langage of labels within that classification."@en;
  sh:name "langage coverage"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_classification_dctlicense
  sh:order 24;
  sh:path dct:license;
  sh:description "The URI to the legal document giving official permission to do something with the classification."@en;
  sh:maxCount 1;
  sh:name "license"@en;
  sh:nodeKind sh:IRI;  
  sh:severity sh:Violation .

xkos:P_classification_owldeprecated
  sh:order 25;
  sh:path owl:deprecated;
  sh:description "Indicates the classification is no longer active and has been superseded by a new revision."@en;
  sh:maxCount 1;
  sh:name "deprecated"@en;
  sh:nodeKind sh:Literal;  
  sh:datatype xsd:boolean;
  sh:severity sh:Violation .

xkos:P_classification_elibased_on
  sh:order 26;
  sh:path eli:based_on;
  sh:description "Legislation on which the nomenclature is based. Use of an ELI (European Legislation Identifier) URI is preferred, if one is available."@en;
  sh:maxCount 1;
  sh:name "based on legislation"@en;
  sh:nodeKind sh:IRI;  
  sh:severity sh:Violation .

## Other Shapes necessary to encode Classification Shape

xkos:ExplanatoryNoteInEnglishShape a sh:NodeShape;
  rdfs:label "Explanatory Note in english"@en;
  sh:property [
    sh:path xkos:plainText ;
    sh:datatype rdf:langString;
    sh:languageIn ("en");
    sh:maxCount 1;
    sh:minCount 1;
    sh:name "value"@en;
    sh:nodeKind sh:Literal;
  ]
  .

xkos:ExplanatoryNoteNotInEnglishShape a sh:NodeShape;
  rdfs:label "Explanatory Note not in english"@en;
  sh:property [
    sh:path xkos:plainText;
    sh:datatype rdf:langString;
    sh:maxCount 1;
    sh:minCount 1;
    sh:name "value"@en;
    sh:nodeKind sh:Literal;
    sh:node [
      sh:not [ sh:languageIn ("en") ]
    ] ;
  ]
  .

# Versioned Note Shape

xkos:VersionedNoteShape a sh:NodeShape;
  rdfs:label "Versioned note"@en;
  # notes must have an IRI
  sh:nodeKind sh:IRI;
  sh:order 3;
  # any value of these properties are matched by this shape
  sh:targetObjectsOf skos:scopeNote;
  sh:targetObjectsOf skos:definition;
  sh:targetObjectsOf xkos:coreContentNote;
  sh:targetObjectsOf xkos:additionalContentNote;
  sh:targetObjectsOf xkos:exclusionNote;
  sh:targetObjectsOf xkos:inclusionNote;
  sh:targetObjectsOf xkos:caseLaw;
  sh:property 
    xkos:P_note_xkos_plainText,
    xkos:P_note_dct_language,
    xkos:P_note_dcat_version,
    xkos:P_note_schema_startDate,
    xkos:P_note_schema_endDate,
    xkos:P_note_rdf_value;
  .

## Mandatory properties

xkos:P_note_xkos_plainText
  sh:order 30;
  sh:path xkos:plainText;
  sh:datatype rdf:langString;
  sh:description "The value of the note, in plain text (no HTML / XML markup). The literal is tagged with a proper language tag."@en;
  sh:minCount 1;
  sh:maxCount 1;
  sh:name "value (plain text)"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_note_dct_language
  sh:order 31;
  sh:path dct:language;
  sh:datatype xsd:language;
  sh:description "The language code of the note. This is a repetition of the language tag of the xkos:plainText attribute, that makes it easier to query/select notes in a certain language."@en;
  sh:minCount 1;
  sh:maxCount 1;
  sh:name "language"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_note_dcat_version
  sh:order 32;
  sh:path dcat:version;
  sh:datatype xsd:int;
  sh:description "The version number of the note. e.g. \"1\"^^xsd:int, \"2\"^^xsd:int, etc. Note that this version number will typically be used in the URI of the xkos:ExplanatoryNote."@en;
  sh:minCount 1;
  sh:maxCount 1;
  sh:name "version"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_note_schema_startDate
  sh:order 33;
  sh:path schema:startDate;
  sh:datatype xsd:dateTime;
  sh:description "The date from which this note content is valid."@en;
  sh:minCount 1;
  sh:maxCount 1;
  sh:name "start date"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

xkos:P_note_schema_endDate
  sh:order 34;
  sh:path schema:endDate;
  sh:datatype xsd:dateTime;
  sh:description "The date until which this note content was (or will be) valid, indicating it was (or will be) replaced with another note with a different text, and its version number increased by 1. This property is not set in the case if there is no known end date."@en;
  sh:maxCount 1;
  sh:name "end date"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .

## recommended properties


## optional properties

xkos:P_note_rdf_value
  sh:order 35;
  sh:path rdf:value;
  sh:datatype rdf:XMLLiteral;
  sh:description "If needed the value of the note containing HTML or XML markup."@en;
  sh:maxCount 1;
  sh:name "value (with markup)"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .


# Timestamped Note Shape

xkos:TimestampedNoteShape a sh:NodeShape;
  rdfs:label "Timestamped note"@en;
  # notes must have an IRI
  sh:nodeKind sh:IRI;
  sh:order 4;
  # any value of these properties are matched by this shape
  sh:targetObjectsOf skos:changeNote;
  # some property shapes are common with versioned note shape
  sh:property 
    xkos:P_note_xkos_plainText,
    xkos:P_note_dct_language,
    xkos:P_note_dcat_version,
    xkos:P_note_dct_issued;
  .

## Mandatory properties

xkos:P_note_dct_issued
  sh:order 40;
  sh:path dct:issued;
  sh:datatype xsd:dateTime;
  sh:description "The date at which the note was issued. Note that this date will typically be used in the URI of the xkos:ExplanatoryNote."@en;
  sh:minCount 1;
  sh:maxCount 1;
  sh:name "date of publication"@en;
  sh:nodeKind sh:Literal;  
  sh:severity sh:Violation .




# Correspondence Shape

xkos:CorrespondenceShape a sh:NodeShape;
  rdfs:label "Correspondence"@en;
  sh:targetClass xkos:Correspondence;
  sh:nodeKind sh:IRI;
  sh:order 4;
  sh:property 
    # mandatory
    xkos:P_correspondence_skosprefLabel_en,
    xkos:P_correspondence_dctissued,
    # recommended
    xkos:P_correspondence_skosprefLabel_other,
    xkos:P_correspondence_skosscopeNote,
    xkos:P_correspondence_dctcreator,
    # optional
    xkos:P_correspondence_skosscopeNote_other,
    xkos:P_correspondence_dctlicense,
    xkos:P_correspondence_rdfsseeAlso,
    xkos:P_correspondence_xkosweightedBy;    
.

## Mandatory properties

xkos:P_correspondence_skosprefLabel_en 
  sh:order 1;
  sh:path skos:prefLabel;
  sh:datatype rdf:langString;
  sh:description "A name given to the correspondence table in english."@en;
  sh:name "name in english"@en;
  sh:nodeKind sh:Literal;
  sh:qualifiedMaxCount 1;
  sh:qualifiedMinCount 1;
  sh:qualifiedValueShape [
    sh:languageIn ("en")
  ] ;
  sh:severity sh:Violation
  .

xkos:P_correspondence_dctissued 
  sh:order 2;
  sh:path dct:issued;
  sh:datatype xsd:date;
  sh:description "The publication date of the correspondence table."@en;
  sh:maxCount 1;
  sh:minCount 1;
  sh:name "date of publication"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

## Recommended properties

xkos:P_correspondence_skosprefLabel_other 
  sh:order 3;
  sh:path skos:prefLabel;
  sh:datatype rdf:langString;
  sh:description "A name given to the correspondence table in another language than english, with a proper language tag."@en;
  sh:name "name not in english"@en;
  sh:nodeKind sh:Literal;
  sh:severity sh:Violation .

xkos:P_correspondence_skosscopeNote 
  sh:order 4;
  sh:path skos:scopeNote;
  sh:description "The explanatory note MUST have a xkos:plainText property which value is a long descriptive text about the classification scheme in English, with a language tag set at ‘@en’"@en;
  sh:name "long description"@en;
  sh:class xkos:ExplanatoryNote;
  sh:nodeKind sh:BlankNodeOrIRI;
  sh:severity sh:Violation .

xkos:P_correspondence_dctcreator 
  sh:order 5;
  sh:path dct:creator;
  sh:class dct:Agent;
  sh:description "An agent responsible for creating the correspondence table."@en; 
  sh:name "creator"@en;
  sh:severity sh:Violation .

## Optional properties

xkos:P_correspondence_skosscopeNote_other 
 sh:order 6;
 sh:path skos:scopeNote;
 sh:description "A short descriptive text about the correspondance table in another language than english. The explanatory note MUST have a xkos:plainText property with a language tag set appropriately."@en;
 sh:name "scope note"@en;
 sh:class xkos:ExplanatoryNote;
 sh:nodeKind sh:BlankNodeOrIRI;
 sh:severity sh:Violation .

xkos:P_correspondence_dctlicense
  sh:order 7;
  sh:path dct:license;
  sh:description "The URI to the legal document giving official permission to do something with the entire correspondence table."@en;
  sh:maxCount 1;
  sh:name "license"@en;
  sh:nodeKind sh:IRI;  
  sh:severity sh:Violation .

xkos:P_correspondence_rdfsseeAlso
  sh:order 8;
  sh:path rdfs:seeAlso;
  sh:description "Refers to another correspondence table based on the same classifications but with a different approach (e.g. reversing the role of the source and target classification)."@en;
  sh:name "basis for"@en;
  sh:qualifiedMaxCount 1;
  sh:qualifiedValueShape [
    sh:class xkos:Correspondence ;
  ] ;
  sh:nodeKind sh:IRI;  
  sh:severity sh:Violation .

xkos:P_correspondence_xkosweightedBy
  sh:order 9;
  sh:path xkos:weightedBy;
  sh:description "Refers to a matrix that contains the weights / ratios associated to each pair of mapped source and target concepts."@en;
  sh:name "weighted by"@en;
  sh:maxCount 1;
  sh:class qb:DataSet ;
  sh:nodeKind sh:IRI;  
  sh:severity sh:Violation .