org.apache.jena.shacl.engine.constraint.ConstraintPairwise 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.Collections;
import java.util.Objects;
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.event.*;
import org.apache.jena.sparql.expr.ExprNotComparableException;
import org.apache.jena.sparql.expr.NodeValue;
import org.apache.jena.sparql.path.Path;
import org.apache.jena.system.G;

/**
 * Base of "4.5 Property Pair Constraint Components"
 */
public abstract class ConstraintPairwise implements Constraint {

    protected final Node value;
    private final Node constraintComponent;

    protected ConstraintPairwise(Node value, Node constraintComponent) {
        this.value = value;
        this.constraintComponent = constraintComponent;
    }

    public Node getValue() {
        return value;
    }

    @Override
    final
    public Node getComponent() {
        return constraintComponent;
    }

    @Override
    public void validateNodeShape(ValidationContext vCxt, Graph data, Shape shape, Node focusNode) {
        validatePropertyShape(vCxt, data, shape, focusNode, null, Collections.singleton(focusNode));
    }

    @Override
    final
    public void validatePropertyShape(ValidationContext vCxt, Graph data, Shape shape,
                         Node focusNode, Path path, Set pathNodes) {
        // pathNodes is (focusNode, sh:path ?V) = valueNodes
        Set compareNodes = G.allSP(data, focusNode, value);
        validate(vCxt, shape, focusNode, path, pathNodes, compareNodes);
    }

    protected AbstractConstraintEvaluationEvent makeEventSingleCompareNode(ValidationContext vCxt, Shape shape,
                    Node focusNode, Path path, Node valueNode, Node compareNode, boolean isValid) {
        if (valueNode.equals(focusNode)) {
            return new ConstraintEvaluatedOnFocusNodeWithSingleCompareNodeEvent(vCxt, shape, focusNode, this,
                            compareNode, isValid);
        }
        return new ConstraintEvaluatedOnSinglePathNodeWithSingleCompareNodeEvent(vCxt, shape,
                        focusNode, this, path, valueNode, compareNode,
                        isValid);
    }

    protected AbstractConstraintEvaluationEvent makeEvent(ValidationContext vCxt, Shape shape,
                    Node focusNode, Path path, Set pathNodes, Set compareNodes, boolean isValid) {
        if (pathNodes.size() == 1 && pathNodes.contains(focusNode)) {
            return new ConstraintEvaluatedOnFocusNodeWithCompareNodesEvent(vCxt, shape, focusNode, this,
                            compareNodes, isValid);
        }
        return new ConstraintEvaluatedOnPathNodesWithCompareNodesEvent(vCxt, shape,
                        focusNode, this, path, pathNodes, compareNodes,
                        isValid);
    }

    protected AbstractConstraintEvaluationEvent makeEventSinglePathNode(ValidationContext vCxt, Shape shape,
                    Node focusNode, Path path, Node pathNode, Set compareNodes, boolean isValid) {
        if (pathNode.equals(focusNode)) {
            return new ConstraintEvaluatedOnFocusNodeWithCompareNodesEvent(vCxt, shape, focusNode, this,
                            compareNodes, isValid);
        }
        return new ConstraintEvaluatedOnSinglePathNodeWithCompareNodesEvent(vCxt, shape,
                        focusNode, this, path, pathNode, compareNodes,
                        isValid);
    }

    public abstract void validate(ValidationContext vCxt, Shape shape, Node focusNode, Path path,
                                  Set pathNodes, Set compareNodes);

    protected int compare(Node n1, Node n2) {
        NodeValue nv1 = NodeValue.makeNode(n1);
        NodeValue nv2 = NodeValue.makeNode(n2);
        try {
          return NodeValue.compare(nv1, nv2);
      } catch (ExprNotComparableException ex) {
          // Known to be not a Expr compare constant value.
          return -999;
      }
    }

    @Override
    public int hashCode() {
        return Objects.hash(constraintComponent, value);
    }

    @Override
    public boolean equals(Object obj) {
        if ( this == obj )
            return true;
        if ( obj == null )
            return false;
        if ( getClass() != obj.getClass() )
            return false;
        ConstraintPairwise other = (ConstraintPairwise)obj;
        return Objects.equals(constraintComponent, other.constraintComponent) && Objects.equals(value, other.value);
    }
}