src/jalview/schemes/FollowerColourScheme.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.analysis.Conservation;
  24 import jalview.datamodel.AnnotatedCollectionI;
  25 import jalview.datamodel.ProfilesI;
  26 import jalview.datamodel.SequenceCollectionI;
  27 import jalview.datamodel.SequenceI;
  28
  29 import java.util.Map;
  30
  31 /**
  32  * Colourscheme that takes its colours from some other colourscheme
  33  *
  34  * @author jimp
  35  *
  36  */
  37 public class FollowerColourScheme extends ResidueColourScheme
  38 {
  39
  40   protected ColourSchemeI colourScheme;
  41
  42   public ColourSchemeI getBaseColour()
  43   {
  44     return colourScheme;
  45   }
  46
  47   @Override
  48   public void setConsensus(ProfilesI consensus)
  49   {
  50     if (colourScheme != null)
  51     {
  52       colourScheme.setConsensus(consensus);
  53     }
  54   }
  55
  56   @Override
  57   public void setConservation(Conservation cons)
  58   {
  59     if (colourScheme != null)
  60     {
  61       colourScheme.setConservation(cons);
  62     }
  63   }
  64
  65   @Override
  66   public void setConservationInc(int i)
  67   {
  68     if (colourScheme != null)
  69     {
  70       colourScheme.setConservationInc(i);
  71     }
  72   }
  73
  74   @Override
  75   public String getSchemeName()
  76   {
  77     return "Follower";
  78   }
  79
  80   /**
  81    * Returns a new instance of this colour scheme with which the given data may
  82    * be coloured
  83    */
  84   @Override
  85   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
  86           Map<SequenceI, SequenceCollectionI> hrs)
  87   {
  88     return new FollowerColourScheme();
  89   }
  90
  91 }