src/jalview/datamodel/ProfileI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 public interface ProfileI
  24 {
  25
  26   /**
  27    * Set the full profile of counts
  28    *
  29    * @param residueCounts
  30    */
  31   public abstract void setCounts(ResidueCount residueCounts);
  32   public abstract void setSSCounts(SecondaryStructureCount secondaryStructureCount);
  33
  34
  35   /**
  36    * Returns the percentage identity of the profile, i.e. the highest proportion
  37    * of conserved (equal) symbols. The percentage is as a fraction of all
  38    * sequences, or only ungapped sequences if flag ignoreGaps is set true.
  39    *
  40    * @param ignoreGaps
  41    * @return
  42    */
  43   public abstract float getPercentageIdentity(boolean ignoreGaps);
  44
  45   public abstract float getSSPercentageIdentity(boolean ignoreGaps);
  46
  47   /**
  48    * Returns the full symbol counts for this profile
  49    *
  50    * @return
  51    */
  52   public abstract ResidueCount getCounts();
  53
  54   /**
  55    * Returns the number of sequences in the profile
  56    *
  57    * @return
  58    */
  59   public abstract int getHeight();
  60
  61   /**
  62    * Returns the number of sequences in the profile which had a gap character
  63    * (or were too short to be included in this column's profile)
  64    *
  65    * @return
  66    */
  67   public abstract int getGapped();
  68
  69   /**
  70    * Returns the highest count for any symbol(s) in the profile
  71    *
  72    * @return
  73    */
  74   public abstract int getMaxCount();
  75   public abstract int getMaxSSCount();
  76
  77   /**
  78    * Returns the symbol (or concatenated symbols) which have the highest count
  79    * in the profile, or an empty string if there were no symbols counted
  80    *
  81    * @return
  82    */
  83   public abstract String getModalResidue();
  84   public abstract String getModalSS();
  85
  86   /**
  87    * Answers the number of non-gapped sequences in the profile
  88    *
  89    * @return
  90    */
  91   public abstract int getNonGapped();
  92   SecondaryStructureCount getSSCounts();
  93
  94 }