org.semanticweb.elk.reasoner.saturation.rules.Rule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elk-reasoner Show documentation
The core ELK Reasoner package
The newest version!
package org.semanticweb.elk.reasoner.saturation.rules;

import org.semanticweb.elk.reasoner.saturation.conclusions.model.ClassConclusion;
import org.semanticweb.elk.reasoner.saturation.conclusions.model.SubClassConclusion;
import org.semanticweb.elk.reasoner.saturation.context.ContextPremises;

/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
 * %%
 * Licensed 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.
 * #L%
 */

/**
 * A rule that can be applied to a given premise (either a
 * {@link ClassConclusion} or an object representing a {@link ClassConclusion})
 * together with other {@link ClassConclusion}s stored in within
 * {@link ContextPremises}. The rule produces other {@link ClassConclusion}s
 * using the given {@link ClassInferenceProducer} .
 * 
 * @author "Yevgeny Kazakov"
 * 
 * @param 
 *            the type of premises to which the rule can be applied
 */
public interface Rule {

	/**
	 * Apply the rule to the given premise representing a
	 * {@link ClassConclusion} and other {@link ClassConclusion}s stored in
	 * within the given {@link ContextPremises} and produce
	 * {@link ClassConclusion}s using the given {@link ClassInferenceProducer}
	 * 
	 * @param premise
	 *            the element to which the rule is applied, it represents a
	 *            {@link ClassConclusion}
	 * @param premises
	 *            the {@link ContextPremises} from which other matching premises
	 *            of the rule are taken
	 * @param producer
	 *            the {@link ClassInferenceProducer} using which
	 *            {@link ClassConclusion}s of the inferences are produced
	 * 
	 */
	public void apply(P premise, ContextPremises premises,
			ClassInferenceProducer producer);

	/**
	 * Like {@link #apply(Object, ContextPremises, ClassInferenceProducer)}, but
	 * produces additional redundant inferences using the
	 * {@link ClassInferenceProducer} that are not necessary for producing the
	 * required conclusion, but may be necessary to capture all proofs from
	 * axioms
	 * 
	 * @param premise
	 *            the element to which the rule is applied, it represents a
	 *            {@link ClassConclusion}
	 * @param premises
	 *            the {@link ContextPremises} from which other matching premises
	 *            of the rule are taken
	 * @param producer
	 *            the {@link ClassInferenceProducer} using which
	 *            {@link ClassConclusion}s of the inferences are produced
	 */
	public void applyTracing(P premise, ContextPremises premises,
			ClassInferenceProducer producer);

	/**
	 * @return {@code true} if this {@link Rule} produces only
	 *         {@link ClassConclusion}s with the same value of
	 *         {@link ClassConclusion#getTraceRoot()} and
	 *         {@link SubClassConclusion#getTraceSubRoot()} (if
	 *         {@link SubClassConclusion}) as the premise to which it applies.
	 *         Returns {@code false} if all {@link ClassConclusion}s produced
	 *         have different values of {@link ClassConclusion#getTraceRoot()}
	 *         or {@link SubClassConclusion#getTraceSubRoot()} then the premise.
	 * @see ClassConclusion#getTraceRoot()
	 * @see SubClassConclusion#getDestination()
	 */
	public boolean isTracingRule();

	public void accept(RuleVisitor visitor, P premise,
			ContextPremises premises, ClassInferenceProducer producer);

}