JAL-2094 first pass with jalview.api.ColorI interface
[jalview.git] / src / jalview / schemes / Blosum62ColourScheme.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.analysis.AAFrequency;
24 import jalview.datamodel.AnnotatedCollectionI;
25 import jalview.datamodel.SequenceCollectionI;
26 import jalview.datamodel.SequenceI;
27
28 import java.awt.Color;
29 import java.util.Map;
30
31 public class Blosum62ColourScheme extends ResidueColourScheme
32 {
33   public Blosum62ColourScheme()
34   {
35     super();
36   }
37
38   @Override
39   public Color findColour(char res, int j, SequenceI seq)
40   {
41     if ('a' <= res && res <= 'z')
42     {
43       // TO UPPERCASE !!!
44       res -= ('a' - 'A');
45     }
46
47     if (consensus == null || j >= consensus.length || consensus[j] == null
48             || (threshold != 0 && !aboveThreshold(res, j)))
49     {
50       return Color.white;
51     }
52
53     Color currentColour;
54
55     if (!jalview.util.Comparison.isGap(res))
56     {
57       String max = (String) consensus[j].get(AAFrequency.MAXRESIDUE);
58
59       if (max.indexOf(res) > -1)
60       {
61         // TODO use a constant here?
62         currentColour = new Color(154, 154, 255);
63       }
64       else
65       {
66         int c = 0;
67         int max_aa = 0;
68         int n = max.length();
69
70         do
71         {
72           c += ResidueProperties.getBLOSUM62(max.charAt(max_aa), res);
73         } while (++max_aa < n);
74
75         if (c > 0)
76         {
77           // TODO use a constant here?
78           currentColour = new Color(204, 204, 255);
79         }
80         else
81         {
82           currentColour = Color.white;
83         }
84       }
85
86       if (conservationColouring)
87       {
88         currentColour = applyConservation(currentColour, j);
89       }
90     }
91     else
92     {
93       return Color.white;
94     }
95
96     return currentColour;
97   }
98
99   @Override
100   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
101           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
102   {
103     ColourSchemeI newcs = super.applyTo(sg, hiddenRepSequences);
104     return newcs;
105   }
106 }