Package com.compomics.util.experiment.identification.filtering.items

Enum AssumptionFilterItem

java.lang.Object
java.lang.Enum<AssumptionFilterItem>
com.compomics.util.experiment.identification.filtering.items.AssumptionFilterItem
All Implemented Interfaces:
FilterItem, Serializable, Comparable<AssumptionFilterItem>, java.lang.constant.Constable
public enum AssumptionFilterItem extends Enum<AssumptionFilterItem> implements FilterItem
Enum of the different items an assumption filter can filter on.
Author:
Marc Vaudel

  • Enum Constant Details

  • Field Details

    • name

      public final String name
      The name of the filtering item.

    • description

      public final String description
      The description of the filtering item.

  • Method Details

    • values

      public static AssumptionFilterItem[] 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 AssumptionFilterItem 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

    • getItem

      public static AssumptionFilterItem getItem(String itemName)
      Returns the item designated by the given name.
      Parameters:
      itemName - the name of the item of interest
      Returns:
      the item of interest

    • getName

      public String getName()
      Description copied from interface: FilterItem
      Returns the name of the item.
      Specified by:
      getName in interface FilterItem
      Returns:
      the name of the item

    • getDescription

      public String getDescription()
      Description copied from interface: FilterItem
      Returns a description of the item.
      Specified by:
      getDescription in interface FilterItem
      Returns:
      a description of the item

    • getPossibleValues

      public FilterItem[] getPossibleValues()
      Description copied from interface: FilterItem
      Returns the possible items of this kind.
      Specified by:
      getPossibleValues in interface FilterItem
      Returns:
      the possible items of this kind

    • isNumber

      public boolean isNumber()
      Description copied from interface: FilterItem
      Indicates whether the item expects a number as threshold.
      Specified by:
      isNumber in interface FilterItem
      Returns:
      a boolean indicating whether the item expects a number as threshold

    • getPossibilities

      public ArrayList<String> getPossibilities()
      Description copied from interface: FilterItem
      In case the filter has predefined values, return the possible values, null otherwise.
      Specified by:
      getPossibilities in interface FilterItem
      Returns:
      a list of possible values to select from

    • needsModifications

      public boolean needsModifications()
      Description copied from interface: FilterItem
      Indicates whether the item expects a list of modifications to filter on.
      Specified by:
      needsModifications in interface FilterItem
      Returns:
      a boolean indicating whether the item expects a list of modifications to filter on