dff2bf3bd94f4d0a258891f101a9b2058351ee99
[jalview.git] / NucleotideColourScheme.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 /**
28  * DOCUMENT ME!
29  * 
30  * @author $author$
31  * @version $Revision$
32  */
33 public class NucleotideColourScheme extends ResidueColourScheme
34 {
35   /**
36    * Creates a new NucleotideColourScheme object.
37    */
38   public NucleotideColourScheme()
39   {
40     super(ResidueProperties.nucleotideIndex, ResidueProperties.nucleotide,
41             0);
42   }
43
44   /**
45    * DOCUMENT ME!
46    * 
47    * @param n
48    *          DOCUMENT ME!
49    * 
50    * @return DOCUMENT ME!
51    */
52   @Override
53   public Color findColour(char c)
54   {
55     // System.out.println("called"); log.debug
56     return colors[ResidueProperties.nucleotideIndex[c]];
57   }
58
59   /**
60    * DOCUMENT ME!
61    * 
62    * @param n
63    *          DOCUMENT ME!
64    * @param j
65    *          DOCUMENT ME!
66    * 
67    * @return DOCUMENT ME!
68    */
69   @Override
70   public Color findColour(char c, int j, SequenceI seq)
71   {
72     Color currentColour;
73     if ((threshold == 0) || aboveThreshold(c, j))
74     {
75       try
76       {
77         currentColour = colors[ResidueProperties.nucleotideIndex[c]];
78       } catch (Exception ex)
79       {
80         return Color.white;
81       }
82     }
83     else
84     {
85       return Color.white;
86     }
87
88     if (conservationColouring)
89     {
90       currentColour = applyConservation(currentColour, j);
91     }
92
93     return currentColour;
94   }
95 }