2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
22 * This extension was written by Benjamin Schuster-Boeckler at sanger.ac.uk
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;
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;
48 import java.util.StringTokenizer;
49 import java.util.Vector;
51 import com.stevesoft.pat.Regex;
53 import fr.orsay.lri.varna.exceptions.ExceptionUnmatchedClosingParentheses;
54 import fr.orsay.lri.varna.factories.RNAFactory;
55 import fr.orsay.lri.varna.models.rna.RNA;
57 // import org.apache.log4j.*;
60 * This class is supposed to parse a Stockholm format file into Jalview There
61 * are TODOs in this class: we do not know what the database source and version
62 * is for the file when parsing the #GS= AC tag which associates accessions with
63 * sequences. Database references are also not parsed correctly: a separate
64 * reference string parser must be added to parse the database reference form
65 * into Jalview's local representation.
67 * @author bsb at sanger.ac.uk
68 * @author Natasha Shersnev (Dundee, UK) (Stockholm file writer)
69 * @author Lauren Lui (UCSC, USA) (RNA secondary structure annotation import as
71 * @author Anne Menard (Paris, FR) (VARNA parsing of Stockholm file data)
72 * @version 0.3 + jalview mods
75 public class StockholmFile extends AlignFile
77 private static final Regex OPEN_PAREN = new Regex("(<|\\[)", "(");
79 private static final Regex CLOSE_PAREN = new Regex("(>|\\])", ")");
81 private static final Regex DETECT_BRACKETS = new Regex(
82 "(<|>|\\[|\\]|\\(|\\))");
84 StringBuffer out; // output buffer
88 public StockholmFile()
93 * Creates a new StockholmFile object for output.
95 public StockholmFile(AlignmentI al)
100 public StockholmFile(String inFile, DataSourceType type)
106 public StockholmFile(FileParse source) throws IOException
112 public void initData()
118 * Parse a file in Stockholm format into Jalview's data model using VARNA
120 * @throws IOException
121 * If there is an error with the input file
123 public void parse_with_VARNA(java.io.File inFile) throws IOException
125 FileReader fr = null;
126 fr = new FileReader(inFile);
128 BufferedReader r = new BufferedReader(fr);
129 List<RNA> result = null;
132 result = RNAFactory.loadSecStrStockholm(r);
133 } catch (ExceptionUnmatchedClosingParentheses umcp)
135 errormessage = "Unmatched parentheses in annotation. Aborting ("
136 + umcp.getMessage() + ")";
137 throw new IOException(umcp);
139 // DEBUG System.out.println("this is the secondary scructure:"
141 SequenceI[] seqs = new SequenceI[result.size()];
143 for (int i = 0; i < result.size(); i++)
145 // DEBUG System.err.println("Processing i'th sequence in Stockholm file")
146 RNA current = result.get(i);
148 String seq = current.getSeq();
149 String rna = current.getStructDBN(true);
150 // DEBUG System.out.println(seq);
151 // DEBUG System.err.println(rna);
153 int end = seq.length() - 1;
154 id = safeName(getDataName());
155 seqs[i] = new Sequence(id, seq, begin, end);
156 String[] annot = new String[rna.length()];
157 Annotation[] ann = new Annotation[rna.length()];
158 for (int j = 0; j < rna.length(); j++)
160 annot[j] = rna.substring(j, j + 1);
164 for (int k = 0; k < rna.length(); k++)
166 ann[k] = new Annotation(annot[k], "", Rna.getRNASecStrucState(
167 annot[k]).charAt(0), 0f);
170 AlignmentAnnotation align = new AlignmentAnnotation("Sec. str.",
171 current.getID(), ann);
173 seqs[i].addAlignmentAnnotation(align);
174 seqs[i].setRNA(result.get(i));
175 this.annotations.addElement(align);
182 * Parse a file in Stockholm format into Jalview's data model. The file has to
183 * be passed at construction time
185 * @throws IOException
186 * If there is an error with the input file
189 public void parse() throws IOException
191 StringBuffer treeString = new StringBuffer();
192 String treeName = null;
193 // --------------- Variable Definitions -------------------
197 Hashtable seqAnn = new Hashtable(); // Sequence related annotations
198 LinkedHashMap<String, String> seqs = new LinkedHashMap<String, String>();
199 Regex p, r, rend, s, x;
200 // Temporary line for processing RNA annotation
201 // String RNAannot = "";
203 // ------------------ Parsing File ----------------------
204 // First, we have to check that this file has STOCKHOLM format, i.e. the
205 // first line must match
207 r = new Regex("# STOCKHOLM ([\\d\\.]+)");
208 if (!r.search(nextLine()))
210 throw new IOException(
212 .getString("exception.stockholm_invalid_format"));
216 version = r.stringMatched(1);
218 // logger.debug("Stockholm version: " + version);
221 // We define some Regexes here that will be used regularily later
222 rend = new Regex("^\\s*\\/\\/"); // Find the end of an alignment
223 p = new Regex("(\\S+)\\/(\\d+)\\-(\\d+)"); // split sequence id in
225 s = new Regex("(\\S+)\\s+(\\S*)\\s+(.*)"); // Parses annotation subtype
226 r = new Regex("#=(G[FSRC]?)\\s+(.*)"); // Finds any annotation line
227 x = new Regex("(\\S+)\\s+(\\S+)"); // split id from sequence
229 // Convert all bracket types to parentheses (necessary for passing to VARNA)
230 Regex openparen = new Regex("(<|\\[)", "(");
231 Regex closeparen = new Regex("(>|\\])", ")");
233 // Detect if file is RNA by looking for bracket types
234 Regex detectbrackets = new Regex("(<|>|\\[|\\]|\\(|\\))");
241 openparen.optimize();
242 closeparen.optimize();
244 while ((line = nextLine()) != null)
246 if (line.length() == 0)
250 if (rend.search(line))
252 // End of the alignment, pass stuff back
253 this.noSeqs = seqs.size();
255 String seqdb, dbsource = null;
256 Regex pf = new Regex("PF[0-9]{5}(.*)"); // Finds AC for Pfam
257 Regex rf = new Regex("RF[0-9]{5}(.*)"); // Finds AC for Rfam
258 if (getAlignmentProperty("AC") != null)
260 String dbType = getAlignmentProperty("AC").toString();
261 if (pf.search(dbType))
263 // PFAM Alignment - so references are typically from Uniprot
266 else if (rf.search(dbType))
271 // logger.debug("Number of sequences: " + this.noSeqs);
272 for (Map.Entry<String, String> skey : seqs.entrySet())
274 // logger.debug("Processing sequence " + acc);
275 String acc = skey.getKey();
276 String seq = skey.getValue();
277 if (maxLength < seq.length())
279 maxLength = seq.length();
285 * Retrieve hash of annotations for this accession Associate
286 * Annotation with accession
288 Hashtable accAnnotations = null;
290 if (seqAnn != null && seqAnn.containsKey(acc))
292 accAnnotations = (Hashtable) seqAnn.remove(acc);
293 // TODO: add structures to sequence
296 // Split accession in id and from/to
299 sid = p.stringMatched(1);
300 start = Integer.parseInt(p.stringMatched(2));
301 end = Integer.parseInt(p.stringMatched(3));
303 // logger.debug(sid + ", " + start + ", " + end);
305 Sequence seqO = new Sequence(sid, seq, start, end);
306 // Add Description (if any)
307 if (accAnnotations != null && accAnnotations.containsKey("DE"))
309 String desc = (String) accAnnotations.get("DE");
310 seqO.setDescription((desc == null) ? "" : desc);
312 // Add DB References (if any)
313 if (accAnnotations != null && accAnnotations.containsKey("DR"))
315 String dbr = (String) accAnnotations.get("DR");
316 if (dbr != null && dbr.indexOf(";") > -1)
318 String src = dbr.substring(0, dbr.indexOf(";"));
319 String acn = dbr.substring(dbr.indexOf(";") + 1);
320 jalview.util.DBRefUtils.parseToDbRef(seqO, src, "0", acn);
324 if (accAnnotations != null && accAnnotations.containsKey("AC"))
326 if (dbsource != null)
328 String dbr = (String) accAnnotations.get("AC");
331 // we could get very clever here - but for now - just try to
332 // guess accession type from source of alignment plus structure
334 guessDatabaseFor(seqO, dbr, dbsource);
338 // else - do what ? add the data anyway and prompt the user to
339 // specify what references these are ?
342 Hashtable features = null;
343 // We need to adjust the positions of all features to account for gaps
346 features = (Hashtable) accAnnotations.remove("features");
347 } catch (java.lang.NullPointerException e)
349 // loggerwarn("Getting Features for " + acc + ": " +
353 // if we have features
354 if (features != null)
356 int posmap[] = seqO.findPositionMap();
357 Enumeration i = features.keys();
358 while (i.hasMoreElements())
360 // TODO: parse out secondary structure annotation as annotation
362 // TODO: parse out scores as annotation row
363 // TODO: map coding region to core jalview feature types
364 String type = i.nextElement().toString();
365 Hashtable content = (Hashtable) features.remove(type);
367 // add alignment annotation for this feature
368 String key = type2id(type);
371 if (accAnnotations != null
372 && accAnnotations.containsKey(key))
374 Vector vv = (Vector) accAnnotations.get(key);
375 for (int ii = 0; ii < vv.size(); ii++)
377 AlignmentAnnotation an = (AlignmentAnnotation) vv
379 seqO.addAlignmentAnnotation(an);
385 Enumeration j = content.keys();
386 while (j.hasMoreElements())
388 String desc = j.nextElement().toString();
389 String ns = content.get(desc).toString();
390 char[] byChar = ns.toCharArray();
391 for (int k = 0; k < byChar.length; k++)
394 if (!(c == ' ' || c == '_' || c == '-' || c == '.')) // PFAM
401 int new_pos = posmap[k]; // look up nearest seqeunce
402 // position to this column
403 SequenceFeature feat = new SequenceFeature(type, desc,
404 new_pos, new_pos, 0f, null);
406 seqO.addSequenceFeature(feat);
416 // logger.debug("Adding seq " + acc + " from " + start + " to " + end
418 this.seqs.addElement(seqO);
420 return; // finished parsing this segment of source
422 else if (!r.search(line))
424 // System.err.println("Found sequence line: " + line);
426 // Split sequence in sequence and accession parts
429 // logger.error("Could not parse sequence line: " + line);
430 throw new IOException(MessageManager.formatMessage(
431 "exception.couldnt_parse_sequence_line",
432 new String[] { line }));
434 String ns = seqs.get(x.stringMatched(1));
439 ns += x.stringMatched(2);
441 seqs.put(x.stringMatched(1), ns);
445 String annType = r.stringMatched(1);
446 String annContent = r.stringMatched(2);
448 // System.err.println("type:" + annType + " content: " + annContent);
450 if (annType.equals("GF"))
453 * Generic per-File annotation, free text Magic features: #=GF NH
454 * <tree in New Hampshire eXtended format> #=GF TN <Unique identifier
455 * for the next tree> Pfam descriptions: 7. DESCRIPTION OF FIELDS
457 * Compulsory fields: ------------------
459 * AC Accession number: Accession number in form PFxxxxx.version or
460 * PBxxxxxx. ID Identification: One word name for family. DE
461 * Definition: Short description of family. AU Author: Authors of the
462 * entry. SE Source of seed: The source suggesting the seed members
463 * belong to one family. GA Gathering method: Search threshold to
464 * build the full alignment. TC Trusted Cutoff: Lowest sequence score
465 * and domain score of match in the full alignment. NC Noise Cutoff:
466 * Highest sequence score and domain score of match not in full
467 * alignment. TP Type: Type of family -- presently Family, Domain,
468 * Motif or Repeat. SQ Sequence: Number of sequences in alignment. AM
469 * Alignment Method The order ls and fs hits are aligned to the model
470 * to build the full align. // End of alignment.
472 * Optional fields: ----------------
474 * DC Database Comment: Comment about database reference. DR Database
475 * Reference: Reference to external database. RC Reference Comment:
476 * Comment about literature reference. RN Reference Number: Reference
477 * Number. RM Reference Medline: Eight digit medline UI number. RT
478 * Reference Title: Reference Title. RA Reference Author: Reference
479 * Author RL Reference Location: Journal location. PI Previous
480 * identifier: Record of all previous ID lines. KW Keywords: Keywords.
481 * CC Comment: Comments. NE Pfam accession: Indicates a nested domain.
482 * NL Location: Location of nested domains - sequence ID, start and
485 * Obsolete fields: ----------- AL Alignment method of seed: The
486 * method used to align the seed members.
488 // Let's save the annotations, maybe we'll be able to do something
489 // with them later...
490 Regex an = new Regex("(\\w+)\\s*(.*)");
491 if (an.search(annContent))
493 if (an.stringMatched(1).equals("NH"))
495 treeString.append(an.stringMatched(2));
497 else if (an.stringMatched(1).equals("TN"))
499 if (treeString.length() > 0)
501 if (treeName == null)
503 treeName = "Tree " + (getTreeCount() + 1);
505 addNewickTree(treeName, treeString.toString());
507 treeName = an.stringMatched(2);
508 treeString = new StringBuffer();
510 setAlignmentProperty(an.stringMatched(1), an.stringMatched(2));
513 else if (annType.equals("GS"))
515 // Generic per-Sequence annotation, free text
517 * Pfam uses these features: Feature Description ---------------------
518 * ----------- AC <accession> ACcession number DE <freetext>
519 * DEscription DR <db>; <accession>; Database Reference OS <organism>
520 * OrganiSm (species) OC <clade> Organism Classification (clade, etc.)
521 * LO <look> Look (Color, etc.)
523 if (s.search(annContent))
525 String acc = s.stringMatched(1);
526 String type = s.stringMatched(2);
527 String content = s.stringMatched(3);
528 // TODO: store DR in a vector.
529 // TODO: store AC according to generic file db annotation.
531 if (seqAnn.containsKey(acc))
533 ann = (Hashtable) seqAnn.get(acc);
537 ann = new Hashtable();
539 ann.put(type, content);
540 seqAnn.put(acc, ann);
544 // throw new IOException("Error parsing " + line);
545 System.err.println(">> missing annotation: " + line);
548 else if (annType.equals("GC"))
550 // Generic per-Column annotation, exactly 1 char per column
551 // always need a label.
552 if (x.search(annContent))
554 // parse out and create alignment annotation directly.
555 parseAnnotationRow(annotations, x.stringMatched(1),
559 else if (annType.equals("GR"))
561 // Generic per-Sequence AND per-Column markup, exactly 1 char per
564 * Feature Description Markup letters ------- -----------
565 * -------------- SS Secondary Structure [HGIEBTSCX] SA Surface
566 * Accessibility [0-9X] (0=0%-10%; ...; 9=90%-100%) TM TransMembrane
567 * [Mio] PP Posterior Probability [0-9*] (0=0.00-0.05; 1=0.05-0.15;
568 * *=0.95-1.00) LI LIgand binding [*] AS Active Site [*] IN INtron (in
571 if (s.search(annContent))
573 String acc = s.stringMatched(1);
574 String type = s.stringMatched(2);
575 String seq = new String(s.stringMatched(3));
576 String description = null;
577 // Check for additional information about the current annotation
578 // We use a simple string tokenizer here for speed
579 StringTokenizer sep = new StringTokenizer(seq, " \t");
580 description = sep.nextToken();
581 if (sep.hasMoreTokens())
583 seq = sep.nextToken();
588 description = new String();
590 // sequence id with from-to fields
593 // Get an object with all the annotations for this sequence
594 if (seqAnn.containsKey(acc))
596 // logger.debug("Found annotations for " + acc);
597 ann = (Hashtable) seqAnn.get(acc);
601 // logger.debug("Creating new annotations holder for " + acc);
602 ann = new Hashtable();
603 seqAnn.put(acc, ann);
605 // TODO test structure, call parseAnnotationRow with vector from
606 // hashtable for specific sequence
608 // Get an object with all the content for an annotation
609 if (ann.containsKey("features"))
611 // logger.debug("Found features for " + acc);
612 features = (Hashtable) ann.get("features");
616 // logger.debug("Creating new features holder for " + acc);
617 features = new Hashtable();
618 ann.put("features", features);
622 if (features.containsKey(this.id2type(type)))
624 // logger.debug("Found content for " + this.id2type(type));
625 content = (Hashtable) features.get(this.id2type(type));
629 // logger.debug("Creating new content holder for " +
630 // this.id2type(type));
631 content = new Hashtable();
632 features.put(this.id2type(type), content);
634 String ns = (String) content.get(description);
640 content.put(description, ns);
642 // if(type.equals("SS")){
644 if (seqAnn.containsKey(acc))
646 strucAnn = (Hashtable) seqAnn.get(acc);
650 strucAnn = new Hashtable();
653 Vector<AlignmentAnnotation> newStruc = new Vector<AlignmentAnnotation>();
654 parseAnnotationRow(newStruc, type, ns);
655 for (AlignmentAnnotation alan : newStruc)
657 alan.visible = false;
659 // annotations.addAll(newStruc);
660 strucAnn.put(type, newStruc);
661 seqAnn.put(acc, strucAnn);
667 .println("Warning - couldn't parse sequence annotation row line:\n"
669 // throw new IOException("Error parsing " + line);
674 throw new IOException(MessageManager.formatMessage(
675 "exception.unknown_annotation_detected", new String[] {
676 annType, annContent }));
680 if (treeString.length() > 0)
682 if (treeName == null)
684 treeName = "Tree " + (1 + getTreeCount());
686 addNewickTree(treeName, treeString.toString());
691 * Demangle an accession string and guess the originating sequence database
692 * for a given sequence
695 * sequence to be annotated
697 * Accession string for sequence
699 * source database for alignment (PFAM or RFAM)
701 private void guessDatabaseFor(Sequence seqO, String dbr, String dbsource)
703 DBRefEntry dbrf = null;
704 List<DBRefEntry> dbrs = new ArrayList<DBRefEntry>();
705 String seqdb = "Unknown", sdbac = "" + dbr;
706 int st = -1, en = -1, p;
707 if ((st = sdbac.indexOf("/")) > -1)
709 String num, range = sdbac.substring(st + 1);
710 sdbac = sdbac.substring(0, st);
711 if ((p = range.indexOf("-")) > -1)
714 if (p < range.length())
716 num = range.substring(p).trim();
719 en = Integer.parseInt(num);
720 } catch (NumberFormatException x)
722 // could warn here that index is invalid
731 num = range.substring(0, p).trim();
734 st = Integer.parseInt(num);
735 } catch (NumberFormatException x)
737 // could warn here that index is invalid
741 if (dbsource.equals("PFAM"))
744 if (sdbac.indexOf(".") > -1)
746 // strip of last subdomain
747 sdbac = sdbac.substring(0, sdbac.indexOf("."));
748 dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, seqdb, dbsource,
755 dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, dbsource, dbsource,
764 seqdb = "EMBL"; // total guess - could be ENA, or something else these
766 if (sdbac.indexOf(".") > -1)
768 // strip off last subdomain
769 sdbac = sdbac.substring(0, sdbac.indexOf("."));
770 dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, seqdb, dbsource,
778 dbrf = jalview.util.DBRefUtils.parseToDbRef(seqO, dbsource, dbsource,
785 if (st != -1 && en != -1)
787 for (DBRefEntry d : dbrs)
789 jalview.util.MapList mp = new jalview.util.MapList(new int[] {
790 seqO.getStart(), seqO.getEnd() }, new int[] { st, en }, 1, 1);
791 jalview.datamodel.Mapping mping = new Mapping(mp);
797 protected static AlignmentAnnotation parseAnnotationRow(
798 Vector<AlignmentAnnotation> annotation, String label,
801 String convert1, convert2 = null;
803 convert1 = OPEN_PAREN.replaceAll(annots);
804 convert2 = CLOSE_PAREN.replaceAll(convert1);
808 if (label.contains("_cons"))
810 type = (label.indexOf("_cons") == label.length() - 5) ? label
811 .substring(0, label.length() - 5) : label;
814 type = id2type(type);
815 if (type.equals("secondary structure"))
819 // decide on secondary structure or not.
820 Annotation[] els = new Annotation[annots.length()];
821 for (int i = 0; i < annots.length(); i++)
823 String pos = annots.substring(i, i + 1);
825 ann = new Annotation(pos, "", ' ', 0f); // 0f is 'valid' null - will not
829 // if (" .-_".indexOf(pos) == -1)
831 if (DETECT_BRACKETS.search(pos))
833 ann.secondaryStructure = Rna.getRNASecStrucState(pos).charAt(0);
837 ann.secondaryStructure = ResidueProperties.getDssp3state(pos)
841 if (ann.secondaryStructure == pos.charAt(0))
843 ann.displayCharacter = ""; // null; // " ";
847 ann.displayCharacter = " " + ann.displayCharacter;
855 AlignmentAnnotation annot = null;
856 Enumeration<AlignmentAnnotation> e = annotation.elements();
857 while (e.hasMoreElements())
859 annot = e.nextElement();
860 if (annot.label.equals(type))
868 annot = new AlignmentAnnotation(type, type, els);
869 annotation.addElement(annot);
873 Annotation[] anns = new Annotation[annot.annotations.length
875 System.arraycopy(annot.annotations, 0, anns, 0,
876 annot.annotations.length);
877 System.arraycopy(els, 0, anns, annot.annotations.length, els.length);
878 annot.annotations = anns;
879 // System.out.println("else: ");
885 public String print(SequenceI[] s, boolean jvSuffix)
887 out = new StringBuffer();
888 out.append("# STOCKHOLM 1.0");
891 // find max length of id
895 Hashtable dataRef = null;
896 while ((in < s.length) && (s[in] != null))
898 String tmp = printId(s[in], jvSuffix);
899 if (s[in].getSequence().length > max)
901 max = s[in].getSequence().length;
904 if (tmp.length() > maxid)
906 maxid = tmp.length();
908 if (s[in].getDBRefs() != null)
910 for (int idb = 0; idb < s[in].getDBRefs().length; idb++)
914 dataRef = new Hashtable();
917 String datAs1 = s[in].getDBRefs()[idb].getSource().toString()
919 + s[in].getDBRefs()[idb].getAccessionId().toString();
920 dataRef.put(tmp, datAs1);
928 // output database type
929 if (al.getProperties() != null)
931 if (!al.getProperties().isEmpty())
933 Enumeration key = al.getProperties().keys();
934 Enumeration val = al.getProperties().elements();
935 while (key.hasMoreElements())
937 out.append("#=GF " + key.nextElement() + " " + val.nextElement());
943 // output database accessions
946 Enumeration en = dataRef.keys();
947 while (en.hasMoreElements())
949 Object idd = en.nextElement();
950 String type = (String) dataRef.remove(idd);
951 out.append(new Format("%-" + (maxid - 2) + "s").form("#=GS "
952 + idd.toString() + " "));
953 if (type.contains("PFAM") || type.contains("RFAM"))
956 out.append(" AC " + type.substring(type.indexOf(";") + 1));
960 out.append(" DR " + type + " ");
966 // output annotations
967 while (i < s.length && s[i] != null)
969 if (s[i].getDatasetSequence() != null)
971 SequenceI ds = s[i].getDatasetSequence();
972 AlignmentAnnotation[] alAnot;
975 alAnot = s[i].getAnnotation();
979 for (int j = 0; j < alAnot.length; j++)
981 if (ds.getSequenceFeatures() != null)
983 feature = ds.getSequenceFeatures()[0].type;
985 // ?bug - feature may still have previous loop value
986 String key = type2id(feature);
993 // out.append("#=GR ");
994 out.append(new Format("%-" + maxid + "s").form("#=GR "
995 + printId(s[i], jvSuffix) + " " + key + " "));
996 ann = alAnot[j].annotations;
997 boolean isrna = alAnot[j].isValidStruc();
999 for (int k = 0; k < ann.length; k++)
1001 seq += outputCharacter(key, k, isrna, ann, s[i]);
1004 out.append(newline);
1009 out.append(new Format("%-" + maxid + "s")
1010 .form(printId(s[i], jvSuffix) + " "));
1011 out.append(s[i].getSequenceAsString());
1012 out.append(newline);
1016 // alignment annotation
1017 AlignmentAnnotation aa;
1018 if (al.getAlignmentAnnotation() != null)
1020 for (int ia = 0; ia < al.getAlignmentAnnotation().length; ia++)
1022 aa = al.getAlignmentAnnotation()[ia];
1023 if (aa.autoCalculated || !aa.visible || aa.sequenceRef != null)
1030 if (aa.label.equals("seq"))
1036 key = type2id(aa.label.toLowerCase());
1043 label = key + "_cons";
1050 label = label.replace(" ", "_");
1052 out.append(new Format("%-" + maxid + "s").form("#=GC " + label
1054 boolean isrna = aa.isValidStruc();
1055 for (int j = 0; j < aa.annotations.length; j++)
1057 seq += outputCharacter(key, j, isrna, aa.annotations, null);
1060 out.append(newline);
1065 out.append(newline);
1067 return out.toString();
1071 * add an annotation character to the output row
1080 private char outputCharacter(String key, int k, boolean isrna,
1081 Annotation[] ann, SequenceI sequenceI)
1084 Annotation annot = ann[k];
1085 String ch = (annot == null) ? ((sequenceI == null) ? "-" : Character
1086 .toString(sequenceI.getCharAt(k))) : annot.displayCharacter;
1087 if (key != null && key.equals("SS"))
1091 // sensible gap character if one is available or make one up
1092 return sequenceI == null ? '-' : sequenceI.getCharAt(k);
1096 // valid secondary structure AND no alternative label (e.g. ' B')
1097 if (annot.secondaryStructure > ' ' && ch.length() < 2)
1099 return annot.secondaryStructure;
1104 if (ch.length() == 0)
1108 else if (ch.length() == 1)
1112 else if (ch.length() > 1)
1119 public String print()
1121 out = new StringBuffer();
1122 out.append("# STOCKHOLM 1.0");
1123 out.append(newline);
1124 print(getSeqsAsArray(), false);
1127 out.append(newline);
1128 return out.toString();
1131 private static Hashtable typeIds = null;
1135 if (typeIds == null)
1137 typeIds = new Hashtable();
1138 typeIds.put("SS", "secondary structure");
1139 typeIds.put("SA", "surface accessibility");
1140 typeIds.put("TM", "transmembrane");
1141 typeIds.put("PP", "posterior probability");
1142 typeIds.put("LI", "ligand binding");
1143 typeIds.put("AS", "active site");
1144 typeIds.put("IN", "intron");
1145 typeIds.put("IR", "interacting residue");
1146 typeIds.put("AC", "accession");
1147 typeIds.put("OS", "organism");
1148 typeIds.put("CL", "class");
1149 typeIds.put("DE", "description");
1150 typeIds.put("DR", "reference");
1151 typeIds.put("LO", "look");
1152 typeIds.put("RF", "reference positions");
1157 protected static String id2type(String id)
1159 if (typeIds.containsKey(id))
1161 return (String) typeIds.get(id);
1163 System.err.println("Warning : Unknown Stockholm annotation type code "
1168 protected static String type2id(String type)
1171 Enumeration e = typeIds.keys();
1172 while (e.hasMoreElements())
1174 Object ll = e.nextElement();
1175 if (typeIds.get(ll).toString().equals(type))
1185 System.err.println("Warning : Unknown Stockholm annotation type: "
1191 * make a friendly ID string.
1194 * @return truncated dataName to after last '/'
1196 private String safeName(String dataName)
1199 while ((b = dataName.indexOf("/")) > -1 && b < dataName.length())
1201 dataName = dataName.substring(b + 1).trim();
1204 int e = (dataName.length() - dataName.indexOf(".")) + 1;
1205 dataName = dataName.substring(1, e).trim();