Package com.compomics.util.experiment.identification.peptide_fragmentation.models.ms2pip.features_configuration

Class FeaturesMap

java.lang.Object

com.compomics.util.experiment.identification.peptide_fragmentation.models.ms2pip.features_configuration.FeaturesMap

public class FeaturesMap
extends Object

This class contains a map of selected features indexed by category.

Author:

Marc Vaudel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	currentVersion	Current version of the features.

Constructor Summary

Constructors

Constructor	Description
FeaturesMap()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addFeature(Ms2pipFeature ms2pipFeature)	Adds a feature to the map.
Set<String>	getCategories()	Returns the different categories of the features in this map.
Ms2pipFeature[]	getFeatures(String category)	Returns the features in the map for the given category.
int	getnFeatures()	Returns the number of features in the map.
String[]	getSortedFeaturesList()	Returns a sorted list of features categories.
int	getVersion()	Returns the version of the features used to create the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

currentVersion

public static final int currentVersion

Current version of the features. This number should be incremented when non backward compatible changes are made to the implemented features.

See Also:

• Constant Field Values

Constructor Details

FeaturesMap

public FeaturesMap()

Constructor.

Method Details

getVersion

public int getVersion()

Returns the version of the features used to create the map.

Returns:

the version of the features used to create the map

addFeature

public void addFeature(Ms2pipFeature ms2pipFeature)

Adds a feature to the map.

Parameters:

ms2pipFeature - the feature to add.

getCategories

public Set<String> getCategories()

Returns the different categories of the features in this map.

Returns:

the different categories of the features in this map

getSortedFeaturesList

public String[] getSortedFeaturesList()

Returns a sorted list of features categories.

Returns:

a sorted list of features categories

getFeatures

public Ms2pipFeature[] getFeatures(String category)

Returns the features in the map for the given category.

Parameters:

category - the category.

Returns:

the list of features in the map for the given category

getnFeatures

public int getnFeatures()

Returns the number of features in the map.

Returns:

the number of features in the map