Class AAPropertyRelationshipFeature
java.lang.Object
com.compomics.util.experiment.identification.peptide_fragmentation.models.ms2pip.features_configuration.features.AAPropertyRelationshipFeature
- All Implemented Interfaces:
Ms2pipFeature
,MultipleAAPropertyFeature
public class AAPropertyRelationshipFeature extends Object implements Ms2pipFeature, MultipleAAPropertyFeature
Feature based on the relationship between two amino acid features.
- Author:
- Marc Vaudel
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AAPropertyRelationshipFeature.Relationship
The different relationships implemented. -
Field Summary
Fields Modifier and Type Field Description static int
index
The index of this ms2pip feature.Fields inherited from interface com.compomics.util.experiment.identification.peptide_fragmentation.models.ms2pip.features_configuration.Ms2pipFeature
implementations
-
Constructor Summary
Constructors Constructor Description AAPropertyRelationshipFeature()
Empty default constructorAAPropertyRelationshipFeature(AAPropertyRelationshipFeature.Relationship relationship, AAPropertyFeature aminoAcidFeature1, AAPropertyFeature aminoAcidFeature2)
Constructor. -
Method Summary
Modifier and Type Method Description AAPropertyFeature
getAminoAcidFeature1()
Returns the first amino acid feature.AAPropertyFeature
getAminoAcidFeature2()
Returns the second amino acid feature.AminoAcid.Property[]
getAminoAcidProperties()
Returns the amino acid properties to consider.String
getCategory()
Returns the category of the feature.String
getDescription()
Returns the description of the feature.int
getIndex()
Returns an integer unique to this class.AAPropertyRelationshipFeature.Relationship
getRelationship()
Returns the relationship between the features.void
setAminoAcidFeature1(AAPropertyFeature aminoAcidFeature1)
Sets the first amino acid feature.void
setAminoAcidFeature2(AAPropertyFeature aminoAcidFeature2)
Sets the second amino acid feature.void
setRelationship(AAPropertyRelationshipFeature.Relationship relationship)
Sets the relationship between the features.
-
Field Details
-
index
public static final int indexThe index of this ms2pip feature.- See Also:
- Constant Field Values
-
-
Constructor Details
-
AAPropertyRelationshipFeature
public AAPropertyRelationshipFeature()Empty default constructor -
AAPropertyRelationshipFeature
public AAPropertyRelationshipFeature(AAPropertyRelationshipFeature.Relationship relationship, AAPropertyFeature aminoAcidFeature1, AAPropertyFeature aminoAcidFeature2)Constructor.- Parameters:
relationship
- the relationship between the amino acid feature.aminoAcidFeature1
- the first amino acid featureaminoAcidFeature2
- the second amino acid feature
-
-
Method Details
-
getRelationship
Returns the relationship between the features.- Returns:
- the relationship between the features
-
setRelationship
Sets the relationship between the features.- Parameters:
relationship
- the relationship between the features
-
getAminoAcidFeature1
Returns the first amino acid feature.- Returns:
- the first amino acid feature
-
setAminoAcidFeature1
Sets the first amino acid feature.- Parameters:
aminoAcidFeature1
- the first amino acid feature
-
getAminoAcidFeature2
Returns the second amino acid feature.- Returns:
- the second amino acid feature
-
setAminoAcidFeature2
Sets the second amino acid feature.- Parameters:
aminoAcidFeature2
- the second amino acid feature
-
getCategory
Description copied from interface:Ms2pipFeature
Returns the category of the feature.- Specified by:
getCategory
in interfaceMs2pipFeature
- Returns:
- the category of the feature
-
getDescription
Description copied from interface:Ms2pipFeature
Returns the description of the feature.- Specified by:
getDescription
in interfaceMs2pipFeature
- Returns:
- the description of the feature
-
getAminoAcidProperties
Description copied from interface:MultipleAAPropertyFeature
Returns the amino acid properties to consider.- Specified by:
getAminoAcidProperties
in interfaceMultipleAAPropertyFeature
- Returns:
- the amino acid properties to consider
-
getIndex
public int getIndex()Description copied from interface:Ms2pipFeature
Returns an integer unique to this class.- Specified by:
getIndex
in interfaceMs2pipFeature
- Returns:
- an integer unique to this class
-