nl.uu.cs.ape.models.AuxModulePredicate 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.models;

import java.util.Collection;
import java.util.SortedSet;
import java.util.TreeSet;

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

/**
 * The {@code AuxModulePredicate} class represents an abstract class used
 * strictly to represent artificially generated modules, used to abstract
 * over existing taxonomy terms. Objects of this class represent disjunctions
 * of conjunctions of existing modules.
 *
 * @author Vedran Kasalica
 */
public class AuxModulePredicate extends AbstractModule implements AuxiliaryPredicate {

    /**
     * Modules that are generalized with the auxiliary predicate.
     */
    private SortedSet containingPredicates;

    /**
     * Field defines the connective between the subclasses of the predicate.
     */
    private final LogicOperation logicOp;

    /**
     * Create an auxiliary predicate.

     * 

     * It is recommended to use the method
     * {@link AuxModulePredicate#generateAuxiliaryPredicate} to generate an
     * auxiliary object.
     *
     * @param moduleName           - name of the auxiliary module predicate
     * @param moduleID             - ID of the auxiliary module predicate
     * @param rootNode             - module root node
     * @param containingPredicates - collection of module predicates that comprise
     *                             the auxiliary predicate
     * @param logicOp              - logical operation that binds the comprised
     *                             predicates
     */
    private AuxModulePredicate(String moduleName, String moduleID, String rootNode,
            Collection containingPredicates, LogicOperation logicOp) {
        super(moduleName, moduleID, rootNode, NodeType.ABSTRACT);
        this.logicOp = logicOp;
        this.containingPredicates = new TreeSet();
        this.containingPredicates.addAll(containingPredicates);
    }

    /**
     * Method used to generate a new predicate that should provide an interface for
     * handling multiple predicates.
     * New predicated is used to simplify interaction with a set of related
     * tools/types.
     * 
     * The original predicates are available as consumed predicates(see
     * {@link AuxModulePredicate#getGeneralizedPredicates()}) of the new
     * {@link TaxonomyPredicate}.
     *
     * @param relatedPredicates Set of sorted type that are logically related to the
     *                          new abstract type (label of the equivalent sets is
     *                          always the same due to its ordering).
     * @param logicOp           Logical operation that describes the relation
     *                          between the types.
     * @param domainSetup       - domain model
     * 
     * @return An abstract predicate that provides abstraction over a
     *         disjunction/conjunction of the labels.
     */
    public static AbstractModule generateAuxiliaryPredicate(SortedSet relatedPredicates,
            LogicOperation logicOp, APEDomainSetup domainSetup) {
        if (relatedPredicates.isEmpty()) {
            return null;
        }
        if (relatedPredicates.size() == 1) {
            return (AbstractModule) relatedPredicates.first();
        }
        String abstractLabel = APEUtils.getLabelFromList(relatedPredicates, logicOp);

        AuxModulePredicate newAbsType = (AuxModulePredicate) domainSetup.getAllModules()
                .addPredicate(new AuxModulePredicate(abstractLabel, abstractLabel,
                        relatedPredicates.first().getRootNodeID(), relatedPredicates, logicOp));

        if (newAbsType != null) {
            domainSetup.addHelperPredicate(newAbsType);
            newAbsType.setAsRelevantTaxonomyTerm(domainSetup.getAllModules());
        }
        return newAbsType;
    }

    public LogicOperation getLogicOp() {
        return logicOp;
    }

    public SortedSet getGeneralizedPredicates() {
        return this.containingPredicates;
    }

}