uk.ac.liv.pgb.analytica.lib.Task Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analytica-lib Show documentation

Library allowing generation of plots and data from proteomics and metabolomics mass spectrometry data through the use of R and java methods.

The newest version!

package uk.ac.liv.pgb.analytica.lib;

import java.io.File;

/**
 * Represents actions that a task, of any type, must support.
 * @author sperkins
 */
public interface Task {
    /**
     * Get the name of the task.
     * @return The task name.
     */
    String getName();

    /**
     * Checks whether the given file is compatible with this task.
     * @param file Input file.
     * @return True if the given file is compatible with this task.
     */
    boolean compatibleWith(File file);

    /**
     * Executes this task with the given file and graphics policy.
     * @param file The input file.
     * @param policy The graphics policy.
     * @return The execution result describing the output of the task.
     */
    TaskExecutionResult execute(File file, GraphicsPolicy policy);
}