Merge branch 'documentation/JAL-2325_release2101' into releases/Release_2_10_Branch
[jalview.git] / src / jalview / schemes / RNAInteractionColourScheme.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.SequenceI;
24
25 import java.awt.Color;
26
27 public class RNAInteractionColourScheme extends ResidueColourScheme
28 {
29   public RNAInteractionColourScheme()
30   {
31     super();
32   }
33
34   /**
35    * DOCUMENT ME!
36    * 
37    * @param n
38    *          DOCUMENT ME!
39    * 
40    * @return DOCUMENT ME!
41    */
42   @Override
43   public Color findColour(char c)
44   {
45     // System.out.println("called"); log.debug
46     return colors[ResidueProperties.nucleotideIndex[c]];
47   }
48
49   /**
50    * DOCUMENT ME!
51    * 
52    * @param n
53    *          DOCUMENT ME!
54    * @param j
55    *          DOCUMENT ME!
56    * 
57    * @return DOCUMENT ME!
58    */
59   @Override
60   public Color findColour(char c, int j, SequenceI seq)
61   {
62     Color currentColour;
63     if ((threshold == 0) || aboveThreshold(c, j))
64     {
65       try
66       {
67         currentColour = colors[ResidueProperties.nucleotideIndex[c]];
68       } catch (Exception ex)
69       {
70         return Color.white;
71       }
72     }
73     else
74     {
75       return Color.white;
76     }
77
78     if (conservationColouring)
79     {
80       currentColour = applyConservation(currentColour, j);
81     }
82
83     return currentColour;
84   }
85 }