Package ca.corefacility.bioinformatics.irida.model.enums

Enum AnalysisState

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COMPLETED
      An analysis that has completed and been loaded into IRIDA.
      COMPLETING
      An analysis that is complete but data needs to be transferred back into IRIDA.
      DOWNLOADING
      Deprecated.
      This is no longer a valid state.
      ERROR
      An analysis that was not successfully able to run.
      FINISHED_DOWNLOADING
      Deprecated.
      This is no longer a valid state.
      FINISHED_RUNNING
      An analysis that has finished running in the execution manager.
      NEW
      Occurs when an analysis is first entered for submission.
      POST_PROCESSING
      An analysis currently undergoing post processing
      PREPARED
      Occurs when an analysis is finished preparing.
      PREPARING
      Occurs when an analysis is starting to be submitted.
      RUNNING
      An analysis that is running in the execution manager.
      SUBMITTING
      Occurs when an analysis is first submitting.
      TRANSFERRED
      An analysis that has been transferred to IRIDA, but has not had post processing performed.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AnalysisState fromString​(java.lang.String stateString)
      Given a string defining a state, converts this to a AnalysisState.
      static java.util.List<AnalysisState> getRunningStates()
      Get the AnalysisStates that denote an AnalysisSubmission that has been picked up and is currently being processed.
      java.lang.String toString()
      static AnalysisState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AnalysisState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NEW

        public static final AnalysisState NEW
        Occurs when an analysis is first entered for submission.

      • DOWNLOADING

        @Deprecated(since="0.17.0")
public static final AnalysisState DOWNLOADING
        Deprecated.
        This is no longer a valid state. This must still exist in IRIDA in cases where this state has been recored in the audit tables.
        Occurs when an analysis is downloading remote files

      • FINISHED_DOWNLOADING

        @Deprecated(since="0.17.0")
public static final AnalysisState FINISHED_DOWNLOADING
        Deprecated.
        This is no longer a valid state. This must still exist in IRIDA in cases where this state has been recored in the audit tables.
        Occurs when an analysis has completed downloading remote files

      • PREPARING

        public static final AnalysisState PREPARING
        Occurs when an analysis is starting to be submitted.

      • PREPARED

        public static final AnalysisState PREPARED
        Occurs when an analysis is finished preparing.

      • SUBMITTING

        public static final AnalysisState SUBMITTING
        Occurs when an analysis is first submitting.

      • RUNNING

        public static final AnalysisState RUNNING
        An analysis that is running in the execution manager.

      • FINISHED_RUNNING

        public static final AnalysisState FINISHED_RUNNING
        An analysis that has finished running in the execution manager.

      • COMPLETING

        public static final AnalysisState COMPLETING
        An analysis that is complete but data needs to be transferred back into IRIDA.

      • COMPLETED

        public static final AnalysisState COMPLETED
        An analysis that has completed and been loaded into IRIDA.

      • TRANSFERRED

        public static final AnalysisState TRANSFERRED
        An analysis that has been transferred to IRIDA, but has not had post processing performed.

      • POST_PROCESSING

        public static final AnalysisState POST_PROCESSING
        An analysis currently undergoing post processing

      • ERROR

        public static final AnalysisState ERROR
        An analysis that was not successfully able to run.

    • Method Detail

      • values

        public static AnalysisState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AnalysisState c : AnalysisState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AnalysisState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromString

        public static AnalysisState fromString​(java.lang.String stateString)
        Given a string defining a state, converts this to a AnalysisState.
        Parameters:
        stateString - The string defining the state.
        Returns:
        A AnalysisState for the corresponding state.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<AnalysisState>