nl.uu.cs.ape.solver.SynthesisEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of APE Show documentation

APE is a command line tool and an API for the automated exploration of possible computational pipelines (workflows) from large collections of computational tools.

There is a newer version: 2.3.0

Show newest version

package nl.uu.cs.ape.solver;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.List;

import nl.uu.cs.ape.automaton.TypeAutomaton;
import nl.uu.cs.ape.domain.APEDomainSetup;
import nl.uu.cs.ape.models.SATAtomMappings;
import nl.uu.cs.ape.solver.solutionStructure.SolutionWorkflow;

/**
 * The {@code SynthesisEngine} interface is used to facilitate different
 * synthesis implementations over the given input.
 *
 * @author Vedran Kasalica
 */
public interface SynthesisEngine {

	/**
	 * Synthesis encoding boolean.
	 *
	 * @return True if the encoding was successful, false otherwise.
	 * @throws IOException the io exception
	 */
	public boolean synthesisEncoding() throws IOException;

	/**
	 * Synthesis execution boolean.
	 *
	 * @return List of solutions.
	 * @throws IOException           sat encoding not defined
	 * @throws FileNotFoundException Configuration file error
	 */
	public List synthesisExecution() throws FileNotFoundException, IOException;

	/**
	 * Get type automaton.
	 * 
	 * @return The type automaton.
	 */
	public TypeAutomaton getTypeAutomaton();

	/**
	 * Get domain model.
	 * 
	 * @return Object that contains the domain model annotations, params, etc.
	 */
	public APEDomainSetup getDomainSetup();

	/**
	 * Get atom mappings
	 * 
	 * @return Atom mappings.
	 */
	public SATAtomMappings getMappings();

	/**
	 * Get current solution size.
	 * 
	 * @return Size of the solution as int.
	 */
	public int getSolutionSize();

	/**
	 * Delete all temp files generated.
	 */
	public void deleteTempFiles() throws IOException;

}