JAL-2416 order score models by order of addition rather than name
[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.datamodel.AnnotatedCollectionI;
24 import jalview.datamodel.SequenceCollectionI;
25 import jalview.datamodel.SequenceI;
26 import jalview.util.Comparison;
27
28 import java.awt.Color;
29 import java.util.Map;
30
31 public class Blosum62ColourScheme extends ResidueColourScheme
32 {
33   private static final Color LIGHT_BLUE = new Color(204, 204, 255);
34   private static final Color DARK_BLUE = new Color(154, 154, 255);
35
36   public Blosum62ColourScheme()
37   {
38     super();
39   }
40
41   /**
42    * Returns a new instance of this colour scheme with which the given data may
43    * be coloured
44    */
45   @Override
46   public ColourSchemeI getInstance(AnnotatedCollectionI coll,
47           Map<SequenceI, SequenceCollectionI> hrs)
48   {
49     return new Blosum62ColourScheme();
50   }
51
52   @Override
53   public Color findColour(char res, int j, SequenceI seq,
54           String consensusResidue, float pid)
55   {
56     /*
57      * compare as upper case; note consensusResidue is 
58      * always computed as uppercase
59      */
60     if ('a' <= res && res <= 'z')
61     {
62       res -= ('a' - 'A');
63     }
64
65     if (Comparison.isGap(res) || consensusResidue == null)
66     {
67       return Color.white;
68     }
69
70     Color colour;
71
72     if (consensusResidue.indexOf(res) > -1)
73     {
74       colour = DARK_BLUE;
75     }
76     else
77     {
78       float score = 0;
79
80       for (char consensus : consensusResidue.toCharArray())
81       {
82         score += ResidueProperties.getBLOSUM62(consensus, res);
83       }
84
85       if (score > 0)
86       {
87         colour = LIGHT_BLUE;
88       }
89       else
90       {
91         colour = Color.white;
92       }
93     }
94     return colour;
95   }
96
97   @Override
98   public boolean isPeptideSpecific()
99   {
100     return true;
101   }
102
103   @Override
104   public String getSchemeName()
105   {
106     return JalviewColourScheme.Blosum62.toString();
107   }
108
109   @Override
110   public boolean isSimple()
111   {
112     return false;
113   }
114 }