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

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

  • Field Details

    • index

      public static final int index
      The index of this ms2pip feature.
      See Also:

  • 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 feature
      aminoAcidFeature2 - the second amino acid feature

  • Method Details

    • getRelationship

      public AAPropertyRelationshipFeature.Relationship getRelationship()
      Returns the relationship between the features.
      Returns:
      the relationship between the features

    • setRelationship

      public void setRelationship(AAPropertyRelationshipFeature.Relationship relationship)
      Sets the relationship between the features.
      Parameters:
      relationship - the relationship between the features

    • getAminoAcidFeature1

      public AAPropertyFeature getAminoAcidFeature1()
      Returns the first amino acid feature.
      Returns:
      the first amino acid feature

    • setAminoAcidFeature1

      public void setAminoAcidFeature1(AAPropertyFeature aminoAcidFeature1)
      Sets the first amino acid feature.
      Parameters:
      aminoAcidFeature1 - the first amino acid feature

    • getAminoAcidFeature2

      public AAPropertyFeature getAminoAcidFeature2()
      Returns the second amino acid feature.
      Returns:
      the second amino acid feature

    • setAminoAcidFeature2

      public void setAminoAcidFeature2(AAPropertyFeature aminoAcidFeature2)
      Sets the second amino acid feature.
      Parameters:
      aminoAcidFeature2 - the second amino acid feature

    • getCategory

      public String getCategory()
      Description copied from interface: Ms2pipFeature
      Returns the category of the feature.
      Specified by:
      getCategory in interface Ms2pipFeature
      Returns:
      the category of the feature

    • getDescription

      public String getDescription()
      Description copied from interface: Ms2pipFeature
      Returns the description of the feature.
      Specified by:
      getDescription in interface Ms2pipFeature
      Returns:
      the description of the feature

    • getAminoAcidProperties

      public AminoAcid.Property[] getAminoAcidProperties()
      Description copied from interface: MultipleAAPropertyFeature
      Returns the amino acid properties to consider.
      Specified by:
      getAminoAcidProperties in interface MultipleAAPropertyFeature
      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 interface Ms2pipFeature
      Returns:
      an integer unique to this class