nl.uu.cs.ape.models.AbstractModule Maven / Gradle / Ivy

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.models;

import java.util.List;

import nl.uu.cs.ape.utils.APEUtils;
import nl.uu.cs.ape.models.enums.NodeType;
import nl.uu.cs.ape.models.logic.constructs.TaxonomyPredicate;

/**
 * The {@code AbstractModule} class represents modules/tools provided by the
 * Module Taxonomy as well as their abstraction classes. Instances of
 * {@link AbstractModule} can be actual tools or their abstraction classes,
 * while all instances of the actual tools are extended to {@link Module}.
 *
 * @author Vedran Kasalica
 */
public class AbstractModule extends TaxonomyPredicate {

    private final String moduleName;
    private final String moduleID;

    /**
     * Creates an abstract module from {@code moduleName} and {@code moduleID}.
     *
     * @param moduleName Name of the module.
     * @param moduleID   Unique module identifier.
     * @param rootNode   ID of the Taxonomy Root node corresponding to the Module.
     * @param nodeType   {@link NodeType} object describing the type w.r.t. the
     *                   Module Taxonomy.
     */
    public AbstractModule(String moduleName, String moduleID, String rootNode, NodeType nodeType) {
        super(rootNode, nodeType);
        this.moduleName = moduleName;
        this.moduleID = moduleID;
    }

    /**
     * Generate an AbstractModule from an existing one. In order to provide means
     * for combining Module and AbstractModule objects.
     *
     * @param abstractModule Abstract module that is being copied
     * @param nodeType       {@link NodeType} object describing the type w.r.t. the
     *                       Module Taxonomy.
     */
    public AbstractModule(TaxonomyPredicate abstractModule, NodeType nodeType) {
        super(abstractModule, (nodeType != null) ? nodeType : abstractModule.getNodeType());
        this.moduleName = abstractModule.getPredicateLabel();
        this.moduleID = abstractModule.getPredicateID();
    }

    @Override
    public String getPredicateID() {
        return moduleID;
    }

    @Override
    public String getPredicateLabel() {
        return moduleName;
    }

    @Override
    public String getPredicateLongLabel() {
        if (moduleID.endsWith("[tool]")) {
            return APEUtils.removeNLastChar(moduleID, 6);
        } else {
            return moduleID;
        }
    }

    /**
     * Returns null. Abstract classes do not have input types.
     *
     * @return null module input
     */
    public List getModuleInput() {
        return null;
    }

    /**
     * Returns null. Abstract classes do not have output types.
     *
     * @return null module output
     */
    public List getModuleOutput() {
        return null;
    }

    @Override
    public String getType() {
        return "abstract module";
    }

}