Merge branch 'features/JAL-2360colourSchemeApplicability' into features/JAL-2371colle...
[jalview.git] / 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.datamodel.AnnotatedCollectionI;
24 import jalview.datamodel.SequenceCollectionI;
25 import jalview.datamodel.SequenceI;
26
27 import java.util.Map;
28
29 /**
30  * Colourscheme that takes its colours from some other colourscheme
31  * 
32  * @author jimp
33  * 
34  */
35 public class FollowerColourScheme extends ResidueColourScheme
36 {
37
38   private ColourSchemeI colourScheme;
39
40   public ColourSchemeI getBaseColour()
41   {
42     return colourScheme;
43   }
44
45   @Override
46   public String getSchemeName()
47   {
48     return "Follower";
49   }
50
51   /**
52    * Returns a new instance of this colour scheme with which the given data may
53    * be coloured
54    */
55   @Override
56   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
57           Map<SequenceI, SequenceCollectionI> hrs)
58   {
59     return new FollowerColourScheme();
60   }
61
62   protected ColourSchemeI getColourScheme()
63   {
64     return colourScheme;
65   }
66
67   protected void setColourScheme(ColourSchemeI colourScheme)
68   {
69     this.colourScheme = colourScheme;
70   }
71
72 }