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