org.apache.jena.shacl.engine.constraint.ConstraintEntity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jena-shacl Show documentation
SHACL engine for Apache Jena
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jena.shacl.engine.constraint;

import java.util.Set;

import org.apache.jena.graph.Graph;
import org.apache.jena.graph.Node;
import org.apache.jena.shacl.engine.ValidationContext;
import org.apache.jena.shacl.parser.Constraint;
import org.apache.jena.shacl.parser.Shape;
import org.apache.jena.shacl.validation.ReportItem;
import org.apache.jena.shacl.validation.event.ConstraintEvaluatedOnPathNodesEvent;
import org.apache.jena.sparql.path.Path;

/** A Constraint that handles an RDF "entity" (e.g. triples with the same subject)
 *  and produces a single report based on a test using the set of pathNodes or a single focusNode.
 *  {@link MinCount}, {@link MaxCount}, {@link HasValueConstraint}.
 *  
 *  Contrast this with {@link ConstraintDataTerm} which handles an RDF "entity" and
 *  produces one report for each item in the set of nodes. {@link ClassConstraint}.
 *
 *  @see ConstraintDataTerm
 */
public abstract class ConstraintEntity implements Constraint {

    @Override
    public abstract void validateNodeShape(ValidationContext vCxt, Graph data, Shape shape, Node focusNode);

    @Override
    final
    public void validatePropertyShape(ValidationContext vCxt, Graph data, Shape shape, Node focusNode, Path path, Set pathNodes) {
        ReportItem item = validate(vCxt, pathNodes);
        boolean passed = item == null;
        vCxt.notifyValidationListener(() -> new ConstraintEvaluatedOnPathNodesEvent(vCxt, shape, focusNode, this, path, pathNodes,
                        passed));
        if ( passed )
            return;
        vCxt.reportEntry(item.getMessage(), shape, focusNode, path, item.getValue(), this);
    }

    public abstract ReportItem validate(ValidationContext vCxt, Set pathNodes);
}