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.
23 import jalview.analysis.Conservation;
24 import jalview.api.AlignViewportI;
25 import jalview.datamodel.AlignmentAnnotation;
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.Annotation;
28 import jalview.datamodel.ColumnSelection;
29 import jalview.datamodel.GraphLine;
30 import jalview.datamodel.HiddenSequences;
31 import jalview.datamodel.PDBEntry;
32 import jalview.datamodel.PDBEntry.Type;
33 import jalview.datamodel.SequenceGroup;
34 import jalview.datamodel.SequenceI;
35 import jalview.schemes.ColourSchemeI;
36 import jalview.schemes.ColourSchemeProperty;
37 import jalview.schemes.UserColourScheme;
38 import jalview.structure.StructureSelectionManager;
40 import java.io.BufferedReader;
42 import java.io.FileReader;
43 import java.io.IOException;
44 import java.io.InputStreamReader;
45 import java.io.StringReader;
47 import java.util.ArrayList;
48 import java.util.BitSet;
49 import java.util.Enumeration;
50 import java.util.Hashtable;
51 import java.util.List;
53 import java.util.StringTokenizer;
54 import java.util.Vector;
56 public class AnnotationFile
58 public AnnotationFile()
64 * character used to write newlines
66 protected String newline = System.getProperty("line.separator");
69 * set new line string and reset the output buffer
73 public void setNewlineString(String nl)
79 public String getNewlineString()
88 text = new StringBuffer("JALVIEW_ANNOTATION" + newline + "# Created: "
89 + new java.util.Date() + newline + newline);
95 * convenience method for pre-2.9 annotation files which have no view, hidden
96 * columns or hidden row keywords.
101 * @return annotation file as a string.
103 public String printAnnotations(AlignmentAnnotation[] annotations,
104 List<SequenceGroup> list, Hashtable properties)
106 return printAnnotations(annotations, list, properties, null, null, null);
111 * hold all the information about a particular view definition read from or
112 * written out in an annotations file.
116 public String viewname;
118 public HiddenSequences hidseqs;
120 public ColumnSelection hiddencols;
122 public Vector visibleGroups;
124 public Hashtable hiddenRepSeqs;
126 public ViewDef(String viewname, HiddenSequences hidseqs,
127 ColumnSelection hiddencols, Hashtable hiddenRepSeqs)
129 this.viewname = viewname;
130 this.hidseqs = hidseqs;
131 this.hiddencols = hiddencols;
132 this.hiddenRepSeqs = hiddenRepSeqs;
137 * Prepare an annotation file given a set of annotations, groups, alignment
138 * properties and views.
144 * @return annotation file
146 public String printAnnotations(AlignmentAnnotation[] annotations,
147 List<SequenceGroup> list, Hashtable properties,
148 ColumnSelection cs, AlignmentI al, ViewDef view)
152 if (view.viewname != null)
154 text.append("VIEW_DEF\t" + view.viewname + "\n");
158 list = view.visibleGroups;
162 cs = view.hiddencols;
166 // add hidden rep sequences.
169 // first target - store and restore all settings for a view.
170 if (al != null && al.hasSeqrep())
172 text.append("VIEW_SETREF\t" + al.getSeqrep().getName() + "\n");
174 if (cs != null && cs.hasHiddenColumns())
176 text.append("VIEW_HIDECOLS\t");
177 List<int[]> hc = cs.getHiddenColumns();
178 boolean comma = false;
195 // TODO: allow efficient recovery of annotation data shown in several
197 if (annotations != null)
199 boolean oneColour = true;
200 AlignmentAnnotation row;
202 SequenceI refSeq = null;
203 SequenceGroup refGroup = null;
205 StringBuffer colours = new StringBuffer();
206 StringBuffer graphLine = new StringBuffer();
207 StringBuffer rowprops = new StringBuffer();
208 Hashtable<Integer, String> graphGroup = new Hashtable<Integer, String>();
209 Hashtable<Integer, Object[]> graphGroup_refs = new Hashtable<Integer, Object[]>();
210 BitSet graphGroupSeen = new BitSet();
212 java.awt.Color color;
214 for (int i = 0; i < annotations.length; i++)
216 row = annotations[i];
220 && !(row.graphGroup > -1 && graphGroupSeen
221 .get(row.graphGroup)))
229 // mark any sequence references for the row
230 writeSequence_Ref(refSeq, row.sequenceRef);
231 refSeq = row.sequenceRef;
232 // mark any group references for the row
233 writeGroup_Ref(refGroup, row.groupRef);
234 refGroup = row.groupRef;
236 boolean hasGlyphs = row.hasIcons, hasLabels = row.hasText, hasValues = row.hasScore, hasText = false;
237 // lookahead to check what the annotation row object actually contains.
238 for (int j = 0; row.annotations != null
239 && j < row.annotations.length
240 && (!hasGlyphs || !hasLabels || !hasValues); j++)
242 if (row.annotations[j] != null)
244 hasLabels |= (row.annotations[j].displayCharacter != null
245 && row.annotations[j].displayCharacter.length() > 0 && !row.annotations[j].displayCharacter
247 hasGlyphs |= (row.annotations[j].secondaryStructure != 0 && row.annotations[j].secondaryStructure != ' ');
248 hasValues |= (!Float.isNaN(row.annotations[j].value)); // NaNs can't
251 hasText |= (row.annotations[j].description != null && row.annotations[j].description
256 if (row.graph == AlignmentAnnotation.NO_GRAPH)
258 text.append("NO_GRAPH\t");
259 hasValues = false; // only secondary structure
260 // hasLabels = false; // and annotation description string.
264 if (row.graph == AlignmentAnnotation.BAR_GRAPH)
266 text.append("BAR_GRAPH\t");
267 hasGlyphs = false; // no secondary structure
270 else if (row.graph == AlignmentAnnotation.LINE_GRAPH)
272 hasGlyphs = false; // no secondary structure
273 text.append("LINE_GRAPH\t");
276 if (row.getThreshold() != null)
278 graphLine.append("GRAPHLINE\t");
279 graphLine.append(row.label);
280 graphLine.append("\t");
281 graphLine.append(row.getThreshold().value);
282 graphLine.append("\t");
283 graphLine.append(row.getThreshold().label);
284 graphLine.append("\t");
285 graphLine.append(jalview.util.Format.getHexString(row
286 .getThreshold().colour));
287 graphLine.append(newline);
290 if (row.graphGroup > -1)
292 graphGroupSeen.set(row.graphGroup);
293 Integer key = new Integer(row.graphGroup);
294 if (graphGroup.containsKey(key))
296 graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);
301 graphGroup_refs.put(key, new Object[] { refSeq, refGroup });
302 graphGroup.put(key, row.label);
307 text.append(row.label + "\t");
308 if (row.description != null)
310 text.append(row.description + "\t");
312 for (int j = 0; row.annotations != null
313 && j < row.annotations.length; j++)
316 && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))
321 if (row.annotations[j] != null)
324 if (hasGlyphs) // could be also hasGlyphs || ...
328 if (row.annotations[j].secondaryStructure != ' ')
330 // only write out the field if its not whitespace.
331 text.append(row.annotations[j].secondaryStructure);
337 if (!Float.isNaN(row.annotations[j].value))
339 text.append(comma + row.annotations[j].value);
343 // System.err.println("Skipping NaN - not valid value.");
344 text.append(comma + 0f);// row.annotations[j].value);
350 // TODO: labels are emitted after values for bar graphs.
351 if // empty labels are allowed, so
352 (row.annotations[j].displayCharacter != null
353 && row.annotations[j].displayCharacter.length() > 0
354 && !row.annotations[j].displayCharacter.equals(" "))
356 text.append(comma + row.annotations[j].displayCharacter);
362 if (row.annotations[j].description != null
363 && row.annotations[j].description.length() > 0
364 && !row.annotations[j].description
365 .equals(row.annotations[j].displayCharacter))
367 text.append(comma + row.annotations[j].description);
371 if (color != null && !color.equals(row.annotations[j].colour))
376 color = row.annotations[j].colour;
378 if (row.annotations[j].colour != null
379 && row.annotations[j].colour != java.awt.Color.black)
383 + jalview.util.Format
384 .getHexString(row.annotations[j].colour)
394 text.append("\t" + row.score);
397 text.append(newline);
399 if (color != null && color != java.awt.Color.black && oneColour)
401 colours.append("COLOUR\t");
402 colours.append(row.label);
403 colours.append("\t");
404 colours.append(jalview.util.Format.getHexString(color));
405 colours.append(newline);
407 if (row.scaleColLabel || row.showAllColLabels
408 || row.centreColLabels)
410 rowprops.append("ROWPROPERTIES\t");
411 rowprops.append(row.label);
412 rowprops.append("\tscaletofit=");
413 rowprops.append(row.scaleColLabel);
414 rowprops.append("\tshowalllabs=");
415 rowprops.append(row.showAllColLabels);
416 rowprops.append("\tcentrelabs=");
417 rowprops.append(row.centreColLabels);
418 rowprops.append(newline);
420 if (graphLine.length() > 0)
422 text.append(graphLine.toString());
423 graphLine.setLength(0);
427 text.append(newline);
429 text.append(colours.toString());
430 if (graphGroup.size() > 0)
432 SequenceI oldRefSeq = refSeq;
433 SequenceGroup oldRefGroup = refGroup;
434 for (Map.Entry<Integer, String> combine_statement : graphGroup
437 Object[] seqRefAndGroup = graphGroup_refs.get(combine_statement
440 writeSequence_Ref(refSeq, (SequenceI) seqRefAndGroup[0]);
441 refSeq = (SequenceI) seqRefAndGroup[0];
443 writeGroup_Ref(refGroup, (SequenceGroup) seqRefAndGroup[1]);
444 refGroup = (SequenceGroup) seqRefAndGroup[1];
445 text.append("COMBINE\t");
446 text.append(combine_statement.getValue());
447 text.append(newline);
449 writeSequence_Ref(refSeq, oldRefSeq);
452 writeGroup_Ref(refGroup, oldRefGroup);
453 refGroup = oldRefGroup;
455 text.append(rowprops.toString());
463 if (properties != null)
465 text.append(newline);
466 text.append(newline);
467 text.append("ALIGNMENT");
468 Enumeration en = properties.keys();
469 while (en.hasMoreElements())
471 String key = en.nextElement().toString();
475 text.append(properties.get(key));
477 // TODO: output alignment visualization settings here if required
478 // iterate through one or more views, defining, marking columns and rows
479 // as visible/hidden, and emmitting view properties.
480 // View specific annotation is
483 return text.toString();
486 private Object writeGroup_Ref(SequenceGroup refGroup,
487 SequenceGroup next_refGroup)
489 if (next_refGroup == null)
492 if (refGroup != null)
494 text.append(newline);
495 text.append("GROUP_REF\t");
496 text.append("ALIGNMENT");
497 text.append(newline);
503 if (refGroup == null || refGroup != next_refGroup)
505 text.append(newline);
506 text.append("GROUP_REF\t");
507 text.append(next_refGroup.getName());
508 text.append(newline);
515 private boolean writeSequence_Ref(SequenceI refSeq, SequenceI next_refSeq)
518 if (next_refSeq == null)
522 text.append(newline);
523 text.append("SEQUENCE_REF\t");
524 text.append("ALIGNMENT");
525 text.append(newline);
531 if (refSeq == null || refSeq != next_refSeq)
533 text.append(newline);
534 text.append("SEQUENCE_REF\t");
535 text.append(next_refSeq.getName());
536 text.append(newline);
543 public void printGroups(List<SequenceGroup> list)
545 SequenceI seqrep = null;
546 for (SequenceGroup sg : list)
550 text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"
551 + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1)
557 seqrep = sg.getSeqrep();
558 text.append("SEQUENCE_REF\t");
559 text.append(seqrep.getName());
560 text.append(newline);
561 text.append("SEQUENCE_GROUP\t");
562 text.append(sg.getName());
564 text.append((seqrep.findPosition(sg.getStartRes())));
566 text.append((seqrep.findPosition(sg.getEndRes())));
570 for (int s = 0; s < sg.getSize(); s++)
572 text.append(sg.getSequenceAt(s).getName());
575 text.append(newline);
576 text.append("PROPERTIES\t");
577 text.append(sg.getName());
580 if (sg.getDescription() != null)
582 text.append("description=");
583 text.append(sg.getDescription());
588 text.append("colour=");
589 text.append(ColourSchemeProperty.getColourName(sg.cs));
591 if (sg.cs.getThreshold() != 0)
593 text.append("pidThreshold=");
594 text.append(sg.cs.getThreshold());
596 if (sg.cs.conservationApplied())
598 text.append("consThreshold=");
599 text.append(sg.cs.getConservationInc());
603 text.append("outlineColour=");
604 text.append(jalview.util.Format.getHexString(sg.getOutlineColour()));
607 text.append("displayBoxes=");
608 text.append(sg.getDisplayBoxes());
610 text.append("displayText=");
611 text.append(sg.getDisplayText());
613 text.append("colourText=");
614 text.append(sg.getColourText());
616 text.append("showUnconserved=");
617 text.append(sg.getShowNonconserved());
619 if (sg.textColour != java.awt.Color.black)
621 text.append("textCol1=");
622 text.append(jalview.util.Format.getHexString(sg.textColour));
625 if (sg.textColour2 != java.awt.Color.white)
627 text.append("textCol2=");
628 text.append(jalview.util.Format.getHexString(sg.textColour2));
631 if (sg.thresholdTextColour != 0)
633 text.append("textColThreshold=");
634 text.append(sg.thresholdTextColour);
637 if (sg.idColour != null)
639 text.append("idColour=");
640 text.append(jalview.util.Format.getHexString(sg.idColour));
645 text.append("hide=true\t");
649 text.append("hidecols=true\t");
653 // terminate the last line and clear the sequence ref for the group
654 text.append(newline);
655 text.append("SEQUENCE_REF");
657 text.append(newline);
658 text.append(newline);
663 SequenceI refSeq = null;
665 String refSeqId = null;
667 public boolean annotateAlignmentView(AlignViewportI viewport,
668 String file, String protocol)
670 ColumnSelection colSel = viewport.getColumnSelection();
673 colSel = new ColumnSelection();
675 boolean rslt = readAnnotationFile(viewport.getAlignment(), colSel,
677 if (rslt && (colSel.hasSelectedColumns() || colSel.hasHiddenColumns()))
679 viewport.setColumnSelection(colSel);
685 public boolean readAnnotationFile(AlignmentI al, String file,
688 return readAnnotationFile(al, null, file, protocol);
691 public boolean readAnnotationFile(AlignmentI al, ColumnSelection colSel,
692 String file, String protocol)
695 BufferedReader in = null;
698 if (protocol.equals(AppletFormatAdapter.FILE))
700 in = new BufferedReader(new FileReader(file));
701 baseUri = new File(file).getParent();
711 else if (protocol.equals(AppletFormatAdapter.URL))
713 URL url = new URL(file);
714 in = new BufferedReader(new InputStreamReader(url.openStream()));
715 String bs = url.toExternalForm();
716 baseUri = bs.substring(0, bs.indexOf(url.getHost())
717 + url.getHost().length());
718 baseUri += url.toURI().getPath();
719 if (baseUri.lastIndexOf("/") > -1)
721 baseUri = baseUri.substring(0, baseUri.lastIndexOf("/")) + "/";
724 else if (protocol.equals(AppletFormatAdapter.PASTE))
726 in = new BufferedReader(new StringReader(file));
727 // TODO - support mimencoded PDBs for a paste.. ?
730 else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))
732 java.io.InputStream is = getClass().getResourceAsStream("/" + file);
735 in = new BufferedReader(new java.io.InputStreamReader(is));
736 // TODO: this probably doesn't work for classloader - needs a test
737 baseUri = new File("/" + file).getParent() + "/";
742 return parseAnnotationFrom(al, colSel, in);
745 } catch (Exception ex)
747 ex.printStackTrace();
748 System.out.println("Problem reading annotation file: " + ex);
751 System.out.println("Last read line " + nlinesread + ": '"
752 + lastread + "' (first 80 chars) ...");
761 String lastread = "";
764 * used for resolving absolute references to resources relative to
765 * annotationFile location
769 private static String GRAPHLINE = "GRAPHLINE", COMBINE = "COMBINE",
770 STRUCTMODEL = "STRUCTMODEL";
772 public boolean parseAnnotationFrom(AlignmentI al, ColumnSelection colSel,
773 BufferedReader in) throws Exception
776 ArrayList<Object[]> combineAnnotation_calls = new ArrayList<Object[]>();
777 ArrayList<Object[]> deferredAnnotation_calls = new ArrayList<Object[]>();
778 boolean modified = false;
779 String groupRef = null;
780 Hashtable groupRefRows = new Hashtable();
782 Hashtable autoAnnots = new Hashtable();
784 String line, label, description, token;
785 int graphStyle, index;
787 int existingAnnotations = 0;
788 // when true - will add new rows regardless of whether they are duplicate
789 // auto-annotation like consensus or conservation graphs
790 boolean overrideAutoAnnot = false;
791 if (al.getAlignmentAnnotation() != null)
793 existingAnnotations = al.getAlignmentAnnotation().length;
794 if (existingAnnotations > 0)
796 AlignmentAnnotation[] aa = al.getAlignmentAnnotation();
797 for (int aai = 0; aai < aa.length; aai++)
799 if (aa[aai].autoCalculated)
801 // make a note of the name and description
803 autoAnnotsKey(aa[aai], aa[aai].sequenceRef,
804 (aa[aai].groupRef == null ? null
805 : aa[aai].groupRef.getName())),
812 int alWidth = al.getWidth();
815 Annotation[] annotations;
816 AlignmentAnnotation annotation = null;
818 // First confirm this is an Annotation file
819 boolean jvAnnotationFile = false;
820 while ((line = in.readLine()) != null)
823 lastread = new String(line);
824 if (line.indexOf("#") == 0)
829 if (line.indexOf("JALVIEW_ANNOTATION") > -1)
831 jvAnnotationFile = true;
836 if (!jvAnnotationFile)
842 while ((line = in.readLine()) != null)
845 lastread = new String(line);
846 if (line.indexOf("#") == 0
847 || line.indexOf("JALVIEW_ANNOTATION") > -1
848 || line.length() == 0)
853 st = new StringTokenizer(line, "\t");
854 token = st.nextToken();
855 if (token.equalsIgnoreCase("COLOUR"))
857 // TODO: use graduated colour def'n here too
858 colourAnnotations(al, st.nextToken(), st.nextToken());
863 else if (token.equalsIgnoreCase(COMBINE))
865 // keep a record of current state and resolve groupRef at end
866 combineAnnotation_calls
867 .add(new Object[] { st, refSeq, groupRef });
871 else if (token.equalsIgnoreCase("ROWPROPERTIES"))
873 addRowProperties(al, st);
877 else if (token.equalsIgnoreCase(GRAPHLINE))
880 deferredAnnotation_calls.add(new Object[] { GRAPHLINE, st,
886 else if (token.equalsIgnoreCase("SEQUENCE_REF"))
888 if (st.hasMoreTokens())
890 refSeq = al.findName(refSeqId = st.nextToken());
897 refSeqIndex = Integer.parseInt(st.nextToken());
902 .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");
904 } catch (Exception ex)
916 else if (token.equalsIgnoreCase("GROUP_REF"))
918 // Group references could be forward or backwards, so they are
919 // resolved after the whole file is read in
921 if (st.hasMoreTokens())
923 groupRef = st.nextToken();
924 if (groupRef.length() < 1)
926 groupRef = null; // empty string
930 if (groupRefRows.get(groupRef) == null)
932 groupRefRows.put(groupRef, new Vector());
938 else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))
945 else if (token.equalsIgnoreCase("PROPERTIES"))
947 addProperties(al, st);
952 else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))
954 setBelowAlignment(al, st);
958 else if (token.equalsIgnoreCase("ALIGNMENT"))
960 addAlignmentDetails(al, st);
964 // else if (token.equalsIgnoreCase("VIEW_DEF"))
966 // addOrSetView(al,st);
970 else if (token.equalsIgnoreCase("VIEW_SETREF"))
974 al.setSeqrep(refSeq);
979 else if (token.equalsIgnoreCase("VIEW_HIDECOLS"))
981 if (st.hasMoreTokens())
985 colSel = new ColumnSelection();
987 parseHideCols(colSel, st.nextToken());
992 else if (token.equalsIgnoreCase("HIDE_INSERTIONS"))
994 SequenceI sr = refSeq == null ? al.getSeqrep() : refSeq;
997 sr = al.getSequenceAt(0);
1004 .println("Cannot process HIDE_INSERTIONS without an alignment view: Ignoring line: "
1009 // consider deferring this till after the file has been parsed ?
1010 colSel.hideInsertionsFor(sr);
1016 else if (token.equalsIgnoreCase(STRUCTMODEL))
1018 boolean failedtoadd = true;
1020 // STRUCTMODEL <QUERYID> <TemplateID> <URL to model> <URL to
1022 if (st.hasMoreTokens()) {
1023 refSeq = al.findName(refSeqId = st.nextToken());
1026 System.err.println("Couldn't locate " + refSeqId
1027 + " in the alignment for STRUCTMODEL");
1032 String tempId = st.nextToken();
1033 String urlToModel = st.nextToken();
1034 String urlToPairwise = st.hasMoreTokens() ? st.nextToken()
1036 if (add_structmodel(al, refSeq, tempId, urlToModel,
1039 failedtoadd = false;
1046 .println("Need <QueryId> <TemplateId> <URL to Model> [<URL to pairwise alignment>] as tab separated fields after "
1053 // Parse out the annotation row
1054 graphStyle = AlignmentAnnotation.getGraphValueFromString(token);
1055 label = st.nextToken();
1058 annotations = new Annotation[alWidth];
1060 float score = Float.NaN;
1062 if (st.hasMoreTokens())
1064 line = st.nextToken();
1066 if (line.indexOf("|") == -1)
1069 if (st.hasMoreTokens())
1071 line = st.nextToken();
1075 if (st.hasMoreTokens())
1077 // This must be the score
1078 score = Float.valueOf(st.nextToken()).floatValue();
1081 st = new StringTokenizer(line, "|", true);
1083 boolean emptyColumn = true;
1084 boolean onlyOneElement = (st.countTokens() == 1);
1086 while (st.hasMoreElements() && index < alWidth)
1088 token = st.nextToken().trim();
1094 score = Float.valueOf(token).floatValue();
1096 } catch (NumberFormatException ex)
1101 if (token.equals("|"))
1112 annotations[index++] = parseAnnotation(token, graphStyle);
1113 emptyColumn = false;
1119 annotation = new AlignmentAnnotation(label, description,
1120 (index == 0) ? null : annotations, 0, 0, graphStyle);
1122 annotation.score = score;
1123 if (!overrideAutoAnnot
1124 && autoAnnots.containsKey(autoAnnotsKey(annotation, refSeq,
1127 // skip - we've already got an automatic annotation of this type.
1130 // otherwise add it!
1134 annotation.belowAlignment = false;
1135 // make a copy of refSeq so we can find other matches in the alignment
1136 SequenceI referedSeq = refSeq;
1139 // copy before we do any mapping business.
1140 // TODO: verify that undo/redo with 1:many sequence associated
1141 // annotations can be undone correctly
1142 AlignmentAnnotation ann = new AlignmentAnnotation(annotation);
1144 .createSequenceMapping(referedSeq, refSeqIndex, false);
1145 annotation.adjustForAlignment();
1146 referedSeq.addAlignmentAnnotation(annotation);
1147 al.addAnnotation(annotation);
1148 al.setAnnotationIndex(annotation,
1149 al.getAlignmentAnnotation().length
1150 - existingAnnotations - 1);
1151 if (groupRef != null)
1153 ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
1155 // and recover our virgin copy to use again if necessary.
1158 } while (refSeqId != null
1159 && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);
1163 al.addAnnotation(annotation);
1164 al.setAnnotationIndex(annotation,
1165 al.getAlignmentAnnotation().length - existingAnnotations
1167 if (groupRef != null)
1169 ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
1172 // and set modification flag
1175 // Resolve the groupRefs
1176 Hashtable<String, SequenceGroup> groupRefLookup = new Hashtable<String, SequenceGroup>();
1177 Enumeration en = groupRefRows.keys();
1179 while (en.hasMoreElements())
1181 groupRef = (String) en.nextElement();
1182 boolean matched = false;
1183 // Resolve group: TODO: add a getGroupByName method to alignments
1184 for (SequenceGroup theGroup : al.getGroups())
1186 if (theGroup.getName().equals(groupRef))
1190 // TODO: specify and implement duplication of alignment annotation
1191 // for multiple group references.
1193 .println("Ignoring 1:many group reference mappings for group name '"
1199 Vector rowset = (Vector) groupRefRows.get(groupRef);
1200 groupRefLookup.put(groupRef, theGroup);
1201 if (rowset != null && rowset.size() > 0)
1203 AlignmentAnnotation alan = null;
1204 for (int elm = 0, elmSize = rowset.size(); elm < elmSize; elm++)
1206 alan = (AlignmentAnnotation) rowset.elementAt(elm);
1207 alan.groupRef = theGroup;
1213 ((Vector) groupRefRows.get(groupRef)).removeAllElements();
1215 // process any deferred attribute settings for each context
1216 for (Object[] _deferred_args : deferredAnnotation_calls)
1218 if (_deferred_args[0] == GRAPHLINE)
1221 (StringTokenizer) _deferred_args[1], // st
1222 (SequenceI) _deferred_args[2], // refSeq
1223 (_deferred_args[3] == null) ? null : groupRefLookup
1224 .get(_deferred_args[3]) // the reference
1230 // finally, combine all the annotation rows within each context.
1232 * number of combine statements in this annotation file. Used to create
1233 * new groups for combined annotation graphs without disturbing existing
1236 int combinecount = 0;
1237 for (Object[] _combine_args : combineAnnotation_calls)
1239 combineAnnotations(al,
1241 (StringTokenizer) _combine_args[0], // st
1242 (SequenceI) _combine_args[1], // refSeq
1243 (_combine_args[2] == null) ? null : groupRefLookup
1244 .get(_combine_args[2]) // the reference group,
1253 * resolve a structural model and generate and add an alignment sequence for
1259 * @param urlToPairwise
1260 * @return true if model and sequence was added
1262 private boolean add_structmodel(AlignmentI al, SequenceI refSeq2, String tempId,
1263 String urlToModel, String urlToPairwise)
1265 String warningMessage = null, modelPath = null, modelProt = null, aliPath = null, aliProt = null;
1266 boolean added = false;
1268 // locate tempId. if it exists, will need to merge, otherwise:
1269 SequenceI templateSeq = al.findName(tempId);
1270 // 1. load urlToModel
1271 modelPath = resolveAbsolute(urlToModel);
1272 modelProt = AppletFormatAdapter.checkProtocol(modelPath);
1273 // need to transfer to local temp file ?
1274 PDBEntry modelpe = new PDBEntry(tempId, null, Type.FILE, modelPath);
1275 PDBEntry templpe = new PDBEntry(tempId, null, Type.FILE, modelPath);
1276 refSeq2.addPDBId(modelpe);
1277 aliPath = resolveAbsolute(urlToPairwise);
1278 aliProt = AppletFormatAdapter.checkProtocol(aliPath);
1279 // 2. load urlToPairwise
1280 AlignmentI pwa = new AppletFormatAdapter().readFile(aliPath, aliProt,
1282 SequenceI qPw = null, tPw = null;
1285 // resolve query/template sequences in provided alignment
1286 qPw = pwa.findName(refSeqId);
1287 tPw = pwa.findName(tempId);
1290 // (qPw != null && tPw != null)
1293 // refalQ vvva--addrvvvtttddd
1294 // refalT ---aaaa---sss---ddd
1295 // profalQ ---v-v-v-a.-.-a---dd--r--vvvtt--td--dd
1296 // profalT ---.-.-.-aa-a-a---..--.--sss..--.d--dd
1297 // Pragmatic solution here:
1298 // Map templpe onto refalT only where refalT and refalQ are both
1301 // columns for start..end in refSeq2
1302 int[] gapMap = refSeq2.gapMap();
1303 // insert gaps in tPw
1304 int curi = 0, width = refSeq2.getLength();
1309 // assume 1:1 - so synthesise sequences to use to construct mapping
1310 StructureFile pdbf = StructureSelectionManager
1311 .getStructureSelectionManager().setMapping(false,
1312 new SequenceI[] { refSeq2.getDatasetSequence() },
1313 null, modelPath, modelProt);
1314 refSeq2.getDatasetSequence().addPDBId(modelpe);
1315 if (templateSeq == null && tPw != null)
1317 tPw.createDatasetSequence();
1318 tPw.getDatasetSequence().addPDBId(templpe); // needs to set mapping based on model yet...
1319 al.addSequence(tPw);
1323 // 3. pad/insert gaps in urlToPairwise according to gaps already present in
1325 // 4. add padded tempId sequence to alignment
1326 // 4. associate urlToModel with refSeq2 based on position map provided by
1328 // 5. associate urlToModel with tempId based on position map provided by
1330 // start a thread to load urlToModel and process/annotate sequences.
1331 } catch (IOException x)
1333 warningMessage = x.toString();
1335 if (warningMessage !=null)
1337 System.err.println("Warnings whilst processing STRUCTMODEL: "+warningMessage);
1343 private String resolveAbsolute(String relURI)
1345 if (relURI.indexOf(":/") > -1 || relURI.startsWith("/")
1346 || "".equals(baseUri) || relURI.startsWith(baseUri))
1350 return baseUri + relURI;
1353 private void parseHideCols(ColumnSelection colSel, String nextToken)
1355 StringTokenizer inval = new StringTokenizer(nextToken, ",");
1356 while (inval.hasMoreTokens())
1358 String range = inval.nextToken().trim();
1359 int from, to = range.indexOf("-");
1362 from = to = Integer.parseInt(range);
1365 colSel.hideColumns(from, to);
1370 from = Integer.parseInt(range.substring(0, to));
1371 if (to < range.length() - 1)
1373 to = Integer.parseInt(range.substring(to + 1));
1379 if (from > 0 && to >= from)
1381 colSel.hideColumns(from, to);
1387 private Object autoAnnotsKey(AlignmentAnnotation annotation,
1388 SequenceI refSeq, String groupRef)
1390 return annotation.graph + "\t" + annotation.label + "\t"
1391 + annotation.description + "\t"
1392 + (refSeq != null ? refSeq.getDisplayId(true) : "");
1395 Annotation parseAnnotation(String string, int graphStyle)
1397 boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH); // don't
1406 String desc = null, displayChar = null;
1407 char ss = ' '; // secondaryStructure
1409 boolean parsedValue = false, dcset = false;
1412 java.awt.Color colour = null;
1413 int i = string.indexOf("[");
1414 int j = string.indexOf("]");
1415 if (i > -1 && j > -1)
1417 UserColourScheme ucs = new UserColourScheme();
1419 colour = ucs.getColourFromString(string.substring(i + 1, j));
1420 if (i > 0 && string.charAt(i - 1) == ',')
1422 // clip the preceding comma as well
1425 string = string.substring(0, i) + string.substring(j + 1);
1428 StringTokenizer st = new StringTokenizer(string, ",", true);
1430 boolean seenContent = false;
1432 while (st.hasMoreTokens())
1435 token = st.nextToken().trim();
1436 if (token.equals(","))
1438 if (!seenContent && parsedValue && !dcset)
1440 // allow the value below the bar/line to be empty
1444 seenContent = false;
1456 displayChar = token;
1458 value = new Float(token).floatValue();
1461 } catch (NumberFormatException ex)
1467 if (token.length() == 1)
1469 displayChar = token;
1473 && (token.length() == 1 && "()<>[]{}AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"
1476 // Either this character represents a helix or sheet
1477 // or an integer which can be displayed
1478 ss = token.charAt(0);
1479 if (displayChar.equals(token.substring(0, 1)))
1484 else if (desc == null || (parsedValue && pass > 2))
1490 // if (!dcset && string.charAt(string.length() - 1) == ',')
1492 // displayChar = " "; // empty display char symbol.
1494 if (displayChar != null && desc != null && desc.length() == 1)
1496 if (displayChar.length() > 1)
1498 // switch desc and displayChar - legacy support
1499 String tmp = displayChar;
1505 if (displayChar.equals(desc))
1507 // duplicate label - hangover from the 'robust parser' above
1512 Annotation anot = new Annotation(displayChar, desc, ss, value);
1514 anot.colour = colour;
1519 void colourAnnotations(AlignmentI al, String label, String colour)
1521 UserColourScheme ucs = new UserColourScheme(colour);
1522 Annotation[] annotations;
1523 for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1525 if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))
1527 annotations = al.getAlignmentAnnotation()[i].annotations;
1528 for (int j = 0; j < annotations.length; j++)
1530 if (annotations[j] != null)
1532 annotations[j].colour = ucs.findColour('A');
1539 void combineAnnotations(AlignmentI al, int combineCount,
1540 StringTokenizer st, SequenceI seqRef, SequenceGroup groupRef)
1542 String group = st.nextToken();
1543 // First make sure we are not overwriting the graphIndex
1545 if (al.getAlignmentAnnotation() != null)
1547 for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1549 AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
1551 if (aa.graphGroup > graphGroup)
1553 // try to number graphGroups in order of occurence.
1554 graphGroup = aa.graphGroup + 1;
1556 if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
1557 && aa.label.equalsIgnoreCase(group))
1559 if (aa.graphGroup > -1)
1561 graphGroup = aa.graphGroup;
1565 if (graphGroup <= combineCount)
1567 graphGroup = combineCount + 1;
1569 aa.graphGroup = graphGroup;
1575 // Now update groups
1576 while (st.hasMoreTokens())
1578 group = st.nextToken();
1579 for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1581 AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
1582 if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
1583 && aa.label.equalsIgnoreCase(group))
1585 aa.graphGroup = graphGroup;
1594 .println("Couldn't combine annotations. None are added to alignment yet!");
1598 void addLine(AlignmentI al, StringTokenizer st, SequenceI seqRef,
1599 SequenceGroup groupRef)
1601 String group = st.nextToken();
1602 AlignmentAnnotation annotation = null, alannot[] = al
1603 .getAlignmentAnnotation();
1604 float value = new Float(st.nextToken()).floatValue();
1605 String label = st.hasMoreTokens() ? st.nextToken() : null;
1606 java.awt.Color colour = null;
1607 if (st.hasMoreTokens())
1609 UserColourScheme ucs = new UserColourScheme(st.nextToken());
1610 colour = ucs.findColour('A');
1612 if (alannot != null)
1614 for (int i = 0; i < alannot.length; i++)
1616 if (alannot[i].label.equalsIgnoreCase(group)
1617 && (seqRef == null || alannot[i].sequenceRef == seqRef)
1618 && (groupRef == null || alannot[i].groupRef == groupRef))
1620 alannot[i].setThreshold(new GraphLine(value, label, colour));
1624 if (annotation == null)
1630 void addGroup(AlignmentI al, StringTokenizer st)
1632 SequenceGroup sg = new SequenceGroup();
1633 sg.setName(st.nextToken());
1637 rng = st.nextToken();
1638 if (rng.length() > 0 && !rng.startsWith("*"))
1640 sg.setStartRes(Integer.parseInt(rng) - 1);
1646 rng = st.nextToken();
1647 if (rng.length() > 0 && !rng.startsWith("*"))
1649 sg.setEndRes(Integer.parseInt(rng) - 1);
1653 sg.setEndRes(al.getWidth() - 1);
1655 } catch (Exception e)
1658 .println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"
1659 + rng + "' - assuming alignment width for group.");
1660 // assume group is full width
1662 sg.setEndRes(al.getWidth() - 1);
1665 String index = st.nextToken();
1666 if (index.equals("-1"))
1668 while (st.hasMoreElements())
1670 sg.addSequence(al.findName(st.nextToken()), false);
1675 StringTokenizer st2 = new StringTokenizer(index, ",");
1677 while (st2.hasMoreTokens())
1679 String tmp = st2.nextToken();
1680 if (tmp.equals("*"))
1682 for (int i = 0; i < al.getHeight(); i++)
1684 sg.addSequence(al.getSequenceAt(i), false);
1687 else if (tmp.indexOf("-") >= 0)
1689 StringTokenizer st3 = new StringTokenizer(tmp, "-");
1691 int start = (Integer.parseInt(st3.nextToken()));
1692 int end = (Integer.parseInt(st3.nextToken()));
1696 for (int i = start; i <= end; i++)
1698 sg.addSequence(al.getSequenceAt(i - 1), false);
1704 sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1), false);
1711 sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);
1712 sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);
1713 sg.setSeqrep(refSeq);
1716 if (sg.getSize() > 0)
1722 void addRowProperties(AlignmentI al, StringTokenizer st)
1724 String label = st.nextToken(), keyValue, key, value;
1725 boolean scaletofit = false, centerlab = false, showalllabs = false;
1726 while (st.hasMoreTokens())
1728 keyValue = st.nextToken();
1729 key = keyValue.substring(0, keyValue.indexOf("="));
1730 value = keyValue.substring(keyValue.indexOf("=") + 1);
1731 if (key.equalsIgnoreCase("scaletofit"))
1733 scaletofit = Boolean.valueOf(value).booleanValue();
1735 if (key.equalsIgnoreCase("showalllabs"))
1737 showalllabs = Boolean.valueOf(value).booleanValue();
1739 if (key.equalsIgnoreCase("centrelabs"))
1741 centerlab = Boolean.valueOf(value).booleanValue();
1743 AlignmentAnnotation[] alr = al.getAlignmentAnnotation();
1746 for (int i = 0; i < alr.length; i++)
1748 if (alr[i].label.equalsIgnoreCase(label))
1750 alr[i].centreColLabels = centerlab;
1751 alr[i].scaleColLabel = scaletofit;
1752 alr[i].showAllColLabels = showalllabs;
1759 void addProperties(AlignmentI al, StringTokenizer st)
1762 // So far we have only added groups to the annotationHash,
1763 // the idea is in the future properties can be added to
1764 // alignments, other annotations etc
1765 if (al.getGroups() == null)
1770 String name = st.nextToken();
1771 SequenceGroup sg = null;
1772 for (SequenceGroup _sg : al.getGroups())
1774 if ((sg = _sg).getName().equals(name))
1786 String keyValue, key, value;
1787 ColourSchemeI def = sg.cs;
1789 while (st.hasMoreTokens())
1791 keyValue = st.nextToken();
1792 key = keyValue.substring(0, keyValue.indexOf("="));
1793 value = keyValue.substring(keyValue.indexOf("=") + 1);
1795 if (key.equalsIgnoreCase("description"))
1797 sg.setDescription(value);
1799 else if (key.equalsIgnoreCase("colour"))
1801 sg.cs = ColourSchemeProperty.getColour(al, value);
1803 else if (key.equalsIgnoreCase("pidThreshold"))
1805 sg.cs.setThreshold(Integer.parseInt(value), true);
1808 else if (key.equalsIgnoreCase("consThreshold"))
1810 sg.cs.setConservationInc(Integer.parseInt(value));
1811 Conservation c = new Conservation("Group", 3,
1812 sg.getSequences(null), sg.getStartRes(),
1813 sg.getEndRes() + 1);
1816 c.verdict(false, 25); // TODO: refer to conservation percent threshold
1818 sg.cs.setConservation(c);
1821 else if (key.equalsIgnoreCase("outlineColour"))
1823 sg.setOutlineColour(new UserColourScheme(value).findColour('A'));
1825 else if (key.equalsIgnoreCase("displayBoxes"))
1827 sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());
1829 else if (key.equalsIgnoreCase("showUnconserved"))
1831 sg.setShowNonconserved(Boolean.valueOf(value).booleanValue());
1833 else if (key.equalsIgnoreCase("displayText"))
1835 sg.setDisplayText(Boolean.valueOf(value).booleanValue());
1837 else if (key.equalsIgnoreCase("colourText"))
1839 sg.setColourText(Boolean.valueOf(value).booleanValue());
1841 else if (key.equalsIgnoreCase("textCol1"))
1843 sg.textColour = new UserColourScheme(value).findColour('A');
1845 else if (key.equalsIgnoreCase("textCol2"))
1847 sg.textColour2 = new UserColourScheme(value).findColour('A');
1849 else if (key.equalsIgnoreCase("textColThreshold"))
1851 sg.thresholdTextColour = Integer.parseInt(value);
1853 else if (key.equalsIgnoreCase("idColour"))
1855 // consider warning if colour doesn't resolve to a real colour
1856 sg.setIdColour((def = new UserColourScheme(value))
1859 else if (key.equalsIgnoreCase("hide"))
1861 // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
1862 sg.setHidereps(true);
1864 else if (key.equalsIgnoreCase("hidecols"))
1866 // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
1867 sg.setHideCols(true);
1869 sg.recalcConservation();
1878 void setBelowAlignment(AlignmentI al, StringTokenizer st)
1881 AlignmentAnnotation aa, ala[] = al.getAlignmentAnnotation();
1885 .print("Warning - no annotation to set below for sequence associated annotation:");
1887 while (st.hasMoreTokens())
1889 token = st.nextToken();
1892 System.err.print(" " + token);
1896 for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
1898 aa = al.getAlignmentAnnotation()[i];
1899 if (aa.sequenceRef == refSeq && aa.label.equals(token))
1901 aa.belowAlignment = true;
1908 System.err.print("\n");
1912 void addAlignmentDetails(AlignmentI al, StringTokenizer st)
1914 String keyValue, key, value;
1915 while (st.hasMoreTokens())
1917 keyValue = st.nextToken();
1918 key = keyValue.substring(0, keyValue.indexOf("="));
1919 value = keyValue.substring(keyValue.indexOf("=") + 1);
1920 al.setProperty(key, value);
1925 * Write annotations as a CSV file of the form 'label, value, value, ...' for
1928 * @param annotations
1929 * @return CSV file as a string.
1931 public String printCSVAnnotations(AlignmentAnnotation[] annotations)
1933 if (annotations == null)
1937 StringBuffer sp = new StringBuffer();
1938 for (int i = 0; i < annotations.length; i++)
1940 String atos = annotations[i].toString();
1944 int cp = atos.indexOf("\n", p);
1945 sp.append(annotations[i].label);
1949 sp.append(atos.substring(p, cp + 1));
1953 sp.append(atos.substring(p));
1959 return sp.toString();
1962 public String printAnnotationsForView(AlignViewportI viewport)
1964 return printAnnotations(viewport.isShowAnnotation() ? viewport
1965 .getAlignment().getAlignmentAnnotation() : null, viewport
1966 .getAlignment().getGroups(), viewport.getAlignment()
1967 .getProperties(), viewport.getColumnSelection(),
1968 viewport.getAlignment(), null);
1971 public String printAnnotationsForAlignment(AlignmentI al)
1973 return printAnnotations(al.getAlignmentAnnotation(), al.getGroups(),
1974 al.getProperties(), null, al, null);