src/jalview/io/StockholmFile.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 /*
  22  * This extension was written by Benjamin Schuster-Boeckler at sanger.ac.uk
  23  */
  24 package jalview.io;
  25
  26 import jalview.analysis.Rna;
  27 import jalview.datamodel.AlignmentAnnotation;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.Annotation;
  30 import jalview.datamodel.DBRefEntry;
  31 import jalview.datamodel.DBRefSource;
  32 import jalview.datamodel.Mapping;
  33 import jalview.datamodel.Sequence;
  34 import jalview.datamodel.SequenceFeature;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.schemes.ResidueProperties;
  37 import jalview.util.Comparison;
  38 import jalview.util.DBRefUtils;
  39 import jalview.util.Format;
  40 import jalview.util.MessageManager;
  41
  42 import java.io.BufferedReader;
  43 import java.io.FileReader;
  44 import java.io.IOException;
  45 import java.util.ArrayList;
  46 import java.util.Enumeration;
  47 import java.util.Hashtable;
  48 import java.util.LinkedHashMap;
  49 import java.util.List;
  50 import java.util.Map;
  51 import java.util.Vector;
  52
  53 import com.stevesoft.pat.Regex;
  54
  55 import fr.orsay.lri.varna.exceptions.ExceptionUnmatchedClosingParentheses;
  56 import fr.orsay.lri.varna.factories.RNAFactory;
  57 import fr.orsay.lri.varna.models.rna.RNA;
  58
  59 // import org.apache.log4j.*;
  60
  61 /**
  62  * This class is supposed to parse a Stockholm format file into Jalview There
  63  * are TODOs in this class: we do not know what the database source and version
  64  * is for the file when parsing the #GS= AC tag which associates accessions with
  65  * sequences. Database references are also not parsed correctly: a separate
  66  * reference string parser must be added to parse the database reference form
  67  * into Jalview's local representation.
  68  *
  69  * @author bsb at sanger.ac.uk
  70  * @author Natasha Shersnev (Dundee, UK) (Stockholm file writer)
  71  * @author Lauren Lui (UCSC, USA) (RNA secondary structure annotation import as
  72  *         stockholm)
  73  * @author Anne Menard (Paris, FR) (VARNA parsing of Stockholm file data)
  74  * @version 0.3 + jalview mods
  75  *
  76  */
  77 public class StockholmFile extends AlignFile
  78 {
  79   private static final String ANNOTATION = "annotation";
  80
  81   private static final Regex OPEN_PAREN = new Regex("(<|\\[)", "(");
  82
  83   private static final Regex CLOSE_PAREN = new Regex("(>|\\])", ")");
  84
  85   public static final Regex DETECT_BRACKETS = new Regex(
  86           "(<|>|\\[|\\]|\\(|\\)|\\{|\\})");
  87
  88   // WUSS extended symbols. Avoid ambiguity with protein SS annotations by using NOT_RNASS first.
  89   public static final String RNASS_BRACKETS = "<>[](){}AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz";
  90
  91   // use the following regex to decide an annotations (whole) line is NOT an RNA
  92   // SS (it contains only E,H,e,h and other non-brace/non-alpha chars)
  93   private static final Regex NOT_RNASS = new Regex(
  94           "^[^<>[\\](){}A-DF-Za-df-z]*$");
  95
  96   StringBuffer out; // output buffer
  97
  98   AlignmentI al;
  99
 100   public StockholmFile()
 101   {
 102   }
 103
 104   /**
 105    * Creates a new StockholmFile object for output.
 106    */
 107   public StockholmFile(AlignmentI al)
 108   {
 109     this.al = al;
 110   }
 111
 112   public StockholmFile(String inFile, DataSourceType type)
 113           throws IOException
 114   {
 115     super(inFile, type);
 116   }
 117
 118   public StockholmFile(FileParse source) throws IOException
 119   {
 120     super(source);
 121   }
 122
 123   @Override
 124   public void initData()
 125   {
 126     super.initData();
 127   }
 128
 129   /**
 130    * Parse a file in Stockholm format into Jalview's data model using VARNA
 131    *
 132    * @throws IOException
 133    *           If there is an error with the input file
 134    */
 135   public void parse_with_VARNA(java.io.File inFile) throws IOException
 136   {
 137     FileReader fr = null;
 138     fr = new FileReader(inFile);
 139
 140     BufferedReader r = new BufferedReader(fr);
 141     List<RNA> result = null;
 142     try
 143     {
 144       result = RNAFactory.loadSecStrStockholm(r);
 145     } catch (ExceptionUnmatchedClosingParentheses umcp)
 146     {
 147       errormessage = "Unmatched parentheses in annotation. Aborting ("
 148               + umcp.getMessage() + ")";
 149       throw new IOException(umcp);
 150     }
 151     // DEBUG System.out.println("this is the secondary scructure:"
 152     // +result.size());
 153     SequenceI[] seqs = new SequenceI[result.size()];
 154     String id = null;
 155     for (int i = 0; i < result.size(); i++)
 156     {
 157       // DEBUG System.err.println("Processing i'th sequence in Stockholm file")
 158       RNA current = result.get(i);
 159
 160       String seq = current.getSeq();
 161       String rna = current.getStructDBN(true);
 162       // DEBUG System.out.println(seq);
 163       // DEBUG System.err.println(rna);
 164       int begin = 0;
 165       int end = seq.length() - 1;
 166       id = safeName(getDataName());
 167       seqs[i] = new Sequence(id, seq, begin, end);
 168       String[] annot = new String[rna.length()];
 169       Annotation[] ann = new Annotation[rna.length()];
 170       for (int j = 0; j < rna.length(); j++)
 171       {
 172         annot[j] = rna.substring(j, j + 1);
 173
 174       }
 175
 176       for (int k = 0; k < rna.length(); k++)
 177       {
 178         ann[k] = new Annotation(annot[k], "",
 179                 Rna.getRNASecStrucState(annot[k]).charAt(0), 0f);
 180
 181       }
 182       AlignmentAnnotation align = new AlignmentAnnotation("Sec. str.",
 183               current.getID(), ann);
 184
 185       seqs[i].addAlignmentAnnotation(align);
 186       seqs[i].setRNA(result.get(i));
 187       this.annotations.addElement(align);
 188     }
 189     this.setSeqs(seqs);
 190
 191   }
 192
 193   /**
 194    * Parse a file in Stockholm format into Jalview's data model. The file has to
 195    * be passed at construction time
 196    *
 197    * @throws IOException
 198    *           If there is an error with the input file
 199    */
 200   @Override
 201   public void parse() throws IOException
 202   {
 203     StringBuffer treeString = new StringBuffer();
 204     String treeName = null;
 205     // --------------- Variable Definitions -------------------
 206     String line;
 207     String version;
 208     // String id;
 209     Hashtable seqAnn = new Hashtable(); // Sequence related annotations
 210     LinkedHashMap<String, String> seqs = new LinkedHashMap<>();
 211     Regex p, r, rend, s, x;
 212     // Temporary line for processing RNA annotation
 213     // String RNAannot = "";
 214
 215     // ------------------ Parsing File ----------------------
 216     // First, we have to check that this file has STOCKHOLM format, i.e. the
 217     // first line must match
 218
 219     r = new Regex("# STOCKHOLM ([\\d\\.]+)");
 220     if (!r.search(nextLine()))
 221     {
 222       throw new IOException(MessageManager
 223               .getString("exception.stockholm_invalid_format"));
 224     }
 225     else
 226     {
 227       version = r.stringMatched(1);
 228
 229       // logger.debug("Stockholm version: " + version);
 230     }
 231
 232     // We define some Regexes here that will be used regularily later
 233     rend = new Regex("^\\s*\\/\\/"); // Find the end of an alignment
 234     p = new Regex("(\\S+)\\/(\\d+)\\-(\\d+)"); // split sequence id in
 235     // id/from/to
 236     s = new Regex("(\\S+)\\s+(\\S*)\\s+(.*)"); // Parses annotation subtype
 237     r = new Regex("#=(G[FSRC]?)\\s+(.*)"); // Finds any annotation line
 238     x = new Regex("(\\S+)\\s+(\\S+)"); // split id from sequence
 239
 240     // Convert all bracket types to parentheses (necessary for passing to VARNA)
 241     Regex openparen = new Regex("(<|\\[)", "(");
 242     Regex closeparen = new Regex("(>|\\])", ")");
 243
 244     // Detect if file is RNA by looking for bracket types
 245     Regex detectbrackets = new Regex("(<|>|\\[|\\]|\\(|\\))");
 246
 247     rend.optimize();
 248     p.optimize();
 249     s.optimize();
 250     r.optimize();
 251     x.optimize();
 252     openparen.optimize();
 253     closeparen.optimize();
 254
 255     while ((line = nextLine()) != null)
 256     {
 257       if (line.length() == 0)
 258       {
 259         continue;
 260       }
 261       if (rend.search(line))
 262       {
 263         // End of the alignment, pass stuff back
 264         this.noSeqs = seqs.size();
 265
 266         String seqdb, dbsource = null;
 267         Regex pf = new Regex("PF[0-9]{5}(.*)"); // Finds AC for Pfam
 268         Regex rf = new Regex("RF[0-9]{5}(.*)"); // Finds AC for Rfam
 269         if (getAlignmentProperty("AC") != null)
 270         {
 271           String dbType = getAlignmentProperty("AC").toString();
 272           if (pf.search(dbType))
 273           {
 274             // PFAM Alignment - so references are typically from Uniprot
 275             dbsource = "PFAM";
 276           }
 277           else if (rf.search(dbType))
 278           {
 279             dbsource = "RFAM";
 280           }
 281         }
 282         // logger.debug("Number of sequences: " + this.noSeqs);
 283         for (Map.Entry<String, String> skey : seqs.entrySet())
 284         {
 285           // logger.debug("Processing sequence " + acc);
 286           String acc = skey.getKey();
 287           String seq = skey.getValue();
 288           if (maxLength < seq.length())
 289           {
 290             maxLength = seq.length();
 291           }
 292           int start = 1;
 293           int end = -1;
 294           String sid = acc;
 295           /*
 296            * Retrieve hash of annotations for this accession Associate
 297            * Annotation with accession
 298            */
 299           Hashtable accAnnotations = null;
 300
 301           if (seqAnn != null && seqAnn.containsKey(acc))
 302           {
 303             accAnnotations = (Hashtable) seqAnn.remove(acc);
 304             // TODO: add structures to sequence
 305           }
 306
 307           // Split accession in id and from/to
 308           if (p.search(acc))
 309           {
 310             sid = p.stringMatched(1);
 311             start = Integer.parseInt(p.stringMatched(2));
 312             end = Integer.parseInt(p.stringMatched(3));
 313           }
 314           // logger.debug(sid + ", " + start + ", " + end);
 315
 316           Sequence seqO = new Sequence(sid, seq, start, end);
 317           // Add Description (if any)
 318           if (accAnnotations != null && accAnnotations.containsKey("DE"))
 319           {
 320             String desc = (String) accAnnotations.get("DE");
 321             seqO.setDescription((desc == null) ? "" : desc);
 322           }
 323           // Add DB References (if any)
 324           if (accAnnotations != null && accAnnotations.containsKey("DR"))
 325           {
 326             String dbr = (String) accAnnotations.get("DR");
 327             if (dbr != null && dbr.indexOf(";") > -1)
 328             {
 329               String src = dbr.substring(0, dbr.indexOf(";"));
 330               String acn = dbr.substring(dbr.indexOf(";") + 1);
 331               jalview.util.DBRefUtils.parseToDbRef(seqO, src, "0", acn);
 332             }
 333           }
 334
 335           if (accAnnotations != null && accAnnotations.containsKey("AC"))
 336           {
 337             if (dbsource != null)
 338             {
 339               String dbr = (String) accAnnotations.get("AC");
 340               if (dbr != null)
 341               {
 342                 // we could get very clever here - but for now - just try to
 343                 // guess accession type from source of alignment plus structure
 344                 // of accession
 345                 guessDatabaseFor(seqO, dbr, dbsource);
 346
 347               }
 348             }
 349             // else - do what ? add the data anyway and prompt the user to
 350             // specify what references these are ?
 351           }
 352
 353           Hashtable features = null;
 354           // We need to adjust the positions of all features to account for gaps
 355           try
 356           {
 357             features = (Hashtable) accAnnotations.remove("features");
 358           } catch (java.lang.NullPointerException e)
 359           {
 360             // loggerwarn("Getting Features for " + acc + ": " +
 361             // e.getMessage());
 362             // continue;
 363           }
 364           // if we have features
 365           if (features != null)
 366           {
 367             int posmap[] = seqO.findPositionMap();
 368             Enumeration i = features.keys();
 369             while (i.hasMoreElements())
 370             {
 371               // TODO: parse out secondary structure annotation as annotation
 372               // row
 373               // TODO: parse out scores as annotation row
 374               // TODO: map coding region to core jalview feature types
 375               String type = i.nextElement().toString();
 376               Hashtable content = (Hashtable) features.remove(type);
 377
 378               // add alignment annotation for this feature
 379               String key = type2id(type);
 380
 381               /*
 382                * have we added annotation rows for this type ?
 383                */
 384               boolean annotsAdded = false;
 385               if (key != null)
 386               {
 387                 if (accAnnotations != null
 388                         && accAnnotations.containsKey(key))
 389                 {
 390                   Vector vv = (Vector) accAnnotations.get(key);
 391                   for (int ii = 0; ii < vv.size(); ii++)
 392                   {
 393                     annotsAdded = true;
 394                     AlignmentAnnotation an = (AlignmentAnnotation) vv
 395                             .elementAt(ii);
 396                     seqO.addAlignmentAnnotation(an);
 397                     annotations.add(an);
 398                   }
 399                 }
 400               }
 401
 402               Enumeration j = content.keys();
 403               while (j.hasMoreElements())
 404               {
 405                 String desc = j.nextElement().toString();
 406                 if (ANNOTATION.equals(desc) && annotsAdded)
 407                 {
 408                   // don't add features if we already added an annotation row
 409                   continue;
 410                 }
 411                 String ns = content.get(desc).toString();
 412                 char[] byChar = ns.toCharArray();
 413                 for (int k = 0; k < byChar.length; k++)
 414                 {
 415                   char c = byChar[k];
 416                   if (!(c == ' ' || c == '_' || c == '-' || c == '.')) // PFAM
 417                   // uses
 418                   // '.'
 419                   // for
 420                   // feature
 421                   // background
 422                   {
 423                     int new_pos = posmap[k]; // look up nearest seqeunce
 424                     // position to this column
 425                     SequenceFeature feat = new SequenceFeature(type, desc,
 426                             new_pos, new_pos, null);
 427
 428                     seqO.addSequenceFeature(feat);
 429                   }
 430                 }
 431               }
 432
 433             }
 434
 435           }
 436           // garbage collect
 437
 438           // logger.debug("Adding seq " + acc + " from " + start + " to " + end
 439           // + ": " + seq);
 440           this.seqs.addElement(seqO);
 441         }
 442         return; // finished parsing this segment of source
 443       }
 444       else if (!r.search(line))
 445       {
 446         // System.err.println("Found sequence line: " + line);
 447
 448         // Split sequence in sequence and accession parts
 449         if (!x.search(line))
 450         {
 451           // logger.error("Could not parse sequence line: " + line);
 452           throw new IOException(MessageManager.formatMessage(
 453                   "exception.couldnt_parse_sequence_line", new String[]
 454                   { line }));
 455         }
 456         String ns = seqs.get(x.stringMatched(1));
 457         if (ns == null)
 458         {
 459           ns = "";
 460         }
 461         ns += x.stringMatched(2);
 462
 463         seqs.put(x.stringMatched(1), ns);
 464       }
 465       else
 466       {
 467         String annType = r.stringMatched(1);
 468         String annContent = r.stringMatched(2);
 469
 470         // System.err.println("type:" + annType + " content: " + annContent);
 471
 472         if (annType.equals("GF"))
 473         {
 474           /*
 475            * Generic per-File annotation, free text Magic features: #=GF NH
 476            * <tree in New Hampshire eXtended format> #=GF TN <Unique identifier
 477            * for the next tree> Pfam descriptions: 7. DESCRIPTION OF FIELDS
 478            *
 479            * Compulsory fields: ------------------
 480            *
 481            * AC Accession number: Accession number in form PFxxxxx.version or
 482            * PBxxxxxx. ID Identification: One word name for family. DE
 483            * Definition: Short description of family. AU Author: Authors of the
 484            * entry. SE Source of seed: The source suggesting the seed members
 485            * belong to one family. GA Gathering method: Search threshold to
 486            * build the full alignment. TC Trusted Cutoff: Lowest sequence score
 487            * and domain score of match in the full alignment. NC Noise Cutoff:
 488            * Highest sequence score and domain score of match not in full
 489            * alignment. TP Type: Type of family -- presently Family, Domain,
 490            * Motif or Repeat. SQ Sequence: Number of sequences in alignment. AM
 491            * Alignment Method The order ls and fs hits are aligned to the model
 492            * to build the full align. // End of alignment.
 493            *
 494            * Optional fields: ----------------
 495            *
 496            * DC Database Comment: Comment about database reference. DR Database
 497            * Reference: Reference to external database. RC Reference Comment:
 498            * Comment about literature reference. RN Reference Number: Reference
 499            * Number. RM Reference Medline: Eight digit medline UI number. RT
 500            * Reference Title: Reference Title. RA Reference Author: Reference
 501            * Author RL Reference Location: Journal location. PI Previous
 502            * identifier: Record of all previous ID lines. KW Keywords: Keywords.
 503            * CC Comment: Comments. NE Pfam accession: Indicates a nested domain.
 504            * NL Location: Location of nested domains - sequence ID, start and
 505            * end of insert.
 506            *
 507            * Obsolete fields: ----------- AL Alignment method of seed: The
 508            * method used to align the seed members.
 509            */
 510           // Let's save the annotations, maybe we'll be able to do something
 511           // with them later...
 512           Regex an = new Regex("(\\w+)\\s*(.*)");
 513           if (an.search(annContent))
 514           {
 515             if (an.stringMatched(1).equals("NH"))
 516             {
 517               treeString.append(an.stringMatched(2));
 518             }
 519             else if (an.stringMatched(1).equals("TN"))
 520             {
 521               if (treeString.length() > 0)
 522               {
 523                 if (treeName == null)
 524                 {
 525                   treeName = "Tree " + (getTreeCount() + 1);
 526                 }
 527                 addNewickTree(treeName, treeString.toString());
 528               }
 529               treeName = an.stringMatched(2);
 530               treeString = new StringBuffer();
 531             }
 532             // TODO: JAL-3532 - this is where GF comments and database references are lost
 533             // suggest overriding this method for Stockholm files to catch and properly
 534             // process CC, DR etc into multivalued properties
 535             setAlignmentProperty(an.stringMatched(1), an.stringMatched(2));
 536           }
 537         }
 538         else if (annType.equals("GS"))
 539         {
 540           // Generic per-Sequence annotation, free text
 541           /*
 542            * Pfam uses these features: Feature Description ---------------------
 543            * ----------- AC <accession> ACcession number DE <freetext>
 544            * DEscription DR <db>; <accession>; Database Reference OS <organism>
 545            * OrganiSm (species) OC <clade> Organism Classification (clade, etc.)
 546            * LO <look> Look (Color, etc.)
 547            */
 548           if (s.search(annContent))
 549           {
 550             String acc = s.stringMatched(1);
 551             String type = s.stringMatched(2);
 552             String content = s.stringMatched(3);
 553             // TODO: store DR in a vector.
 554             // TODO: store AC according to generic file db annotation.
 555             Hashtable ann;
 556             if (seqAnn.containsKey(acc))
 557             {
 558               ann = (Hashtable) seqAnn.get(acc);
 559             }
 560             else
 561             {
 562               ann = new Hashtable();
 563             }
 564             ann.put(type, content);
 565             seqAnn.put(acc, ann);
 566           }
 567           else
 568           {
 569             // throw new IOException("Error parsing " + line);
 570             System.err.println(">> missing annotation: " + line);
 571           }
 572         }
 573         else if (annType.equals("GC"))
 574         {
 575           // Generic per-Column annotation, exactly 1 char per column
 576           // always need a label.
 577           if (x.search(annContent))
 578           {
 579             // parse out and create alignment annotation directly.
 580             parseAnnotationRow(annotations, x.stringMatched(1),
 581                     x.stringMatched(2));
 582           }
 583         }
 584         else if (annType.equals("GR"))
 585         {
 586           // Generic per-Sequence AND per-Column markup, exactly 1 char per
 587           // column
 588           /*
 589            * Feature Description Markup letters ------- -----------
 590            * -------------- SS Secondary Structure [HGIEBTSCX] SA Surface
 591            * Accessibility [0-9X] (0=0%-10%; ...; 9=90%-100%) TM TransMembrane
 592            * [Mio] PP Posterior Probability [0-9*] (0=0.00-0.05; 1=0.05-0.15;
 593            * *=0.95-1.00) LI LIgand binding [*] AS Active Site [*] IN INtron (in
 594            * or after) [0-2]
 595            */
 596           if (s.search(annContent))
 597           {
 598             String acc = s.stringMatched(1);
 599             String type = s.stringMatched(2);
 600             String oseq = s.stringMatched(3);
 601             /*
 602              * copy of annotation field that may be processed into whitespace chunks
 603              */
 604             String seq = new String(oseq);
 605
 606             Hashtable ann;
 607             // Get an object with all the annotations for this sequence
 608             if (seqAnn.containsKey(acc))
 609             {
 610               // logger.debug("Found annotations for " + acc);
 611               ann = (Hashtable) seqAnn.get(acc);
 612             }
 613             else
 614             {
 615               // logger.debug("Creating new annotations holder for " + acc);
 616               ann = new Hashtable();
 617               seqAnn.put(acc, ann);
 618             }
 619
 620             // // start of block for appending annotation lines for wrapped
 621             // stokchholm file
 622             // TODO test structure, call parseAnnotationRow with vector from
 623             // hashtable for specific sequence
 624
 625             Hashtable features;
 626             // Get an object with all the content for an annotation
 627             if (ann.containsKey("features"))
 628             {
 629               // logger.debug("Found features for " + acc);
 630               features = (Hashtable) ann.get("features");
 631             }
 632             else
 633             {
 634               // logger.debug("Creating new features holder for " + acc);
 635               features = new Hashtable();
 636               ann.put("features", features);
 637             }
 638
 639             Hashtable content;
 640             if (features.containsKey(this.id2type(type)))
 641             {
 642               // logger.debug("Found content for " + this.id2type(type));
 643               content = (Hashtable) features.get(this.id2type(type));
 644             }
 645             else
 646             {
 647               // logger.debug("Creating new content holder for " +
 648               // this.id2type(type));
 649               content = new Hashtable();
 650               features.put(this.id2type(type), content);
 651             }
 652             String ns = (String) content.get(ANNOTATION);
 653
 654             if (ns == null)
 655             {
 656               ns = "";
 657             }
 658             // finally, append the annotation line
 659             ns += seq;
 660             content.put(ANNOTATION, ns);
 661             // // end of wrapped annotation block.
 662             // // Now a new row is created with the current set of data
 663
 664             Hashtable strucAnn;
 665             if (seqAnn.containsKey(acc))
 666             {
 667               strucAnn = (Hashtable) seqAnn.get(acc);
 668             }
 669             else
 670             {
 671               strucAnn = new Hashtable();
 672             }
 673
 674             Vector<AlignmentAnnotation> newStruc = new Vector<>();
 675             parseAnnotationRow(newStruc, type, ns);
 676             for (AlignmentAnnotation alan : newStruc)
 677             {
 678               alan.visible = false;
 679             }
 680             // new annotation overwrites any existing annotation...
 681
 682             strucAnn.put(type, newStruc);
 683             seqAnn.put(acc, strucAnn);
 684           }
 685           // }
 686           else
 687           {
 688             System.err.println(
 689                     "Warning - couldn't parse sequence annotation row line:\n"
 690                             + line);
 691             // throw new IOException("Error parsing " + line);
 692           }
 693         }
 694         else
 695         {
 696           throw new IOException(MessageManager.formatMessage(
 697                   "exception.unknown_annotation_detected", new String[]
 698                   { annType, annContent }));
 699         }
 700       }
 701     }
 702     if (treeString.length() > 0)
 703     {
 704       if (treeName == null)
 705       {
 706         treeName = "Tree " + (1 + getTreeCount());
 707       }
 708       addNewickTree(treeName, treeString.toString());
 709     }
 710   }
 711
 712   /**
 713    * Demangle an accession string and guess the originating sequence database
 714    * for a given sequence
 715    *
 716    * @param seqO
 717    *          sequence to be annotated
 718    * @param dbr
 719    *          Accession string for sequence
 720    * @param dbsource
 721    *          source database for alignment (PFAM or RFAM)
 722    */
 723   private void guessDatabaseFor(Sequence seqO, String dbr, String dbsource)
 724   {
 725     DBRefEntry dbrf = null;
 726     List<DBRefEntry> dbrs = new ArrayList<>();
 727     String seqdb = "Unknown", sdbac = "" + dbr;
 728     int st = -1, en = -1, p;
 729     if ((st = sdbac.indexOf("/")) > -1)
 730     {
 731       String num, range = sdbac.substring(st + 1);
 732       sdbac = sdbac.substring(0, st);
 733       if ((p = range.indexOf("-")) > -1)
 734       {
 735         p++;
 736         if (p < range.length())
 737         {
 738           num = range.substring(p).trim();
 739           try
 740           {
 741             en = Integer.parseInt(num);
 742           } catch (NumberFormatException x)
 743           {
 744             // could warn here that index is invalid
 745             en = -1;
 746           }
 747         }
 748       }
 749       else
 750       {
 751         p = range.length();
 752       }
 753       num = range.substring(0, p).trim();
 754       try
 755       {
 756         st = Integer.parseInt(num);
 757       } catch (NumberFormatException x)
 758       {
 759         // could warn here that index is invalid
 760         st = -1;
 761       }
 762     }
 763     if (dbsource.equals("PFAM"))
 764     {
 765       seqdb = "UNIPROT";
 766       if (sdbac.indexOf(".") > -1)
 767       {
 768         // strip of last subdomain
 769         sdbac = sdbac.substring(0, sdbac.indexOf("."));
 770         dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, seqdb, dbsource,
 771                 sdbac);
 772         if (dbrf != null)
 773         {
 774           dbrs.add(dbrf);
 775         }
 776       }
 777       dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, dbsource, dbsource,
 778               dbr);
 779       if (dbr != null)
 780       {
 781         dbrs.add(dbrf);
 782       }
 783     }
 784     else
 785     {
 786       seqdb = "EMBL"; // total guess - could be ENA, or something else these
 787                       // days
 788       if (sdbac.indexOf(".") > -1)
 789       {
 790         // strip off last subdomain
 791         sdbac = sdbac.substring(0, sdbac.indexOf("."));
 792         dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, seqdb, dbsource,
 793                 sdbac);
 794         if (dbrf != null)
 795         {
 796           dbrs.add(dbrf);
 797         }
 798       }
 799
 800       dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, dbsource, dbsource,
 801               dbr);
 802       if (dbrf != null)
 803       {
 804         dbrs.add(dbrf);
 805       }
 806     }
 807     if (st != -1 && en != -1)
 808     {
 809       for (DBRefEntry d : dbrs)
 810       {
 811         jalview.util.MapList mp = new jalview.util.MapList(
 812                 new int[]
 813                 { seqO.getStart(), seqO.getEnd() }, new int[] { st, en }, 1,
 814                 1);
 815         jalview.datamodel.Mapping mping = new Mapping(mp);
 816         d.setMap(mping);
 817       }
 818     }
 819   }
 820
 821   protected static AlignmentAnnotation parseAnnotationRow(
 822           Vector<AlignmentAnnotation> annotation, String label,
 823           String annots)
 824   {
 825     String convert1, convert2 = null;
 826
 827     // convert1 = OPEN_PAREN.replaceAll(annots);
 828     // convert2 = CLOSE_PAREN.replaceAll(convert1);
 829     // annots = convert2;
 830
 831     String type = label;
 832     if (label.contains("_cons"))
 833     {
 834       type = (label.indexOf("_cons") == label.length() - 5)
 835               ? label.substring(0, label.length() - 5)
 836               : label;
 837     }
 838     boolean ss = false, posterior = false;
 839     type = id2type(type);
 840
 841     boolean isrnass = false;
 842     if (type.equalsIgnoreCase("secondary structure"))
 843     {
 844       ss = true;
 845       isrnass = !NOT_RNASS.search(annots); // sorry about the double negative
 846                                            // here (it's easier for dealing with
 847                                            // other non-alpha-non-brace chars)
 848     }
 849     if (type.equalsIgnoreCase("posterior probability"))
 850     {
 851       posterior = true;
 852     }
 853     // decide on secondary structure or not.
 854     Annotation[] els = new Annotation[annots.length()];
 855     for (int i = 0; i < annots.length(); i++)
 856     {
 857       String pos = annots.substring(i, i + 1);
 858       Annotation ann;
 859       ann = new Annotation(pos, "", ' ', 0f); // 0f is 'valid' null - will not
 860       // be written out
 861       if (ss)
 862       {
 863         // if (" .-_".indexOf(pos) == -1)
 864         {
 865           if (isrnass && RNASS_BRACKETS.indexOf(pos) >= 0)
 866           {
 867             ann.secondaryStructure = Rna.getRNASecStrucState(pos).charAt(0);
 868             ann.displayCharacter = "" + pos.charAt(0);
 869           }
 870           else
 871           {
 872             ann.secondaryStructure = ResidueProperties.getDssp3state(pos)
 873                     .charAt(0);
 874
 875             if (ann.secondaryStructure == pos.charAt(0))
 876             {
 877               ann.displayCharacter = ""; // null; // " ";
 878             }
 879             else
 880             {
 881               ann.displayCharacter = " " + ann.displayCharacter;
 882             }
 883           }
 884         }
 885
 886       }
 887       if (posterior && !ann.isWhitespace()
 888               && !Comparison.isGap(pos.charAt(0)))
 889       {
 890         float val = 0;
 891         // symbol encodes values - 0..*==0..10
 892         if (pos.charAt(0) == '*')
 893         {
 894           val = 10;
 895         }
 896         else
 897         {
 898           val = pos.charAt(0) - '0';
 899           if (val > 9)
 900           {
 901             val = 10;
 902           }
 903         }
 904         ann.value = val;
 905       }
 906
 907       els[i] = ann;
 908     }
 909     AlignmentAnnotation annot = null;
 910     Enumeration<AlignmentAnnotation> e = annotation.elements();
 911     while (e.hasMoreElements())
 912     {
 913       annot = e.nextElement();
 914       if (annot.label.equals(type))
 915       {
 916         break;
 917       }
 918       annot = null;
 919     }
 920     if (annot == null)
 921     {
 922       annot = new AlignmentAnnotation(type, type, els);
 923       annotation.addElement(annot);
 924     }
 925     else
 926     {
 927       Annotation[] anns = new Annotation[annot.annotations.length
 928               + els.length];
 929       System.arraycopy(annot.annotations, 0, anns, 0,
 930               annot.annotations.length);
 931       System.arraycopy(els, 0, anns, annot.annotations.length, els.length);
 932       annot.annotations = anns;
 933       // System.out.println("else: ");
 934     }
 935     return annot;
 936   }
 937
 938   private String dbref_to_ac_record(DBRefEntry ref)
 939   {
 940     return ref.getSource().toString() + " ; "
 941             + ref.getAccessionId().toString();
 942   }
 943   @Override
 944   public String print(SequenceI[] s, boolean jvSuffix)
 945   {
 946     out = new StringBuffer();
 947     out.append("# STOCKHOLM 1.0");
 948     out.append(newline);
 949
 950     // find max length of id
 951     int max = 0;
 952     int maxid = 0;
 953     int in = 0;
 954     Hashtable dataRef = null;
 955     while ((in < s.length) && (s[in] != null))
 956     {
 957       boolean isAA = s[in].isProtein();
 958       String tmp = printId(s[in], jvSuffix);
 959       max = Math.max(max, s[in].getLength());
 960
 961       if (tmp.length() > maxid)
 962       {
 963         maxid = tmp.length();
 964       }
 965       if (s[in].getDBRefs() != null)
 966       {
 967         if (dataRef == null)
 968         {
 969           dataRef = new Hashtable();
 970         }
 971         List<DBRefEntry> primrefs = s[in].getPrimaryDBRefs();
 972         if (primrefs.size() >= 1)
 973         {
 974           dataRef.put(tmp, dbref_to_ac_record(primrefs.get(0)));
 975         }
 976         else
 977         {
 978           for (int idb = 0; idb < s[in].getDBRefs().length; idb++)
 979           {
 980             DBRefEntry dbref = s[in].getDBRefs()[idb];
 981             dataRef.put(tmp, dbref_to_ac_record(dbref));
 982             // if we put in a uniprot or EMBL record then we're done:
 983             if (isAA && DBRefSource.UNIPROT
 984                     .equals(DBRefUtils.getCanonicalName(dbref.getSource())))
 985             {
 986               break;
 987             }
 988             if (!isAA && DBRefSource.EMBL
 989                     .equals(DBRefUtils.getCanonicalName(dbref.getSource())))
 990             {
 991               break;
 992             }
 993           }
 994         }
 995       }
 996       in++;
 997     }
 998     maxid += 9;
 999     int i = 0;
1000
1001     // output database type
1002     if (al.getProperties() != null)
1003     {
1004       if (!al.getProperties().isEmpty())
1005       {
1006         Enumeration key = al.getProperties().keys();
1007         Enumeration val = al.getProperties().elements();
1008         while (key.hasMoreElements())
1009         {
1010           out.append("#=GF " + key.nextElement() + " " + val.nextElement());
1011           out.append(newline);
1012         }
1013       }
1014     }
1015
1016     // output database accessions
1017     if (dataRef != null)
1018     {
1019       Enumeration en = dataRef.keys();
1020       while (en.hasMoreElements())
1021       {
1022         Object idd = en.nextElement();
1023         String type = (String) dataRef.remove(idd);
1024         out.append(new Format("%-" + (maxid - 2) + "s")
1025                 .form("#=GS " + idd.toString() + " "));
1026         if (type.contains("PFAM") || type.contains("RFAM"))
1027         {
1028
1029           out.append(" AC " + type.substring(type.indexOf(";") + 1));
1030         }
1031         else
1032         {
1033           out.append(" DR " + type + " ");
1034         }
1035         out.append(newline);
1036       }
1037     }
1038
1039     // output annotations
1040     while (i < s.length && s[i] != null)
1041     {
1042       AlignmentAnnotation[] alAnot = s[i].getAnnotation();
1043       if (alAnot != null)
1044       {
1045         Annotation[] ann;
1046         for (int j = 0; j < alAnot.length; j++)
1047         {
1048
1049           String key = type2id(alAnot[j].label);
1050           boolean isrna = alAnot[j].isValidStruc();
1051
1052           if (isrna)
1053           {
1054             // hardwire to secondary structure if there is RNA secondary
1055             // structure on the annotation
1056             key = "SS";
1057           }
1058           if (key == null)
1059           {
1060
1061             continue;
1062           }
1063
1064           // out.append("#=GR ");
1065           out.append(new Format("%-" + maxid + "s").form(
1066                   "#=GR " + printId(s[i], jvSuffix) + " " + key + " "));
1067           ann = alAnot[j].annotations;
1068           String seq = "";
1069           for (int k = 0; k < ann.length; k++)
1070           {
1071             seq += outputCharacter(key, k, isrna, ann, s[i]);
1072           }
1073           out.append(seq);
1074           out.append(newline);
1075         }
1076       }
1077
1078       out.append(new Format("%-" + maxid + "s")
1079               .form(printId(s[i], jvSuffix) + " "));
1080       out.append(s[i].getSequenceAsString());
1081       out.append(newline);
1082       i++;
1083     }
1084
1085     // alignment annotation
1086     AlignmentAnnotation aa;
1087     if (al.getAlignmentAnnotation() != null)
1088     {
1089       for (int ia = 0; ia < al.getAlignmentAnnotation().length; ia++)
1090       {
1091         aa = al.getAlignmentAnnotation()[ia];
1092         if (aa.autoCalculated || !aa.visible || aa.sequenceRef != null)
1093         {
1094           continue;
1095         }
1096         String seq = "";
1097         String label;
1098         String key = "";
1099         if (aa.label.equals("seq"))
1100         {
1101           label = "seq_cons";
1102         }
1103         else
1104         {
1105           key = type2id(aa.label.toLowerCase());
1106           if (key == null)
1107           {
1108             label = aa.label;
1109           }
1110           else
1111           {
1112             label = key + "_cons";
1113           }
1114         }
1115         if (label == null)
1116         {
1117           label = aa.label;
1118         }
1119         label = label.replace(" ", "_");
1120
1121         out.append(
1122                 new Format("%-" + maxid + "s").form("#=GC " + label + " "));
1123         boolean isrna = aa.isValidStruc();
1124         for (int j = 0; j < aa.annotations.length; j++)
1125         {
1126           seq += outputCharacter(key, j, isrna, aa.annotations, null);
1127         }
1128         out.append(seq);
1129         out.append(newline);
1130       }
1131     }
1132
1133     out.append("//");
1134     out.append(newline);
1135
1136     return out.toString();
1137   }
1138
1139   /**
1140    * add an annotation character to the output row
1141    *
1142    * @param seq
1143    * @param key
1144    * @param k
1145    * @param isrna
1146    * @param ann
1147    * @param sequenceI
1148    */
1149   private char outputCharacter(String key, int k, boolean isrna,
1150           Annotation[] ann, SequenceI sequenceI)
1151   {
1152     char seq = ' ';
1153     Annotation annot = ann[k];
1154     String ch = (annot == null)
1155             ? ((sequenceI == null) ? "-"
1156                     : Character.toString(sequenceI.getCharAt(k)))
1157             : (annot.displayCharacter == null
1158                     ? String.valueOf(annot.secondaryStructure)
1159                     : annot.displayCharacter);
1160     if (ch == null)
1161     {
1162       ch = " ";
1163     }
1164     if (key != null && key.equals("SS"))
1165     {
1166       char ssannotchar = ' ';
1167       boolean charset = false;
1168       if (annot == null)
1169       {
1170         // sensible gap character
1171         ssannotchar = ' ';
1172         charset = true;
1173       }
1174       else
1175       {
1176         // valid secondary structure AND no alternative label (e.g. ' B')
1177         if (annot.secondaryStructure > ' ' && ch.length() < 2)
1178         {
1179           ssannotchar = annot.secondaryStructure;
1180           charset = true;
1181         }
1182       }
1183       if (charset)
1184       {
1185         return (ssannotchar == ' ' && isrna) ? '.' : ssannotchar;
1186       }
1187     }
1188
1189     if (ch.length() == 0)
1190     {
1191       seq = '.';
1192     }
1193     else if (ch.length() == 1)
1194     {
1195       seq = ch.charAt(0);
1196     }
1197     else if (ch.length() > 1)
1198     {
1199       seq = ch.charAt(1);
1200     }
1201
1202     return (seq == ' ' && key != null && key.equals("SS") && isrna) ? '.'
1203             : seq;
1204   }
1205
1206   public String print()
1207   {
1208     out = new StringBuffer();
1209     out.append("# STOCKHOLM 1.0");
1210     out.append(newline);
1211     print(getSeqsAsArray(), false);
1212
1213     out.append("//");
1214     out.append(newline);
1215     return out.toString();
1216   }
1217
1218   private static Hashtable typeIds = null;
1219
1220   static
1221   {
1222     if (typeIds == null)
1223     {
1224       typeIds = new Hashtable();
1225       typeIds.put("SS", "Secondary Structure");
1226       typeIds.put("SA", "Surface Accessibility");
1227       typeIds.put("TM", "transmembrane");
1228       typeIds.put("PP", "Posterior Probability");
1229       typeIds.put("LI", "ligand binding");
1230       typeIds.put("AS", "active site");
1231       typeIds.put("IN", "intron");
1232       typeIds.put("IR", "interacting residue");
1233       typeIds.put("AC", "accession");
1234       typeIds.put("OS", "organism");
1235       typeIds.put("CL", "class");
1236       typeIds.put("DE", "description");
1237       typeIds.put("DR", "reference");
1238       typeIds.put("LO", "look");
1239       typeIds.put("RF", "Reference Positions");
1240
1241     }
1242   }
1243
1244   protected static String id2type(String id)
1245   {
1246     if (typeIds.containsKey(id))
1247     {
1248       return (String) typeIds.get(id);
1249     }
1250     System.err.println(
1251             "Warning : Unknown Stockholm annotation type code " + id);
1252     return id;
1253   }
1254
1255   protected static String type2id(String type)
1256   {
1257     String key = null;
1258     Enumeration e = typeIds.keys();
1259     while (e.hasMoreElements())
1260     {
1261       Object ll = e.nextElement();
1262       if (typeIds.get(ll).toString().equalsIgnoreCase(type))
1263       {
1264         key = (String) ll;
1265         break;
1266       }
1267     }
1268     if (key != null)
1269     {
1270       return key;
1271     }
1272     System.err.println(
1273             "Warning : Unknown Stockholm annotation type: " + type);
1274     return key;
1275   }
1276
1277   /**
1278    * make a friendly ID string.
1279    *
1280    * @param dataName
1281    * @return truncated dataName to after last '/'
1282    */
1283   private String safeName(String dataName)
1284   {
1285     int b = 0;
1286     while ((b = dataName.indexOf("/")) > -1 && b < dataName.length())
1287     {
1288       dataName = dataName.substring(b + 1).trim();
1289
1290     }
1291     int e = (dataName.length() - dataName.indexOf(".")) + 1;
1292     dataName = dataName.substring(1, e).trim();
1293     return dataName;
1294   }
1295 }