Add comments and Javadoc

Author: atextor

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/LiteralComparator.java

@@ -17,6 +17,9 @@
 
 import org.apache.jena.rdf.model.Literal;
 
+/**
+ * A {@link Comparator} for RDF {@link Literal}s that takes into account their type
+ */
 public class LiteralComparator implements Comparator<Literal> {
    @Override
    public int compare( final Literal literal1, final Literal literal2 ) {

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/RdfTypes.java

@@ -25,6 +25,9 @@
 
 import com.google.common.collect.ImmutableList;
 
+/**
+ * Provides functions to find out information about the types of resources
+ */
 public class RdfTypes {
    public static List<Resource> superTypesOfType( final Resource type ) {
       final List<Resource> types = new ArrayList<>();

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/SHACL.java

@@ -18,6 +18,9 @@
 
 import io.openmanufacturing.sds.aspectmodel.vocabulary.Namespace;
 
+/**
+ * Vocabulary for the Shapes Constraint Language (SHACL)
+ */
 public class SHACL implements Namespace {
    public final String NS = "http://www.w3.org/ns/shacl#";
 

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/ShaclValidator.java

@@ -67,7 +67,7 @@ public ShaclValidator( final Model shapesModel ) {
     * Validates a model element using the SHACL shapes the validator was initialized with.
     * {@link Resource#getModel()} on the element must not return null, i.e., the resource may not be created using
     * {@link org.apache.jena.rdf.model.ResourceFactory#createProperty(String)}, but instead must be created via {@link Model#createResource(String)}.
-    * @param element the element to validated
+    * @param element the element to be validated
     * @return the list of {@link Violation}s if there are violations
     */
    public List<Violation> validateElement( final Resource element ) {
@@ -99,7 +99,7 @@ public List<Violation> validateShapeForElement( final Resource element, final Sh
             }
 
             // MinCount needs to be handled separately: If the property is not used at all on the target node, but a MinCount constraints >= 1
-            // exists, a violation must be emitted even no value for the property exists
+            // exists, a violation must be emitted even though no value for the property exists
             if ( reachableNodes.isEmpty() && constraint instanceof MinCountConstraint && property.path() instanceof PredicatePath predicatePath ) {
                final Property rdfProperty = model.createProperty( predicatePath.predicate().getURI() );
                final EvaluationContext context = new EvaluationContext( element, shape, Optional.of( rdfProperty ), List.of(), this );

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/Shape.java

@@ -24,11 +24,14 @@
 import io.openmanufacturing.sds.aspectmodel.shacl.constraint.Constraint;
 
 /**
- * Implements <code>sh:NodeShape</code>
+ * Implements <a href="https://www.w3.org/TR/shacl/#node-shapes">sh:NodeShape</a>
  */
 public interface Shape {
    Attributes attributes();
 
+   /**
+    * Implements the valid values for <a href="https://www.w3.org/TR/shacl/#NodeKindConstraintComponent">sh:nodeKind</a>
+    */
    enum NodeKind {
       BlankNode, IRI, Literal, BlankNodeOrIRI, BlankNodeOrLiteral, IRIOrLiteral;
 

core/sds-aspect-model-validator/src/main/java/io/openmanufacturing/sds/aspectmodel/shacl/ShapeLoader.java

@@ -75,6 +75,9 @@
 import io.openmanufacturing.sds.aspectmodel.shacl.path.ZeroOrMorePath;
 import io.openmanufacturing.sds.aspectmodel.shacl.path.ZeroOrOnePath;
 
+/**
+ * Takes an RDF model describing one or more SHACL shapes as input and parses them into {@link Shape}s
+ */
 public class ShapeLoader implements Function<Model, List<Shape.Node>> {
    private static final SHACL SHACL = new SHACL();