Enum PeptideFilterItem
java.lang.Object
java.lang.Enum<PeptideFilterItem>
com.compomics.util.experiment.identification.filtering.items.PeptideFilterItem
- All Implemented Interfaces:
FilterItem
,Serializable
,Comparable<PeptideFilterItem>
,java.lang.constant.Constable
public enum PeptideFilterItem extends Enum<PeptideFilterItem> implements FilterItem
Enum of the different items a peptide filter can filter on.
- Author:
- Marc Vaudel
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description confidence
modification
nConfidentPSMs
nPSMs
nValidatedPSMs
proteinAccession
proteinDescription
proteinInference
sequence
stared
validationStatus
-
Field Summary
Fields Modifier and Type Field Description String
description
The description of the filtering item.String
name
The name of the filtering item. -
Method Summary
Modifier and Type Method Description String
getDescription()
Returns a description of the item.static PeptideFilterItem
getItem(String itemName)
Returns the item designated by the given name.String
getName()
Returns the name of the item.ArrayList<String>
getPossibilities()
In case the filter has predefined values, return the possible values, null otherwise.FilterItem[]
getPossibleValues()
Returns the possible items of this kind.boolean
isNumber()
Indicates whether the item expects a number as threshold.boolean
needsModifications()
Indicates whether the item expects a list of modifications to filter on.static PeptideFilterItem
valueOf(String name)
Returns the enum constant of this type with the specified name.static PeptideFilterItem[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
Field Details
-
name
The name of the filtering item. -
description
The description of the filtering item.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getItem
Returns the item designated by the given name.- Parameters:
itemName
- the name of the item of interest- Returns:
- the item of interest
-
getName
Description copied from interface:FilterItem
Returns the name of the item.- Specified by:
getName
in interfaceFilterItem
- Returns:
- the name of the item
-
getDescription
Description copied from interface:FilterItem
Returns a description of the item.- Specified by:
getDescription
in interfaceFilterItem
- Returns:
- a description of the item
-
getPossibleValues
Description copied from interface:FilterItem
Returns the possible items of this kind.- Specified by:
getPossibleValues
in interfaceFilterItem
- Returns:
- the possible items of this kind
-
isNumber
public boolean isNumber()Description copied from interface:FilterItem
Indicates whether the item expects a number as threshold.- Specified by:
isNumber
in interfaceFilterItem
- Returns:
- a boolean indicating whether the item expects a number as threshold
-
getPossibilities
Description copied from interface:FilterItem
In case the filter has predefined values, return the possible values, null otherwise.- Specified by:
getPossibilities
in interfaceFilterItem
- Returns:
- a list of possible values to select from
-
needsModifications
public boolean needsModifications()Description copied from interface:FilterItem
Indicates whether the item expects a list of modifications to filter on.- Specified by:
needsModifications
in interfaceFilterItem
- Returns:
- a boolean indicating whether the item expects a list of modifications to filter on
-