SD Creation Wizard API
Backend service to convert an input shacl shape into JSON form for the frontend service.
- Input is expected to be a MultipartFile file.
- Output object is ShaclModel.java. It consists of a list of json objects for prefixes in the input file and another list of json objects for the shapes listed in the input file.
- Each shape is depicted in VicShape.java. Shape name is stored in variable schema. Properties of the shape are stored in variable called 'constraints' which is of type ShapeProperties.java.
- Test instances can be found under src/test/resources.
- JUnit test cases can be found under src/test/java.
Sample input:
@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 xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix ex: <http://www.w3.org/example#> .
schema:PersonShape
a sh:NodeShape ;
sh:targetClass ex:Person ;
sh:property [
sh:path schema:givenName ;
sh:datatype xsd:string ;
sh:name "Peter Parker" ;
sh:minCount 1;
sh:maxCount 1;
sh:minLength 3;
sh:maxLength 8;
sh:order 1
] ;
sh:property [
sh:path schema:gender ;
sh:in ( "female" "male" ) ;
sh:minCount 1;
sh:maxCount 1;
sh:order 2;
] ;
sh:property [
sh:path schema:birthDate ;
sh:minCount 1;
sh:maxCount 1;
sh:order 3;
] ;
sh:property [
sh:path schema:age ;
sh:minCount 1;
sh:maxCount 1;
sh:minInclusive 18 ;
sh:maxInclusive 65 ;
] .
Corresponding output:
{
"prefixList": [
{
"alias": "schema",
"url": "http://schema.org/"
},
{
"alias": "ex",
"url": "http://www.w3.org/example#"
},
{
"alias": "rdf",
"url": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
},
{
"alias": "sh",
"url": "http://www.w3.org/ns/shacl#"
},
{
"alias": "xsd",
"url": "http://www.w3.org/2001/XMLSchema#"
},
{
"alias": "rdfs",
"url": "http://www.w3.org/2000/01/rdf-schema#"
}
],
"shapes": [
{
"schema": "PersonShape",
"targetClassPrefix": "ex",
"targetClassName": "Person",
"constraints": [
{
"path": {
"prefix": "schema",
"value": "age"
},
"minCount": 1,
"maxCount": 1,
"validations": [
{
"key": "maxInclusive",
"value": 65
},
{
"key": "minInclusive",
"value": 18
}
]
},
{
"path": {
"prefix": "schema",
"value": "birthDate"
},
"minCount": 1,
"maxCount": 1,
"order": 3
},
{
"path": {
"prefix": "schema",
"value": "gender"
},
"minCount": 1,
"maxCount": 1,
"in": [
{
"value": "female"
},
{
"value": "male"
}
],
"order": 2
},
{
"path": {
"prefix": "schema",
"value": "givenName"
},
"name": "Peter Parker",
"datatype": {
"prefix": "xsd",
"value": "string"
},
"minCount": 1,
"maxCount": 1,
"order": 1,
"validations": [
{
"key": "maxLength",
"value": 8
},
{
"key": "minLength",
"value": 3
}
]
}
]
}
]
}
Using pre-defined SHACL shapes
- Place JSON files in a
shapesdirectory under the JAR file (*.ttl file extension) -
http://localhost:8080/getAvailableShapesreturns all available shapes, e.g.,["foo.json", "bar.json"] -
http://localhost:8080/getAvailableShapesCategorizedreturns all available shapes based on their categories, e.g.,"shapes": { "Participant": ["1.json", "2.json"], "Service": ["3.json]" } -
http://localhost:8080/getJSON?name=foo.jsonreturns the content of the respective JSON as string, e.g.,{text: "Hello World!"}
Development and Docker instructions
- For development in IntelliJ, please ensure that the Maven plugin registry is enabled
Docker:
- works on port 8080
- docker build command :
docker build -t springio/gs-spring-boot-docker . - Sample run command :
docker run -p 8080:8080 springio/gs-spring-boot-docker
Supported SHACL Features ("Rules")
The SD Creation Wizard supports many features from the W3C Shapes Constraint Language (SHACL):
-
sh:minLengthandsh:maxLength: Length of textual (string) values -
sh:minCountandsh:maxCount: Specify mandatory attributes and declare their expected cardinality -
sh:minInclusive,sh:maxInclusive,sh:minExclusive,sh:maxExclusive: Ranges for numerical values -
sh:order: Control the ordering of attributes in the SD Creation Wizard UI. -
sh:group: Group multiple attributes into logical areas in the UI. -
sh:pathwithsh:classorsh:datatype: Specify the type of attributes and their targets, which can be classes or simple datatypes like string, URI, decimal, etc. -
sh:nameandsh:description: Human-readable text and description in natural language. Multiple languages are supported. -
skos:example: List one or more example values to make field completion more convenient for end users. -
sh:or: Basic support for logical operators. -
sh:rule: Set a rule for examplehiddenfor hide the field.
Supported HASH Generator
- Create a new element into
hash-config.ymland define the field names intohashConfigList. Thekeyis a value defined into YAML file (valueIn). Thevaluefield must contain the URL of the PDF document. - Create a new element into
hash-config.ymland define the field names intohashModelFieldList. The element (hashDoc,hashAlg,hashValue) match thetitlevalue defined in the YAML file.