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

Enum PsValidationFeature

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

  • Enum Constant Details

    • validated_protein

      @SerializedName("PsValidationFeature.validated_protein") public static final PsValidationFeature validated_protein

    • total_protein

      @SerializedName("PsValidationFeature.total_protein") public static final PsValidationFeature total_protein

    • protein_fdr

      @SerializedName("PsValidationFeature.protein_fdr") public static final PsValidationFeature protein_fdr

    • protein_fnr

      @SerializedName("PsValidationFeature.protein_fnr") public static final PsValidationFeature protein_fnr

    • protein_confidence

      @SerializedName("PsValidationFeature.protein_confidence") public static final PsValidationFeature protein_confidence

    • protein_pep

      @SerializedName("PsValidationFeature.protein_pep") public static final PsValidationFeature protein_pep

    • protein_accuracy

      @SerializedName("PsValidationFeature.protein_accuracy") public static final PsValidationFeature protein_accuracy

    • validated_peptide

      @SerializedName("PsValidationFeature.validated_peptide") public static final PsValidationFeature validated_peptide

    • total_peptide

      @SerializedName("PsValidationFeature.total_peptide") public static final PsValidationFeature total_peptide

    • peptide_fdr

      @SerializedName("PsValidationFeature.peptide_fdr") public static final PsValidationFeature peptide_fdr

    • peptide_fnr

      @SerializedName("PsValidationFeature.peptide_fnr") public static final PsValidationFeature peptide_fnr

    • peptide_confidence

      @SerializedName("PsValidationFeature.peptide_confidence") public static final PsValidationFeature peptide_confidence

    • peptide_pep

      @SerializedName("PsValidationFeature.peptide_pep") public static final PsValidationFeature peptide_pep

    • peptide_accuracy

      @SerializedName("PsValidationFeature.peptide_accuracy") public static final PsValidationFeature peptide_accuracy

    • validated_psm

      @SerializedName("PsValidationFeature.validated_psm") public static final PsValidationFeature validated_psm

    • total_psm

      @SerializedName("PsValidationFeature.total_psm") public static final PsValidationFeature total_psm

    • psm_fdr

      @SerializedName("PsValidationFeature.psm_fdr") public static final PsValidationFeature psm_fdr

    • psm_fnr

      @SerializedName("PsValidationFeature.psm_fnr") public static final PsValidationFeature psm_fnr

    • psm_confidence

      @SerializedName("PsValidationFeature.psm_confidence") public static final PsValidationFeature psm_confidence

    • psm_pep

      @SerializedName("PsValidationFeature.psm_pep") public static final PsValidationFeature psm_pep

    • psm_accuracy

      @SerializedName("PsValidationFeature.psm_accuracy") public static final PsValidationFeature psm_accuracy

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