src/jalview/schemes/NucleotideColourScheme.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  * DOCUMENT ME!
  32  *
  33  * @author $author$
  34  * @version $Revision$
  35  */
  36 public class NucleotideColourScheme extends ResidueColourScheme
  37 {
  38   /**
  39    * Creates a new NucleotideColourScheme object.
  40    */
  41   public NucleotideColourScheme()
  42   {
  43     super(ResidueProperties.nucleotideIndex, ResidueProperties.nucleotide);
  44   }
  45
  46   /**
  47    * DOCUMENT ME!
  48    *
  49    * @param n
  50    *          DOCUMENT ME!
  51    *
  52    * @return DOCUMENT ME!
  53    */
  54   @Override
  55   public Color findColour(char c)
  56   {
  57     return colors[ResidueProperties.nucleotideIndex[c]];
  58   }
  59
  60   @Override
  61   public boolean isNucleotideSpecific()
  62   {
  63     return true;
  64   }
  65
  66   @Override
  67   public String getSchemeName()
  68   {
  69     return JalviewColourScheme.Nucleotide.toString();
  70   }
  71
  72   /**
  73    * Returns a new instance of this colour scheme with which the given data may
  74    * be coloured
  75    */
  76   @Override
  77   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
  78           Map<SequenceI, SequenceCollectionI> hrs)
  79   {
  80     return new NucleotideColourScheme();
  81   }
  82 }