eu.isas.peptideshaker.followup

Enum ProgenesisExport.ExportType

java.lang.Object

java.lang.Enum<ProgenesisExport.ExportType>

eu.isas.peptideshaker.followup.ProgenesisExport.ExportType

All Implemented Interfaces:

Serializable, Comparable<ProgenesisExport.ExportType>

Enclosing class:

ProgenesisExport

public static enum ProgenesisExport.ExportType
extends Enum<ProgenesisExport.ExportType>

Enum of the different types of export implemented.

Enum Constant Summary

Enum Constants

Enum Constant and Description
confident_ptms Exports the Confidently localized PTMs of Validated PSMs of Validated Peptides of Validated Proteins
validated_psms Exports the spectra of validated PSMs.
validated_psms_peptides Exports the spectra of validated PSMs of validated peptides.
validated_psms_peptides_proteins Exports the spectra of validated PSMs of validated peptides of validated proteins.

Field Summary

Fields

Modifier and Type	Field and Description
String	description Description of the export.
int	index Index for the export type.

Method Summary

Modifier and Type	Method and Description
static String	getCommandLineOptions() Returns a description of the command line arguments.
static String[]	getPossibilities() Returns all possibilities descriptions in an array of string.
static ProgenesisExport.ExportType	getTypeFromIndex(int index) Returns the export type corresponding to a given index.
static ProgenesisExport.ExportType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgenesisExport.ExportType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

validated_psms_peptides_proteins

public static final ProgenesisExport.ExportType validated_psms_peptides_proteins

Exports the spectra of validated PSMs of validated peptides of validated proteins.

validated_psms_peptides

public static final ProgenesisExport.ExportType validated_psms_peptides

Exports the spectra of validated PSMs of validated peptides.

validated_psms

public static final ProgenesisExport.ExportType validated_psms

Exports the spectra of validated PSMs.

confident_ptms

public static final ProgenesisExport.ExportType confident_ptms

Exports the Confidently localized PTMs of Validated PSMs of Validated Peptides of Validated Proteins

Field Detail

index

public int index

Index for the export type.

description

public String description

Description of the export.

Method Detail

values

public static ProgenesisExport.ExportType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProgenesisExport.ExportType c : ProgenesisExport.ExportType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProgenesisExport.ExportType 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

getTypeFromIndex

public static ProgenesisExport.ExportType getTypeFromIndex(int index)

Returns the export type corresponding to a given index.

Parameters:

index - the index of interest

Returns:

the export type

getPossibilities

public static String[] getPossibilities()

Returns all possibilities descriptions in an array of string. Tip: the position in the array corresponds to the type index.

Returns:

all possibilities descriptions in an array of string

getCommandLineOptions

public static String getCommandLineOptions()

Returns a description of the command line arguments.

Returns:

a description of the command line arguments