org.semanticweb.elk.reasoner.saturation.inferences.LinkComposition 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
There is a newer version: 0.29.0
package org.semanticweb.elk.reasoner.saturation.inferences;

/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2015 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%
 */

import org.semanticweb.elk.reasoner.indexing.model.IndexedComplexPropertyChain;
import org.semanticweb.elk.reasoner.indexing.model.IndexedContextRoot;
import org.semanticweb.elk.reasoner.indexing.model.IndexedObjectProperty;
import org.semanticweb.elk.reasoner.indexing.model.IndexedPropertyChain;
import org.semanticweb.elk.reasoner.saturation.conclusions.model.BackwardLink;
import org.semanticweb.elk.reasoner.saturation.conclusions.model.ForwardLink;
import org.semanticweb.elk.reasoner.saturation.conclusions.model.SubPropertyChain;

/**
 * A common interface for inferences with premises {@link BackwardLink},
 * {@link SubPropertyChain}, {@link ForwardLink} and {@link SubPropertyChain}:

 * 
 * {@code
 *   (1)             (2)       (3)           (4)
 *  C ⊑ <∃R1>.[D]  R1 ⊑ R2  [D] ⊑ <∃P1>.E  P1 ⊑ P2  ...
 * ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
 *                      ...
 * }
 * 
 * The parameters can be obtained as follows:

 * 
 * R1 = {@link #getPremiseBackwardRelation()}

 * D = {@link #getOrigin()}

 * P1 = {@link #getPremiseForwardChain()}

 * E = {@link #getPremiseTarget()}

 * R2P2 = {@link #getComposition()} (from which R2 and P2 can be obtained)

 * 
 * @author "Yevgeny Kazakov"
 */
public interface LinkComposition extends ClassInference {

	/**
	 * @return the BackwardLink#getSource() of the first premise
	 */
	public IndexedContextRoot getPremiseSource();

	/**
	 * @return the {@link BackwardLink#getRelation()} of the first premise
	 */
	public IndexedObjectProperty getPremiseBackwardRelation();

	/**
	 * @return the {@link ForwardLink#getChain()} of the third premise
	 */
	public IndexedPropertyChain getPremiseForwardChain();

	/**
	 * @return the {@link ForwardLink#getTarget()} of the third premise
	 */
	public IndexedContextRoot getPremiseTarget();

	/**
	 * @return the {@link IndexedComplexPropertyChain} that is produced as the
	 *         result of the composition
	 */
	public IndexedComplexPropertyChain getComposition();

	/**
	 * @param factory
	 *            the factory for creating conclusions
	 * 
	 * @return the {@link BackwardLink} used as premise in this
	 *         {@link LinkComposition}; its {@link BackwardLink#getRelation()}
	 *         equals to {@link #getPremiseBackwardRelation()}
	 */
	public BackwardLink getFirstPremise(BackwardLink.Factory factory);

	/**
	 * @param factory
	 *            the factory for creating conclusions
	 * 
	 * @return the {@link SubPropertyChain} used as premise of this
	 *         {@link LinkComposition}; its
	 *         {@link SubPropertyChain#getSubChain()} equals to
	 *         {@link #getPremiseBackwardRelation()}
	 */
	public SubPropertyChain getSecondPremise(SubPropertyChain.Factory factory);

	/**
	 * @param factory
	 *            the factory for creating conclusions
	 * 
	 * @return the {@link ForwardLink} used as premise of this
	 *         {@link LinkComposition}; its {@link ForwardLink#getChain()}
	 *         equals to {@link #getPremiseForwardChain()}
	 */
	public ForwardLink getThirdPremise(ForwardLink.Factory factory);

	/**
	 * @param factory
	 *            the factory for creating conclusions
	 *            
	 * @return the {@link SubPropertyChain} used as premise of this
	 *         {@link LinkComposition}; its
	 *         {@link SubPropertyChain#getSubChain()} equals to
	 *         {@link #getPremiseForwardChain()}
	 */
	public SubPropertyChain getFourthPremise(SubPropertyChain.Factory factory);

	public  O accept(Visitor visitor);

	/**
	 * Visitor pattern for instances
	 * 
	 * @author Yevgeny Kazakov
	 *
	 * @param 
	 *            the type of the output
	 */
	public static interface Visitor
			extends
				BackwardLinkComposition.Visitor,
				ForwardLinkComposition.Visitor {

		// combined interface

	}

}