fr.lirmm.graphik.integraal.api.backward_chaining.QueryRewriterWithCompilation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integraal-graal-ruleset-analysis Show documentation
Rule base analysis for InteGraal. This is imported from Graal
The newest version!
/*
 * Copyright (C) Inria Sophia Antipolis - Méditerranée / LIRMM
 * (Université de Montpellier & CNRS) (2014 - 2017)
 *
 * Contributors :
 *
 * Clément SIPIETER 
 * Mélanie KÖNIG
 * Swan ROCHER
 * Jean-François BAGET
 * Michel LECLÈRE
 * Marie-Laure MUGNIER 
 *
 *
 * This file is part of Graal .
 *
 * This software is governed by the CeCILL  license under French law and
 * abiding by the rules of distribution of free software.  You can  use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */
package fr.lirmm.graphik.integraal.api.backward_chaining;

import fr.lirmm.graphik.integraal.api.core.ConjunctiveQuery;
import fr.lirmm.graphik.integraal.api.core.EffectiveConjunctiveQuery;
import fr.lirmm.graphik.integraal.api.core.Rule;
import fr.lirmm.graphik.integraal.api.core.RulesCompilation;
import fr.lirmm.graphik.integraal.api.util.TimeoutException;
import fr.lirmm.graphik.util.stream.CloseableIterator;

/**
 * @author Clément Sipieter (INRIA) {@literal }
 *
 */
public interface QueryRewriterWithCompilation extends QueryRewriter {

	/**
	 * Rewrite the specified query using the specified set of rules and compilation. 
	 * @param query
	 * @param rules
	 * @param compilation
	 * @return an Iterator over the rewritings.
	 */
	CloseableIterator execute(ConjunctiveQuery query, Iterable rules,
	    RulesCompilation compilation);

	/**
	 * Rewrite the specified query using the specified set of rules and compilation. If the method execution time exceed the specified timeout (in milliseconds) then 
	 * the method will be interrupted and a {@link TimeoutException} will be throw.
	 * @param query
	 * @param rules
	 * @param compilation
	 * @param timeout
	 * @return an Iterator over the rewritings.
	 * @throws TimeoutException
	 */
	CloseableIterator execute(ConjunctiveQuery query, Iterable rules,
		    RulesCompilation compilation, long timeout) throws TimeoutException;
}