001/*
002 * Copyright 2018 Leibniz-Institut für Analytische Wissenschaften – ISAS – e.V..
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.isas.mztab2.validation;
017
018import de.isas.mztab2.cvmapping.RuleEvaluationResult;
019import de.isas.mztab2.model.Parameter;
020import info.psidev.cvmapping.CvMappingRule;
021import java.util.List;
022import org.apache.commons.jxpath.Pointer;
023import org.apache.commons.lang3.tuple.Pair;
024
025/**
026 * Interface for rule logic handling implementations. 
027 * @author nilshoffmann
028 */
029public interface CvRuleHandler {
030    /**
031     * Handle the provided rule according to the implementor's logic. The rule is applied to all elements 
032     * within the filtered selection where it is applicable.
033     * @param rule the rule to apply
034     * @param filteredSelection the selection of pointer,paramter pairs to apply the rule on
035     * @return the rule evaluation result
036     */
037    RuleEvaluationResult handleRule(CvMappingRule rule,
038        List<Pair<Pointer, Parameter>> filteredSelection);
039}