src/jalview/io/AnnotationFile.java

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