com.compomics.util.experiment.personalization

Interface UrParameter

All Superinterfaces:

Serializable

All Known Implementing Classes:

PepnovoAssumptionDetails, TagAssumption

public interface UrParameter
extends Serializable

This interface will be used to reference refined parameters. Utilities Refined parameters are referenced by a family name (for example Peptizer) and an integer indexing the parameter in the family. If your implementation of an ExperimentObject was a protein this would be a PTM... Acknowledging the great creativity of the code comments would be greatly appreciated!

Author:

Marc Vaudel

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID The version UID for Serialization/Deserialization compatibility

Method Summary

Modifier and Type	Method and Description
String	getFamilyName() This method returns the family name of the parameter.
int	getIndex() This method returns the index of the parameter.

Field Detail

serialVersionUID

static final long serialVersionUID

The version UID for Serialization/Deserialization compatibility

See Also:

Constant Field Values

Method Detail

getFamilyName

String getFamilyName()

This method returns the family name of the parameter. Shall not contain '|'.

Returns:

family name

getIndex

int getIndex()

This method returns the index of the parameter. Shall not contain '|'.

Returns:

the index of the parameter