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

Enum PsFragmentFeature

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

  • Enum Constant Details

    • annotation

      @SerializedName("PsFragmentFeature.annotation") public static final PsFragmentFeature annotation

    • fragment_type

      @SerializedName("PsFragmentFeature.fragment_type") public static final PsFragmentFeature fragment_type

    • fragment_subType

      @SerializedName("PsFragmentFeature.fragment_subType") public static final PsFragmentFeature fragment_subType

    • fragment_number

      @SerializedName("PsFragmentFeature.fragment_number") public static final PsFragmentFeature fragment_number

    • fragment_losses

      @SerializedName("PsFragmentFeature.fragment_losses") public static final PsFragmentFeature fragment_losses

    • fragment_name

      @SerializedName("PsFragmentFeature.fragment_name") public static final PsFragmentFeature fragment_name

    • fragment_charge

      @SerializedName("PsFragmentFeature.fragment_charge") public static final PsFragmentFeature fragment_charge

    • theoretic_mz

      @SerializedName("PsFragmentFeature.theoretic_mz") public static final PsFragmentFeature theoretic_mz

    • mz

      @SerializedName("PsFragmentFeature.mz") public static final PsFragmentFeature mz

    • intensity

      @SerializedName("PsFragmentFeature.intensity") public static final PsFragmentFeature intensity

    • error_Da

      @SerializedName("PsFragmentFeature.error_Da") public static final PsFragmentFeature error_Da

    • error_ppm

      @SerializedName("PsFragmentFeature.error_ppm") public static final PsFragmentFeature error_ppm

  • 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 PsFragmentFeature[] 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 PsFragmentFeature 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