openphar 0.1.0

data/shapes/chp/monograph.ttl

@@ -0,0 +1,153 @@
+# Open Pharmacopoeia - SHACL shapes for Chinese Pharmacopoeia monographs.
+#
+# These shapes document the structural contract every ChP monograph must
+# satisfy. They can also be used by a SHACL processor to validate JSON-LD
+# output produced by ChP::JsonLD::Exporter.
+#
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
+@prefix op: <https://www.openphar.org/ontology/core/> .
+@prefix chp: <https://www.openphar.org/ontology/publisher/chp/> .
+
+# =============================================================================
+# BASE SHAPE — applies to every ChP monograph regardless of type
+# =============================================================================
+
+chp:MonographShape
+    a sh:NodeShape ;
+    sh:targetClass chp:Monograph ;
+    sh:property [
+        sh:path chp:entryId ;
+        sh:datatype xsd:integer ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:severity sh:Violation ;
+        sh:message "ChP monograph must have exactly one chp:entryId."@en ;
+    ] ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:datatype xsd:integer ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:severity sh:Violation ;
+        sh:message "ChP monograph must have exactly one chp:bookId in 1..4."@en ;
+    ] ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:in ( 1 2 3 4 ) ;
+        sh:severity sh:Violation ;
+    ] ;
+    sh:property [
+        sh:path dct:title ;
+        sh:datatype xsd:string ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:severity sh:Violation ;
+        sh:message "ChP monograph must have a title."@en ;
+    ] ;
+    sh:property [
+        sh:path op:publisher ;
+        sh:hasValue "ChP" ;
+        sh:severity sh:Violation ;
+    ] ;
+    sh:property [
+        sh:path op:belongsToEdition ;
+        sh:nodeKind sh:IRI ;
+        sh:minCount 1 ;
+        sh:severity sh:Violation ;
+    ] ;
+    sh:property [
+        sh:path chp:directoryTitle ;
+        sh:datatype xsd:string ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+    ] ;
+    sh:property [
+        sh:path chp:pinyinTitle ;
+        sh:datatype xsd:string ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+    ] ;
+    sh:property [
+        sh:path chp:htmlContent ;
+        sh:datatype xsd:string ;
+        sh:severity sh:Info ;
+    ] .
+
+# =============================================================================
+# TYPE-SPECIFIC SHAPES
+# =============================================================================
+
+chp:TcmCrudeDrugShape
+    a sh:NodeShape ;
+    sh:targetClass chp:TcmCrudeDrug ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 1 ;
+        sh:severity sh:Violation ;
+        sh:message "TcmCrudeDrug must be in Vol I (bookId=1)."@en ;
+    ] ;
+    sh:property [
+        sh:path chp:eTitle ;
+        sh:datatype xsd:string ;
+        sh:minCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "TCM crude drugs should carry a Latin botanical/zoological name."@en ;
+    ] .
+
+chp:TcmExtractShape
+    a sh:NodeShape ;
+    sh:targetClass chp:TcmExtract ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 1 ;
+        sh:severity sh:Violation ;
+    ] .
+
+chp:TcmFormulationShape
+    a sh:NodeShape ;
+    sh:targetClass chp:TcmFormulation ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 1 ;
+        sh:severity sh:Violation ;
+    ] .
+
+chp:ChemicalSubstanceShape
+    a sh:NodeShape ;
+    sh:targetClass chp:ChemicalSubstance ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 2 ;
+        sh:severity sh:Violation ;
+    ] .
+
+chp:ChemicalPreparationShape
+    a sh:NodeShape ;
+    sh:targetClass chp:ChemicalPreparation ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 2 ;
+        sh:severity sh:Violation ;
+    ] .
+
+chp:BiologicShape
+    a sh:NodeShape ;
+    sh:targetClass chp:Biologic ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 3 ;
+        sh:severity sh:Violation ;
+    ] .
+
+chp:GeneralChapterShape
+    a sh:NodeShape ;
+    sh:targetClass chp:GeneralChapter ;
+    sh:property [
+        sh:path chp:bookId ;
+        sh:hasValue 4 ;
+        sh:severity sh:Violation ;
+    ] .

data/shapes/edition-shapes.ttl

@@ -0,0 +1,230 @@
+# Open Pharmacopoeia - SHACL Shapes for Edition Validation
+#
+# This file defines SHACL shapes for validating pharmacopoeia edition data.
+# Ensures that all required properties are present and have correct types.
+
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix op: <https://www.openphar.org/ontology/core/> .
+@prefix bib: <https://www.openphar.org/ontology/bibliographic/> .
+@prefix shape: <https://www.openphar.org/shapes/> .
+
+<https://www.openphar.org/shapes/edition-shapes>
+    a owl:Ontology ;
+    rdfs:label "Open Pharmacopoeia Edition Shapes"@en ;
+    rdfs:comment "SHACL shapes for validating pharmacopoeia editions and supplements."@en ;
+    owl:imports <https://www.openphar.org/ontology/bibliographic/edition> ;
+    sh:declare [
+        sh:prefix "bib" ;
+        sh:namespace "https://www.openphar.org/ontology/bibliographic/"^^xsd:anyURI
+    ] , [
+        sh:prefix "op" ;
+        sh:namespace "https://www.openphar.org/ontology/core/"^^xsd:anyURI
+    ] .
+
+# =============================================================================
+# EDITION SHAPE
+# =============================================================================
+
+shape:EditionShape
+    a sh:NodeShape ;
+    sh:targetClass bib:Edition ;
+
+    # Required properties
+    sh:property [
+        sh:path bib:editionNumber ;
+        sh:datatype xsd:string ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "An edition must have exactly one edition number."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:hasPublisher ;
+        sh:class op:Publisher ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "An edition must have exactly one publisher."@en
+    ] ;
+
+    sh:property [
+        sh:path skos:prefLabel ;
+        sh:datatype rdf:langString ;
+        sh:minCount 1 ;
+        sh:message "An edition must have at least one preferred label."@en
+    ] ;
+
+    # Optional but recommended properties
+    sh:property [
+        sh:path bib:publicationDate ;
+        sh:datatype xsd:date ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "An edition should have a publication date."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:effectiveDate ;
+        sh:datatype xsd:date ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "An edition should have an effective date."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:editionUrl ;
+        sh:datatype xsd:anyURI ;
+        sh:maxCount 1 ;
+        sh:severity sh:Info ;
+        sh:message "An edition may have an official URL."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:monographCount ;
+        sh:datatype xsd:integer ;
+        sh:maxCount 1 ;
+        sh:severity sh:Info ;
+        sh:message "An edition may have a monograph count."@en
+    ] ;
+
+    # Supplements
+    sh:property [
+        sh:path bib:hasSupplement ;
+        sh:class bib:Supplement ;
+        sh:node shape:SupplementShape ;
+        sh:severity sh:Info ;
+        sh:message "An edition may have supplements."@en
+    ] .
+
+# =============================================================================
+# SUPPLEMENT SHAPE
+# =============================================================================
+
+shape:SupplementShape
+    a sh:NodeShape ;
+    sh:targetClass bib:Supplement ;
+
+    # Required properties
+    sh:property [
+        sh:path bib:supplementNumber ;
+        sh:datatype xsd:string ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "A supplement must have exactly one supplement number."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:supplementTo ;
+        sh:class bib:Edition ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "A supplement must belong to exactly one edition."@en
+    ] ;
+
+    # Optional but recommended properties
+    sh:property [
+        sh:path bib:supplementPublicationDate ;
+        sh:datatype xsd:date ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "A supplement should have a publication date."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:supplementEffectiveDate ;
+        sh:datatype xsd:date ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "A supplement should have an effective date."@en
+    ] ;
+
+    # Monograph changes
+    sh:property [
+        sh:path bib:addsMonograph ;
+        sh:class op:PharmacopoeiaMonograph ;
+        sh:severity sh:Info ;
+        sh:message "A supplement may add monographs."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:revisesMonograph ;
+        sh:class op:PharmacopoeiaMonograph ;
+        sh:severity sh:Info ;
+        sh:message "A supplement may revise monographs."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:deletesMonograph ;
+        sh:class op:PharmacopoeiaMonograph ;
+        sh:severity sh:Info ;
+        sh:message "A supplement may delete monographs."@en
+    ] .
+
+# =============================================================================
+# VERSION HISTORY SHAPE
+# =============================================================================
+
+shape:VersionHistoryShape
+    a sh:NodeShape ;
+    sh:targetClass bib:VersionHistory ;
+
+    sh:property [
+        sh:path bib:versionFor ;
+        sh:class op:PharmacopoeiaMonograph ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "A version history must be for exactly one monograph."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:hasVersion ;
+        sh:class bib:MonographVersion ;
+        sh:minCount 1 ;
+        sh:node shape:MonographVersionShape ;
+        sh:message "A version history must have at least one version entry."@en
+    ] .
+
+# =============================================================================
+# MONOGRAPH VERSION SHAPE
+# =============================================================================
+
+shape:MonographVersionShape
+    a sh:NodeShape ;
+    sh:targetClass bib:MonographVersion ;
+
+    sh:property [
+        sh:path bib:inEdition ;
+        sh:class bib:Edition ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "A monograph version must be in exactly one edition or supplement."@en
+    ] ;
+
+    sh:property [
+        sh:path bib:changeType ;
+        sh:class bib:ChangeType ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:message "A monograph version must have exactly one change type."@en
+    ] .
+
+# =============================================================================
+# MONOGRAPH WITH EDITION LINKING SHAPE
+# =============================================================================
+
+shape:MonographWithEditionShape
+    a sh:NodeShape ;
+    sh:targetClass op:PharmacopoeiaMonograph ;
+
+    sh:property [
+        sh:path op:belongsToEdition ;
+        sh:class bib:Edition ;
+        sh:minCount 1 ;
+        sh:maxCount 1 ;
+        sh:severity sh:Warning ;
+        sh:message "A monograph should belong to an edition."@en
+    ] .