nl.uu.cs.ape.domain.APEDimensionsException 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.domain;

/**
 * The {@code APEDataDimensionsOverlapException} exception will be thrown if the
 * data dimensions are not annotated properly.
 * 
 * @author Vedran Kasalica
 *
 */
public class APEDimensionsException extends RuntimeException {

    /**
     * Instantiates a new Ape exception.
     *
     * @param message The message that will be passed to the {@link Exception} super
     *                class.
     */
    private APEDimensionsException(String message) {
        super(message);
    }

    /**
     * Exception is thrown when the dimensions described in the OWL file have
     * overlaps.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return Dimensions exception with information that may help the user solve
     *         the problem.
     */
    public static APEDimensionsException dimensionsOverlap(String message) {
        return new APEDimensionsException(String.format("The data dimensions cannot overlap. %s", message));
    }

    /**
     * Exception is thrown when a dimension expected does not exist.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return Dimensions exception with information that may help the user solve
     *         the problem.
     */
    public static APEDimensionsException notExistingDimension(String message) {
        return new APEDimensionsException(String.format("The dimension does not exist. %s", message));
    }

    /**
     * Exception is thrown when a dimension does not contain the specified subclass.
     * 
     * @param message - Application specific message that may help the user solve
     *                the problem.
     * @return Dimensions exception with information that may help the user solve
     *         the problem.
     */
    public static APEDimensionsException dimensionDoesNotContainClass(String message) {
        return new APEDimensionsException(
                String.format("The data dimension does not contain the specified subclass. %s", message));
    }
}