src/jalview/io/AnnotationFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.io;
  22
  23 import jalview.analysis.Conservation;
  24 import jalview.api.AlignViewportI;
  25 import jalview.datamodel.AlignmentAnnotation;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.Annotation;
  28 import jalview.datamodel.ColumnSelection;
  29 import jalview.datamodel.GraphLine;
  30 import jalview.datamodel.HiddenSequences;
  31 import jalview.datamodel.SequenceGroup;
  32 import jalview.datamodel.SequenceI;
  33 import jalview.schemes.ColourSchemeI;
  34 import jalview.schemes.ColourSchemeProperty;
  35 import jalview.schemes.ResidueProperties;
  36 import jalview.schemes.UserColourScheme;
  37
  38 import java.io.BufferedReader;
  39 import java.io.FileReader;
  40 import java.io.InputStreamReader;
  41 import java.io.StringReader;
  42 import java.net.URL;
  43 import java.util.ArrayList;
  44 import java.util.BitSet;
  45 import java.util.Enumeration;
  46 import java.util.Hashtable;
  47 import java.util.List;
  48 import java.util.Map;
  49 import java.util.StringTokenizer;
  50 import java.util.Vector;
  51
  52 public class AnnotationFile
  53 {
  54   public AnnotationFile()
  55   {
  56     init();
  57   }
  58
  59   /**
  60    * character used to write newlines
  61    */
  62   protected String newline = System.getProperty("line.separator");
  63
  64   /**
  65    * set new line string and reset the output buffer
  66    *
  67    * @param nl
  68    */
  69   public void setNewlineString(String nl)
  70   {
  71     newline = nl;
  72     init();
  73   }
  74
  75   public String getNewlineString()
  76   {
  77     return newline;
  78   }
  79
  80   StringBuffer text;
  81
  82   private void init()
  83   {
  84     text = new StringBuffer("JALVIEW_ANNOTATION" + newline + "# Created: "
  85             + new java.util.Date() + newline + newline);
  86     refSeq = null;
  87     refSeqId = null;
  88   }
  89
  90   /**
  91    * convenience method for pre-2.9 annotation files which have no view, hidden
  92    * columns or hidden row keywords.
  93    *
  94    * @param annotations
  95    * @param list
  96    * @param properties
  97    * @return annotation file as a string.
  98    */
  99   public String printAnnotations(AlignmentAnnotation[] annotations,
 100           List<SequenceGroup> list, Hashtable properties)
 101   {
 102     return printAnnotations(annotations, list, properties, null, null, null);
 103
 104   }
 105
 106   /**
 107    * hold all the information about a particular view definition read from or
 108    * written out in an annotations file.
 109    */
 110   public class ViewDef
 111   {
 112     public String viewname;
 113
 114     public HiddenSequences hidseqs;
 115
 116     public ColumnSelection hiddencols;
 117
 118     public Vector visibleGroups;
 119
 120     public Hashtable hiddenRepSeqs;
 121
 122     public ViewDef(String viewname, HiddenSequences hidseqs,
 123             ColumnSelection hiddencols, Hashtable hiddenRepSeqs)
 124     {
 125       this.viewname = viewname;
 126       this.hidseqs = hidseqs;
 127       this.hiddencols = hiddencols;
 128       this.hiddenRepSeqs = hiddenRepSeqs;
 129     }
 130   }
 131
 132   /**
 133    * Prepare an annotation file given a set of annotations, groups, alignment
 134    * properties and views.
 135    *
 136    * @param annotations
 137    * @param list
 138    * @param properties
 139    * @param views
 140    * @return annotation file
 141    */
 142   public String printAnnotations(AlignmentAnnotation[] annotations,
 143           List<SequenceGroup> list, Hashtable properties,
 144           ColumnSelection cs, AlignmentI al, ViewDef view)
 145   {
 146     if (view != null)
 147     {
 148       if (view.viewname != null)
 149       {
 150         text.append("VIEW_DEF\t" + view.viewname + "\n");
 151       }
 152       if (list == null)
 153       {
 154         list = view.visibleGroups;
 155       }
 156       if (cs == null)
 157       {
 158         cs = view.hiddencols;
 159       }
 160       if (al == null)
 161       {
 162         // add hidden rep sequences.
 163       }
 164     }
 165     // first target - store and restore all settings for a view.
 166     if (al != null && al.hasSeqrep())
 167     {
 168       text.append("VIEW_SETREF\t" + al.getSeqrep().getName() + "\n");
 169     }
 170     if (cs != null && cs.hasHiddenColumns())
 171     {
 172       text.append("VIEW_HIDECOLS\t");
 173       List<int[]> hc = cs.getHiddenColumns();
 174       boolean comma = false;
 175       for (int[] r : hc)
 176       {
 177         if (!comma)
 178         {
 179           comma = true;
 180         }
 181         else
 182         {
 183           text.append(",");
 184         }
 185         text.append(r[0]);
 186         text.append("-");
 187         text.append(r[1]);
 188       }
 189       text.append("\n");
 190     }
 191     // TODO: allow efficient recovery of annotation data shown in several
 192     // different views
 193     if (annotations != null)
 194     {
 195       boolean oneColour = true;
 196       AlignmentAnnotation row;
 197       String comma;
 198       SequenceI refSeq = null;
 199       SequenceGroup refGroup = null;
 200
 201       StringBuffer colours = new StringBuffer();
 202       StringBuffer graphLine = new StringBuffer();
 203       StringBuffer rowprops = new StringBuffer();
 204       Hashtable<Integer, String> graphGroup = new Hashtable<Integer, String>();
 205       Hashtable<Integer, Object[]> graphGroup_refs = new Hashtable<Integer, Object[]>();
 206       BitSet graphGroupSeen = new BitSet();
 207
 208       java.awt.Color color;
 209
 210       for (int i = 0; i < annotations.length; i++)
 211       {
 212         row = annotations[i];
 213
 214         if (!row.visible
 215                 && !row.hasScore()
 216                 && !(row.graphGroup > -1 && graphGroupSeen
 217                         .get(row.graphGroup)))
 218         {
 219           continue;
 220         }
 221
 222         color = null;
 223         oneColour = true;
 224
 225         // mark any sequence references for the row
 226         writeSequence_Ref(refSeq, row.sequenceRef);
 227         refSeq = row.sequenceRef;
 228         // mark any group references for the row
 229         writeGroup_Ref(refGroup, row.groupRef);
 230         refGroup = row.groupRef;
 231
 232         boolean hasGlyphs = row.hasIcons, hasLabels = row.hasText, hasValues = row.hasScore, hasText = false;
 233         // lookahead to check what the annotation row object actually contains.
 234         for (int j = 0; row.annotations != null
 235                 && j < row.annotations.length
 236                 && (!hasGlyphs || !hasLabels || !hasValues); j++)
 237         {
 238           if (row.annotations[j] != null)
 239           {
 240             hasLabels |= (row.annotations[j].displayCharacter != null
 241                     && row.annotations[j].displayCharacter.length() > 0 && !row.annotations[j].displayCharacter
 242                     .equals(" "));
 243             hasGlyphs |= (row.annotations[j].secondaryStructure != 0 && row.annotations[j].secondaryStructure != ' ');
 244             hasValues |= (!Float.isNaN(row.annotations[j].value)); // NaNs can't
 245             // be
 246             // rendered..
 247             hasText |= (row.annotations[j].description != null && row.annotations[j].description
 248                     .length() > 0);
 249           }
 250         }
 251
 252         if (row.graph == AlignmentAnnotation.NO_GRAPH)
 253         {
 254           text.append("NO_GRAPH\t");
 255           hasValues = false; // only secondary structure
 256           // hasLabels = false; // and annotation description string.
 257         }
 258         else
 259         {
 260           if (row.graph == AlignmentAnnotation.BAR_GRAPH)
 261           {
 262             text.append("BAR_GRAPH\t");
 263             hasGlyphs = false; // no secondary structure
 264
 265           }
 266           else if (row.graph == AlignmentAnnotation.LINE_GRAPH)
 267           {
 268             hasGlyphs = false; // no secondary structure
 269             text.append("LINE_GRAPH\t");
 270           }
 271
 272           if (row.getThreshold() != null)
 273           {
 274             graphLine.append("GRAPHLINE\t");
 275             graphLine.append(row.label);
 276             graphLine.append("\t");
 277             graphLine.append(row.getThreshold().value);
 278             graphLine.append("\t");
 279             graphLine.append(row.getThreshold().label);
 280             graphLine.append("\t");
 281             graphLine.append(jalview.util.Format.getHexString(row
 282                     .getThreshold().colour));
 283             graphLine.append(newline);
 284           }
 285
 286           if (row.graphGroup > -1)
 287           {
 288             graphGroupSeen.set(row.graphGroup);
 289             Integer key = new Integer(row.graphGroup);
 290             if (graphGroup.containsKey(key))
 291             {
 292               graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);
 293
 294             }
 295             else
 296             {
 297               graphGroup_refs.put(key, new Object[] { refSeq, refGroup });
 298               graphGroup.put(key, row.label);
 299             }
 300           }
 301         }
 302
 303         text.append(row.label + "\t");
 304         if (row.description != null)
 305         {
 306           text.append(row.description + "\t");
 307         }
 308         for (int j = 0; row.annotations != null
 309                 && j < row.annotations.length; j++)
 310         {
 311           if (refSeq != null
 312                   && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))
 313           {
 314             continue;
 315           }
 316
 317           if (row.annotations[j] != null)
 318           {
 319             comma = "";
 320             if (hasGlyphs) // could be also hasGlyphs || ...
 321             {
 322
 323               text.append(comma);
 324               if (row.annotations[j].secondaryStructure != ' ')
 325               {
 326                 // only write out the field if its not whitespace.
 327                 text.append(row.annotations[j].secondaryStructure);
 328               }
 329               comma = ",";
 330             }
 331             if (hasValues)
 332             {
 333               if (!Float.isNaN(row.annotations[j].value))
 334               {
 335                 text.append(comma + row.annotations[j].value);
 336               }
 337               else
 338               {
 339                 // System.err.println("Skipping NaN - not valid value.");
 340                 text.append(comma + 0f);// row.annotations[j].value);
 341               }
 342               comma = ",";
 343             }
 344             if (hasLabels)
 345             {
 346               // TODO: labels are emitted after values for bar graphs.
 347               if // empty labels are allowed, so
 348               (row.annotations[j].displayCharacter != null
 349                       && row.annotations[j].displayCharacter.length() > 0
 350                       && !row.annotations[j].displayCharacter.equals(" "))
 351               {
 352                 text.append(comma + row.annotations[j].displayCharacter);
 353                 comma = ",";
 354               }
 355             }
 356             if (hasText)
 357             {
 358               if (row.annotations[j].description != null
 359                       && row.annotations[j].description.length() > 0
 360                       && !row.annotations[j].description
 361                               .equals(row.annotations[j].displayCharacter))
 362               {
 363                 text.append(comma + row.annotations[j].description);
 364                 comma = ",";
 365               }
 366             }
 367             if (color != null && !color.equals(row.annotations[j].colour))
 368             {
 369               oneColour = false;
 370             }
 371
 372             color = row.annotations[j].colour;
 373
 374             if (row.annotations[j].colour != null
 375                     && row.annotations[j].colour != java.awt.Color.black)
 376             {
 377               text.append(comma
 378                       + "["
 379                       + jalview.util.Format
 380                               .getHexString(row.annotations[j].colour)
 381                       + "]");
 382               comma = ",";
 383             }
 384           }
 385           text.append("|");
 386         }
 387
 388         if (row.hasScore())
 389         {
 390           text.append("\t" + row.score);
 391         }
 392
 393         text.append(newline);
 394
 395         if (color != null && color != java.awt.Color.black && oneColour)
 396         {
 397           colours.append("COLOUR\t");
 398           colours.append(row.label);
 399           colours.append("\t");
 400           colours.append(jalview.util.Format.getHexString(color));
 401           colours.append(newline);
 402         }
 403         if (row.scaleColLabel || row.showAllColLabels
 404                 || row.centreColLabels)
 405         {
 406           rowprops.append("ROWPROPERTIES\t");
 407           rowprops.append(row.label);
 408           rowprops.append("\tscaletofit=");
 409           rowprops.append(row.scaleColLabel);
 410           rowprops.append("\tshowalllabs=");
 411           rowprops.append(row.showAllColLabels);
 412           rowprops.append("\tcentrelabs=");
 413           rowprops.append(row.centreColLabels);
 414           rowprops.append(newline);
 415         }
 416         if (graphLine.length() > 0)
 417         {
 418           text.append(graphLine.toString());
 419           graphLine.setLength(0);
 420         }
 421       }
 422
 423       text.append(newline);
 424
 425       text.append(colours.toString());
 426       if (graphGroup.size() > 0)
 427       {
 428         SequenceI oldRefSeq = refSeq;
 429         SequenceGroup oldRefGroup = refGroup;
 430         for (Map.Entry<Integer, String> combine_statement : graphGroup
 431                 .entrySet())
 432         {
 433           Object[] seqRefAndGroup = graphGroup_refs.get(combine_statement
 434                   .getKey());
 435
 436           writeSequence_Ref(refSeq, (SequenceI) seqRefAndGroup[0]);
 437           refSeq = (SequenceI) seqRefAndGroup[0];
 438
 439           writeGroup_Ref(refGroup, (SequenceGroup) seqRefAndGroup[1]);
 440           refGroup = (SequenceGroup) seqRefAndGroup[1];
 441           text.append("COMBINE\t");
 442           text.append(combine_statement.getValue());
 443           text.append(newline);
 444         }
 445         writeSequence_Ref(refSeq, oldRefSeq);
 446         refSeq = oldRefSeq;
 447
 448         writeGroup_Ref(refGroup, oldRefGroup);
 449         refGroup = oldRefGroup;
 450       }
 451       text.append(rowprops.toString());
 452     }
 453
 454     if (list != null)
 455     {
 456       printGroups(list);
 457     }
 458
 459     if (properties != null)
 460     {
 461       text.append(newline);
 462       text.append(newline);
 463       text.append("ALIGNMENT");
 464       Enumeration en = properties.keys();
 465       while (en.hasMoreElements())
 466       {
 467         String key = en.nextElement().toString();
 468         text.append("\t");
 469         text.append(key);
 470         text.append("=");
 471         text.append(properties.get(key));
 472       }
 473       // TODO: output alignment visualization settings here if required
 474       // iterate through one or more views, defining, marking columns and rows
 475       // as visible/hidden, and emmitting view properties.
 476       // View specific annotation is
 477     }
 478
 479     return text.toString();
 480   }
 481
 482   private Object writeGroup_Ref(SequenceGroup refGroup,
 483           SequenceGroup next_refGroup)
 484   {
 485     if (next_refGroup == null)
 486     {
 487
 488       if (refGroup != null)
 489       {
 490         text.append(newline);
 491         text.append("GROUP_REF\t");
 492         text.append("ALIGNMENT");
 493         text.append(newline);
 494       }
 495       return true;
 496     }
 497     else
 498     {
 499       if (refGroup == null || refGroup != next_refGroup)
 500       {
 501         text.append(newline);
 502         text.append("GROUP_REF\t");
 503         text.append(next_refGroup.getName());
 504         text.append(newline);
 505         return true;
 506       }
 507     }
 508     return false;
 509   }
 510
 511   private boolean writeSequence_Ref(SequenceI refSeq, SequenceI next_refSeq)
 512   {
 513
 514     if (next_refSeq == null)
 515     {
 516       if (refSeq != null)
 517       {
 518         text.append(newline);
 519         text.append("SEQUENCE_REF\t");
 520         text.append("ALIGNMENT");
 521         text.append(newline);
 522         return true;
 523       }
 524     }
 525     else
 526     {
 527       if (refSeq == null || refSeq != next_refSeq)
 528       {
 529         text.append(newline);
 530         text.append("SEQUENCE_REF\t");
 531         text.append(next_refSeq.getName());
 532         text.append(newline);
 533         return true;
 534       }
 535     }
 536     return false;
 537   }
 538
 539   public void printGroups(List<SequenceGroup> list)
 540   {
 541     SequenceI seqrep = null;
 542     for (SequenceGroup sg : list)
 543     {
 544       if (!sg.hasSeqrep())
 545       {
 546         text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"
 547                 + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1)
 548                 + "\t" + "-1\t");
 549         seqrep = null;
 550       }
 551       else
 552       {
 553         seqrep = sg.getSeqrep();
 554         text.append("SEQUENCE_REF\t");
 555         text.append(seqrep.getName());
 556         text.append(newline);
 557         text.append("SEQUENCE_GROUP\t");
 558         text.append(sg.getName());
 559         text.append("\t");
 560         text.append((seqrep.findPosition(sg.getStartRes())));
 561         text.append("\t");
 562         text.append((seqrep.findPosition(sg.getEndRes())));
 563         text.append("\t");
 564         text.append("-1\t");
 565       }
 566       for (int s = 0; s < sg.getSize(); s++)
 567       {
 568         text.append(sg.getSequenceAt(s).getName());
 569         text.append("\t");
 570       }
 571       text.append(newline);
 572       text.append("PROPERTIES\t");
 573       text.append(sg.getName());
 574       text.append("\t");
 575
 576       if (sg.getDescription() != null)
 577       {
 578         text.append("description=");
 579         text.append(sg.getDescription());
 580         text.append("\t");
 581       }
 582       if (sg.cs != null)
 583       {
 584         text.append("colour=");
 585         text.append(ColourSchemeProperty.getColourName(sg.cs));
 586         text.append("\t");
 587         if (sg.cs.getThreshold() != 0)
 588         {
 589           text.append("pidThreshold=");
 590           text.append(sg.cs.getThreshold());
 591         }
 592         if (sg.cs.conservationApplied())
 593         {
 594           text.append("consThreshold=");
 595           text.append(sg.cs.getConservationInc());
 596           text.append("\t");
 597         }
 598       }
 599       text.append("outlineColour=");
 600       text.append(jalview.util.Format.getHexString(sg.getOutlineColour()));
 601       text.append("\t");
 602
 603       text.append("displayBoxes=");
 604       text.append(sg.getDisplayBoxes());
 605       text.append("\t");
 606       text.append("displayText=");
 607       text.append(sg.getDisplayText());
 608       text.append("\t");
 609       text.append("colourText=");
 610       text.append(sg.getColourText());
 611       text.append("\t");
 612       text.append("showUnconserved=");
 613       text.append(sg.getShowNonconserved());
 614       text.append("\t");
 615       if (sg.textColour != java.awt.Color.black)
 616       {
 617         text.append("textCol1=");
 618         text.append(jalview.util.Format.getHexString(sg.textColour));
 619         text.append("\t");
 620       }
 621       if (sg.textColour2 != java.awt.Color.white)
 622       {
 623         text.append("textCol2=");
 624         text.append(jalview.util.Format.getHexString(sg.textColour2));
 625         text.append("\t");
 626       }
 627       if (sg.thresholdTextColour != 0)
 628       {
 629         text.append("textColThreshold=");
 630         text.append(sg.thresholdTextColour);
 631         text.append("\t");
 632       }
 633       if (sg.idColour != null)
 634       {
 635         text.append("idColour=");
 636         text.append(jalview.util.Format.getHexString(sg.idColour));
 637         text.append("\t");
 638       }
 639       if (sg.isHidereps())
 640       {
 641         text.append("hide=true\t");
 642       }
 643       if (sg.isHideCols())
 644       {
 645         text.append("hidecols=true\t");
 646       }
 647       if (seqrep != null)
 648       {
 649         // terminate the last line and clear the sequence ref for the group
 650         text.append(newline);
 651         text.append("SEQUENCE_REF");
 652       }
 653       text.append(newline);
 654       text.append(newline);
 655
 656     }
 657   }
 658
 659   SequenceI refSeq = null;
 660
 661   String refSeqId = null;
 662
 663   public boolean annotateAlignmentView(AlignViewportI viewport,
 664           String file, String protocol)
 665   {
 666     ColumnSelection colSel = viewport.getColumnSelection();
 667     if (colSel == null)
 668     {
 669       colSel = new ColumnSelection();
 670     }
 671     boolean rslt = readAnnotationFile(viewport.getAlignment(), colSel,
 672             file, protocol);
 673     if (rslt && (colSel.hasSelectedColumns() || colSel.hasHiddenColumns()))
 674     {
 675       viewport.setColumnSelection(colSel);
 676     }
 677
 678     return rslt;
 679   }
 680
 681   public boolean readAnnotationFile(AlignmentI al, String file,
 682           String protocol)
 683   {
 684     return readAnnotationFile(al, null, file, protocol);
 685   }
 686
 687   public boolean readAnnotationFile(AlignmentI al, ColumnSelection colSel,
 688           String file, String protocol)
 689   {
 690     BufferedReader in = null;
 691     try
 692     {
 693       if (protocol.equals(AppletFormatAdapter.FILE))
 694       {
 695         in = new BufferedReader(new FileReader(file));
 696       }
 697       else if (protocol.equals(AppletFormatAdapter.URL))
 698       {
 699         URL url = new URL(file);
 700         in = new BufferedReader(new InputStreamReader(url.openStream()));
 701       }
 702       else if (protocol.equals(AppletFormatAdapter.PASTE))
 703       {
 704         in = new BufferedReader(new StringReader(file));
 705       }
 706       else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))
 707       {
 708         java.io.InputStream is = getClass().getResourceAsStream("/" + file);
 709         if (is != null)
 710         {
 711           in = new BufferedReader(new java.io.InputStreamReader(is));
 712         }
 713       }
 714       if (in != null)
 715       {
 716         return parseAnnotationFrom(al, colSel, in);
 717       }
 718
 719     } catch (Exception ex)
 720     {
 721       ex.printStackTrace();
 722       System.out.println("Problem reading annotation file: " + ex);
 723       if (nlinesread > 0)
 724       {
 725         System.out.println("Last read line " + nlinesread + ": '"
 726                 + lastread + "' (first 80 chars) ...");
 727       }
 728       return false;
 729     }
 730     return false;
 731   }
 732
 733   long nlinesread = 0;
 734
 735   String lastread = "";
 736
 737   private static String GRAPHLINE = "GRAPHLINE", COMBINE = "COMBINE",
 738           STRUCTMODEL = "STRUCTMODEL";
 739
 740   public boolean parseAnnotationFrom(AlignmentI al, ColumnSelection colSel,
 741           BufferedReader in) throws Exception
 742   {
 743     nlinesread = 0;
 744     ArrayList<Object[]> combineAnnotation_calls = new ArrayList<Object[]>();
 745     ArrayList<Object[]> deferredAnnotation_calls = new ArrayList<Object[]>();
 746     boolean modified = false;
 747     String groupRef = null;
 748     Hashtable groupRefRows = new Hashtable();
 749
 750     Hashtable autoAnnots = new Hashtable();
 751     {
 752       String line, label, description, token;
 753       int graphStyle, index;
 754       int refSeqIndex = 1;
 755       int existingAnnotations = 0;
 756       // when true - will add new rows regardless of whether they are duplicate
 757       // auto-annotation like consensus or conservation graphs
 758       boolean overrideAutoAnnot = false;
 759       if (al.getAlignmentAnnotation() != null)
 760       {
 761         existingAnnotations = al.getAlignmentAnnotation().length;
 762         if (existingAnnotations > 0)
 763         {
 764           AlignmentAnnotation[] aa = al.getAlignmentAnnotation();
 765           for (int aai = 0; aai < aa.length; aai++)
 766           {
 767             if (aa[aai].autoCalculated)
 768             {
 769               // make a note of the name and description
 770               autoAnnots.put(
 771                       autoAnnotsKey(aa[aai], aa[aai].sequenceRef,
 772                               (aa[aai].groupRef == null ? null
 773                                       : aa[aai].groupRef.getName())),
 774                       new Integer(1));
 775             }
 776           }
 777         }
 778       }
 779
 780       int alWidth = al.getWidth();
 781
 782       StringTokenizer st;
 783       Annotation[] annotations;
 784       AlignmentAnnotation annotation = null;
 785
 786       // First confirm this is an Annotation file
 787       boolean jvAnnotationFile = false;
 788       while ((line = in.readLine()) != null)
 789       {
 790         nlinesread++;
 791         lastread = new String(line);
 792         if (line.indexOf("#") == 0)
 793         {
 794           continue;
 795         }
 796
 797         if (line.indexOf("JALVIEW_ANNOTATION") > -1)
 798         {
 799           jvAnnotationFile = true;
 800           break;
 801         }
 802       }
 803
 804       if (!jvAnnotationFile)
 805       {
 806         in.close();
 807         return false;
 808       }
 809
 810       while ((line = in.readLine()) != null)
 811       {
 812         nlinesread++;
 813         lastread = new String(line);
 814         if (line.indexOf("#") == 0
 815                 || line.indexOf("JALVIEW_ANNOTATION") > -1
 816                 || line.length() == 0)
 817         {
 818           continue;
 819         }
 820
 821         st = new StringTokenizer(line, "\t");
 822         token = st.nextToken();
 823         if (token.equalsIgnoreCase("COLOUR"))
 824         {
 825           // TODO: use graduated colour def'n here too
 826           colourAnnotations(al, st.nextToken(), st.nextToken());
 827           modified = true;
 828           continue;
 829         }
 830
 831         else if (token.equalsIgnoreCase(COMBINE))
 832         {
 833           // keep a record of current state and resolve groupRef at end
 834           combineAnnotation_calls
 835                   .add(new Object[] { st, refSeq, groupRef });
 836           modified = true;
 837           continue;
 838         }
 839         else if (token.equalsIgnoreCase("ROWPROPERTIES"))
 840         {
 841           addRowProperties(al, st);
 842           modified = true;
 843           continue;
 844         }
 845         else if (token.equalsIgnoreCase(GRAPHLINE))
 846         {
 847           // resolve at end
 848           deferredAnnotation_calls.add(new Object[] { GRAPHLINE, st,
 849               refSeq, groupRef });
 850           modified = true;
 851           continue;
 852         }
 853
 854         else if (token.equalsIgnoreCase("SEQUENCE_REF"))
 855         {
 856           if (st.hasMoreTokens())
 857           {
 858             refSeq = al.findName(refSeqId = st.nextToken());
 859             if (refSeq == null)
 860             {
 861               refSeqId = null;
 862             }
 863             try
 864             {
 865               refSeqIndex = Integer.parseInt(st.nextToken());
 866               if (refSeqIndex < 1)
 867               {
 868                 refSeqIndex = 1;
 869                 System.out
 870                         .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");
 871               }
 872             } catch (Exception ex)
 873             {
 874               refSeqIndex = 1;
 875             }
 876           }
 877           else
 878           {
 879             refSeq = null;
 880             refSeqId = null;
 881           }
 882           continue;
 883         }
 884         else if (token.equalsIgnoreCase("GROUP_REF"))
 885         {
 886           // Group references could be forward or backwards, so they are
 887           // resolved after the whole file is read in
 888           groupRef = null;
 889           if (st.hasMoreTokens())
 890           {
 891             groupRef = st.nextToken();
 892             if (groupRef.length() < 1)
 893             {
 894               groupRef = null; // empty string
 895             }
 896             else
 897             {
 898               if (groupRefRows.get(groupRef) == null)
 899               {
 900                 groupRefRows.put(groupRef, new Vector());
 901               }
 902             }
 903           }
 904           continue;
 905         }
 906         else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))
 907         {
 908           addGroup(al, st);
 909           modified = true;
 910           continue;
 911         }
 912
 913         else if (token.equalsIgnoreCase("PROPERTIES"))
 914         {
 915           addProperties(al, st);
 916           modified = true;
 917           continue;
 918         }
 919
 920         else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))
 921         {
 922           setBelowAlignment(al, st);
 923           modified = true;
 924           continue;
 925         }
 926         else if (token.equalsIgnoreCase("ALIGNMENT"))
 927         {
 928           addAlignmentDetails(al, st);
 929           modified = true;
 930           continue;
 931         }
 932         // else if (token.equalsIgnoreCase("VIEW_DEF"))
 933         // {
 934         // addOrSetView(al,st);
 935         // modified = true;
 936         // continue;
 937         // }
 938         else if (token.equalsIgnoreCase("VIEW_SETREF"))
 939         {
 940           if (refSeq != null)
 941           {
 942             al.setSeqrep(refSeq);
 943           }
 944           modified = true;
 945           continue;
 946         }
 947         else if (token.equalsIgnoreCase("VIEW_HIDECOLS"))
 948         {
 949           if (st.hasMoreTokens())
 950           {
 951             if (colSel == null)
 952             {
 953               colSel = new ColumnSelection();
 954             }
 955             parseHideCols(colSel, st.nextToken());
 956           }
 957           modified = true;
 958           continue;
 959         }
 960         else if (token.equalsIgnoreCase("HIDE_INSERTIONS"))
 961         {
 962           SequenceI sr = refSeq == null ? al.getSeqrep() : refSeq;
 963           if (sr == null)
 964           {
 965             sr = al.getSequenceAt(0);
 966           }
 967           if (sr != null)
 968           {
 969             if (colSel == null)
 970             {
 971               System.err
 972                       .println("Cannot process HIDE_INSERTIONS without an alignment view: Ignoring line: "
 973                               + line);
 974             }
 975             else
 976             {
 977               // consider deferring this till after the file has been parsed ?
 978               colSel.hideInsertionsFor(sr);
 979             }
 980           }
 981           modified = true;
 982           continue;
 983         }
 984         else if (token.equalsIgnoreCase(STRUCTMODEL))
 985         {
 986           boolean failedtoadd = true;
 987           // expect
 988           // STRUCTMODEL <QUERYID> <TemplateID> <URL to model> <URL to
 989           // alignment>
 990           if (st.hasMoreTokens()) {
 991             refSeq = al.findName(refSeqId = st.nextToken());
 992             if (refSeq == null)
 993             {
 994               System.err.println("Couldn't locate " + refSeqId
 995                       + " in the alignment for STRUCTMODEL");
 996               refSeqId = null;
 997             }
 998             else
 999             {
1000               String tempId = st.nextToken();
1001               String urlToModel = st.nextToken();
1002               String urlToPairwise = st.hasMoreTokens() ? st.nextToken()
1003                       : "";
1004               if (add_structmodel(refSeq, tempId, urlToModel, urlToPairwise))
1005               {
1006                 failedtoadd = false;
1007               }
1008             }
1009           }
1010           if (failedtoadd)
1011           {
1012             System.err
1013                     .println("Need <QueryId> <TemplateId> <URL to Model> [<URL to pairwise alignment>] as tab separated fields after "
1014                             + STRUCTMODEL);
1015           } else {
1016             modified = true;
1017           }
1018           continue;
1019         }
1020         // Parse out the annotation row
1021         graphStyle = AlignmentAnnotation.getGraphValueFromString(token);
1022         label = st.nextToken();
1023
1024         index = 0;
1025         annotations = new Annotation[alWidth];
1026         description = null;
1027         float score = Float.NaN;
1028
1029         if (st.hasMoreTokens())
1030         {
1031           line = st.nextToken();
1032
1033           if (line.indexOf("|") == -1)
1034           {
1035             description = line;
1036             if (st.hasMoreTokens())
1037             {
1038               line = st.nextToken();
1039             }
1040           }
1041
1042           if (st.hasMoreTokens())
1043           {
1044             // This must be the score
1045             score = Float.valueOf(st.nextToken()).floatValue();
1046           }
1047
1048           st = new StringTokenizer(line, "|", true);
1049
1050           boolean emptyColumn = true;
1051           boolean onlyOneElement = (st.countTokens() == 1);
1052
1053           while (st.hasMoreElements() && index < alWidth)
1054           {
1055             token = st.nextToken().trim();
1056
1057             if (onlyOneElement)
1058             {
1059               try
1060               {
1061                 score = Float.valueOf(token).floatValue();
1062                 break;
1063               } catch (NumberFormatException ex)
1064               {
1065               }
1066             }
1067
1068             if (token.equals("|"))
1069             {
1070               if (emptyColumn)
1071               {
1072                 index++;
1073               }
1074
1075               emptyColumn = true;
1076             }
1077             else
1078             {
1079               annotations[index++] = parseAnnotation(token, graphStyle);
1080               emptyColumn = false;
1081             }
1082           }
1083
1084         }
1085
1086         annotation = new AlignmentAnnotation(label, description,
1087                 (index == 0) ? null : annotations, 0, 0, graphStyle);
1088
1089         annotation.score = score;
1090         if (!overrideAutoAnnot
1091                 && autoAnnots.containsKey(autoAnnotsKey(annotation, refSeq,
1092                         groupRef)))
1093         {
1094           // skip - we've already got an automatic annotation of this type.
1095           continue;
1096         }
1097         // otherwise add it!
1098         if (refSeq != null)
1099         {
1100
1101           annotation.belowAlignment = false;
1102           // make a copy of refSeq so we can find other matches in the alignment
1103           SequenceI referedSeq = refSeq;
1104           do
1105           {
1106             // copy before we do any mapping business.
1107             // TODO: verify that undo/redo with 1:many sequence associated
1108             // annotations can be undone correctly
1109             AlignmentAnnotation ann = new AlignmentAnnotation(annotation);
1110             annotation
1111                     .createSequenceMapping(referedSeq, refSeqIndex, false);
1112             annotation.adjustForAlignment();
1113             referedSeq.addAlignmentAnnotation(annotation);
1114             al.addAnnotation(annotation);
1115             al.setAnnotationIndex(annotation,
1116                     al.getAlignmentAnnotation().length
1117                             - existingAnnotations - 1);
1118             if (groupRef != null)
1119             {
1120               ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
1121             }
1122             // and recover our virgin copy to use again if necessary.
1123             annotation = ann;
1124
1125           } while (refSeqId != null
1126                   && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);
1127         }
1128         else
1129         {
1130           al.addAnnotation(annotation);
1131           al.setAnnotationIndex(annotation,
1132                   al.getAlignmentAnnotation().length - existingAnnotations
1133                           - 1);
1134           if (groupRef != null)
1135           {
1136             ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
1137           }
1138         }
1139         // and set modification flag
1140         modified = true;
1141       }
1142       // Resolve the groupRefs
1143       Hashtable<String, SequenceGroup> groupRefLookup = new Hashtable<String, SequenceGroup>();
1144       Enumeration en = groupRefRows.keys();
1145
1146       while (en.hasMoreElements())
1147       {
1148         groupRef = (String) en.nextElement();
1149         boolean matched = false;
1150         // Resolve group: TODO: add a getGroupByName method to alignments
1151         for (SequenceGroup theGroup : al.getGroups())
1152         {
1153           if (theGroup.getName().equals(groupRef))
1154           {
1155             if (matched)
1156             {
1157               // TODO: specify and implement duplication of alignment annotation
1158               // for multiple group references.
1159               System.err
1160                       .println("Ignoring 1:many group reference mappings for group name '"
1161                               + groupRef + "'");
1162             }
1163             else
1164             {
1165               matched = true;
1166               Vector rowset = (Vector) groupRefRows.get(groupRef);
1167               groupRefLookup.put(groupRef, theGroup);
1168               if (rowset != null && rowset.size() > 0)
1169               {
1170                 AlignmentAnnotation alan = null;
1171                 for (int elm = 0, elmSize = rowset.size(); elm < elmSize; elm++)
1172                 {
1173                   alan = (AlignmentAnnotation) rowset.elementAt(elm);
1174                   alan.groupRef = theGroup;
1175                 }
1176               }
1177             }
1178           }
1179         }
1180         ((Vector) groupRefRows.get(groupRef)).removeAllElements();
1181       }
1182       // process any deferred attribute settings for each context
1183       for (Object[] _deferred_args : deferredAnnotation_calls)
1184       {
1185         if (_deferred_args[0] == GRAPHLINE)
1186         {
1187           addLine(al,
1188                   (StringTokenizer) _deferred_args[1], // st
1189                   (SequenceI) _deferred_args[2], // refSeq
1190                   (_deferred_args[3] == null) ? null : groupRefLookup
1191                           .get(_deferred_args[3]) // the reference
1192                                                   // group, or null
1193           );
1194         }
1195       }
1196
1197       // finally, combine all the annotation rows within each context.
1198       /**
1199        * number of combine statements in this annotation file. Used to create
1200        * new groups for combined annotation graphs without disturbing existing
1201        * ones
1202        */
1203       int combinecount = 0;
1204       for (Object[] _combine_args : combineAnnotation_calls)
1205       {
1206         combineAnnotations(al,
1207                 ++combinecount,
1208                 (StringTokenizer) _combine_args[0], // st
1209                 (SequenceI) _combine_args[1], // refSeq
1210                 (_combine_args[2] == null) ? null : groupRefLookup
1211                         .get(_combine_args[2]) // the reference group,
1212                                                // or null
1213         );
1214       }
1215     }
1216     return modified;
1217   }
1218
1219   /**
1220    * resolve a structural model and generate and add an alignment sequence for
1221    * it
1222    *
1223    * @param refSeq2
1224    * @param tempId
1225    * @param urlToModel
1226    * @param urlToPairwise
1227    * @return true if model and sequence was added
1228    */
1229   private boolean add_structmodel(SequenceI refSeq2, String tempId,
1230           String urlToModel, String urlToPairwise)
1231   {
1232
1233     return false;
1234   }
1235
1236   private void add_structmodel(StringTokenizer st)
1237   {
1238
1239     // TODO Auto-generated method stub
1240
1241   }
1242
1243   private void parseHideCols(ColumnSelection colSel, String nextToken)
1244   {
1245     StringTokenizer inval = new StringTokenizer(nextToken, ",");
1246     while (inval.hasMoreTokens())
1247     {
1248       String range = inval.nextToken().trim();
1249       int from, to = range.indexOf("-");
1250       if (to == -1)
1251       {
1252         from = to = Integer.parseInt(range);
1253         if (from >= 0)
1254         {
1255           colSel.hideColumns(from, to);
1256         }
1257       }
1258       else
1259       {
1260         from = Integer.parseInt(range.substring(0, to));
1261         if (to < range.length() - 1)
1262         {
1263           to = Integer.parseInt(range.substring(to + 1));
1264         }
1265         else
1266         {
1267           to = from;
1268         }
1269         if (from > 0 && to >= from)
1270         {
1271           colSel.hideColumns(from, to);
1272         }
1273       }
1274     }
1275   }
1276
1277   private Object autoAnnotsKey(AlignmentAnnotation annotation,
1278           SequenceI refSeq, String groupRef)
1279   {
1280     return annotation.graph + "\t" + annotation.label + "\t"
1281             + annotation.description + "\t"
1282             + (refSeq != null ? refSeq.getDisplayId(true) : "");
1283   }
1284
1285   Annotation parseAnnotation(String string, int graphStyle)
1286   {
1287     boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH); // don't
1288     // do the
1289     // glyph
1290     // test
1291     // if we
1292     // don't
1293     // want
1294     // secondary
1295     // structure
1296     String desc = null, displayChar = null;
1297     char ss = ' '; // secondaryStructure
1298     float value = 0;
1299     boolean parsedValue = false, dcset = false;
1300
1301     // find colour here
1302     java.awt.Color colour = null;
1303     int i = string.indexOf("[");
1304     int j = string.indexOf("]");
1305     if (i > -1 && j > -1)
1306     {
1307       UserColourScheme ucs = new UserColourScheme();
1308
1309       colour = ucs.getColourFromString(string.substring(i + 1, j));
1310       if (i > 0 && string.charAt(i - 1) == ',')
1311       {
1312         // clip the preceding comma as well
1313         i--;
1314       }
1315       string = string.substring(0, i) + string.substring(j + 1);
1316     }
1317
1318     StringTokenizer st = new StringTokenizer(string, ",", true);
1319     String token;
1320     boolean seenContent = false;
1321     int pass = 0;
1322     while (st.hasMoreTokens())
1323     {
1324       pass++;
1325       token = st.nextToken().trim();
1326       if (token.equals(","))
1327       {
1328         if (!seenContent && parsedValue && !dcset)
1329         {
1330           // allow the value below the bar/line to be empty
1331           dcset = true;
1332           displayChar = " ";
1333         }
1334         seenContent = false;
1335         continue;
1336       }
1337       else
1338       {
1339         seenContent = true;
1340       }
1341
1342       if (!parsedValue)
1343       {
1344         try
1345         {
1346           displayChar = token;
1347           // foo
1348           value = new Float(token).floatValue();
1349           parsedValue = true;
1350           continue;
1351         } catch (NumberFormatException ex)
1352         {
1353         }
1354       }
1355       else
1356       {
1357         if (token.length() == 1)
1358         {
1359           displayChar = token;
1360         }
1361       }
1362       if (hasSymbols
1363               && (token.length() == 1 && "()<>[]{}AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"
1364                       .contains(token)))
1365       {
1366         // Either this character represents a helix or sheet
1367         // or an integer which can be displayed
1368         ss = token.charAt(0);
1369         if (displayChar.equals(token.substring(0, 1)))
1370         {
1371           displayChar = "";
1372         }
1373       }
1374       else if (desc == null || (parsedValue && pass > 2))
1375       {
1376         desc = token;
1377       }
1378
1379     }
1380     // if (!dcset && string.charAt(string.length() - 1) == ',')
1381     // {
1382     // displayChar = " "; // empty display char symbol.
1383     // }
1384     if (displayChar != null && desc != null && desc.length() == 1)
1385     {
1386       if (displayChar.length() > 1)
1387       {
1388         // switch desc and displayChar - legacy support
1389         String tmp = displayChar;
1390         displayChar = desc;
1391         desc = tmp;
1392       }
1393       else
1394       {
1395         if (displayChar.equals(desc))
1396         {
1397           // duplicate label - hangover from the 'robust parser' above
1398           desc = null;
1399         }
1400       }
1401     }
1402     Annotation anot = new Annotation(displayChar, desc, ss, value);
1403
1404     anot.colour = colour;
1405
1406     return anot;
1407   }
1408
1409   void colourAnnotations(AlignmentI al, String label, String colour)
1410   {
1411     UserColourScheme ucs = new UserColourScheme(colour);
1412     Annotation[] annotations;
1413     for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1414     {
1415       if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))
1416       {
1417         annotations = al.getAlignmentAnnotation()[i].annotations;
1418         for (int j = 0; j < annotations.length; j++)
1419         {
1420           if (annotations[j] != null)
1421           {
1422             annotations[j].colour = ucs.findColour('A');
1423           }
1424         }
1425       }
1426     }
1427   }
1428
1429   void combineAnnotations(AlignmentI al, int combineCount,
1430           StringTokenizer st, SequenceI seqRef, SequenceGroup groupRef)
1431   {
1432     String group = st.nextToken();
1433     // First make sure we are not overwriting the graphIndex
1434     int graphGroup = 0;
1435     if (al.getAlignmentAnnotation() != null)
1436     {
1437       for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1438       {
1439         AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
1440
1441         if (aa.graphGroup > graphGroup)
1442         {
1443           // try to number graphGroups in order of occurence.
1444           graphGroup = aa.graphGroup + 1;
1445         }
1446         if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
1447                 && aa.label.equalsIgnoreCase(group))
1448         {
1449           if (aa.graphGroup > -1)
1450           {
1451             graphGroup = aa.graphGroup;
1452           }
1453           else
1454           {
1455             if (graphGroup <= combineCount)
1456             {
1457               graphGroup = combineCount + 1;
1458             }
1459             aa.graphGroup = graphGroup;
1460           }
1461           break;
1462         }
1463       }
1464
1465       // Now update groups
1466       while (st.hasMoreTokens())
1467       {
1468         group = st.nextToken();
1469         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1470         {
1471           AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
1472           if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
1473                   && aa.label.equalsIgnoreCase(group))
1474           {
1475             aa.graphGroup = graphGroup;
1476             break;
1477           }
1478         }
1479       }
1480     }
1481     else
1482     {
1483       System.err
1484               .println("Couldn't combine annotations. None are added to alignment yet!");
1485     }
1486   }
1487
1488   void addLine(AlignmentI al, StringTokenizer st, SequenceI seqRef,
1489           SequenceGroup groupRef)
1490   {
1491     String group = st.nextToken();
1492     AlignmentAnnotation annotation = null, alannot[] = al
1493             .getAlignmentAnnotation();
1494     float value = new Float(st.nextToken()).floatValue();
1495     String label = st.hasMoreTokens() ? st.nextToken() : null;
1496     java.awt.Color colour = null;
1497     if (st.hasMoreTokens())
1498     {
1499       UserColourScheme ucs = new UserColourScheme(st.nextToken());
1500       colour = ucs.findColour('A');
1501     }
1502     if (alannot != null)
1503     {
1504       for (int i = 0; i < alannot.length; i++)
1505       {
1506         if (alannot[i].label.equalsIgnoreCase(group)
1507                 && (seqRef == null || alannot[i].sequenceRef == seqRef)
1508                 && (groupRef == null || alannot[i].groupRef == groupRef))
1509         {
1510           alannot[i].setThreshold(new GraphLine(value, label, colour));
1511         }
1512       }
1513     }
1514     if (annotation == null)
1515     {
1516       return;
1517     }
1518   }
1519
1520   void addGroup(AlignmentI al, StringTokenizer st)
1521   {
1522     SequenceGroup sg = new SequenceGroup();
1523     sg.setName(st.nextToken());
1524     String rng = "";
1525     try
1526     {
1527       rng = st.nextToken();
1528       if (rng.length() > 0 && !rng.startsWith("*"))
1529       {
1530         sg.setStartRes(Integer.parseInt(rng) - 1);
1531       }
1532       else
1533       {
1534         sg.setStartRes(0);
1535       }
1536       rng = st.nextToken();
1537       if (rng.length() > 0 && !rng.startsWith("*"))
1538       {
1539         sg.setEndRes(Integer.parseInt(rng) - 1);
1540       }
1541       else
1542       {
1543         sg.setEndRes(al.getWidth() - 1);
1544       }
1545     } catch (Exception e)
1546     {
1547       System.err
1548               .println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"
1549                       + rng + "' - assuming alignment width for group.");
1550       // assume group is full width
1551       sg.setStartRes(0);
1552       sg.setEndRes(al.getWidth() - 1);
1553     }
1554
1555     String index = st.nextToken();
1556     if (index.equals("-1"))
1557     {
1558       while (st.hasMoreElements())
1559       {
1560         sg.addSequence(al.findName(st.nextToken()), false);
1561       }
1562     }
1563     else
1564     {
1565       StringTokenizer st2 = new StringTokenizer(index, ",");
1566
1567       while (st2.hasMoreTokens())
1568       {
1569         String tmp = st2.nextToken();
1570         if (tmp.equals("*"))
1571         {
1572           for (int i = 0; i < al.getHeight(); i++)
1573           {
1574             sg.addSequence(al.getSequenceAt(i), false);
1575           }
1576         }
1577         else if (tmp.indexOf("-") >= 0)
1578         {
1579           StringTokenizer st3 = new StringTokenizer(tmp, "-");
1580
1581           int start = (Integer.parseInt(st3.nextToken()));
1582           int end = (Integer.parseInt(st3.nextToken()));
1583
1584           if (end > start)
1585           {
1586             for (int i = start; i <= end; i++)
1587             {
1588               sg.addSequence(al.getSequenceAt(i - 1), false);
1589             }
1590           }
1591         }
1592         else
1593         {
1594           sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1), false);
1595         }
1596       }
1597     }
1598
1599     if (refSeq != null)
1600     {
1601       sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);
1602       sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);
1603       sg.setSeqrep(refSeq);
1604     }
1605
1606     if (sg.getSize() > 0)
1607     {
1608       al.addGroup(sg);
1609     }
1610   }
1611
1612   void addRowProperties(AlignmentI al, StringTokenizer st)
1613   {
1614     String label = st.nextToken(), keyValue, key, value;
1615     boolean scaletofit = false, centerlab = false, showalllabs = false;
1616     while (st.hasMoreTokens())
1617     {
1618       keyValue = st.nextToken();
1619       key = keyValue.substring(0, keyValue.indexOf("="));
1620       value = keyValue.substring(keyValue.indexOf("=") + 1);
1621       if (key.equalsIgnoreCase("scaletofit"))
1622       {
1623         scaletofit = Boolean.valueOf(value).booleanValue();
1624       }
1625       if (key.equalsIgnoreCase("showalllabs"))
1626       {
1627         showalllabs = Boolean.valueOf(value).booleanValue();
1628       }
1629       if (key.equalsIgnoreCase("centrelabs"))
1630       {
1631         centerlab = Boolean.valueOf(value).booleanValue();
1632       }
1633       AlignmentAnnotation[] alr = al.getAlignmentAnnotation();
1634       if (alr != null)
1635       {
1636         for (int i = 0; i < alr.length; i++)
1637         {
1638           if (alr[i].label.equalsIgnoreCase(label))
1639           {
1640             alr[i].centreColLabels = centerlab;
1641             alr[i].scaleColLabel = scaletofit;
1642             alr[i].showAllColLabels = showalllabs;
1643           }
1644         }
1645       }
1646     }
1647   }
1648
1649   void addProperties(AlignmentI al, StringTokenizer st)
1650   {
1651
1652     // So far we have only added groups to the annotationHash,
1653     // the idea is in the future properties can be added to
1654     // alignments, other annotations etc
1655     if (al.getGroups() == null)
1656     {
1657       return;
1658     }
1659
1660     String name = st.nextToken();
1661     SequenceGroup sg = null;
1662     for (SequenceGroup _sg : al.getGroups())
1663     {
1664       if ((sg = _sg).getName().equals(name))
1665       {
1666         break;
1667       }
1668       else
1669       {
1670         sg = null;
1671       }
1672     }
1673
1674     if (sg != null)
1675     {
1676       String keyValue, key, value;
1677       ColourSchemeI def = sg.cs;
1678       sg.cs = null;
1679       while (st.hasMoreTokens())
1680       {
1681         keyValue = st.nextToken();
1682         key = keyValue.substring(0, keyValue.indexOf("="));
1683         value = keyValue.substring(keyValue.indexOf("=") + 1);
1684
1685         if (key.equalsIgnoreCase("description"))
1686         {
1687           sg.setDescription(value);
1688         }
1689         else if (key.equalsIgnoreCase("colour"))
1690         {
1691           sg.cs = ColourSchemeProperty.getColour(al, value);
1692         }
1693         else if (key.equalsIgnoreCase("pidThreshold"))
1694         {
1695           sg.cs.setThreshold(Integer.parseInt(value), true);
1696
1697         }
1698         else if (key.equalsIgnoreCase("consThreshold"))
1699         {
1700           sg.cs.setConservationInc(Integer.parseInt(value));
1701           Conservation c = new Conservation("Group",
1702                   ResidueProperties.propHash, 3, sg.getSequences(null),
1703                   sg.getStartRes(), sg.getEndRes() + 1);
1704
1705           c.calculate();
1706           c.verdict(false, 25); // TODO: refer to conservation percent threshold
1707
1708           sg.cs.setConservation(c);
1709
1710         }
1711         else if (key.equalsIgnoreCase("outlineColour"))
1712         {
1713           sg.setOutlineColour(new UserColourScheme(value).findColour('A'));
1714         }
1715         else if (key.equalsIgnoreCase("displayBoxes"))
1716         {
1717           sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());
1718         }
1719         else if (key.equalsIgnoreCase("showUnconserved"))
1720         {
1721           sg.setShowNonconserved(Boolean.valueOf(value).booleanValue());
1722         }
1723         else if (key.equalsIgnoreCase("displayText"))
1724         {
1725           sg.setDisplayText(Boolean.valueOf(value).booleanValue());
1726         }
1727         else if (key.equalsIgnoreCase("colourText"))
1728         {
1729           sg.setColourText(Boolean.valueOf(value).booleanValue());
1730         }
1731         else if (key.equalsIgnoreCase("textCol1"))
1732         {
1733           sg.textColour = new UserColourScheme(value).findColour('A');
1734         }
1735         else if (key.equalsIgnoreCase("textCol2"))
1736         {
1737           sg.textColour2 = new UserColourScheme(value).findColour('A');
1738         }
1739         else if (key.equalsIgnoreCase("textColThreshold"))
1740         {
1741           sg.thresholdTextColour = Integer.parseInt(value);
1742         }
1743         else if (key.equalsIgnoreCase("idColour"))
1744         {
1745           // consider warning if colour doesn't resolve to a real colour
1746           sg.setIdColour((def = new UserColourScheme(value))
1747                   .findColour('A'));
1748         }
1749         else if (key.equalsIgnoreCase("hide"))
1750         {
1751           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
1752           sg.setHidereps(true);
1753         }
1754         else if (key.equalsIgnoreCase("hidecols"))
1755         {
1756           // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
1757           sg.setHideCols(true);
1758         }
1759         sg.recalcConservation();
1760       }
1761       if (sg.cs == null)
1762       {
1763         sg.cs = def;
1764       }
1765     }
1766   }
1767
1768   void setBelowAlignment(AlignmentI al, StringTokenizer st)
1769   {
1770     String token;
1771     AlignmentAnnotation aa, ala[] = al.getAlignmentAnnotation();
1772     if (ala == null)
1773     {
1774       System.err
1775               .print("Warning - no annotation to set below for sequence associated annotation:");
1776     }
1777     while (st.hasMoreTokens())
1778     {
1779       token = st.nextToken();
1780       if (ala == null)
1781       {
1782         System.err.print(" " + token);
1783       }
1784       else
1785       {
1786         for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1787         {
1788           aa = al.getAlignmentAnnotation()[i];
1789           if (aa.sequenceRef == refSeq && aa.label.equals(token))
1790           {
1791             aa.belowAlignment = true;
1792           }
1793         }
1794       }
1795     }
1796     if (ala == null)
1797     {
1798       System.err.print("\n");
1799     }
1800   }
1801
1802   void addAlignmentDetails(AlignmentI al, StringTokenizer st)
1803   {
1804     String keyValue, key, value;
1805     while (st.hasMoreTokens())
1806     {
1807       keyValue = st.nextToken();
1808       key = keyValue.substring(0, keyValue.indexOf("="));
1809       value = keyValue.substring(keyValue.indexOf("=") + 1);
1810       al.setProperty(key, value);
1811     }
1812   }
1813
1814   /**
1815    * Write annotations as a CSV file of the form 'label, value, value, ...' for
1816    * each row.
1817    *
1818    * @param annotations
1819    * @return CSV file as a string.
1820    */
1821   public String printCSVAnnotations(AlignmentAnnotation[] annotations)
1822   {
1823     if (annotations == null)
1824     {
1825       return "";
1826     }
1827     StringBuffer sp = new StringBuffer();
1828     for (int i = 0; i < annotations.length; i++)
1829     {
1830       String atos = annotations[i].toString();
1831       int p = 0;
1832       do
1833       {
1834         int cp = atos.indexOf("\n", p);
1835         sp.append(annotations[i].label);
1836         sp.append(",");
1837         if (cp > p)
1838         {
1839           sp.append(atos.substring(p, cp + 1));
1840         }
1841         else
1842         {
1843           sp.append(atos.substring(p));
1844           sp.append(newline);
1845         }
1846         p = cp + 1;
1847       } while (p > 0);
1848     }
1849     return sp.toString();
1850   }
1851
1852   public String printAnnotationsForView(AlignViewportI viewport)
1853   {
1854     return printAnnotations(viewport.isShowAnnotation() ? viewport
1855             .getAlignment().getAlignmentAnnotation() : null, viewport
1856             .getAlignment().getGroups(), viewport.getAlignment()
1857             .getProperties(), viewport.getColumnSelection(),
1858             viewport.getAlignment(), null);
1859   }
1860
1861   public String printAnnotationsForAlignment(AlignmentI al)
1862   {
1863     return printAnnotations(al.getAlignmentAnnotation(), al.getGroups(),
1864             al.getProperties(), null, al, null);
1865   }
1866 }