nl.uu.cs.ape.sat.automaton.ModuleAutomaton 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.sat.automaton;

import nl.uu.cs.ape.sat.models.enums.WorkflowElement;

import java.util.ArrayList;
import java.util.List;

/**
 * The {@code ModuleAutomaton} class is used to represent the module automaton. Module Automaton represents the structure that tools in the provided solutions will follow.
 * Module automaton is represented as an array of {@link State}.
 * 
 * Labeling of the automaton is provided in
 * /APE/res/WorkflowAutomaton_Implementation.png.
 *
 * @author Vedran Kasalica
 */
public class ModuleAutomaton implements Automaton {

    private List moduleStates;

    /**
     * Generate the Module State automatons based on the defined length.
     *
     * @param automataBound  Length of the automaton.
     * @param inputBranching Input branching factor (max number of inputs for modules).
     * @param outputBranching Output branching factor (max number of inputs for modules).
     */
    public ModuleAutomaton(int automataBound, int inputBranching, int outputBranching) {
        moduleStates = new ArrayList();
        automataBound = Math.max(automataBound, 1);

        for (int i = 1; i <= automataBound; i++) {
            State tmpState = new State(WorkflowElement.MODULE, null, i, inputBranching, outputBranching);
            moduleStates.add(tmpState);
        }
    }

    /**
     * Add {@link State} to the Module automaton.
     *
     * @param state Module state to be added.
     */
    public void addState(State state) {
        moduleStates.add(state);
    }

    /**
     * Return the size of the Module automaton.
     *
     * @return Current amount of module states.
     */
    public int size() {
        return moduleStates.size();
    }

    /**
     * Return {@code i}-th Module state from the automaton.
     *
     * @param i Ordering number of the state to be returned.
     * @return Module State.
     */
    public State get(int i) {
        return moduleStates.get(i);
    }

    /* (non-Javadoc)
     * @see nl.uu.cs.ape.sat.automaton.Automaton#getAllStates()
     */
    @Override
    public List getAllStates() {
        return moduleStates;
    }

    /**
     * Print.
     */
    public void print() {
        System.out.println("-------------------------------------------------------------");
        System.out.println("\tModule automaton:");
        System.out.println("-------------------------------------------------------------");
        for (State state : moduleStates) {
            System.out.println("\tModule state: " + state.getPredicateID() + ", order number: " + state.getAbsoluteStateNumber());
        }
        System.out.println("-------------------------------------------------------------");

    }
}