Merge branch 'releases/Release_2_11_4_Branch'
[jalview.git] / schemes / PurinePyrimidineColourScheme.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3  * Copyright (C) 2014 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 java.awt.*;
24
25 /**
26  * Class is based off of NucleotideColourScheme
27  * 
28  * @author Lauren Michelle Lui
29  */
30 public class PurinePyrimidineColourScheme extends ResidueColourScheme
31 {
32   /**
33    * Creates a new PurinePyrimidineColourScheme object.
34    */
35   public PurinePyrimidineColourScheme()
36   {
37     super(ResidueProperties.purinepyrimidineIndex,
38             ResidueProperties.purinepyrimidine, 0);
39   }
40
41   /**
42    * Finds the corresponding color for the type of character inputed
43    * 
44    * @param c
45    *          Character in sequence
46    * 
47    * @return Color from purinepyrimidineIndex in
48    *         jalview.schemes.ResidueProperties
49    */
50   public Color findColour(char c)
51   {
52     return colors[ResidueProperties.purinepyrimidineIndex[c]];
53   }
54
55   /**
56    * Returns color based on conservation
57    * 
58    * @param c
59    *          Character in sequence
60    * @param j
61    *          Threshold
62    * 
63    * @return Color in RGB
64    */
65   public Color findColour(char c, int j)
66   {
67     Color currentColour;
68     if ((threshold == 0) || aboveThreshold(c, j))
69     {
70       try
71       {
72         currentColour = colors[ResidueProperties.purinepyrimidineIndex[c]];
73       } catch (Exception ex)
74       {
75         return Color.white;
76       }
77     }
78     else
79     {
80       return Color.white;
81     }
82
83     if (conservationColouring)
84     {
85       currentColour = applyConservation(currentColour, j);
86     }
87
88     return currentColour;
89   }
90 }