src/jalview/schemes/PurinePyrimidineColourScheme.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.schemes;
  22
  23 import java.awt.Color;
  24
  25 /**
  26  * Class is based off of NucleotideColourScheme
  27  *
  28  * @author Lauren Michelle Lui
  29  */
  30 public class PurinePyrimidineColourScheme extends ResidueColourScheme
  31 {
  32   /**
  33    * Creates a new PurinePyrimidineColourScheme object.
  34    */
  35   public PurinePyrimidineColourScheme()
  36   {
  37     super(ResidueProperties.purinepyrimidineIndex,
  38             ResidueProperties.purinepyrimidine, 0);
  39   }
  40
  41   /**
  42    * Finds the corresponding color for the type of character inputed
  43    *
  44    * @param c
  45    *          Character in sequence
  46    *
  47    * @return Color from purinepyrimidineIndex in
  48    *         jalview.schemes.ResidueProperties
  49    */
  50   @Override
  51   public Color findColour(char c)
  52   {
  53     return colors[ResidueProperties.purinepyrimidineIndex[c]];
  54   }
  55
  56   /**
  57    * Returns color based on conservation
  58    *
  59    * @param c
  60    *          Character in sequence
  61    * @param j
  62    *          Threshold
  63    *
  64    * @return Color in RGB
  65    */
  66   public Color findColour(char c, int j)
  67   {
  68     Color currentColour;
  69     if ((threshold == 0) || aboveThreshold(c, j))
  70     {
  71       try
  72       {
  73         currentColour = colors[ResidueProperties.purinepyrimidineIndex[c]];
  74       } catch (Exception ex)
  75       {
  76         return Color.white;
  77       }
  78     }
  79     else
  80     {
  81       return Color.white;
  82     }
  83
  84     if (conservationColouring)
  85     {
  86       currentColour = applyConservation(currentColour, j);
  87     }
  88
  89     return currentColour;
  90   }
  91
  92   @Override
  93   public boolean isNucleotideSpecific()
  94   {
  95     return true;
  96   }
  97
  98   @Override
  99   public String getSchemeName()
 100   {
 101     return JalviewColourScheme.PurinePyrimidine.toString();
 102   }
 103 }