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