nl.uu.cs.ape.solver.solutionStructure.SolutionWorkflowNode 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.

The newest version!

package nl.uu.cs.ape.solver.solutionStructure;

import nl.uu.cs.ape.automaton.State;

/**
 * The {@code SolutionWorkflowNode} class is used to represent a node in the
 * actual solution workflow.
 *
 * @author Vedran Kasalica
 */
public abstract class SolutionWorkflowNode implements Comparable {

    /**
     * State in the automaton that the Node refers to.
     */
    private State automatonState;

    /**
     * Instantiates a new Solution workflow node.
     *
     * @param automatonState the automaton state
     */
    protected SolutionWorkflowNode(State automatonState) {
        this.automatonState = automatonState;
    }

    /**
     * Gets automaton state.
     *
     * @return the automaton state
     */
    public State getAutomatonState() {
        return this.automatonState;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((automatonState == null) ? 0 : automatonState.hashCode());
        return result;
    }

    /**
     * Two SolutionWorkflowNodes are equal if they represent the same state in the
     * workflow.
     *
     * @return true if the state that the describe is the same.
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        SolutionWorkflowNode other = (SolutionWorkflowNode) obj;
        if (automatonState == null) {
            if (other.automatonState != null)
                return false;
        } else if (!automatonState.equals(other.automatonState))
            return false;
        return true;
    }

    /**
     * Compares the two SolutionWorkflowNodes based on their order in the solution.
     * {@link State} is used to evaluate the absolute position of the node in the
     * workflow.
     *
     * @return a negative integer, zero, or a positive integer as this object is
     *         before than, equal to, or after than the specified
     *         SolutionWorkflowNode.
     */
    @Override
    public int compareTo(SolutionWorkflowNode otherNode) {
        return this.getAutomatonState().compareTo(otherNode.getAutomatonState());
    }

    /**
     * Gets unique node ID.
     *
     * @return The unique ID that identifies the node and should not be used for
     *         presentation.
     */
    public abstract String getNodeID();

    /**
     * Gets node long (full) label (e.g. containing OWL IRIs).
     *
     * @return A label that describes the node using full type and tool IDs (it is
     *         usually much longer than {@link #getNodeLabel()}.
     */
    public abstract String getNodeLongLabel();

    /**
     * Gets node label (e.g. containing OWL labels).
     *
     * @return A human readable and condensed label that describes the node.
     */
    public abstract String getNodeLabel();

}