Class SequenceMatchingParameters
java.lang.Object
com.compomics.util.experiment.personalization.ExperimentObject
com.compomics.util.parameters.identification.advanced.SequenceMatchingParameters
- All Implemented Interfaces:
Serializable
The sequence matching options.
- Author:
- Marc Vaudel, Harald Barsnes
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe different types of amino acid matching. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SequenceMatchingParametersDefault string matching.Fields inherited from class com.compomics.util.experiment.personalization.ExperimentObject
NO_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SequenceMatchingParametersReturns default preferences from amino acid matching.doubleReturns the maximal share of X's a match can contain, range [0.0-1.0].intReturns the maximum number of PTMs to consider when mapping tags to protein sequences.intReturns the minimum amino acid score.intReturns the minimum tag length.Returns the sequence matching type.Returns a short description of the parameters.static SequenceMatchingParametersReturns preferences for simple string matching.booleanReturns true if tags should only be mapped to enzymatic peptides.booleanisSameAs(SequenceMatchingParameters sequenceMatchingPreferences) Indicates whether another sequence matching preferences is the same as this one.voidsetEnzymaticTagsOnly(boolean enzymaticTagsOnly) Sets whether tags should only be mapped to enzymatic peptides.voidsetLimitX(double limitX) Sets the maximal share of X's a match can contain, range [0.0-1.0].voidsetMaxPtmsPerTagPeptide(int numberOfPtmsPerTagPeptide) Sets the maximum number of PTMs to consider when mapping tags to protein sequences.voidsetMinAminoAcidScore(int minAminoAcidScore) Set the minimum amino acid score.voidsetMinTagLength(int minTagLength) Set the minimum tag length.voidsetSequenceMatchingType(SequenceMatchingParameters.MatchingType sequenceMatchingType) Sets the sequence matching type.Methods inherited from class com.compomics.util.experiment.personalization.ExperimentObject
addUrParam, asLong, clearParametersMap, getId, getUrParam, getUrParams, removeUrParam, setId, setUrParams
-
Field Details
-
DEFAULT_STRING_MATCHING
Default string matching.
-
-
Constructor Details
-
SequenceMatchingParameters
public SequenceMatchingParameters()Constructor for empty preferences.
-
-
Method Details
-
getStringMatching
Returns preferences for simple string matching.- Returns:
- preferences for simple string matching
-
getDefaultSequenceMatching
Returns default preferences from amino acid matching.- Returns:
- default preferences from amino acid matching
-
getSequenceMatchingType
Returns the sequence matching type.- Returns:
- the sequence matching type
-
setSequenceMatchingType
Sets the sequence matching type.- Parameters:
sequenceMatchingType- the sequence matching type
-
getLimitX
public double getLimitX()Returns the maximal share of X's a match can contain, range [0.0-1.0]. Null if not set.- Returns:
- the maximal share of X's a match can contain
-
setLimitX
public void setLimitX(double limitX) Sets the maximal share of X's a match can contain, range [0.0-1.0].- Parameters:
limitX- the maximal share of X's a match can contain
-
isSameAs
Indicates whether another sequence matching preferences is the same as this one.- Parameters:
sequenceMatchingPreferences- the other sequence matching preferences- Returns:
- whether another sequence matching preferences is the same as this one
-
getShortDescription
Returns a short description of the parameters.- Returns:
- a short description of the parameters
-
isEnzymaticTagsOnly
public boolean isEnzymaticTagsOnly()Returns true if tags should only be mapped to enzymatic peptides.- Returns:
- true if tags should only be mapped to enzymatic peptides
-
setEnzymaticTagsOnly
public void setEnzymaticTagsOnly(boolean enzymaticTagsOnly) Sets whether tags should only be mapped to enzymatic peptides.- Parameters:
enzymaticTagsOnly- the enzymaticTagsOnly to set
-
getMaxPtmsPerTagPeptide
public int getMaxPtmsPerTagPeptide()Returns the maximum number of PTMs to consider when mapping tags to protein sequences.- Returns:
- the maximum number of PTMs to consider when mapping tags to protein sequences
-
setMaxPtmsPerTagPeptide
public void setMaxPtmsPerTagPeptide(int numberOfPtmsPerTagPeptide) Sets the maximum number of PTMs to consider when mapping tags to protein sequences.- Parameters:
numberOfPtmsPerTagPeptide- the maxPtmsPerTagPeptide to set
-
getMinAminoAcidScore
public int getMinAminoAcidScore()Returns the minimum amino acid score.- Returns:
- the minAminoAcidScore
-
setMinAminoAcidScore
public void setMinAminoAcidScore(int minAminoAcidScore) Set the minimum amino acid score.- Parameters:
minAminoAcidScore- the minAminoAcidScore to set
-
getMinTagLength
public int getMinTagLength()Returns the minimum tag length.- Returns:
- the minTagLength
-
setMinTagLength
public void setMinTagLength(int minTagLength) Set the minimum tag length.- Parameters:
minTagLength- the minTagLength to set
-