Package fr.ens.biologie.genomique.eoulsan.checkers

Interface Checker

All Known Implementing Classes:
DESeq2DesignChecker, GenomeChecker, GFFChecker, GTFChecker, ReadsChecker
public interface Checker
This interface define a checker.
Since:
1.0
Author:
Laurent Jourdren

  • Method Details

    • getName

      String getName()
      Get the name of the checker.
      Returns:
      the name of the checker

    • isDesignChecker

      boolean isDesignChecker()
      Test if the Checker is a design checker.
      Returns:
      true if this a design checker

    • getFormat

      DataFormat getFormat()
      Get format related to the checker.
      Returns:
      a DataFormat object

    • configure

      void configure(Set<Parameter> stepParameters) throws EoulsanException
      Set the parameters of the checker to configure the checker.
      Parameters:
      stepParameters - parameters of the step
      Throws:
      EoulsanException - if a parameter is invalid

    • check

      boolean check(Data data, CheckStore checkInfo) throws EoulsanException
      Launch the check.
      Parameters:
      data - data to check
      checkInfo - object that contains data shared between the checkers
      Returns:
      true if check pass
      Throws:
      EoulsanException - if an error occurs while executing step

    • getCheckersRequired

      Set<DataFormat> getCheckersRequired()
      Get the list of Checker required to run before this checker.
      Returns:
      a list of DataFormat that are checked by the required checkers