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