Package com.compomics.util.io.export.features.peptideshaker

Enum PsSearchFeature

java.lang.Object
java.lang.Enum<PsSearchFeature>
com.compomics.util.io.export.features.peptideshaker.PsSearchFeature
All Implemented Interfaces:
ExportFeature, Serializable, Comparable<PsSearchFeature>, java.lang.constant.Constable
public enum PsSearchFeature extends Enum<PsSearchFeature> implements ExportFeature
This class lists the export features linked to the spectrum identification.
Author:
Marc Vaudel, Harald Barsnes

  • Enum Constant Details

    • precursor_tolerance_unit

      @SerializedName("PsSearchFeature.precursor_tolerance_unit") public static final PsSearchFeature precursor_tolerance_unit

    • precursor_tolerance

      @SerializedName("PsSearchFeature.precursor_tolerance") public static final PsSearchFeature precursor_tolerance

    • fragment_tolerance_unit

      @SerializedName("PsSearchFeature.fragment_tolerance_unit") public static final PsSearchFeature fragment_tolerance_unit

    • fragment_tolerance

      @SerializedName("PsSearchFeature.fragment_tolerance") public static final PsSearchFeature fragment_tolerance

    • cleavage

      @SerializedName("PsSearchFeature.cleavage") public static final PsSearchFeature cleavage

    • enzyme

      @SerializedName("PsSearchFeature.enzyme") public static final PsSearchFeature enzyme

    • mc

      @SerializedName("PsSearchFeature.mc") public static final PsSearchFeature mc

    • specificity

      @SerializedName("PsSearchFeature.specificity") public static final PsSearchFeature specificity

    • database

      @SerializedName("PsSearchFeature.database") public static final PsSearchFeature database

    • forward_ion

      @SerializedName("PsSearchFeature.forward_ion") public static final PsSearchFeature forward_ion

    • rewind_ion

      @SerializedName("PsSearchFeature.rewind_ion") public static final PsSearchFeature rewind_ion

    • fixed_modifications

      @SerializedName("PsSearchFeature.fixed_modifications") public static final PsSearchFeature fixed_modifications

    • variable_modifications

      @SerializedName("PsSearchFeature.variable_modifications") public static final PsSearchFeature variable_modifications

    • refinement_variable_modifications

      @SerializedName("PsSearchFeature.refinement_variable_modifications") public static final PsSearchFeature refinement_variable_modifications

    • refinement_fixed_modifications

      @SerializedName("PsSearchFeature.refinement_fixed_modifications") public static final PsSearchFeature refinement_fixed_modifications

  • Field Details

    • title

      public String title
      The title of the feature which will be used for column heading.

    • description

      public String description
      The description of the feature.

    • type

      public static final String type
      The type of export feature.
      See Also:

  • Method Details

    • values

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

    • getExportFeatures

      public ArrayList<ExportFeature> getExportFeatures(boolean includeSubFeatures)
      Description copied from interface: ExportFeature
      Returns a list of all implemented export features.
      Specified by:
      getExportFeatures in interface ExportFeature
      Parameters:
      includeSubFeatures - boolean indicating whether sub features should be included
      Returns:
      a list of all implemented export features

    • getTitle

      public String getTitle()
      Description copied from interface: ExportFeature
      Returns the column title of the feature.
      Specified by:
      getTitle in interface ExportFeature
      Returns:
      the column title of the feature

    • getDescription

      public String getDescription()
      Description copied from interface: ExportFeature
      Returns the description of the feature.
      Specified by:
      getDescription in interface ExportFeature
      Returns:
      the description of the feature

    • getFeatureFamily

      public String getFeatureFamily()
      Description copied from interface: ExportFeature
      Returns the family type of this export feature.
      Specified by:
      getFeatureFamily in interface ExportFeature
      Returns:
      the family type of this export feature

    • isAdvanced

      public boolean isAdvanced()
      Description copied from interface: ExportFeature
      Indicates whether a feature is for advanced user only.
      Specified by:
      isAdvanced in interface ExportFeature
      Returns:
      a boolean indicating whether a feature is for advanced user only