JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / renderer / ResidueShaderI.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 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 License for more details.
16  * 
17  * You should have received a copy of the GNU General 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.renderer;
22
23 import jalview.analysis.Conservation;
24 import jalview.datamodel.AnnotatedCollectionI;
25 import jalview.datamodel.ProfilesI;
26 import jalview.datamodel.SequenceCollectionI;
27 import jalview.datamodel.SequenceI;
28 import jalview.schemes.ColourSchemeI;
29
30 import java.awt.Color;
31 import java.util.Map;
32
33 public interface ResidueShaderI
34 {
35   void setConsensus(ProfilesI cons);
36
37   boolean conservationApplied();
38
39   void setConservationApplied(boolean conservationApplied);
40
41   void setConservation(Conservation cons);
42
43   void alignmentChanged(AnnotatedCollectionI alignment,
44           Map<SequenceI, SequenceCollectionI> hiddenReps);
45
46   /**
47    * Sets the percentage consensus threshold value, and whether gaps are ignored
48    * in percentage identity calculation
49    * 
50    * @param consensusThreshold
51    * @param ignoreGaps
52    */
53   void setThreshold(int consensusThreshold,
54           boolean ignoreGaps);
55
56   void setConservationInc(int i);
57
58   int getConservationInc();
59
60   /**
61    * Get the percentage threshold for this colour scheme
62    * 
63    * @return Returns the percentage threshold
64    */
65   int getThreshold();
66
67   /**
68    * Returns the possibly context dependent colour for the given symbol at the
69    * aligned position in the given sequence. For example, the colour may depend
70    * on the symbol's relationship to the consensus residue for the column.
71    * 
72    * @param symbol
73    * @param position
74    * @param seq
75    * @return
76    */
77   Color findColour(char symbol, int position,
78           SequenceI seq);
79
80   ColourSchemeI getColourScheme();
81
82   void setColourScheme(ColourSchemeI cs);
83
84 }