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

Enum PsSpectrumCountingFeature

java.lang.Object

java.lang.Enum<PsSpectrumCountingFeature>

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

All Implemented Interfaces:

ExportFeature, Serializable, Comparable<PsSpectrumCountingFeature>, java.lang.constant.Constable

public enum PsSpectrumCountingFeature
extends Enum<PsSpectrumCountingFeature>
implements ExportFeature

This class lists all the export features related to the spectrum counting.

Author:

Marc Vaudel, Harald Barsnes

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
method
validated

Field Summary

Fields

Modifier and Type	Field	Description
String	description	The description of the feature.
String	title	The title of the feature which will be used for column heading.
static final String	type	The type of export feature.

Fields inherited from interface com.compomics.util.io.export.ExportFeature

serialVersionUID

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the feature.
ArrayList<ExportFeature>	getExportFeatures(boolean includeSubFeatures)	Returns a list of all implemented export features.
String	getFeatureFamily()	Returns the family type of this export feature.
String	getTitle()	Returns the column title of the feature.
boolean	isAdvanced()	Indicates whether a feature is for advanced user only.
static PsSpectrumCountingFeature	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PsSpectrumCountingFeature[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

method

@SerializedName("PsSpectrumCountingFeature.method")
public static final PsSpectrumCountingFeature method

validated

@SerializedName("PsSpectrumCountingFeature.validated")
public static final PsSpectrumCountingFeature validated

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:

• Constant Field Values

Method Details

values

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