JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemes / PurinePyrimidineColourScheme.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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 of the License, or (at your option) any later version.
10  *  
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  * The Jalview Authors are detailed in the 'AUTHORS' file.
18  */
19 package jalview.schemes;
20
21 import java.awt.*;
22
23 /**
24  * Class is based off of NucleotideColourScheme
25  * 
26  * @author Lauren Michelle Lui
27  */
28 public class PurinePyrimidineColourScheme extends ResidueColourScheme
29 {
30   /**
31    * Creates a new PurinePyrimidineColourScheme object.
32    */
33   public PurinePyrimidineColourScheme()
34   {
35     super(ResidueProperties.purinepyrimidineIndex,
36             ResidueProperties.purinepyrimidine, 0);
37   }
38
39   /**
40    * Finds the corresponding color for the type of character inputed
41    * 
42    * @param c
43    *          Character in sequence
44    * 
45    * @return Color from purinepyrimidineIndex in
46    *         jalview.schemes.ResidueProperties
47    */
48   public Color findColour(char c)
49   {
50     return colors[ResidueProperties.purinepyrimidineIndex[c]];
51   }
52
53   /**
54    * Returns color based on conservation
55    * 
56    * @param c
57    *          Character in sequence
58    * @param j
59    *          Threshold
60    * 
61    * @return Color in RGB
62    */
63   public Color findColour(char c, int j)
64   {
65     Color currentColour;
66     if ((threshold == 0) || aboveThreshold(c, j))
67     {
68       try
69       {
70         currentColour = colors[ResidueProperties.purinepyrimidineIndex[c]];
71       } catch (Exception ex)
72       {
73         return Color.white;
74       }
75     }
76     else
77     {
78       return Color.white;
79     }
80
81     if (conservationColouring)
82     {
83       currentColour = applyConservation(currentColour, j);
84     }
85
86     return currentColour;
87   }
88 }