import annotation file from datasource
[jalview.git] / src / jalview / io / AnnotationFile.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
4  * \r
5  * This file is part of Jalview.\r
6  * \r
7  * Jalview is free software: you can redistribute it and/or\r
8  * modify it under the terms of the GNU General Public License \r
9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
10  * \r
11  * Jalview is distributed in the hope that it will be useful, but \r
12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
14  * PURPOSE.  See the GNU General Public License for more details.\r
15  * \r
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
17  */\r
18 package jalview.io;\r
19 \r
20 import java.io.*;\r
21 import java.net.*;\r
22 import java.util.*;\r
23 \r
24 import jalview.analysis.*;\r
25 import jalview.datamodel.*;\r
26 import jalview.schemes.*;\r
27 \r
28 public class AnnotationFile\r
29 {\r
30   StringBuffer text = new StringBuffer("JALVIEW_ANNOTATION\n"\r
31           + "# Created: " + new java.util.Date() + "\n\n");\r
32 \r
33   /**\r
34    * convenience method for pre-2.4 feature files which have no view, hidden\r
35    * columns or hidden row keywords.\r
36    * \r
37    * @param annotations\r
38    * @param groups\r
39    * @param properties\r
40    * @return feature file as a string.\r
41    */\r
42   public String printAnnotations(AlignmentAnnotation[] annotations,\r
43           Vector groups, Hashtable properties)\r
44   {\r
45     return printAnnotations(annotations, groups, properties, null);\r
46 \r
47   }\r
48 \r
49   /**\r
50    * hold all the information about a particular view definition read from or\r
51    * written out in an annotations file.\r
52    */\r
53   public class ViewDef\r
54   {\r
55     public String viewname;\r
56 \r
57     public HiddenSequences hidseqs;\r
58 \r
59     public ColumnSelection hiddencols;\r
60 \r
61     public Vector visibleGroups;\r
62 \r
63     public Hashtable hiddenRepSeqs;\r
64 \r
65     public ViewDef(String viewname, HiddenSequences hidseqs,\r
66             ColumnSelection hiddencols, Hashtable hiddenRepSeqs)\r
67     {\r
68       this.viewname = viewname;\r
69       this.hidseqs = hidseqs;\r
70       this.hiddencols = hiddencols;\r
71       this.hiddenRepSeqs = hiddenRepSeqs;\r
72     }\r
73   }\r
74 \r
75   /**\r
76    * Prepare an annotation file given a set of annotations, groups, alignment\r
77    * properties and views.\r
78    * \r
79    * @param annotations\r
80    * @param groups\r
81    * @param properties\r
82    * @param views\r
83    * @return annotation file\r
84    */\r
85   public String printAnnotations(AlignmentAnnotation[] annotations,\r
86           Vector groups, Hashtable properties, ViewDef[] views)\r
87   {\r
88     // TODO: resolve views issue : annotationFile could contain visible region,\r
89     // or full data + hidden region specifications for a view.\r
90     if (annotations != null)\r
91     {\r
92       boolean oneColour = true;\r
93       AlignmentAnnotation row;\r
94       String comma;\r
95       SequenceI refSeq = null;\r
96       SequenceGroup refGroup = null;\r
97 \r
98       StringBuffer colours = new StringBuffer();\r
99       StringBuffer graphLine = new StringBuffer();\r
100       StringBuffer rowprops = new StringBuffer();\r
101       Hashtable graphGroup = new Hashtable();\r
102 \r
103       java.awt.Color color;\r
104 \r
105       for (int i = 0; i < annotations.length; i++)\r
106       {\r
107         row = annotations[i];\r
108 \r
109         if (!row.visible && !row.hasScore())\r
110         {\r
111           continue;\r
112         }\r
113 \r
114         color = null;\r
115         oneColour = true;\r
116 \r
117         if (row.sequenceRef == null)\r
118         {\r
119           if (refSeq != null)\r
120           {\r
121             text.append("\nSEQUENCE_REF\tALIGNMENT\n");\r
122           }\r
123 \r
124           refSeq = null;\r
125         }\r
126 \r
127         else\r
128         {\r
129           if (refSeq == null || refSeq != row.sequenceRef)\r
130           {\r
131             refSeq = row.sequenceRef;\r
132             text.append("\nSEQUENCE_REF\t" + refSeq.getName() + "\n");\r
133           }\r
134         }\r
135         // mark any group references for the row\r
136         if (row.groupRef == null)\r
137         {\r
138 \r
139           if (refGroup != null)\r
140           {\r
141             text.append("\nGROUP_REF\tALIGNMENT\n");\r
142           }\r
143 \r
144           refGroup = null;\r
145         }\r
146         else\r
147         {\r
148           if (refGroup == null || refGroup != row.groupRef)\r
149           {\r
150             refGroup = row.groupRef;\r
151             text.append("\nGROUP_REF\t" + refGroup.getName() + "\n");\r
152           }\r
153         }\r
154 \r
155         boolean hasGlyphs = row.hasIcons, hasLabels = row.hasText, hasValues = row.hasScore, hasText = false;\r
156         // lookahead to check what the annotation row object actually contains.\r
157         for (int j = 0; row.annotations != null\r
158                 && j < row.annotations.length\r
159                 && (!hasGlyphs || !hasLabels || !hasValues); j++)\r
160         {\r
161           if (row.annotations[j] != null)\r
162           {\r
163             hasLabels |= (row.annotations[j].displayCharacter != null\r
164                     && row.annotations[j].displayCharacter.length() > 0 && !row.annotations[j].displayCharacter\r
165                     .equals(" "));\r
166             hasGlyphs |= (row.annotations[j].secondaryStructure != 0 && row.annotations[j].secondaryStructure != ' ');\r
167             hasValues |= (row.annotations[j].value != Float.NaN); // NaNs can't\r
168             // be\r
169             // rendered..\r
170             hasText |= (row.annotations[j].description != null && row.annotations[j].description\r
171                     .length() > 0);\r
172           }\r
173         }\r
174 \r
175         if (row.graph == AlignmentAnnotation.NO_GRAPH)\r
176         {\r
177           text.append("NO_GRAPH\t");\r
178           hasValues = false; // only secondary structure\r
179           // hasLabels = false; // and annotation description string.\r
180         }\r
181         else\r
182         {\r
183           if (row.graph == AlignmentAnnotation.BAR_GRAPH)\r
184           {\r
185             text.append("BAR_GRAPH\t");\r
186             hasGlyphs = false; // no secondary structure\r
187 \r
188           }\r
189           else if (row.graph == AlignmentAnnotation.LINE_GRAPH)\r
190           {\r
191             hasGlyphs = false; // no secondary structure\r
192             text.append("LINE_GRAPH\t");\r
193           }\r
194 \r
195           if (row.getThreshold() != null)\r
196           {\r
197             graphLine\r
198                     .append("GRAPHLINE\t"\r
199                             + row.label\r
200                             + "\t"\r
201                             + row.getThreshold().value\r
202                             + "\t"\r
203                             + row.getThreshold().label\r
204                             + "\t"\r
205                             + jalview.util.Format.getHexString(row\r
206                                     .getThreshold().colour) + "\n");\r
207           }\r
208 \r
209           if (row.graphGroup > -1)\r
210           {\r
211             String key = String.valueOf(row.graphGroup);\r
212             if (graphGroup.containsKey(key))\r
213             {\r
214               graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);\r
215             }\r
216             else\r
217             {\r
218               graphGroup.put(key, row.label);\r
219             }\r
220           }\r
221         }\r
222 \r
223         text.append(row.label + "\t");\r
224         if (row.description != null)\r
225         {\r
226           text.append(row.description + "\t");\r
227         }\r
228         for (int j = 0; row.annotations != null\r
229                 && j < row.annotations.length; j++)\r
230         {\r
231           if (refSeq != null\r
232                   && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))\r
233           {\r
234             continue;\r
235           }\r
236 \r
237           if (row.annotations[j] != null)\r
238           {\r
239             comma = "";\r
240             if (hasGlyphs) // could be also hasGlyphs || ...\r
241             {\r
242 \r
243               text.append(comma);\r
244               if (row.annotations[j].secondaryStructure != ' ')\r
245               {\r
246                 // only write out the field if its not whitespace.\r
247                 text.append(row.annotations[j].secondaryStructure);\r
248               }\r
249               comma = ",";\r
250             }\r
251             if (hasValues)\r
252             {\r
253               if (row.annotations[j].value != Float.NaN)\r
254               {\r
255                 text.append(comma + row.annotations[j].value);\r
256               }\r
257               else\r
258               {\r
259                 System.err.println("Skipping NaN - not valid value.");\r
260                 text.append(comma + 0f);// row.annotations[j].value);\r
261               }\r
262               comma = ",";\r
263             }\r
264             if (hasLabels)\r
265             {\r
266               // TODO: labels are emitted after values for bar graphs.\r
267               if // empty labels are allowed, so\r
268               (row.annotations[j].displayCharacter != null\r
269                       && row.annotations[j].displayCharacter.length() > 0\r
270                       && !row.annotations[j].displayCharacter.equals(" "))\r
271               {\r
272                 text.append(comma + row.annotations[j].displayCharacter);\r
273                 comma = ",";\r
274               }\r
275             }\r
276             if (hasText)\r
277             {\r
278               if (row.annotations[j].description != null\r
279                       && row.annotations[j].description.length() > 0\r
280                       && !row.annotations[j].description\r
281                               .equals(row.annotations[j].displayCharacter))\r
282               {\r
283                 text.append(comma + row.annotations[j].description);\r
284                 comma = ",";\r
285               }\r
286             }\r
287             if (color != null && !color.equals(row.annotations[j].colour))\r
288             {\r
289               oneColour = false;\r
290             }\r
291 \r
292             color = row.annotations[j].colour;\r
293 \r
294             if (row.annotations[j].colour != null\r
295                     && row.annotations[j].colour != java.awt.Color.black)\r
296             {\r
297               text.append(comma\r
298                       + "["\r
299                       + jalview.util.Format\r
300                               .getHexString(row.annotations[j].colour)\r
301                       + "]");\r
302               comma = ",";\r
303             }\r
304           }\r
305           text.append("|");\r
306         }\r
307 \r
308         if (row.hasScore())\r
309           text.append("\t" + row.score);\r
310 \r
311         text.append("\n");\r
312 \r
313         if (color != null && color != java.awt.Color.black && oneColour)\r
314         {\r
315           colours.append("COLOUR\t" + row.label + "\t"\r
316                   + jalview.util.Format.getHexString(color) + "\n");\r
317         }\r
318         if (row.scaleColLabel || row.showAllColLabels\r
319                 || row.centreColLabels)\r
320         {\r
321           rowprops.append("ROWPROPERTIES\t" + row.label);\r
322           rowprops.append("\tscaletofit=" + row.scaleColLabel);\r
323           rowprops.append("\tshowalllabs=" + row.showAllColLabels);\r
324           rowprops.append("\tcentrelabs=" + row.centreColLabels);\r
325           rowprops.append("\n");\r
326         }\r
327       }\r
328 \r
329       text.append("\n");\r
330 \r
331       text.append(colours.toString());\r
332       text.append(graphLine.toString());\r
333       if (graphGroup.size() > 0)\r
334       {\r
335         text.append("COMBINE\t");\r
336         Enumeration en = graphGroup.elements();\r
337         while (en.hasMoreElements())\r
338         {\r
339           text.append(en.nextElement() + "\n");\r
340         }\r
341       }\r
342       text.append(rowprops.toString());\r
343     }\r
344 \r
345     if (groups != null)\r
346     {\r
347       printGroups(groups);\r
348     }\r
349 \r
350     if (properties != null)\r
351     {\r
352       text.append("\n\nALIGNMENT");\r
353       Enumeration en = properties.keys();\r
354       while (en.hasMoreElements())\r
355       {\r
356         String key = en.nextElement().toString();\r
357         text.append("\t" + key + "=" + properties.get(key));\r
358       }\r
359       // TODO: output alignment visualization settings here if required\r
360 \r
361     }\r
362 \r
363     return text.toString();\r
364   }\r
365 \r
366   public void printGroups(Vector sequenceGroups)\r
367   {\r
368     SequenceGroup sg;\r
369     SequenceI seqrep = null;\r
370     for (int i = 0; i < sequenceGroups.size(); i++)\r
371     {\r
372       sg = (SequenceGroup) sequenceGroups.elementAt(i);\r
373       if (!sg.hasSeqrep())\r
374       {\r
375         text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"\r
376                 + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1)\r
377                 + "\t" + "-1\t");\r
378         seqrep = null;\r
379       }\r
380       else\r
381       {\r
382         seqrep = sg.getSeqrep();\r
383         text.append("SEQUENCE_REF\t" + seqrep.getName() + "\n");\r
384         text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"\r
385                 + (seqrep.findPosition(sg.getStartRes())) + "\t"\r
386                 + (seqrep.findPosition(sg.getEndRes())) + "\t" + "-1\t");\r
387       }\r
388       for (int s = 0; s < sg.getSize(); s++)\r
389       {\r
390         text.append(sg.getSequenceAt(s).getName() + "\t");\r
391       }\r
392 \r
393       text.append("\nPROPERTIES\t" + sg.getName() + "\t");\r
394 \r
395       if (sg.getDescription() != null)\r
396       {\r
397         text.append("description=" + sg.getDescription() + "\t");\r
398       }\r
399       if (sg.cs != null)\r
400       {\r
401         text.append("colour=" + ColourSchemeProperty.getColourName(sg.cs)\r
402                 + "\t");\r
403         if (sg.cs.getThreshold() != 0)\r
404         {\r
405           text.append("pidThreshold=" + sg.cs.getThreshold());\r
406         }\r
407         if (sg.cs.conservationApplied())\r
408         {\r
409           text.append("consThreshold=" + sg.cs.getConservationInc() + "\t");\r
410         }\r
411       }\r
412       text.append("outlineColour="\r
413               + jalview.util.Format.getHexString(sg.getOutlineColour())\r
414               + "\t");\r
415 \r
416       text.append("displayBoxes=" + sg.getDisplayBoxes() + "\t");\r
417       text.append("displayText=" + sg.getDisplayText() + "\t");\r
418       text.append("colourText=" + sg.getColourText() + "\t");\r
419       text.append("showUnconserved=" + sg.getShowNonconserved() + "\t");\r
420       if (sg.textColour != java.awt.Color.black)\r
421       {\r
422         text.append("textCol1="\r
423                 + jalview.util.Format.getHexString(sg.textColour) + "\t");\r
424       }\r
425       if (sg.textColour2 != java.awt.Color.white)\r
426       {\r
427         text.append("textCol2="\r
428                 + jalview.util.Format.getHexString(sg.textColour2) + "\t");\r
429       }\r
430       if (sg.thresholdTextColour != 0)\r
431       {\r
432         text.append("textColThreshold=" + sg.thresholdTextColour + "\t");\r
433       }\r
434       if (sg.idColour != null)\r
435       {\r
436         text.append("idColour="\r
437                 + jalview.util.Format.getHexString(sg.idColour) + "\t");\r
438       }\r
439       if (sg.isHidereps())\r
440       {\r
441         text.append("hide=true\t");\r
442       }\r
443       if (sg.isHideCols())\r
444       {\r
445         text.append("hidecols=true\t");\r
446       }\r
447       if (seqrep != null)\r
448       {\r
449         // terminate the last line and clear the sequence ref for the group\r
450         text.append("\nSEQUENCE_REF");\r
451       }\r
452       text.append("\n\n");\r
453 \r
454     }\r
455   }\r
456 \r
457   SequenceI refSeq = null;\r
458 \r
459   String refSeqId = null;\r
460 \r
461   public boolean readAnnotationFile(AlignmentI al, String file,\r
462           String protocol)\r
463   {\r
464     BufferedReader in = null;\r
465     try\r
466     {\r
467       if (protocol.equals(AppletFormatAdapter.FILE))\r
468       {\r
469         in = new BufferedReader(new FileReader(file));\r
470       }\r
471       else if (protocol.equals(AppletFormatAdapter.URL))\r
472       {\r
473         URL url = new URL(file);\r
474         in = new BufferedReader(new InputStreamReader(url.openStream()));\r
475       }\r
476       else if (protocol.equals(AppletFormatAdapter.PASTE))\r
477       {\r
478         in = new BufferedReader(new StringReader(file));\r
479       }\r
480       else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))\r
481       {\r
482         java.io.InputStream is = getClass().getResourceAsStream("/" + file);\r
483         if (is != null)\r
484         {\r
485           in = new BufferedReader(new java.io.InputStreamReader(is));\r
486         }\r
487       }\r
488       if (in != null)\r
489       {\r
490         return parseAnnotationFrom(al, in);\r
491       }\r
492 \r
493     } catch (Exception ex)\r
494     {\r
495       ex.printStackTrace();\r
496       System.out.println("Problem reading annotation file: " + ex);\r
497       return false;\r
498     }\r
499     return false;\r
500   }\r
501 \r
502   public boolean parseAnnotationFrom(AlignmentI al, BufferedReader in)\r
503           throws Exception\r
504   {\r
505     String groupRef = null;\r
506     Hashtable groupRefRows = new Hashtable();\r
507 \r
508     Hashtable autoAnnots = new Hashtable();\r
509     {\r
510       String line, label, description, token;\r
511       int graphStyle, index;\r
512       int refSeqIndex = 1;\r
513       int existingAnnotations = 0;\r
514       // when true - will add new rows regardless of whether they are duplicate\r
515       // auto-annotation like consensus or conservation graphs\r
516       boolean overrideAutoAnnot = false;\r
517       if (al.getAlignmentAnnotation() != null)\r
518       {\r
519         existingAnnotations = al.getAlignmentAnnotation().length;\r
520         if (existingAnnotations > 0)\r
521         {\r
522           AlignmentAnnotation[] aa = al.getAlignmentAnnotation();\r
523           for (int aai = 0; aai < aa.length; aai++)\r
524           {\r
525             if (aa[aai].autoCalculated)\r
526             {\r
527               // make a note of the name and description\r
528               autoAnnots\r
529                       .put(aa[aai].graph\r
530                               + "\t"\r
531                               + aa[aai].label\r
532                               + "\t"\r
533                               + aa[aai].description\r
534                               + "\t"\r
535                               + (aa[aai].sequenceRef != null ? aa[aai].sequenceRef\r
536                                       .getDisplayId(true) : ""),\r
537                               new Integer(1));\r
538             }\r
539           }\r
540         }\r
541       }\r
542 \r
543       int alWidth = al.getWidth();\r
544 \r
545       StringTokenizer st;\r
546       Annotation[] annotations;\r
547       AlignmentAnnotation annotation = null;\r
548 \r
549       // First confirm this is an Annotation file\r
550       boolean jvAnnotationFile = false;\r
551       while ((line = in.readLine()) != null)\r
552       {\r
553         if (line.indexOf("#") == 0)\r
554         {\r
555           continue;\r
556         }\r
557 \r
558         if (line.indexOf("JALVIEW_ANNOTATION") > -1)\r
559         {\r
560           jvAnnotationFile = true;\r
561           break;\r
562         }\r
563       }\r
564 \r
565       if (!jvAnnotationFile)\r
566       {\r
567         in.close();\r
568         return false;\r
569       }\r
570 \r
571       while ((line = in.readLine()) != null)\r
572       {\r
573         if (line.indexOf("#") == 0\r
574                 || line.indexOf("JALVIEW_ANNOTATION") > -1\r
575                 || line.length() == 0)\r
576         {\r
577           continue;\r
578         }\r
579 \r
580         st = new StringTokenizer(line, "\t");\r
581         token = st.nextToken();\r
582         if (token.equalsIgnoreCase("COLOUR"))\r
583         {\r
584           // TODO: use graduated colour def'n here too\r
585           colourAnnotations(al, st.nextToken(), st.nextToken());\r
586           continue;\r
587         }\r
588 \r
589         else if (token.equalsIgnoreCase("COMBINE"))\r
590         {\r
591           combineAnnotations(al, st);\r
592           continue;\r
593         }\r
594         else if (token.equalsIgnoreCase("ROWPROPERTIES"))\r
595         {\r
596           addRowProperties(al, st);\r
597           continue;\r
598         }\r
599         else if (token.equalsIgnoreCase("GRAPHLINE"))\r
600         {\r
601           addLine(al, st);\r
602           continue;\r
603         }\r
604 \r
605         else if (token.equalsIgnoreCase("SEQUENCE_REF"))\r
606         {\r
607           if (st.hasMoreTokens())\r
608           {\r
609             refSeq = al.findName(refSeqId = st.nextToken());\r
610             if (refSeq == null)\r
611             {\r
612               refSeqId = null;\r
613             }\r
614             try\r
615             {\r
616               refSeqIndex = Integer.parseInt(st.nextToken());\r
617               if (refSeqIndex < 1)\r
618               {\r
619                 refSeqIndex = 1;\r
620                 System.out\r
621                         .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");\r
622               }\r
623             } catch (Exception ex)\r
624             {\r
625               refSeqIndex = 1;\r
626             }\r
627           }\r
628           else\r
629           {\r
630             refSeq = null;\r
631             refSeqId = null;\r
632           }\r
633           continue;\r
634         }\r
635         else if (token.equalsIgnoreCase("GROUP_REF"))\r
636         {\r
637           // Group references could be forward or backwards, so they are\r
638           // resolved after the whole file is read in\r
639           groupRef = null;\r
640           if (st.hasMoreTokens())\r
641           {\r
642             groupRef = st.nextToken();\r
643             if (groupRef.length() < 1)\r
644             {\r
645               groupRef = null; // empty string\r
646             }\r
647             else\r
648             {\r
649               if (groupRefRows.get(groupRef) == null)\r
650               {\r
651                 groupRefRows.put(groupRef, new Vector());\r
652               }\r
653             }\r
654           }\r
655           continue;\r
656         }\r
657         else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))\r
658         {\r
659           addGroup(al, st);\r
660           continue;\r
661         }\r
662 \r
663         else if (token.equalsIgnoreCase("PROPERTIES"))\r
664         {\r
665           addProperties(al, st);\r
666           continue;\r
667         }\r
668 \r
669         else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))\r
670         {\r
671           setBelowAlignment(al, st);\r
672           continue;\r
673         }\r
674         else if (token.equalsIgnoreCase("ALIGNMENT"))\r
675         {\r
676           addAlignmentDetails(al, st);\r
677           continue;\r
678         }\r
679 \r
680         // Parse out the annotation row\r
681         graphStyle = AlignmentAnnotation.getGraphValueFromString(token);\r
682         label = st.nextToken();\r
683 \r
684         index = 0;\r
685         annotations = new Annotation[alWidth];\r
686         description = null;\r
687         float score = Float.NaN;\r
688 \r
689         if (st.hasMoreTokens())\r
690         {\r
691           line = st.nextToken();\r
692 \r
693           if (line.indexOf("|") == -1)\r
694           {\r
695             description = line;\r
696             if (st.hasMoreTokens())\r
697               line = st.nextToken();\r
698           }\r
699 \r
700           if (st.hasMoreTokens())\r
701           {\r
702             // This must be the score\r
703             score = Float.valueOf(st.nextToken()).floatValue();\r
704           }\r
705 \r
706           st = new StringTokenizer(line, "|", true);\r
707 \r
708           boolean emptyColumn = true;\r
709           boolean onlyOneElement = (st.countTokens() == 1);\r
710 \r
711           while (st.hasMoreElements() && index < alWidth)\r
712           {\r
713             token = st.nextToken().trim();\r
714 \r
715             if (onlyOneElement)\r
716             {\r
717               try\r
718               {\r
719                 score = Float.valueOf(token).floatValue();\r
720                 break;\r
721               } catch (NumberFormatException ex)\r
722               {\r
723               }\r
724             }\r
725 \r
726             if (token.equals("|"))\r
727             {\r
728               if (emptyColumn)\r
729               {\r
730                 index++;\r
731               }\r
732 \r
733               emptyColumn = true;\r
734             }\r
735             else\r
736             {\r
737               annotations[index++] = parseAnnotation(token, graphStyle);\r
738               emptyColumn = false;\r
739             }\r
740           }\r
741 \r
742         }\r
743 \r
744         annotation = new AlignmentAnnotation(label, description,\r
745                 (index == 0) ? null : annotations, 0, 0, graphStyle);\r
746 \r
747         annotation.score = score;\r
748         if (!overrideAutoAnnot\r
749                 && autoAnnots\r
750                         .containsKey(annotation.graph\r
751                                 + "\t"\r
752                                 + annotation.label\r
753                                 + "\t"\r
754                                 + annotation.description\r
755                                 + "\t"\r
756                                 + (refSeq != null ? refSeq\r
757                                         .getDisplayId(true) : "")))\r
758         {\r
759           // skip - we've already got an automatic annotation of this type.\r
760           continue;\r
761         }\r
762         // otherwise add it!\r
763         if (refSeq != null)\r
764         {\r
765 \r
766           annotation.belowAlignment = false;\r
767           // make a copy of refSeq so we can find other matches in the alignment\r
768           SequenceI referedSeq = refSeq;\r
769           do\r
770           {\r
771             // copy before we do any mapping business.\r
772             // TODO: verify that undo/redo with 1:many sequence associated\r
773             // annotations can be undone correctly\r
774             AlignmentAnnotation ann = new AlignmentAnnotation(annotation);\r
775             annotation\r
776                     .createSequenceMapping(referedSeq, refSeqIndex, false);\r
777             annotation.adjustForAlignment();\r
778             referedSeq.addAlignmentAnnotation(annotation);\r
779             al.addAnnotation(annotation);\r
780             al.setAnnotationIndex(annotation,\r
781                     al.getAlignmentAnnotation().length\r
782                             - existingAnnotations - 1);\r
783             if (groupRef != null)\r
784             {\r
785               ((Vector) groupRefRows.get(groupRef)).addElement(annotation);\r
786             }\r
787             // and recover our virgin copy to use again if necessary.\r
788             annotation = ann;\r
789 \r
790           } while (refSeqId != null\r
791                   && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);\r
792         }\r
793         else\r
794         {\r
795           al.addAnnotation(annotation);\r
796           al.setAnnotationIndex(annotation,\r
797                   al.getAlignmentAnnotation().length - existingAnnotations\r
798                           - 1);\r
799           if (groupRef != null)\r
800           {\r
801             ((Vector) groupRefRows.get(groupRef)).addElement(annotation);\r
802           }\r
803         }\r
804       }\r
805       // Finally, resolve the groupRefs\r
806       Enumeration en = groupRefRows.keys();\r
807       SequenceGroup theGroup = null;\r
808 \r
809       while (en.hasMoreElements())\r
810       {\r
811         groupRef = (String) en.nextElement();\r
812         boolean matched = false;\r
813         // Resolve group: TODO: add a getGroupByName method to alignments\r
814         Vector grps = al.getGroups();\r
815         for (int g = 0, gSize = grps.size(); g < gSize; g++)\r
816         {\r
817           theGroup = (SequenceGroup) grps.elementAt(g);\r
818           if (theGroup.getName().equals(groupRef))\r
819           {\r
820             if (matched)\r
821             {\r
822               // TODO: specify and implement duplication of alignment annotation\r
823               // for multiple group references.\r
824               System.err\r
825                       .println("Ignoring 1:many group reference mappings for group name '"\r
826                               + groupRef + "'");\r
827             }\r
828             else\r
829             {\r
830               matched = true;\r
831               Vector rowset = (Vector) groupRefRows.get(groupRef);\r
832               if (rowset != null && rowset.size() > 0)\r
833               {\r
834                 AlignmentAnnotation alan = null;\r
835                 for (int elm = 0, elmSize = rowset.size(); elm < elmSize; elm++)\r
836                 {\r
837                   alan = (AlignmentAnnotation) rowset.elementAt(elm);\r
838                   alan.groupRef = theGroup;\r
839                 }\r
840               }\r
841             }\r
842           }\r
843         }\r
844         ((Vector) groupRefRows.get(groupRef)).removeAllElements();\r
845       }\r
846     }\r
847     return true;\r
848   }\r
849 \r
850   Annotation parseAnnotation(String string, int graphStyle)\r
851   {\r
852     boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH); // don't\r
853     // do the\r
854     // glyph\r
855     // test\r
856     // if we\r
857     // don't\r
858     // want\r
859     // secondary\r
860     // structure\r
861     String desc = null, displayChar = null;\r
862     char ss = ' '; // secondaryStructure\r
863     float value = 0;\r
864     boolean parsedValue = false, dcset = false;\r
865 \r
866     // find colour here\r
867     java.awt.Color colour = null;\r
868     int i = string.indexOf("[");\r
869     int j = string.indexOf("]");\r
870     if (i > -1 && j > -1)\r
871     {\r
872       UserColourScheme ucs = new UserColourScheme();\r
873 \r
874       colour = ucs.getColourFromString(string.substring(i + 1, j));\r
875       if (i > 0 && string.charAt(i - 1) == ',')\r
876       {\r
877         // clip the preceding comma as well\r
878         i--;\r
879       }\r
880       string = string.substring(0, i) + string.substring(j + 1);\r
881     }\r
882 \r
883     StringTokenizer st = new StringTokenizer(string, ",", true);\r
884     String token;\r
885     boolean seenContent = false;\r
886     int pass = 0;\r
887     while (st.hasMoreTokens())\r
888     {\r
889       pass++;\r
890       token = st.nextToken().trim();\r
891       if (token.equals(","))\r
892       {\r
893         if (!seenContent && parsedValue && !dcset)\r
894         {\r
895           // allow the value below the bar/line to be empty\r
896           dcset = true;\r
897           displayChar = " ";\r
898         }\r
899         seenContent = false;\r
900         continue;\r
901       }\r
902       else\r
903       {\r
904         seenContent = true;\r
905       }\r
906 \r
907       if (!parsedValue)\r
908       {\r
909         try\r
910         {\r
911           displayChar = token;\r
912           // foo\r
913           value = new Float(token).floatValue();\r
914           parsedValue = true;\r
915           continue;\r
916         } catch (NumberFormatException ex)\r
917         {\r
918         }\r
919       }\r
920       else\r
921       {\r
922         if (token.length() == 1)\r
923         {\r
924           displayChar = token;\r
925         }\r
926       }\r
927       if (hasSymbols\r
928               && (token.equals("H") || token.equals("E") || token\r
929                       .equals(" ")))\r
930       {\r
931         // Either this character represents a helix or sheet\r
932         // or an integer which can be displayed\r
933         ss = token.charAt(0);\r
934         if (displayChar.equals(token.substring(0, 1)))\r
935         {\r
936           displayChar = "";\r
937         }\r
938       }\r
939       else if (desc == null || (parsedValue && pass > 2))\r
940       {\r
941         desc = token;\r
942       }\r
943 \r
944     }\r
945     // if (!dcset && string.charAt(string.length() - 1) == ',')\r
946     // {\r
947     // displayChar = " "; // empty display char symbol.\r
948     // }\r
949     if (displayChar != null && desc != null && desc.length() == 1)\r
950     {\r
951       if (displayChar.length() > 1)\r
952       {\r
953         // switch desc and displayChar - legacy support\r
954         String tmp = displayChar;\r
955         displayChar = desc;\r
956         desc = tmp;\r
957       }\r
958       else\r
959       {\r
960         if (displayChar.equals(desc))\r
961         {\r
962           // duplicate label - hangover from the 'robust parser' above\r
963           desc = null;\r
964         }\r
965       }\r
966     }\r
967     Annotation anot = new Annotation(displayChar, desc, ss, value);\r
968 \r
969     anot.colour = colour;\r
970 \r
971     return anot;\r
972   }\r
973 \r
974   void colourAnnotations(AlignmentI al, String label, String colour)\r
975   {\r
976     UserColourScheme ucs = new UserColourScheme(colour);\r
977     Annotation[] annotations;\r
978     for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
979     {\r
980       if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))\r
981       {\r
982         annotations = al.getAlignmentAnnotation()[i].annotations;\r
983         for (int j = 0; j < annotations.length; j++)\r
984         {\r
985           if (annotations[j] != null)\r
986           {\r
987             annotations[j].colour = ucs.findColour('A');\r
988           }\r
989         }\r
990       }\r
991     }\r
992   }\r
993 \r
994   void combineAnnotations(AlignmentI al, StringTokenizer st)\r
995   {\r
996     int graphGroup = -1;\r
997     String group = st.nextToken();\r
998     // First make sure we are not overwriting the graphIndex\r
999     if (al.getAlignmentAnnotation() != null)\r
1000     {\r
1001       for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
1002       {\r
1003         if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
1004         {\r
1005           graphGroup = al.getAlignmentAnnotation()[i].graphGroup + 1;\r
1006           al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
1007           break;\r
1008         }\r
1009       }\r
1010 \r
1011       // Now update groups\r
1012       while (st.hasMoreTokens())\r
1013       {\r
1014         group = st.nextToken();\r
1015         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
1016         {\r
1017           if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
1018           {\r
1019             al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
1020             break;\r
1021           }\r
1022         }\r
1023       }\r
1024     }\r
1025     else\r
1026     {\r
1027       System.err\r
1028               .println("Couldn't combine annotations. None are added to alignment yet!");\r
1029     }\r
1030   }\r
1031 \r
1032   void addLine(AlignmentI al, StringTokenizer st)\r
1033   {\r
1034     String group = st.nextToken();\r
1035     AlignmentAnnotation annotation = null, alannot[] = al\r
1036             .getAlignmentAnnotation();\r
1037     if (alannot != null)\r
1038     {\r
1039       for (int i = 0; i < alannot.length; i++)\r
1040       {\r
1041         if (alannot[i].label.equalsIgnoreCase(group))\r
1042         {\r
1043           annotation = alannot[i];\r
1044           break;\r
1045         }\r
1046       }\r
1047     }\r
1048     if (annotation == null)\r
1049     {\r
1050       return;\r
1051     }\r
1052     float value = new Float(st.nextToken()).floatValue();\r
1053     String label = st.hasMoreTokens() ? st.nextToken() : null;\r
1054     java.awt.Color colour = null;\r
1055     if (st.hasMoreTokens())\r
1056     {\r
1057       UserColourScheme ucs = new UserColourScheme(st.nextToken());\r
1058       colour = ucs.findColour('A');\r
1059     }\r
1060 \r
1061     annotation.setThreshold(new GraphLine(value, label, colour));\r
1062   }\r
1063 \r
1064   void addGroup(AlignmentI al, StringTokenizer st)\r
1065   {\r
1066     SequenceGroup sg = new SequenceGroup();\r
1067     sg.setName(st.nextToken());\r
1068     String rng = "";\r
1069     try\r
1070     {\r
1071       rng = st.nextToken();\r
1072       if (rng.length() > 0 && !rng.startsWith("*"))\r
1073       {\r
1074         sg.setStartRes(Integer.parseInt(rng) - 1);\r
1075       }\r
1076       else\r
1077       {\r
1078         sg.setStartRes(0);\r
1079       }\r
1080       rng = st.nextToken();\r
1081       if (rng.length() > 0 && !rng.startsWith("*"))\r
1082       {\r
1083         sg.setEndRes(Integer.parseInt(rng) - 1);\r
1084       }\r
1085       else\r
1086       {\r
1087         sg.setEndRes(al.getWidth() - 1);\r
1088       }\r
1089     } catch (Exception e)\r
1090     {\r
1091       System.err\r
1092               .println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"\r
1093                       + rng + "' - assuming alignment width for group.");\r
1094       // assume group is full width\r
1095       sg.setStartRes(0);\r
1096       sg.setEndRes(al.getWidth() - 1);\r
1097     }\r
1098 \r
1099     String index = st.nextToken();\r
1100     if (index.equals("-1"))\r
1101     {\r
1102       while (st.hasMoreElements())\r
1103       {\r
1104         sg.addSequence(al.findName(st.nextToken()), false);\r
1105       }\r
1106     }\r
1107     else\r
1108     {\r
1109       StringTokenizer st2 = new StringTokenizer(index, ",");\r
1110 \r
1111       while (st2.hasMoreTokens())\r
1112       {\r
1113         String tmp = st2.nextToken();\r
1114         if (tmp.equals("*"))\r
1115         {\r
1116           for (int i = 0; i < al.getHeight(); i++)\r
1117           {\r
1118             sg.addSequence(al.getSequenceAt(i), false);\r
1119           }\r
1120         }\r
1121         else if (tmp.indexOf("-") >= 0)\r
1122         {\r
1123           StringTokenizer st3 = new StringTokenizer(tmp, "-");\r
1124 \r
1125           int start = (Integer.parseInt(st3.nextToken()));\r
1126           int end = (Integer.parseInt(st3.nextToken()));\r
1127 \r
1128           if (end > start)\r
1129           {\r
1130             for (int i = start; i <= end; i++)\r
1131             {\r
1132               sg.addSequence(al.getSequenceAt(i - 1), false);\r
1133             }\r
1134           }\r
1135         }\r
1136         else\r
1137         {\r
1138           sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1), false);\r
1139         }\r
1140       }\r
1141     }\r
1142 \r
1143     if (refSeq != null)\r
1144     {\r
1145       sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);\r
1146       sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);\r
1147       sg.setSeqrep(refSeq);\r
1148     }\r
1149 \r
1150     if (sg.getSize() > 0)\r
1151     {\r
1152       al.addGroup(sg);\r
1153     }\r
1154   }\r
1155 \r
1156   void addRowProperties(AlignmentI al, StringTokenizer st)\r
1157   {\r
1158     String label = st.nextToken(), keyValue, key, value;\r
1159     boolean scaletofit = false, centerlab = false, showalllabs = false;\r
1160     while (st.hasMoreTokens())\r
1161     {\r
1162       keyValue = st.nextToken();\r
1163       key = keyValue.substring(0, keyValue.indexOf("="));\r
1164       value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1165       if (key.equalsIgnoreCase("scaletofit"))\r
1166       {\r
1167         scaletofit = Boolean.valueOf(value).booleanValue();\r
1168       }\r
1169       if (key.equalsIgnoreCase("showalllabs"))\r
1170       {\r
1171         showalllabs = Boolean.valueOf(value).booleanValue();\r
1172       }\r
1173       if (key.equalsIgnoreCase("centrelabs"))\r
1174       {\r
1175         centerlab = Boolean.valueOf(value).booleanValue();\r
1176       }\r
1177       AlignmentAnnotation[] alr = al.getAlignmentAnnotation();\r
1178       if (alr != null)\r
1179       {\r
1180         for (int i = 0; i < alr.length; i++)\r
1181         {\r
1182           if (alr[i].label.equalsIgnoreCase(label))\r
1183           {\r
1184             alr[i].centreColLabels = centerlab;\r
1185             alr[i].scaleColLabel = scaletofit;\r
1186             alr[i].showAllColLabels = showalllabs;\r
1187           }\r
1188         }\r
1189       }\r
1190     }\r
1191   }\r
1192 \r
1193   void addProperties(AlignmentI al, StringTokenizer st)\r
1194   {\r
1195 \r
1196     // So far we have only added groups to the annotationHash,\r
1197     // the idea is in the future properties can be added to\r
1198     // alignments, other annotations etc\r
1199     if (al.getGroups() == null)\r
1200     {\r
1201       return;\r
1202     }\r
1203     SequenceGroup sg = null;\r
1204 \r
1205     String name = st.nextToken();\r
1206 \r
1207     Vector groups = al.getGroups();\r
1208     for (int i = 0; i < groups.size(); i++)\r
1209     {\r
1210       sg = (SequenceGroup) groups.elementAt(i);\r
1211       if (sg.getName().equals(name))\r
1212       {\r
1213         break;\r
1214       }\r
1215       else\r
1216       {\r
1217         sg = null;\r
1218       }\r
1219     }\r
1220 \r
1221     if (sg != null)\r
1222     {\r
1223       String keyValue, key, value;\r
1224       ColourSchemeI def = sg.cs;\r
1225       sg.cs = null;\r
1226       while (st.hasMoreTokens())\r
1227       {\r
1228         keyValue = st.nextToken();\r
1229         key = keyValue.substring(0, keyValue.indexOf("="));\r
1230         value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1231 \r
1232         if (key.equalsIgnoreCase("description"))\r
1233         {\r
1234           sg.setDescription(value);\r
1235         }\r
1236         else if (key.equalsIgnoreCase("colour"))\r
1237         {\r
1238           sg.cs = ColourSchemeProperty.getColour(al, value);\r
1239         }\r
1240         else if (key.equalsIgnoreCase("pidThreshold"))\r
1241         {\r
1242           sg.cs.setThreshold(Integer.parseInt(value), true);\r
1243 \r
1244         }\r
1245         else if (key.equalsIgnoreCase("consThreshold"))\r
1246         {\r
1247           sg.cs.setConservationInc(Integer.parseInt(value));\r
1248           Conservation c = new Conservation("Group",\r
1249                   ResidueProperties.propHash, 3, sg.getSequences(null),\r
1250                   sg.getStartRes(), sg.getEndRes() + 1);\r
1251 \r
1252           c.calculate();\r
1253           c.verdict(false, 25);\r
1254 \r
1255           sg.cs.setConservation(c);\r
1256 \r
1257         }\r
1258         else if (key.equalsIgnoreCase("outlineColour"))\r
1259         {\r
1260           sg.setOutlineColour(new UserColourScheme(value).findColour('A'));\r
1261         }\r
1262         else if (key.equalsIgnoreCase("displayBoxes"))\r
1263         {\r
1264           sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());\r
1265         }\r
1266         else if (key.equalsIgnoreCase("showUnconserved"))\r
1267         {\r
1268           sg.setShowNonconserved(Boolean.valueOf(value).booleanValue());\r
1269         }\r
1270         else if (key.equalsIgnoreCase("displayText"))\r
1271         {\r
1272           sg.setDisplayText(Boolean.valueOf(value).booleanValue());\r
1273         }\r
1274         else if (key.equalsIgnoreCase("colourText"))\r
1275         {\r
1276           sg.setColourText(Boolean.valueOf(value).booleanValue());\r
1277         }\r
1278         else if (key.equalsIgnoreCase("textCol1"))\r
1279         {\r
1280           sg.textColour = new UserColourScheme(value).findColour('A');\r
1281         }\r
1282         else if (key.equalsIgnoreCase("textCol2"))\r
1283         {\r
1284           sg.textColour2 = new UserColourScheme(value).findColour('A');\r
1285         }\r
1286         else if (key.equalsIgnoreCase("textColThreshold"))\r
1287         {\r
1288           sg.thresholdTextColour = Integer.parseInt(value);\r
1289         }\r
1290         else if (key.equalsIgnoreCase("idColour"))\r
1291         {\r
1292           // consider warning if colour doesn't resolve to a real colour\r
1293           sg.setIdColour((def = new UserColourScheme(value))\r
1294                   .findColour('A'));\r
1295         }\r
1296         else if (key.equalsIgnoreCase("hide"))\r
1297         {\r
1298           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
1299           sg.setHidereps(true);\r
1300         }\r
1301         else if (key.equalsIgnoreCase("hidecols"))\r
1302         {\r
1303           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
1304           sg.setHideCols(true);\r
1305         }\r
1306         sg.recalcConservation();\r
1307       }\r
1308       if (sg.cs == null)\r
1309       {\r
1310         sg.cs = def;\r
1311       }\r
1312     }\r
1313   }\r
1314 \r
1315   void setBelowAlignment(AlignmentI al, StringTokenizer st)\r
1316   {\r
1317     String token;\r
1318     AlignmentAnnotation aa, ala[] = al.getAlignmentAnnotation();\r
1319     if (ala == null)\r
1320     {\r
1321       System.err\r
1322               .print("Warning - no annotation to set below for sequence associated annotation:");\r
1323     }\r
1324     while (st.hasMoreTokens())\r
1325     {\r
1326       token = st.nextToken();\r
1327       if (ala == null)\r
1328       {\r
1329         System.err.print(" " + token);\r
1330       }\r
1331       else\r
1332       {\r
1333         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
1334         {\r
1335           aa = al.getAlignmentAnnotation()[i];\r
1336           if (aa.sequenceRef == refSeq && aa.label.equals(token))\r
1337           {\r
1338             aa.belowAlignment = true;\r
1339           }\r
1340         }\r
1341       }\r
1342     }\r
1343     if (ala == null)\r
1344     {\r
1345       System.err.print("\n");\r
1346     }\r
1347   }\r
1348 \r
1349   void addAlignmentDetails(AlignmentI al, StringTokenizer st)\r
1350   {\r
1351     String keyValue, key, value;\r
1352     while (st.hasMoreTokens())\r
1353     {\r
1354       keyValue = st.nextToken();\r
1355       key = keyValue.substring(0, keyValue.indexOf("="));\r
1356       value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1357       al.setProperty(key, value);\r
1358     }\r
1359   }\r
1360 \r
1361   /**\r
1362    * Write annotations as a CSV file of the form 'label, value, value, ...' for\r
1363    * each row.\r
1364    * \r
1365    * @param annotations\r
1366    * @return CSV file as a string.\r
1367    */\r
1368   public String printCSVAnnotations(AlignmentAnnotation[] annotations)\r
1369   {\r
1370     StringBuffer sp = new StringBuffer();\r
1371     for (int i = 0; i < annotations.length; i++)\r
1372     {\r
1373       String atos = annotations[i].toString();\r
1374       int p = 0;\r
1375       do\r
1376       {\r
1377         int cp = atos.indexOf("\n", p);\r
1378         sp.append(annotations[i].label);\r
1379         sp.append(",");\r
1380         if (cp > p)\r
1381         {\r
1382           sp.append(atos.substring(p, cp + 1));\r
1383         }\r
1384         else\r
1385         {\r
1386           sp.append(atos.substring(p));\r
1387           sp.append("\n");\r
1388         }\r
1389         p = cp + 1;\r
1390       } while (p > 0);\r
1391     }\r
1392     return sp.toString();\r
1393   }\r
1394 }\r