JAL-4238 minor errors fixed for JalviewJS structure colouring
[jalview.git] / src / jalview / structure / StructureCommandsBase.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.structure;
22
23 import java.awt.Color;
24 import java.util.ArrayList;
25 import java.util.List;
26 import java.util.Map;
27 import java.util.Map.Entry;
28
29 /**
30  * A base class holding methods useful to all classes that implement commands
31  * for structure viewers
32  * 
33  * @author gmcarstairs
34  *
35  */
36 public abstract class StructureCommandsBase implements StructureCommandsI
37 {
38   public static final String NAMESPACE_PREFIX = "jv_";
39
40   private static final String CMD_SEPARATOR = ";";
41
42   /**
43    * Returns something that separates concatenated commands
44    * 
45    * @return
46    */
47   protected String getCommandSeparator()
48   {
49     return CMD_SEPARATOR;
50   }
51
52   /**
53    * Returns the lowest model number used by the structure viewer
54    * 
55    * @return
56    */
57   @Override
58   public int getModelStartNo()
59   {
60     return 0;
61   }
62
63   /**
64    * Helper method to add one contiguous range to the AtomSpec model for the
65    * given value (creating the model if necessary). As used by Jalview,
66    * {@code value} is
67    * <ul>
68    * <li>a colour, when building a 'colour structure by sequence' command</li>
69    * <li>a feature value, when building a 'set Chimera attributes from features'
70    * command</li>
71    * </ul>
72    * 
73    * @param map
74    * @param value
75    * @param model
76    * @param startPos
77    * @param endPos
78    * @param chain
79    */
80   public static final void addAtomSpecRange(Map<Object, AtomSpecModel> map,
81           Object value, String model, int startPos, int endPos,
82           String chain)
83   {
84     /*
85      * Get/initialize map of data for the colour
86      */
87     AtomSpecModel atomSpec = map.get(value);
88     if (atomSpec == null)
89     {
90       atomSpec = new AtomSpecModel();
91       map.put(value, atomSpec);
92     }
93
94     atomSpec.addRange(model, startPos, endPos, chain);
95   }
96
97   /**
98    * Makes a structure viewer attribute name for a Jalview feature type by
99    * prefixing it with "jv_", and replacing any non-alphanumeric characters with
100    * an underscore
101    * 
102    * @param featureType
103    * @return
104    */
105   protected String makeAttributeName(String featureType)
106   {
107     StringBuilder sb = new StringBuilder();
108     if (featureType != null)
109     {
110       for (char c : featureType.toCharArray())
111       {
112         sb.append(Character.isLetterOrDigit(c) ? c : '_');
113       }
114     }
115     String attName = NAMESPACE_PREFIX + sb.toString();
116     return attName;
117   }
118
119   /**
120    * Traverse the map of colours/models/chains/positions to construct a list of
121    * 'color' commands (one per distinct colour used). The format of each command
122    * is specific to the structure viewer.
123    * <p>
124    * The default implementation returns a single command containing one command
125    * per colour, concatenated.
126    * 
127    * @param colourMap
128    * @return
129    */
130   @Override
131   public List<StructureCommandI> colourBySequence(
132           Map<Object, AtomSpecModel> colourMap)
133   {
134     if (colourMap == null)
135     {
136       return null;
137     }
138     List<StructureCommandI> commands = new ArrayList<>();
139     StringBuilder sb = new StringBuilder(colourMap.size() * 20);
140     boolean first = true;
141     for (Object key : colourMap.keySet())
142     {
143       Color colour = (Color) key;
144       final AtomSpecModel colourData = colourMap.get(colour);
145       StructureCommandI command = getColourCommand(colourData, colour);
146       if (!first)
147       {
148         sb.append(getCommandSeparator());
149       }
150       first = false;
151       sb.append(command.getCommand());
152     }
153
154     commands.add(new StructureCommand(sb.toString()));
155     return commands;
156   }
157
158   /**
159    * Returns a command to colour the atoms represented by {@code atomSpecModel}
160    * with the colour specified by {@code colourCode}.
161    * 
162    * @param atomSpecModel
163    * @param colour
164    * @return
165    */
166   protected StructureCommandI getColourCommand(AtomSpecModel atomSpecModel,
167           Color colour)
168   {
169     String atomSpec = getAtomSpec(atomSpecModel, AtomSpecType.RESIDUE_ONLY);
170     return colourResidues(atomSpec, colour);
171   }
172
173   /**
174    * Returns a command to colour the atoms described (in viewer command syntax)
175    * by {@code atomSpec} with the colour specified by {@code colourCode}
176    * 
177    * @param atomSpec
178    * @param colour
179    * @return
180    */
181   protected abstract StructureCommandI colourResidues(String atomSpec,
182           Color colour);
183
184   @Override
185   public List<StructureCommandI> colourByResidues(
186           Map<String, Color> colours)
187   {
188     List<StructureCommandI> commands = new ArrayList<>();
189     for (Entry<String, Color> entry : colours.entrySet())
190     {
191       commands.add(colourResidue(entry.getKey(), entry.getValue()));
192     }
193     return commands;
194   }
195
196   private StructureCommandI colourResidue(String resName, Color col)
197   {
198     String atomSpec = getResidueSpec(resName);
199     return colourResidues(atomSpec, col);
200   }
201
202   /**
203    * Helper method to append one start-end range to an atomspec string
204    * 
205    * @param sb
206    * @param start
207    * @param end
208    * @param chain
209    * @param firstPositionForModel
210    */
211   protected void appendRange(StringBuilder sb, int start, int end,
212           String chain, boolean firstPositionForModel, boolean isChimeraX)
213   {
214     if (!firstPositionForModel)
215     {
216       sb.append(",");
217     }
218     if (end == start)
219     {
220       sb.append(start);
221     }
222     else
223     {
224       sb.append(start).append("-").append(end);
225     }
226
227     if (!isChimeraX)
228     {
229       sb.append(".");
230       if (!" ".equals(chain))
231       {
232         sb.append(chain);
233       }
234     }
235   }
236
237   /**
238    * Returns the atom specifier meaning all occurrences of the given residue
239    * 
240    * @param residue
241    * @return
242    */
243   protected abstract String getResidueSpec(String residue);
244
245   @Override
246   public List<StructureCommandI> setAttributes(
247           Map<String, Map<Object, AtomSpecModel>> featureValues)
248   {
249     // default does nothing, override where this is implemented
250     return null;
251   }
252
253   @Override
254   public List<StructureCommandI> startNotifications(String uri)
255   {
256     return null;
257   }
258
259   @Override
260   public List<StructureCommandI> stopNotifications()
261   {
262     return null;
263   }
264
265   @Override
266   public StructureCommandI getSelectedResidues()
267   {
268     return null;
269   }
270
271   @Override
272   public StructureCommandI listResidueAttributes()
273   {
274     return null;
275   }
276
277   @Override
278   public StructureCommandI getResidueAttributes(String attName)
279   {
280     return null;
281   }
282
283   @Override
284   public StructureCommandI restoreSession(String filePath)
285   {
286     return loadFile(filePath);
287   }
288 }