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);
  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   @Override
  62   public boolean isNucleotideSpecific()
  63   {
  64     return true;
  65   }
  66
  67   @Override
  68   public String getSchemeName()
  69   {
  70     return JalviewColourScheme.PurinePyrimidine.toString();
  71   }
  72
  73   /**
  74    * Returns a new instance of this colour scheme with which the given data may
  75    * be coloured
  76    */
  77   @Override
  78   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
  79           Map<SequenceI, SequenceCollectionI> hrs)
  80   {
  81     return new PurinePyrimidineColourScheme();
  82   }
  83 }