Package com.compomics.util.experiment.identification.validation

Enum MatchValidationLevel

java.lang.Object
java.lang.Enum<MatchValidationLevel>
com.compomics.util.experiment.identification.validation.MatchValidationLevel
All Implemented Interfaces:
Serializable, Comparable<MatchValidationLevel>, java.lang.constant.Constable
public enum MatchValidationLevel extends Enum<MatchValidationLevel>
Enum listing the different levels of match validation.
Author:
Marc Vaudel

  • Enum Constant Details

  • Method Details

    • values

      public static MatchValidationLevel[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static MatchValidationLevel valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getIndex

      public int getIndex()
      Returns the index associated to this possibility.
      Returns:
      the index associated to this possibility

    • getName

      public String getName()
      Returns the name of this possibility.
      Returns:
      the name of this possibility

    • isValidated

      public boolean isValidated()
      Indicates whether this level is considered as validated.
      Returns:
      a boolean indicating whether this level is considered as validated.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<MatchValidationLevel>

    • getIconMap

      public static HashMap<Integer,ImageIcon> getIconMap(Class tempClass)
      Returns the default map of icons for the validation levels.
      Parameters:
      tempClass - reference to the class needed to use getResource (use the getClass method)
      Returns:
      he default map of icons

    • getValidationLevels

      public static MatchValidationLevel[] getValidationLevels()
      Returns the implemented validation levels.
      Returns:
      the implemented validation levels

    • getValidationLevelIndexes

      public static int[] getValidationLevelIndexes()
      Returns an array of the validation level indexes in ascending order of confidence.
      Returns:
      an array of the validation level indexes

    • getTooltipMap

      public static HashMap<Integer,String> getTooltipMap()
      Returns the default map of icons for the validation levels.
      Returns:
      he default map of icons

    • getValidationLevelsNames

      public static String[] getValidationLevelsNames()
      Returns a list of the names of the implemented validation levels.
      Returns:
      a list of the names of the implemented validation levels

    • getMatchValidationLevel

      public static MatchValidationLevel getMatchValidationLevel(String name)
      Returns the match validation level associated to a given name.
      Parameters:
      name - the name
      Returns:
      the match validation level associated to a given name

    • getMatchValidationLevel

      public static MatchValidationLevel getMatchValidationLevel(int index)
      Returns the match validation level associated to a given index.
      Parameters:
      index - the index
      Returns:
      the match validation level associated to a given index