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.api.AlignViewportI;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25
  26 /**
  27  * DOCUMENT ME!
  28  *
  29  * @author $author$
  30  * @version $Revision$
  31  */
  32 public class NucleotideColourScheme extends ResidueColourScheme
  33 {
  34   /**
  35    * Creates a new NucleotideColourScheme object.
  36    */
  37   public NucleotideColourScheme()
  38   {
  39     super(ResidueProperties.nucleotideIndex, ResidueProperties.nucleotide);
  40   }
  41
  42   @Override
  43   public boolean isNucleotideSpecific()
  44   {
  45     return true;
  46   }
  47
  48   @Override
  49   public String getSchemeName()
  50   {
  51     return JalviewColourScheme.Nucleotide.toString();
  52   }
  53
  54   /**
  55    * Returns a new instance of this colour scheme with which the given data may
  56    * be coloured
  57    */
  58   @Override
  59   public ColourSchemeI getInstance(AlignViewportI view,
  60           AnnotatedCollectionI coll)
  61   {
  62     return new NucleotideColourScheme();
  63   }
  64 }