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     String groupRef = null;\r
 465     Hashtable groupRefRows = new Hashtable();\r
 466 \r
 467     Hashtable autoAnnots = new Hashtable();\r
 468     try\r
 469     {\r
 470       BufferedReader in = null;\r
 471       if (protocol.equals(AppletFormatAdapter.FILE))\r
 472       {\r
 473         in = new BufferedReader(new FileReader(file));\r
 474       }\r
 475       else if (protocol.equals(AppletFormatAdapter.URL))\r
 476       {\r
 477         URL url = new URL(file);\r
 478         in = new BufferedReader(new InputStreamReader(url.openStream()));\r
 479       }\r
 480       else if (protocol.equals(AppletFormatAdapter.PASTE))\r
 481       {\r
 482         in = new BufferedReader(new StringReader(file));\r
 483       }\r
 484       else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))\r
 485       {\r
 486         java.io.InputStream is = getClass().getResourceAsStream("/" + file);\r
 487         if (is != null)\r
 488         {\r
 489           in = new BufferedReader(new java.io.InputStreamReader(is));\r
 490         }\r
 491       }\r
 492 \r
 493       String line, label, description, token;\r
 494       int graphStyle, index;\r
 495       int refSeqIndex = 1;\r
 496       int existingAnnotations = 0;\r
 497       // when true - will add new rows regardless of whether they are duplicate\r
 498       // auto-annotation like consensus or conservation graphs\r
 499       boolean overrideAutoAnnot = false;\r
 500       if (al.getAlignmentAnnotation() != null)\r
 501       {\r
 502         existingAnnotations = al.getAlignmentAnnotation().length;\r
 503         if (existingAnnotations > 0)\r
 504         {\r
 505           AlignmentAnnotation[] aa = al.getAlignmentAnnotation();\r
 506           for (int aai = 0; aai < aa.length; aai++)\r
 507           {\r
 508             if (aa[aai].autoCalculated)\r
 509             {\r
 510               // make a note of the name and description\r
 511               autoAnnots\r
 512                       .put(aa[aai].graph\r
 513                               + "\t"\r
 514                               + aa[aai].label\r
 515                               + "\t"\r
 516                               + aa[aai].description\r
 517                               + "\t"\r
 518                               + (aa[aai].sequenceRef != null ? aa[aai].sequenceRef\r
 519                                       .getDisplayId(true) : ""),\r
 520                               new Integer(1));\r
 521             }\r
 522           }\r
 523         }\r
 524       }\r
 525 \r
 526       int alWidth = al.getWidth();\r
 527 \r
 528       StringTokenizer st;\r
 529       Annotation[] annotations;\r
 530       AlignmentAnnotation annotation = null;\r
 531 \r
 532       // First confirm this is an Annotation file\r
 533       boolean jvAnnotationFile = false;\r
 534       while ((line = in.readLine()) != null)\r
 535       {\r
 536         if (line.indexOf("#") == 0)\r
 537         {\r
 538           continue;\r
 539         }\r
 540 \r
 541         if (line.indexOf("JALVIEW_ANNOTATION") > -1)\r
 542         {\r
 543           jvAnnotationFile = true;\r
 544           break;\r
 545         }\r
 546       }\r
 547 \r
 548       if (!jvAnnotationFile)\r
 549       {\r
 550         in.close();\r
 551         return false;\r
 552       }\r
 553 \r
 554       while ((line = in.readLine()) != null)\r
 555       {\r
 556         if (line.indexOf("#") == 0\r
 557                 || line.indexOf("JALVIEW_ANNOTATION") > -1\r
 558                 || line.length() == 0)\r
 559         {\r
 560           continue;\r
 561         }\r
 562 \r
 563         st = new StringTokenizer(line, "\t");\r
 564         token = st.nextToken();\r
 565         if (token.equalsIgnoreCase("COLOUR"))\r
 566         {\r
 567           // TODO: use graduated colour def'n here too\r
 568           colourAnnotations(al, st.nextToken(), st.nextToken());\r
 569           continue;\r
 570         }\r
 571 \r
 572         else if (token.equalsIgnoreCase("COMBINE"))\r
 573         {\r
 574           combineAnnotations(al, st);\r
 575           continue;\r
 576         }\r
 577         else if (token.equalsIgnoreCase("ROWPROPERTIES"))\r
 578         {\r
 579           addRowProperties(al, st);\r
 580           continue;\r
 581         }\r
 582         else if (token.equalsIgnoreCase("GRAPHLINE"))\r
 583         {\r
 584           addLine(al, st);\r
 585           continue;\r
 586         }\r
 587 \r
 588         else if (token.equalsIgnoreCase("SEQUENCE_REF"))\r
 589         {\r
 590           if (st.hasMoreTokens())\r
 591           {\r
 592             refSeq = al.findName(refSeqId = st.nextToken());\r
 593             if (refSeq == null)\r
 594             {\r
 595               refSeqId = null;\r
 596             }\r
 597             try\r
 598             {\r
 599               refSeqIndex = Integer.parseInt(st.nextToken());\r
 600               if (refSeqIndex < 1)\r
 601               {\r
 602                 refSeqIndex = 1;\r
 603                 System.out\r
 604                         .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");\r
 605               }\r
 606             } catch (Exception ex)\r
 607             {\r
 608               refSeqIndex = 1;\r
 609             }\r
 610           }\r
 611           else\r
 612           {\r
 613             refSeq = null;\r
 614             refSeqId = null;\r
 615           }\r
 616           continue;\r
 617         }\r
 618         else if (token.equalsIgnoreCase("GROUP_REF"))\r
 619         {\r
 620           // Group references could be forward or backwards, so they are\r
 621           // resolved after the whole file is read in\r
 622           groupRef = null;\r
 623           if (st.hasMoreTokens())\r
 624           {\r
 625             groupRef = st.nextToken();\r
 626             if (groupRef.length() < 1)\r
 627             {\r
 628               groupRef = null; // empty string\r
 629             }\r
 630             else\r
 631             {\r
 632               if (groupRefRows.get(groupRef) == null)\r
 633               {\r
 634                 groupRefRows.put(groupRef, new Vector());\r
 635               }\r
 636             }\r
 637           }\r
 638           continue;\r
 639         }\r
 640         else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))\r
 641         {\r
 642           addGroup(al, st);\r
 643           continue;\r
 644         }\r
 645 \r
 646         else if (token.equalsIgnoreCase("PROPERTIES"))\r
 647         {\r
 648           addProperties(al, st);\r
 649           continue;\r
 650         }\r
 651 \r
 652         else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))\r
 653         {\r
 654           setBelowAlignment(al, st);\r
 655           continue;\r
 656         }\r
 657         else if (token.equalsIgnoreCase("ALIGNMENT"))\r
 658         {\r
 659           addAlignmentDetails(al, st);\r
 660           continue;\r
 661         }\r
 662 \r
 663         // Parse out the annotation row\r
 664         graphStyle = AlignmentAnnotation.getGraphValueFromString(token);\r
 665         label = st.nextToken();\r
 666 \r
 667         index = 0;\r
 668         annotations = new Annotation[alWidth];\r
 669         description = null;\r
 670         float score = Float.NaN;\r
 671 \r
 672         if (st.hasMoreTokens())\r
 673         {\r
 674           line = st.nextToken();\r
 675 \r
 676           if (line.indexOf("|") == -1)\r
 677           {\r
 678             description = line;\r
 679             if (st.hasMoreTokens())\r
 680               line = st.nextToken();\r
 681           }\r
 682 \r
 683           if (st.hasMoreTokens())\r
 684           {\r
 685             // This must be the score\r
 686             score = Float.valueOf(st.nextToken()).floatValue();\r
 687           }\r
 688 \r
 689           st = new StringTokenizer(line, "|", true);\r
 690 \r
 691           boolean emptyColumn = true;\r
 692           boolean onlyOneElement = (st.countTokens() == 1);\r
 693 \r
 694           while (st.hasMoreElements() && index < alWidth)\r
 695           {\r
 696             token = st.nextToken().trim();\r
 697 \r
 698             if (onlyOneElement)\r
 699             {\r
 700               try\r
 701               {\r
 702                 score = Float.valueOf(token).floatValue();\r
 703                 break;\r
 704               } catch (NumberFormatException ex)\r
 705               {\r
 706               }\r
 707             }\r
 708 \r
 709             if (token.equals("|"))\r
 710             {\r
 711               if (emptyColumn)\r
 712               {\r
 713                 index++;\r
 714               }\r
 715 \r
 716               emptyColumn = true;\r
 717             }\r
 718             else\r
 719             {\r
 720               annotations[index++] = parseAnnotation(token, graphStyle);\r
 721               emptyColumn = false;\r
 722             }\r
 723           }\r
 724 \r
 725         }\r
 726 \r
 727         annotation = new AlignmentAnnotation(label, description,\r
 728                 (index == 0) ? null : annotations, 0, 0, graphStyle);\r
 729 \r
 730         annotation.score = score;\r
 731         if (!overrideAutoAnnot\r
 732                 && autoAnnots\r
 733                         .containsKey(annotation.graph\r
 734                                 + "\t"\r
 735                                 + annotation.label\r
 736                                 + "\t"\r
 737                                 + annotation.description\r
 738                                 + "\t"\r
 739                                 + (refSeq != null ? refSeq\r
 740                                         .getDisplayId(true) : "")))\r
 741         {\r
 742           // skip - we've already got an automatic annotation of this type.\r
 743           continue;\r
 744         }\r
 745         // otherwise add it!\r
 746         if (refSeq != null)\r
 747         {\r
 748 \r
 749           annotation.belowAlignment = false;\r
 750           // make a copy of refSeq so we can find other matches in the alignment\r
 751           SequenceI referedSeq = refSeq;\r
 752           do\r
 753           {\r
 754             // copy before we do any mapping business.\r
 755             // TODO: verify that undo/redo with 1:many sequence associated\r
 756             // annotations can be undone correctly\r
 757             AlignmentAnnotation ann = new AlignmentAnnotation(annotation);\r
 758             annotation\r
 759                     .createSequenceMapping(referedSeq, refSeqIndex, false);\r
 760             annotation.adjustForAlignment();\r
 761             referedSeq.addAlignmentAnnotation(annotation);\r
 762             al.addAnnotation(annotation);\r
 763             al.setAnnotationIndex(annotation,\r
 764                     al.getAlignmentAnnotation().length\r
 765                             - existingAnnotations - 1);\r
 766             if (groupRef != null)\r
 767             {\r
 768               ((Vector) groupRefRows.get(groupRef)).addElement(annotation);\r
 769             }\r
 770             // and recover our virgin copy to use again if necessary.\r
 771             annotation = ann;\r
 772 \r
 773           } while (refSeqId != null\r
 774                   && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);\r
 775         }\r
 776         else\r
 777         {\r
 778           al.addAnnotation(annotation);\r
 779           al.setAnnotationIndex(annotation,\r
 780                   al.getAlignmentAnnotation().length - existingAnnotations\r
 781                           - 1);\r
 782           if (groupRef != null)\r
 783           {\r
 784             ((Vector) groupRefRows.get(groupRef)).addElement(annotation);\r
 785           }\r
 786         }\r
 787       }\r
 788       // Finally, resolve the groupRefs\r
 789       Enumeration en = groupRefRows.keys();\r
 790       SequenceGroup theGroup = null;\r
 791 \r
 792       while (en.hasMoreElements())\r
 793       {\r
 794         groupRef = (String) en.nextElement();\r
 795         boolean matched = false;\r
 796         // Resolve group: TODO: add a getGroupByName method to alignments\r
 797         Vector grps = al.getGroups();\r
 798         for (int g = 0, gSize = grps.size(); g < gSize; g++)\r
 799         {\r
 800           theGroup = (SequenceGroup) grps.elementAt(g);\r
 801           if (theGroup.getName().equals(groupRef))\r
 802           {\r
 803             if (matched)\r
 804             {\r
 805               // TODO: specify and implement duplication of alignment annotation\r
 806               // for multiple group references.\r
 807               System.err\r
 808                       .println("Ignoring 1:many group reference mappings for group name '"\r
 809                               + groupRef + "'");\r
 810             }\r
 811             else\r
 812             {\r
 813               matched = true;\r
 814               Vector rowset = (Vector) groupRefRows.get(groupRef);\r
 815               if (rowset != null && rowset.size() > 0)\r
 816               {\r
 817                 AlignmentAnnotation alan = null;\r
 818                 for (int elm = 0, elmSize = rowset.size(); elm < elmSize; elm++)\r
 819                 {\r
 820                   alan = (AlignmentAnnotation) rowset.elementAt(elm);\r
 821                   alan.groupRef = theGroup;\r
 822                 }\r
 823               }\r
 824             }\r
 825           }\r
 826         }\r
 827         ((Vector) groupRefRows.get(groupRef)).removeAllElements();\r
 828       }\r
 829     } catch (Exception ex)\r
 830     {\r
 831       ex.printStackTrace();\r
 832       System.out.println("Problem reading annotation file: " + ex);\r
 833       return false;\r
 834     }\r
 835     return true;\r
 836   }\r
 837 \r
 838   Annotation parseAnnotation(String string, int graphStyle)\r
 839   {\r
 840     boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH); // don't\r
 841     // do the\r
 842     // glyph\r
 843     // test\r
 844     // if we\r
 845     // don't\r
 846     // want\r
 847     // secondary\r
 848     // structure\r
 849     String desc = null, displayChar = null;\r
 850     char ss = ' '; // secondaryStructure\r
 851     float value = 0;\r
 852     boolean parsedValue = false, dcset = false;\r
 853 \r
 854     // find colour here\r
 855     java.awt.Color colour = null;\r
 856     int i = string.indexOf("[");\r
 857     int j = string.indexOf("]");\r
 858     if (i > -1 && j > -1)\r
 859     {\r
 860       UserColourScheme ucs = new UserColourScheme();\r
 861 \r
 862       colour = ucs.getColourFromString(string.substring(i + 1, j));\r
 863       if (i > 0 && string.charAt(i - 1) == ',')\r
 864       {\r
 865         // clip the preceding comma as well\r
 866         i--;\r
 867       }\r
 868       string = string.substring(0, i) + string.substring(j + 1);\r
 869     }\r
 870 \r
 871     StringTokenizer st = new StringTokenizer(string, ",", true);\r
 872     String token;\r
 873     boolean seenContent = false;\r
 874     int pass = 0;\r
 875     while (st.hasMoreTokens())\r
 876     {\r
 877       pass++;\r
 878       token = st.nextToken().trim();\r
 879       if (token.equals(","))\r
 880       {\r
 881         if (!seenContent && parsedValue && !dcset)\r
 882         {\r
 883           // allow the value below the bar/line to be empty\r
 884           dcset = true;\r
 885           displayChar = " ";\r
 886         }\r
 887         seenContent = false;\r
 888         continue;\r
 889       }\r
 890       else\r
 891       {\r
 892         seenContent = true;\r
 893       }\r
 894 \r
 895       if (!parsedValue)\r
 896       {\r
 897         try\r
 898         {\r
 899           displayChar = token;\r
 900           // foo\r
 901           value = new Float(token).floatValue();\r
 902           parsedValue = true;\r
 903           continue;\r
 904         } catch (NumberFormatException ex)\r
 905         {\r
 906         }\r
 907       }\r
 908       else\r
 909       {\r
 910         if (token.length() == 1)\r
 911         {\r
 912           displayChar = token;\r
 913         }\r
 914       }\r
 915       if (hasSymbols\r
 916               && (token.equals("H") || token.equals("E") || token\r
 917                       .equals(" ")))\r
 918       {\r
 919         // Either this character represents a helix or sheet\r
 920         // or an integer which can be displayed\r
 921         ss = token.charAt(0);\r
 922         if (displayChar.equals(token.substring(0, 1)))\r
 923         {\r
 924           displayChar = "";\r
 925         }\r
 926       }\r
 927       else if (desc == null || (parsedValue && pass > 2))\r
 928       {\r
 929         desc = token;\r
 930       }\r
 931 \r
 932     }\r
 933     // if (!dcset && string.charAt(string.length() - 1) == ',')\r
 934     // {\r
 935     // displayChar = " "; // empty display char symbol.\r
 936     // }\r
 937     if (displayChar != null && desc != null && desc.length() == 1)\r
 938     {\r
 939       if (displayChar.length() > 1)\r
 940       {\r
 941         // switch desc and displayChar - legacy support\r
 942         String tmp = displayChar;\r
 943         displayChar = desc;\r
 944         desc = tmp;\r
 945       }\r
 946       else\r
 947       {\r
 948         if (displayChar.equals(desc))\r
 949         {\r
 950           // duplicate label - hangover from the 'robust parser' above\r
 951           desc = null;\r
 952         }\r
 953       }\r
 954     }\r
 955     Annotation anot = new Annotation(displayChar, desc, ss, value);\r
 956 \r
 957     anot.colour = colour;\r
 958 \r
 959     return anot;\r
 960   }\r
 961 \r
 962   void colourAnnotations(AlignmentI al, String label, String colour)\r
 963   {\r
 964     UserColourScheme ucs = new UserColourScheme(colour);\r
 965     Annotation[] annotations;\r
 966     for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
 967     {\r
 968       if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))\r
 969       {\r
 970         annotations = al.getAlignmentAnnotation()[i].annotations;\r
 971         for (int j = 0; j < annotations.length; j++)\r
 972         {\r
 973           if (annotations[j] != null)\r
 974           {\r
 975             annotations[j].colour = ucs.findColour('A');\r
 976           }\r
 977         }\r
 978       }\r
 979     }\r
 980   }\r
 981 \r
 982   void combineAnnotations(AlignmentI al, StringTokenizer st)\r
 983   {\r
 984     int graphGroup = -1;\r
 985     String group = st.nextToken();\r
 986     // First make sure we are not overwriting the graphIndex\r
 987     if (al.getAlignmentAnnotation() != null)\r
 988     {\r
 989       for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
 990       {\r
 991         if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
 992         {\r
 993           graphGroup = al.getAlignmentAnnotation()[i].graphGroup + 1;\r
 994           al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
 995           break;\r
 996         }\r
 997       }\r
 998 \r
 999       // Now update groups\r
1000       while (st.hasMoreTokens())\r
1001       {\r
1002         group = st.nextToken();\r
1003         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
1004         {\r
1005           if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
1006           {\r
1007             al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
1008             break;\r
1009           }\r
1010         }\r
1011       }\r
1012     }\r
1013     else\r
1014     {\r
1015       System.err\r
1016               .println("Couldn't combine annotations. None are added to alignment yet!");\r
1017     }\r
1018   }\r
1019 \r
1020   void addLine(AlignmentI al, StringTokenizer st)\r
1021   {\r
1022     String group = st.nextToken();\r
1023     AlignmentAnnotation annotation = null, alannot[] = al\r
1024             .getAlignmentAnnotation();\r
1025     if (alannot != null)\r
1026     {\r
1027       for (int i = 0; i < alannot.length; i++)\r
1028       {\r
1029         if (alannot[i].label.equalsIgnoreCase(group))\r
1030         {\r
1031           annotation = alannot[i];\r
1032           break;\r
1033         }\r
1034       }\r
1035     }\r
1036     if (annotation == null)\r
1037     {\r
1038       return;\r
1039     }\r
1040     float value = new Float(st.nextToken()).floatValue();\r
1041     String label = st.hasMoreTokens() ? st.nextToken() : null;\r
1042     java.awt.Color colour = null;\r
1043     if (st.hasMoreTokens())\r
1044     {\r
1045       UserColourScheme ucs = new UserColourScheme(st.nextToken());\r
1046       colour = ucs.findColour('A');\r
1047     }\r
1048 \r
1049     annotation.setThreshold(new GraphLine(value, label, colour));\r
1050   }\r
1051 \r
1052   void addGroup(AlignmentI al, StringTokenizer st)\r
1053   {\r
1054     SequenceGroup sg = new SequenceGroup();\r
1055     sg.setName(st.nextToken());\r
1056     String rng = "";\r
1057     try\r
1058     {\r
1059       rng = st.nextToken();\r
1060       if (rng.length() > 0 && !rng.startsWith("*"))\r
1061       {\r
1062         sg.setStartRes(Integer.parseInt(rng) - 1);\r
1063       }\r
1064       else\r
1065       {\r
1066         sg.setStartRes(0);\r
1067       }\r
1068       rng = st.nextToken();\r
1069       if (rng.length() > 0 && !rng.startsWith("*"))\r
1070       {\r
1071         sg.setEndRes(Integer.parseInt(rng) - 1);\r
1072       }\r
1073       else\r
1074       {\r
1075         sg.setEndRes(al.getWidth() - 1);\r
1076       }\r
1077     } catch (Exception e)\r
1078     {\r
1079       System.err\r
1080               .println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"\r
1081                       + rng + "' - assuming alignment width for group.");\r
1082       // assume group is full width\r
1083       sg.setStartRes(0);\r
1084       sg.setEndRes(al.getWidth() - 1);\r
1085     }\r
1086 \r
1087     String index = st.nextToken();\r
1088     if (index.equals("-1"))\r
1089     {\r
1090       while (st.hasMoreElements())\r
1091       {\r
1092         sg.addSequence(al.findName(st.nextToken()), false);\r
1093       }\r
1094     }\r
1095     else\r
1096     {\r
1097       StringTokenizer st2 = new StringTokenizer(index, ",");\r
1098 \r
1099       while (st2.hasMoreTokens())\r
1100       {\r
1101         String tmp = st2.nextToken();\r
1102         if (tmp.equals("*"))\r
1103         {\r
1104           for (int i = 0; i < al.getHeight(); i++)\r
1105           {\r
1106             sg.addSequence(al.getSequenceAt(i), false);\r
1107           }\r
1108         }\r
1109         else if (tmp.indexOf("-") >= 0)\r
1110         {\r
1111           StringTokenizer st3 = new StringTokenizer(tmp, "-");\r
1112 \r
1113           int start = (Integer.parseInt(st3.nextToken()));\r
1114           int end = (Integer.parseInt(st3.nextToken()));\r
1115 \r
1116           if (end > start)\r
1117           {\r
1118             for (int i = start; i <= end; i++)\r
1119             {\r
1120               sg.addSequence(al.getSequenceAt(i - 1), false);\r
1121             }\r
1122           }\r
1123         }\r
1124         else\r
1125         {\r
1126           sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1), false);\r
1127         }\r
1128       }\r
1129     }\r
1130 \r
1131     if (refSeq != null)\r
1132     {\r
1133       sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);\r
1134       sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);\r
1135       sg.setSeqrep(refSeq);\r
1136     }\r
1137 \r
1138     if (sg.getSize() > 0)\r
1139     {\r
1140       al.addGroup(sg);\r
1141     }\r
1142   }\r
1143 \r
1144   void addRowProperties(AlignmentI al, StringTokenizer st)\r
1145   {\r
1146     String label = st.nextToken(), keyValue, key, value;\r
1147     boolean scaletofit = false, centerlab = false, showalllabs = false;\r
1148     while (st.hasMoreTokens())\r
1149     {\r
1150       keyValue = st.nextToken();\r
1151       key = keyValue.substring(0, keyValue.indexOf("="));\r
1152       value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1153       if (key.equalsIgnoreCase("scaletofit"))\r
1154       {\r
1155         scaletofit = Boolean.valueOf(value).booleanValue();\r
1156       }\r
1157       if (key.equalsIgnoreCase("showalllabs"))\r
1158       {\r
1159         showalllabs = Boolean.valueOf(value).booleanValue();\r
1160       }\r
1161       if (key.equalsIgnoreCase("centrelabs"))\r
1162       {\r
1163         centerlab = Boolean.valueOf(value).booleanValue();\r
1164       }\r
1165       AlignmentAnnotation[] alr = al.getAlignmentAnnotation();\r
1166       if (alr != null)\r
1167       {\r
1168         for (int i = 0; i < alr.length; i++)\r
1169         {\r
1170           if (alr[i].label.equalsIgnoreCase(label))\r
1171           {\r
1172             alr[i].centreColLabels = centerlab;\r
1173             alr[i].scaleColLabel = scaletofit;\r
1174             alr[i].showAllColLabels = showalllabs;\r
1175           }\r
1176         }\r
1177       }\r
1178     }\r
1179   }\r
1180 \r
1181   void addProperties(AlignmentI al, StringTokenizer st)\r
1182   {\r
1183 \r
1184     // So far we have only added groups to the annotationHash,\r
1185     // the idea is in the future properties can be added to\r
1186     // alignments, other annotations etc\r
1187     if (al.getGroups() == null)\r
1188     {\r
1189       return;\r
1190     }\r
1191     SequenceGroup sg = null;\r
1192 \r
1193     String name = st.nextToken();\r
1194 \r
1195     Vector groups = al.getGroups();\r
1196     for (int i = 0; i < groups.size(); i++)\r
1197     {\r
1198       sg = (SequenceGroup) groups.elementAt(i);\r
1199       if (sg.getName().equals(name))\r
1200       {\r
1201         break;\r
1202       }\r
1203       else\r
1204       {\r
1205         sg = null;\r
1206       }\r
1207     }\r
1208 \r
1209     if (sg != null)\r
1210     {\r
1211       String keyValue, key, value;\r
1212       ColourSchemeI def = sg.cs;\r
1213       sg.cs = null;\r
1214       while (st.hasMoreTokens())\r
1215       {\r
1216         keyValue = st.nextToken();\r
1217         key = keyValue.substring(0, keyValue.indexOf("="));\r
1218         value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1219 \r
1220         if (key.equalsIgnoreCase("description"))\r
1221         {\r
1222           sg.setDescription(value);\r
1223         }\r
1224         else if (key.equalsIgnoreCase("colour"))\r
1225         {\r
1226           sg.cs = ColourSchemeProperty.getColour(al, value);\r
1227         }\r
1228         else if (key.equalsIgnoreCase("pidThreshold"))\r
1229         {\r
1230           sg.cs.setThreshold(Integer.parseInt(value), true);\r
1231 \r
1232         }\r
1233         else if (key.equalsIgnoreCase("consThreshold"))\r
1234         {\r
1235           sg.cs.setConservationInc(Integer.parseInt(value));\r
1236           Conservation c = new Conservation("Group",\r
1237                   ResidueProperties.propHash, 3, sg.getSequences(null),\r
1238                   sg.getStartRes(), sg.getEndRes() + 1);\r
1239 \r
1240           c.calculate();\r
1241           c.verdict(false, 25);\r
1242 \r
1243           sg.cs.setConservation(c);\r
1244 \r
1245         }\r
1246         else if (key.equalsIgnoreCase("outlineColour"))\r
1247         {\r
1248           sg.setOutlineColour(new UserColourScheme(value).findColour('A'));\r
1249         }\r
1250         else if (key.equalsIgnoreCase("displayBoxes"))\r
1251         {\r
1252           sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());\r
1253         }\r
1254         else if (key.equalsIgnoreCase("showUnconserved"))\r
1255         {\r
1256           sg.setShowNonconserved(Boolean.valueOf(value).booleanValue());\r
1257         }\r
1258         else if (key.equalsIgnoreCase("displayText"))\r
1259         {\r
1260           sg.setDisplayText(Boolean.valueOf(value).booleanValue());\r
1261         }\r
1262         else if (key.equalsIgnoreCase("colourText"))\r
1263         {\r
1264           sg.setColourText(Boolean.valueOf(value).booleanValue());\r
1265         }\r
1266         else if (key.equalsIgnoreCase("textCol1"))\r
1267         {\r
1268           sg.textColour = new UserColourScheme(value).findColour('A');\r
1269         }\r
1270         else if (key.equalsIgnoreCase("textCol2"))\r
1271         {\r
1272           sg.textColour2 = new UserColourScheme(value).findColour('A');\r
1273         }\r
1274         else if (key.equalsIgnoreCase("textColThreshold"))\r
1275         {\r
1276           sg.thresholdTextColour = Integer.parseInt(value);\r
1277         }\r
1278         else if (key.equalsIgnoreCase("idColour"))\r
1279         {\r
1280           // consider warning if colour doesn't resolve to a real colour\r
1281           sg.setIdColour((def = new UserColourScheme(value))\r
1282                   .findColour('A'));\r
1283         }\r
1284         else if (key.equalsIgnoreCase("hide"))\r
1285         {\r
1286           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
1287           sg.setHidereps(true);\r
1288         }\r
1289         else if (key.equalsIgnoreCase("hidecols"))\r
1290         {\r
1291           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
1292           sg.setHideCols(true);\r
1293         }\r
1294         sg.recalcConservation();\r
1295       }\r
1296       if (sg.cs == null)\r
1297       {\r
1298         sg.cs = def;\r
1299       }\r
1300     }\r
1301   }\r
1302 \r
1303   void setBelowAlignment(AlignmentI al, StringTokenizer st)\r
1304   {\r
1305     String token;\r
1306     AlignmentAnnotation aa, ala[] = al.getAlignmentAnnotation();\r
1307     if (ala == null)\r
1308     {\r
1309       System.err\r
1310               .print("Warning - no annotation to set below for sequence associated annotation:");\r
1311     }\r
1312     while (st.hasMoreTokens())\r
1313     {\r
1314       token = st.nextToken();\r
1315       if (ala == null)\r
1316       {\r
1317         System.err.print(" " + token);\r
1318       }\r
1319       else\r
1320       {\r
1321         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
1322         {\r
1323           aa = al.getAlignmentAnnotation()[i];\r
1324           if (aa.sequenceRef == refSeq && aa.label.equals(token))\r
1325           {\r
1326             aa.belowAlignment = true;\r
1327           }\r
1328         }\r
1329       }\r
1330     }\r
1331     if (ala == null)\r
1332     {\r
1333       System.err.print("\n");\r
1334     }\r
1335   }\r
1336 \r
1337   void addAlignmentDetails(AlignmentI al, StringTokenizer st)\r
1338   {\r
1339     String keyValue, key, value;\r
1340     while (st.hasMoreTokens())\r
1341     {\r
1342       keyValue = st.nextToken();\r
1343       key = keyValue.substring(0, keyValue.indexOf("="));\r
1344       value = keyValue.substring(keyValue.indexOf("=") + 1);\r
1345       al.setProperty(key, value);\r
1346     }\r
1347   }\r
1348 \r
1349   /**\r
1350    * Write annotations as a CSV file of the form 'label, value, value, ...' for\r
1351    * each row.\r
1352    * \r
1353    * @param annotations\r
1354    * @return CSV file as a string.\r
1355    */\r
1356   public String printCSVAnnotations(AlignmentAnnotation[] annotations)\r
1357   {\r
1358     StringBuffer sp = new StringBuffer();\r
1359     for (int i = 0; i < annotations.length; i++)\r
1360     {\r
1361       String atos = annotations[i].toString();\r
1362       int p = 0;\r
1363       do\r
1364       {\r
1365         int cp = atos.indexOf("\n", p);\r
1366         sp.append(annotations[i].label);\r
1367         sp.append(",");\r
1368         if (cp > p)\r
1369         {\r
1370           sp.append(atos.substring(p, cp + 1));\r
1371         }\r
1372         else\r
1373         {\r
1374           sp.append(atos.substring(p));\r
1375           sp.append("\n");\r
1376         }\r
1377         p = cp + 1;\r
1378       } while (p > 0);\r
1379     }\r
1380     return sp.toString();\r
1381   }\r
1382 }\r