com.compomics.util.experiment.biology

Class Peptide

java.lang.Object

com.compomics.util.experiment.personalization.ExperimentObject

com.compomics.util.experiment.biology.Peptide

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Peptide
extends ExperimentObject

This class models a peptide.

Author:

Marc Vaudel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODIFICATION_LOCALIZATION_SEPARATOR Separator preceding confident localization of the confident localization of a modification
static java.lang.String	MODIFICATION_SEPARATOR Separator used to separate modifications in peptide keys

Constructor Summary

Constructors

Constructor and Description
Peptide() Constructor for the peptide.
Peptide(java.lang.String aSequence, java.util.ArrayList<ModificationMatch> modifications) Constructor for the peptide.
Peptide(java.lang.String aSequence, java.util.ArrayList<java.lang.String> parentProteins, java.util.ArrayList<ModificationMatch> modifications) Deprecated. use peptide without proteins and remap the peptide to the proteins a posteriori instead
Peptide(java.lang.String aSequence, java.lang.Double mass, java.util.ArrayList<java.lang.String> parentProteins, java.util.ArrayList<ModificationMatch> modifications) Deprecated. use the constructor without mass. The mass will be recalculated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModificationMatch(ModificationMatch modificationMatch) Adds a modification match.
void	clearModificationMatches() Clears the list of imported modification matches.
void	estimateTheoreticMass() Estimates the theoretic mass of the peptide.
java.lang.String	getCTerminal() Returns the C-terminal of the peptide as a String.
java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>>	getIndexedFixedModifications() Returns an indexed map of all fixed modifications amino acid, (1 is the first) -> list of modification names.
java.lang.String	getKey() Returns the reference key of a peptide.
static java.lang.String	getKey(java.lang.String sequence, java.util.ArrayList<ModificationMatch> modificationMatches) Returns the reference key of a peptide.
java.lang.Double	getMass() Getter for the mass.
java.lang.String	getMatchingKey(AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns a unique key for the peptide when considering the given matching type and mass tolerance.
static int	getModificationCount(java.lang.String peptideKey, java.lang.String modification) Returns how many of the given modification was found in the given peptide.
static java.util.ArrayList<java.lang.String>	getModificationFamily(java.lang.String peptideKey) Returns a list of names of the variable modifications found in the key of a peptide.
java.util.ArrayList<ModificationMatch>	getModificationMatches() Getter for the modifications carried by this peptide.
java.util.ArrayList<java.lang.Integer>	getModifiedIndexes() Returns the indexes of the residues in the peptide that contain at least one variable modification.
java.util.ArrayList<java.lang.Integer>	getModifiedIndexes(boolean excludeFixed) Returns the indexes of the residues in the peptide that contain at least one modification.
int	getNMissedCleavages(Enzyme enzyme) Returns the number of missed cleavages using the specified enzyme.
static int	getNMissedCleavages(java.lang.String sequence, Enzyme enzyme) Returns the number of missed cleavages using the specified enzyme for the given sequence.
static java.util.ArrayList<java.lang.Integer>	getNModificationLocalized(java.lang.String peptideKey, java.lang.String modification) Returns the list of modifications confidently localized or inferred for the peptide indexed by the given key.
static Peptide	getNoModPeptide(Peptide peptide, java.util.ArrayList<PTM> ptms) Returns a version of the peptide which does not contain the inspected PTMs.
java.lang.String	getNTerminal() Returns the N-terminal of the peptide as a String.
int	getNVariableModifications(double modificationMass) Returns the number of variable modifications found with the given mass.
java.util.ArrayList<java.lang.String>	getParentProteins(AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns the parent proteins and remaps the peptide to the protein if no protein mapping was set using the default protein tree of the sequence factory.
java.util.ArrayList<java.lang.String>	getParentProteins(AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance, ProteinTree proteinTree) Returns the parent proteins and remaps the peptide to the protein if no protein mapping was set.
java.util.ArrayList<java.lang.String>	getParentProteins(boolean remap, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns the parent proteins and eventually remaps the peptide to the protein using the default protein tree.
java.util.ArrayList<java.lang.String>	getParentProteins(boolean remap, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance, ProteinTree proteinTree) Returns the parent proteins and eventually remaps the peptide to the protein.
java.util.ArrayList<java.lang.String>	getParentProteinsNoRemapping() Returns the parent proteins without remapping them.
java.util.ArrayList<java.lang.Integer>	getPotentialModificationSites(java.lang.Double ptmMass, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance, ModificationProfile modificationProfile) Returns the potential modification sites as an ordered list of string.
java.util.ArrayList<java.lang.Integer>	getPotentialModificationSites(PTM ptm, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns the potential modification sites as an ordered list of string.
static java.util.ArrayList<java.lang.Integer>	getPotentialModificationSites(java.lang.String sequence, PTM ptm) Deprecated. use getPotentialModificationSites(PTM ptm, AminoAcidPattern.MatchingType matchingType, Double massTolerance)
java.lang.String	getSequence() Getter for the sequence.
static java.lang.String	getSequence(java.lang.String peptideKey) Returns the sequence of the peptide indexed by the given key.
AminoAcidPattern	getSequenceAsPattern() Returns the sequence of this peptide as AminoAcidPattern.
static AminoAcidPattern	getSequenceAsPattern(java.lang.String sequence) Returns the given sequence as AminoAcidPattern.
java.lang.String	getTaggedModifiedSequence(ModificationProfile modificationProfile, boolean useHtmlColorCoding, boolean includeHtmlStartEndTags, boolean useShortName) Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>.
java.lang.String	getTaggedModifiedSequence(ModificationProfile modificationProfile, boolean useHtmlColorCoding, boolean includeHtmlStartEndTags, boolean useShortName, boolean excludeAllFixedPtms) Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>.
static java.lang.String	getTaggedModifiedSequence(ModificationProfile modificationProfile, Peptide peptide, java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> mainModificationSites, java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> secondaryModificationSites, java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> fixedModificationSites, boolean useHtmlColorCoding, boolean includeHtmlStartEndTags, boolean useShortName) Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>.
java.util.ArrayList<java.lang.String>	isCterm(AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns a list of proteins where this peptide can be found in the C-terminus.
boolean	isDecoy() Indicates whether a peptide can be derived from a decoy protein.
boolean	isModifiable(PTM ptm, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Indicates whether the given modification can be found on the peptide.
static boolean	isModified(java.lang.String peptideKey) Returns a boolean indicating whether the peptide has variable modifications based on its key.
static boolean	isModified(java.lang.String peptideKey, java.lang.String modification) Returns a boolean indicating whether the peptide has the given variable modification based on its key.
java.util.ArrayList<java.lang.String>	isNterm(AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns a list of proteins where this peptide can be found in the N-terminus.
boolean	isSameModificationStatus(Peptide anotherPeptide) Indicates whether another peptide has the same variable modifications as this peptide.
boolean	isSameSequence(Peptide anotherPeptide, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Returns a boolean indicating whether another peptide has the same sequence as the given peptide
boolean	isSameSequenceAndModificationStatus(Peptide anotherPeptide, AminoAcidPattern.MatchingType matchingType, java.lang.Double massTolerance) Indicates whether another peptide has the same sequence and modification status without accounting for modification localization.
boolean	sameModificationsAs(Peptide anotherPeptide) Indicates whether another peptide has the same modifications at the same localization as this peptide.
boolean	sameModificationsAs(Peptide anotherPeptide, java.util.ArrayList<java.lang.String> ptms) Indicates whether another peptide has the same modifications at the same localization as this peptide.
void	setParentProteins(java.util.ArrayList<java.lang.String> parentProteins) Sets the parent proteins.

Methods inherited from class com.compomics.util.experiment.personalization.ExperimentObject

addUrParam, getParameterKey, getUrParam

Methods inherited from class java.lang.Object

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

Field Detail

MODIFICATION_LOCALIZATION_SEPARATOR

public static final java.lang.String MODIFICATION_LOCALIZATION_SEPARATOR

Separator preceding confident localization of the confident localization of a modification

See Also:

Constant Field Values

MODIFICATION_SEPARATOR

public static final java.lang.String MODIFICATION_SEPARATOR

Separator used to separate modifications in peptide keys

See Also:

Constant Field Values

Constructor Detail

Peptide

public Peptide()

Constructor for the peptide.

Peptide

public Peptide(java.lang.String aSequence,
       java.util.ArrayList<java.lang.String> parentProteins,
       java.util.ArrayList<ModificationMatch> modifications)
        throws java.lang.IllegalArgumentException

Deprecated. use peptide without proteins and remap the peptide to the proteins a posteriori instead

Constructor for the peptide.

Parameters:

aSequence - The peptide sequence

parentProteins - The parent proteins, cannot be null or empty

modifications - The PTM of this peptide

Throws:

java.lang.IllegalArgumentException - Thrown if the peptide sequence contains unknown amino acids

Peptide

public Peptide(java.lang.String aSequence,
       java.util.ArrayList<ModificationMatch> modifications)
        throws java.lang.IllegalArgumentException

Constructor for the peptide.

Parameters:

aSequence - The peptide sequence

modifications - The PTM of this peptide

Throws:

java.lang.IllegalArgumentException - Thrown if the peptide sequence contains unknown amino acids

Peptide

public Peptide(java.lang.String aSequence,
       java.lang.Double mass,
       java.util.ArrayList<java.lang.String> parentProteins,
       java.util.ArrayList<ModificationMatch> modifications)

Deprecated. use the constructor without mass. The mass will be recalculated.

Constructor for the peptide.

Parameters:

aSequence - The peptide sequence

mass - The peptide mass

parentProteins - The parent proteins, cannot be null or empty

modifications - The PTM of this peptide

Method Detail

getMass

public java.lang.Double getMass()

Getter for the mass.

Returns:

the peptide mass

getModificationMatches

public java.util.ArrayList<ModificationMatch> getModificationMatches()

Getter for the modifications carried by this peptide.

Returns:

the modifications matches as found by the search engine

clearModificationMatches

public void clearModificationMatches()

Clears the list of imported modification matches.

addModificationMatch

public void addModificationMatch(ModificationMatch modificationMatch)

Adds a modification match.

Parameters:

modificationMatch - the modification match to add

getSequence

public java.lang.String getSequence()

Getter for the sequence.

Returns:

the peptide sequence

getNMissedCleavages

public int getNMissedCleavages(Enzyme enzyme)

Returns the number of missed cleavages using the specified enzyme.

Parameters:

enzyme - the enzyme used

Returns:

the amount of missed cleavages

getNMissedCleavages

public static int getNMissedCleavages(java.lang.String sequence,
                      Enzyme enzyme)

Returns the number of missed cleavages using the specified enzyme for the given sequence.

Parameters:

sequence - the peptide sequence

enzyme - the enzyme used

Returns:

the amount of missed cleavages

getParentProteins

public java.util.ArrayList<java.lang.String> getParentProteins(boolean remap,
                                                      AminoAcidPattern.MatchingType matchingType,
                                                      java.lang.Double massTolerance)
                                                        throws java.io.IOException,
                                                               java.lang.ClassNotFoundException,
                                                               java.lang.InterruptedException,
                                                               java.sql.SQLException

Returns the parent proteins and eventually remaps the peptide to the protein using the default protein tree.

Parameters:

remap - boolean indicating whether the peptide sequence should be remapped to the proteins if no protein is found

matchingType - the desired peptide to protein matching type

massTolerance - the ms2 mass tolerance

Returns:

the proteins mapping this peptide

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InterruptedException

java.sql.SQLException

getParentProteins

public java.util.ArrayList<java.lang.String> getParentProteins(AminoAcidPattern.MatchingType matchingType,
                                                      java.lang.Double massTolerance,
                                                      ProteinTree proteinTree)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException,
                                                               java.sql.SQLException,
                                                               java.lang.ClassNotFoundException

Returns the parent proteins and remaps the peptide to the protein if no protein mapping was set.

Parameters:

matchingType - the desired peptide to protein matching type

massTolerance - the ms2 mass tolerance

proteinTree - the protein tree to use for peptide to protein mapping

Returns:

the proteins mapping this peptide

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InterruptedException

java.sql.SQLException

getParentProteins

public java.util.ArrayList<java.lang.String> getParentProteins(AminoAcidPattern.MatchingType matchingType,
                                                      java.lang.Double massTolerance)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException,
                                                               java.sql.SQLException,
                                                               java.lang.ClassNotFoundException

Returns the parent proteins and remaps the peptide to the protein if no protein mapping was set using the default protein tree of the sequence factory.

Parameters:

matchingType - the desired peptide to protein matching type

massTolerance - the ms2 mass tolerance

Returns:

the proteins mapping this peptide

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InterruptedException

java.sql.SQLException

getParentProteins

public java.util.ArrayList<java.lang.String> getParentProteins(boolean remap,
                                                      AminoAcidPattern.MatchingType matchingType,
                                                      java.lang.Double massTolerance,
                                                      ProteinTree proteinTree)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException,
                                                               java.sql.SQLException,
                                                               java.lang.ClassNotFoundException

Returns the parent proteins and eventually remaps the peptide to the protein. Note, the maximal share of 'X's in the sequence is set according to the ProteinMatch MaxX field.

Parameters:

remap - boolean indicating whether the peptide sequence should be remapped to the proteins if no protein is found

matchingType - the desired peptide to protein matching type

massTolerance - the ms2 mass tolerance

proteinTree - the protein tree to use for peptide to protein mapping

Returns:

the proteins mapping this peptide

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InterruptedException

java.sql.SQLException

getParentProteinsNoRemapping

public java.util.ArrayList<java.lang.String> getParentProteinsNoRemapping()

Returns the parent proteins without remapping them. Null if none mapped.

Returns:

an ArrayList containing the parent proteins

setParentProteins

public void setParentProteins(java.util.ArrayList<java.lang.String> parentProteins)

Sets the parent proteins.

Parameters:

parentProteins - the parent proteins as list, cannot be null or empty

getMatchingKey

public java.lang.String getMatchingKey(AminoAcidPattern.MatchingType matchingType,
                              java.lang.Double massTolerance)

Returns a unique key for the peptide when considering the given matching type and mass tolerance. when ambiguity the first amino acid according to AminoAcid.getAminoAcidsList() will be selected. For example the matching key of peptide PEPTLDE_mod1_mod2 is PEPTIDE_mod1_mod2

Parameters:

matchingType - the amino acid matching type

massTolerance - the mass tolerance

Returns:

a key unique to the given matching type

getKey

public java.lang.String getKey()

Returns the reference key of a peptide. index = SEQUENCE_mod1_mod2 with modifications ordered alphabetically.

Returns:

the index of a peptide

getKey

public static java.lang.String getKey(java.lang.String sequence,
                      java.util.ArrayList<ModificationMatch> modificationMatches)

Returns the reference key of a peptide. key = SEQUENCE_mod1_mod2 with modifications ordered alphabetically.

Parameters:

sequence - the sequence of the peptide

modificationMatches - list of modification matches

Returns:

the index of a peptide

isModified

public static boolean isModified(java.lang.String peptideKey)

Returns a boolean indicating whether the peptide has variable modifications based on its key.

Parameters:

peptideKey - the peptide key

Returns:

a boolean indicating whether the peptide has variable modifications

isModified

public static boolean isModified(java.lang.String peptideKey,
                 java.lang.String modification)

Returns a boolean indicating whether the peptide has the given variable modification based on its key.

Parameters:

peptideKey - the peptide key

modification - the name of the modification

Returns:

a boolean indicating whether the peptide has variable modifications

getModificationCount

public static int getModificationCount(java.lang.String peptideKey,
                       java.lang.String modification)

Returns how many of the given modification was found in the given peptide.

Parameters:

peptideKey - the peptide key

modification - the name of the modification

Returns:

the number of modifications

getNVariableModifications

public int getNVariableModifications(double modificationMass)

Returns the number of variable modifications found with the given mass.

Parameters:

modificationMass - the mass of the modification

Returns:

the number of occurrences of this modification

getNModificationLocalized

public static java.util.ArrayList<java.lang.Integer> getNModificationLocalized(java.lang.String peptideKey,
                                                               java.lang.String modification)

Returns the list of modifications confidently localized or inferred for the peptide indexed by the given key.

Parameters:

peptideKey - the peptide key

modification - the name of the modification

Returns:

the number of modifications confidently localized

getSequence

public static java.lang.String getSequence(java.lang.String peptideKey)

Returns the sequence of the peptide indexed by the given key.

Parameters:

peptideKey - the peptide key

Returns:

the corresponding sequence

getModificationFamily

public static java.util.ArrayList<java.lang.String> getModificationFamily(java.lang.String peptideKey)

Returns a list of names of the variable modifications found in the key of a peptide.

Parameters:

peptideKey - the key of a peptide

Returns:

a list of names of the variable modifications found in the key

isModifiable

public boolean isModifiable(PTM ptm,
                   AminoAcidPattern.MatchingType matchingType,
                   java.lang.Double massTolerance)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.InterruptedException,
                            java.io.FileNotFoundException,
                            java.lang.ClassNotFoundException,
                            java.sql.SQLException

Indicates whether the given modification can be found on the peptide. For instance, 'oxidation of M' cannot be found on sequence "PEPTIDE". For the inspection of protein termini and peptide C-terminus the proteins sequences must be accessible from the sequence factory.

Parameters:

ptm - the PTM of interest

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a boolean indicating whether the given modification can be found on the peptide

Throws:

java.io.IOException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.IllegalArgumentException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.InterruptedException - exception thrown whenever an error occurred while reading a protein sequence

java.io.FileNotFoundException

java.lang.ClassNotFoundException

java.sql.SQLException

getPotentialModificationSites

public java.util.ArrayList<java.lang.Integer> getPotentialModificationSites(java.lang.Double ptmMass,
                                                                   AminoAcidPattern.MatchingType matchingType,
                                                                   java.lang.Double massTolerance,
                                                                   ModificationProfile modificationProfile)
                                                                     throws java.io.IOException,
                                                                            java.lang.IllegalArgumentException,
                                                                            java.lang.InterruptedException,
                                                                            java.io.FileNotFoundException,
                                                                            java.lang.ClassNotFoundException,
                                                                            java.sql.SQLException

Returns the potential modification sites as an ordered list of string. 1 is the first amino acid. An empty list is returned if no possibility was found. This method does not account for protein terminal modifications.

Parameters:

ptmMass - the mass of the potential PTM

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

modificationProfile - the modification profile of the identification

Returns:

a list of potential modification sites

Throws:

java.io.IOException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.IllegalArgumentException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.InterruptedException - exception thrown whenever an error occurred while reading a protein sequence

java.io.FileNotFoundException

java.lang.ClassNotFoundException

java.sql.SQLException

getPotentialModificationSites

public java.util.ArrayList<java.lang.Integer> getPotentialModificationSites(PTM ptm,
                                                                   AminoAcidPattern.MatchingType matchingType,
                                                                   java.lang.Double massTolerance)
                                                                     throws java.io.IOException,
                                                                            java.lang.IllegalArgumentException,
                                                                            java.lang.InterruptedException,
                                                                            java.io.FileNotFoundException,
                                                                            java.lang.ClassNotFoundException,
                                                                            java.sql.SQLException

Returns the potential modification sites as an ordered list of string. 1 is the first amino acid. An empty list is returned if no possibility was found.

Parameters:

ptm - the PTM considered

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a list of potential modification sites

Throws:

java.io.IOException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.IllegalArgumentException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.InterruptedException - exception thrown whenever an error occurred while reading a protein sequence

java.io.FileNotFoundException

java.lang.ClassNotFoundException

java.sql.SQLException

getPotentialModificationSites

public static java.util.ArrayList<java.lang.Integer> getPotentialModificationSites(java.lang.String sequence,
                                                                   PTM ptm)
                                                                            throws java.lang.IllegalArgumentException

Deprecated. use getPotentialModificationSites(PTM ptm, AminoAcidPattern.MatchingType matchingType, Double massTolerance)

Returns the potential modification sites as an ordered list of string. 1 is the first aa. an empty list is returned if no possibility was found. This method does not account for protein terminal modifications. Only works if the modification pattern can be fully found in the sequence (single amino acid or terminal patterns smaller than the sequence). Otherwise an IllegalArgumentException will be thrown. Use the non static method then.

Parameters:

sequence - the sequence of the peptide of interest

ptm - the PTM considered

Returns:

a list of potential modification sites

Throws:

java.lang.IllegalArgumentException

isSameSequenceAndModificationStatus

public boolean isSameSequenceAndModificationStatus(Peptide anotherPeptide,
                                          AminoAcidPattern.MatchingType matchingType,
                                          java.lang.Double massTolerance)

Indicates whether another peptide has the same sequence and modification status without accounting for modification localization.

Parameters:

anotherPeptide - the other peptide to compare to this instance

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a boolean indicating whether the other peptide has the same sequence and modification status.

isSameSequence

public boolean isSameSequence(Peptide anotherPeptide,
                     AminoAcidPattern.MatchingType matchingType,
                     java.lang.Double massTolerance)

Returns a boolean indicating whether another peptide has the same sequence as the given peptide

Parameters:

anotherPeptide - the other peptide to compare

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a boolean indicating whether the other peptide has the same sequence

isSameModificationStatus

public boolean isSameModificationStatus(Peptide anotherPeptide)

Indicates whether another peptide has the same variable modifications as this peptide. The localization of the PTM is not accounted for.

Parameters:

anotherPeptide - the other peptide

Returns:

a boolean indicating whether the other peptide has the same variable modifications as the peptide of interest

sameModificationsAs

public boolean sameModificationsAs(Peptide anotherPeptide,
                          java.util.ArrayList<java.lang.String> ptms)

Indicates whether another peptide has the same modifications at the same localization as this peptide. This method comes as a complement of isSameAs, here the localization of all PTMs is taken into account.

Parameters:

anotherPeptide - another peptide

ptms - the PTMs

Returns:

true if the other peptide has the same positions at the same location as the considered peptide

sameModificationsAs

public boolean sameModificationsAs(Peptide anotherPeptide)

Indicates whether another peptide has the same modifications at the same localization as this peptide. This method comes as a complement of isSameAs, here the localization of all PTMs is taken into account.

Parameters:

anotherPeptide - another peptide

Returns:

true if the other peptide has the same positions at the same location as the considered peptide

getNTerminal

public java.lang.String getNTerminal()

Returns the N-terminal of the peptide as a String. Returns "NH2" if the terminal is not modified, otherwise returns the name of the modification. /!\ this method will work only if the PTM found in the peptide are in the PTMFactory.

Returns:

the N-terminal of the peptide as a String, e.g., "NH2"

getCTerminal

public java.lang.String getCTerminal()

Returns the C-terminal of the peptide as a String. Returns "COOH" if the terminal is not modified, otherwise returns the name of the modification. /!\ This method will work only if the PTM found in the peptide are in the PTMFactory.

Returns:

the C-terminal of the peptide as a String, e.g., "COOH"

getTaggedModifiedSequence

public java.lang.String getTaggedModifiedSequence(ModificationProfile modificationProfile,
                                         boolean useHtmlColorCoding,
                                         boolean includeHtmlStartEndTags,
                                         boolean useShortName,
                                         boolean excludeAllFixedPtms)

Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>. /!\ this method will work only if the PTM found in the peptide are in the PTMFactory. /!\ This method uses the modifications as set in the modification matches of this peptide and displays all of them.

Parameters:

modificationProfile - the modification profile of the search

useHtmlColorCoding - if true, color coded HTML is used, otherwise PTM tags, e.g, <mox>, are used

includeHtmlStartEndTags - if true, start and end HTML tags are added

useShortName - if true the short names are used in the tags

excludeAllFixedPtms - if true, all fixed PTMs are excluded

Returns:

the modified sequence as a tagged string

getTaggedModifiedSequence

public java.lang.String getTaggedModifiedSequence(ModificationProfile modificationProfile,
                                         boolean useHtmlColorCoding,
                                         boolean includeHtmlStartEndTags,
                                         boolean useShortName)

Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>. /!\ this method will work only if the PTM found in the peptide are in the PTMFactory. /!\ This method uses the modifications as set in the modification matches of this peptide and displays all of them.

Parameters:

modificationProfile - the modification profile of the search

useHtmlColorCoding - if true, color coded HTML is used, otherwise PTM tags, e.g, <mox>, are used

includeHtmlStartEndTags - if true, start and end HTML tags are added

useShortName - if true the short names are used in the tags

Returns:

the modified sequence as a tagged string

getTaggedModifiedSequence

public static java.lang.String getTaggedModifiedSequence(ModificationProfile modificationProfile,
                                         Peptide peptide,
                                         java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> mainModificationSites,
                                         java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> secondaryModificationSites,
                                         java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> fixedModificationSites,
                                         boolean useHtmlColorCoding,
                                         boolean includeHtmlStartEndTags,
                                         boolean useShortName)

Returns the modified sequence as an tagged string with potential modification sites color coded or with PTM tags, e.g, <mox>. /!\ This method will work only if the PTM found in the peptide are in the PTMFactory. /!\ This method uses the modifications as set in the modification matches of this peptide and displays all of them.

Parameters:

modificationProfile - the modification profile of the search

includeHtmlStartEndTags - if true, start and end HTML tags are added

peptide - the peptide to annotate

mainModificationSites - the main variable modification sites in a map: aa number -> list of modifications (1 is the first AA) (can be null)

secondaryModificationSites - the secondary variable modification sites in a map: aa number -> list of modifications (1 is the first AA) (can be null)

fixedModificationSites - the fixed modification sites in a map: aa number -> list of modifications (1 is the first AA) (can be null)

useHtmlColorCoding - if true, color coded HTML is used, otherwise PTM tags, e.g, <mox>, are used

useShortName - if true the short names are used in the tags

Returns:

the tagged modified sequence as a string

getModifiedIndexes

public java.util.ArrayList<java.lang.Integer> getModifiedIndexes()

Returns the indexes of the residues in the peptide that contain at least one variable modification.

Returns:

the indexes of the modified residues

getModifiedIndexes

public java.util.ArrayList<java.lang.Integer> getModifiedIndexes(boolean excludeFixed)

Returns the indexes of the residues in the peptide that contain at least one modification.

Parameters:

excludeFixed - exclude fixed PTMs

Returns:

the indexes of the modified residues

getIndexedFixedModifications

public java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.String>> getIndexedFixedModifications()

Returns an indexed map of all fixed modifications amino acid, (1 is the first) -> list of modification names.

Returns:

an indexed map of all fixed modifications amino acid

estimateTheoreticMass

public void estimateTheoreticMass()
                           throws java.lang.IllegalArgumentException

Estimates the theoretic mass of the peptide. The previous version is silently overwritten.

Throws:

java.lang.IllegalArgumentException - if the peptide sequence contains unknown amino acids

isNterm

public java.util.ArrayList<java.lang.String> isNterm(AminoAcidPattern.MatchingType matchingType,
                                            java.lang.Double massTolerance)
                                              throws java.io.IOException,
                                                     java.lang.IllegalArgumentException,
                                                     java.lang.InterruptedException,
                                                     java.io.FileNotFoundException,
                                                     java.lang.ClassNotFoundException,
                                                     java.sql.SQLException

Returns a list of proteins where this peptide can be found in the N-terminus. The proteins must be accessible via the sequence factory. If none found, an empty list is returned. Warning: if the parent proteins are not set, they will be set using the default protein tree and the given matching type and mass tolerance

Parameters:

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a list of proteins where this peptide can be found in the N-terminus

Throws:

java.io.IOException - exception thrown whenever an error occurred while reading the protein sequence

java.lang.IllegalArgumentException - exception thrown whenever an error occurred while reading the protein sequence

java.lang.InterruptedException - exception thrown whenever an error occurred while reading the protein sequence

java.io.FileNotFoundException

java.lang.ClassNotFoundException

java.sql.SQLException

isCterm

public java.util.ArrayList<java.lang.String> isCterm(AminoAcidPattern.MatchingType matchingType,
                                            java.lang.Double massTolerance)
                                              throws java.io.IOException,
                                                     java.lang.IllegalArgumentException,
                                                     java.lang.InterruptedException,
                                                     java.io.FileNotFoundException,
                                                     java.lang.ClassNotFoundException,
                                                     java.sql.SQLException

Returns a list of proteins where this peptide can be found in the C-terminus. The proteins must be accessible via the sequence factory. If none found, an empty list is returned. Warning: if the parent proteins are not set, they will be set using the default protein tree and the given matching type and mass tolerance

Parameters:

matchingType - the type of sequence matching

massTolerance - the mass tolerance for matching type 'indistiguishibleAminoAcids'. Can be null otherwise

Returns:

a list of proteins where this peptide can be found in the C-terminus

Throws:

java.io.IOException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.IllegalArgumentException - exception thrown whenever an error occurred while reading a protein sequence

java.lang.InterruptedException - exception thrown whenever an error occurred while reading a protein sequence

java.io.FileNotFoundException

java.lang.ClassNotFoundException

java.sql.SQLException

getSequenceAsPattern

public AminoAcidPattern getSequenceAsPattern()

Returns the sequence of this peptide as AminoAcidPattern.

Returns:

the sequence of this peptide as AminoAcidPattern

getSequenceAsPattern

public static AminoAcidPattern getSequenceAsPattern(java.lang.String sequence)

Returns the given sequence as AminoAcidPattern.

Parameters:

sequence - the sequence of interest

Returns:

the sequence as AminoAcidPattern

isDecoy

public boolean isDecoy()

Indicates whether a peptide can be derived from a decoy protein.

Returns:

whether a peptide can be derived from a decoy protein

getNoModPeptide

public static Peptide getNoModPeptide(Peptide peptide,
                      java.util.ArrayList<PTM> ptms)
                               throws java.io.IOException,
                                      java.sql.SQLException,
                                      java.lang.ClassNotFoundException,
                                      java.lang.InterruptedException

Returns a version of the peptide which does not contain the inspected PTMs.

Parameters:

peptide - the original peptide

ptms - list of inspected PTMs

Returns:

a not modified version of the peptide

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InterruptedException

java.sql.SQLException