-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)\r
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- * \r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- * \r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- * \r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
- */\r
-package jalview.io;\r
-\r
-import java.io.*;\r
-import java.net.*;\r
-import java.util.*;\r
-\r
-import jalview.analysis.*;\r
-import jalview.datamodel.*;\r
-import jalview.schemes.*;\r
-\r
-public class AnnotationFile\r
-{\r
- StringBuffer text = new StringBuffer("JALVIEW_ANNOTATION\n"\r
- + "# Created: " + new java.util.Date() + "\n\n");\r
-\r
- /**\r
- * convenience method for pre-2.4 feature files which have no view, hidden\r
- * columns or hidden row keywords.\r
- * \r
- * @param annotations\r
- * @param groups\r
- * @param properties\r
- * @return feature file as a string.\r
- */\r
- public String printAnnotations(AlignmentAnnotation[] annotations,\r
- Vector groups, Hashtable properties)\r
- {\r
- return printAnnotations(annotations, groups, properties, null);\r
-\r
- }\r
-\r
- /**\r
- * hold all the information about a particular view definition read from or\r
- * written out in an annotations file.\r
- */\r
- public class ViewDef\r
- {\r
- public String viewname;\r
-\r
- public HiddenSequences hidseqs;\r
-\r
- public ColumnSelection hiddencols;\r
-\r
- public Vector visibleGroups;\r
- public Hashtable hiddenRepSeqs;\r
- \r
- public ViewDef(String viewname, HiddenSequences hidseqs,\r
- ColumnSelection hiddencols, Hashtable hiddenRepSeqs)\r
- {\r
- this.viewname = viewname;\r
- this.hidseqs = hidseqs;\r
- this.hiddencols = hiddencols;\r
- this.hiddenRepSeqs = hiddenRepSeqs;\r
- }\r
- }\r
-\r
- public String printAnnotations(AlignmentAnnotation[] annotations,\r
- Vector groups, Hashtable properties, ViewDef[] views)\r
- {\r
- if (annotations != null)\r
- {\r
- boolean oneColour = true;\r
- AlignmentAnnotation row;\r
- String comma;\r
- SequenceI refSeq = null;\r
-\r
- StringBuffer colours = new StringBuffer();\r
- StringBuffer graphLine = new StringBuffer();\r
-\r
- Hashtable graphGroup = new Hashtable();\r
-\r
- java.awt.Color color;\r
-\r
- for (int i = 0; i < annotations.length; i++)\r
- {\r
- row = annotations[i];\r
-\r
- if (!row.visible && !row.hasScore())\r
- {\r
- continue;\r
- }\r
-\r
- color = null;\r
- oneColour = true;\r
-\r
- if (row.sequenceRef == null)\r
- {\r
- if (refSeq != null)\r
- {\r
- text.append("\nSEQUENCE_REF\tALIGNMENT\n");\r
- }\r
-\r
- refSeq = null;\r
- }\r
-\r
- else if (refSeq == null || refSeq != row.sequenceRef)\r
- {\r
- refSeq = row.sequenceRef;\r
- text.append("\nSEQUENCE_REF\t" + refSeq.getName() + "\n");\r
- }\r
-\r
- if (row.graph == AlignmentAnnotation.NO_GRAPH)\r
- {\r
- text.append("NO_GRAPH\t");\r
- }\r
- else\r
- {\r
- if (row.graph == AlignmentAnnotation.BAR_GRAPH)\r
- {\r
- text.append("BAR_GRAPH\t");\r
- }\r
- else if (row.graph == AlignmentAnnotation.LINE_GRAPH)\r
- {\r
- text.append("LINE_GRAPH\t");\r
- }\r
-\r
- if (row.getThreshold() != null)\r
- {\r
- graphLine\r
- .append("GRAPHLINE\t"\r
- + row.label\r
- + "\t"\r
- + row.getThreshold().value\r
- + "\t"\r
- + row.getThreshold().label\r
- + "\t"\r
- + jalview.util.Format.getHexString(row\r
- .getThreshold().colour) + "\n");\r
- }\r
-\r
- if (row.graphGroup > -1)\r
- {\r
- String key = String.valueOf(row.graphGroup);\r
- if (graphGroup.containsKey(key))\r
- {\r
- graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);\r
- }\r
- else\r
- {\r
- graphGroup.put(key, row.label);\r
- }\r
- }\r
- }\r
-\r
- text.append(row.label + "\t");\r
- if (row.description != null)\r
- {\r
- text.append(row.description + "\t");\r
- }\r
-\r
- for (int j = 0; row.annotations != null\r
- && j < row.annotations.length; j++)\r
- {\r
- if (refSeq != null\r
- && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))\r
- {\r
- continue;\r
- }\r
-\r
- if (row.annotations[j] != null)\r
- {\r
- comma = "";\r
- if (row.annotations[j].secondaryStructure != ' ')\r
- {\r
- text.append(comma + row.annotations[j].secondaryStructure);\r
- comma = ",";\r
- }\r
- if (row.annotations[j].displayCharacter != null\r
- && row.annotations[j].displayCharacter.length() > 0\r
- && !row.annotations[j].displayCharacter.equals(" "))\r
- {\r
- text.append(comma + row.annotations[j].displayCharacter);\r
- comma = ",";\r
- }\r
-\r
- if (row.annotations[j] != null)\r
- {\r
- if (color != null && !color.equals(row.annotations[j].colour))\r
- {\r
- oneColour = false;\r
- }\r
-\r
- color = row.annotations[j].colour;\r
- if (row.annotations[j].value != 0f\r
- && row.annotations[j].value != Float.NaN)\r
- {\r
- text.append(comma + row.annotations[j].value);\r
- }\r
- }\r
-\r
- if (row.annotations[j].colour != null\r
- && row.annotations[j].colour != java.awt.Color.black)\r
- {\r
- text.append(comma\r
- + "["\r
- + jalview.util.Format\r
- .getHexString(row.annotations[j].colour)\r
- + "]");\r
- }\r
- }\r
- text.append("|");\r
- }\r
-\r
- if (row.hasScore())\r
- text.append("\t" + row.score);\r
-\r
- text.append("\n");\r
-\r
- if (color != null && color != java.awt.Color.black && oneColour)\r
- {\r
- colours.append("COLOUR\t" + row.label + "\t"\r
- + jalview.util.Format.getHexString(color) + "\n");\r
- }\r
-\r
- }\r
-\r
- text.append("\n");\r
-\r
- text.append(colours.toString());\r
- text.append(graphLine.toString());\r
- if (graphGroup.size() > 0)\r
- {\r
- text.append("COMBINE\t");\r
- Enumeration en = graphGroup.elements();\r
- while (en.hasMoreElements())\r
- {\r
- text.append(en.nextElement() + "\n");\r
- }\r
- }\r
- }\r
-\r
- if (groups != null)\r
- {\r
- printGroups(groups);\r
- }\r
-\r
- if (properties != null)\r
- {\r
- text.append("\n\nALIGNMENT");\r
- Enumeration en = properties.keys();\r
- while (en.hasMoreElements())\r
- {\r
- String key = en.nextElement().toString();\r
- text.append("\t" + key + "=" + properties.get(key));\r
- }\r
- // TODO: output alignment visualization settings here if required\r
-\r
- }\r
-\r
- return text.toString();\r
- }\r
-\r
- public void printGroups(Vector sequenceGroups)\r
- {\r
- SequenceGroup sg;\r
- SequenceI seqrep=null;\r
- for (int i = 0; i < sequenceGroups.size(); i++)\r
- {\r
- sg = (SequenceGroup) sequenceGroups.elementAt(i);\r
- if (!sg.hasSeqrep())\r
- {\r
- text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"\r
- + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1) + "\t"\r
- + "-1\t");\r
- seqrep = null;\r
- } else {\r
- seqrep = sg.getSeqrep();\r
- text.append("SEQUENCE_REF\t"+seqrep.getName()+"\n");\r
- text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"\r
- + (seqrep.findPosition(sg.getStartRes())) + "\t" + (seqrep.findPosition(sg.getEndRes())) + "\t"\r
- + "-1\t");\r
- }\r
- for (int s = 0; s < sg.getSize(); s++)\r
- {\r
- text.append(sg.getSequenceAt(s).getName() + "\t");\r
- }\r
-\r
- text.append("\nPROPERTIES\t" + sg.getName() + "\t");\r
-\r
- if (sg.getDescription() != null)\r
- {\r
- text.append("description=" + sg.getDescription() + "\t");\r
- }\r
- if (sg.cs != null)\r
- {\r
- text.append("colour=" + ColourSchemeProperty.getColourName(sg.cs)\r
- + "\t");\r
- if (sg.cs.getThreshold() != 0)\r
- {\r
- text.append("pidThreshold=" + sg.cs.getThreshold());\r
- }\r
- if (sg.cs.conservationApplied())\r
- {\r
- text.append("consThreshold=" + sg.cs.getConservationInc() + "\t");\r
- }\r
- }\r
- text.append("outlineColour="\r
- + jalview.util.Format.getHexString(sg.getOutlineColour())\r
- + "\t");\r
-\r
- text.append("displayBoxes=" + sg.getDisplayBoxes() + "\t");\r
- text.append("displayText=" + sg.getDisplayText() + "\t");\r
- text.append("colourText=" + sg.getColourText() + "\t");\r
- text.append("showUnconserved="+sg.getShowunconserved()+"\t");\r
- if (sg.textColour != java.awt.Color.black)\r
- {\r
- text.append("textCol1="\r
- + jalview.util.Format.getHexString(sg.textColour) + "\t");\r
- }\r
- if (sg.textColour2 != java.awt.Color.white)\r
- {\r
- text.append("textCol2="\r
- + jalview.util.Format.getHexString(sg.textColour2) + "\t");\r
- }\r
- if (sg.thresholdTextColour != 0)\r
- {\r
- text.append("textColThreshold=" + sg.thresholdTextColour+"\t");\r
- }\r
- if (sg.idColour != null)\r
- {\r
- text.append("idColour="\r
- + jalview.util.Format.getHexString(sg.idColour) + "\t");\r
- }\r
- if (sg.isHidereps())\r
- {\r
- text.append("hide=true\t");\r
- }\r
- if (sg.isHideCols())\r
- {\r
- text.append("hidecols=true\t");\r
- }\r
- if (seqrep!=null)\r
- {\r
- // terminate the last line and clear the sequence ref for the group\r
- text.append("\nSEQUENCE_REF");\r
- }\r
- text.append("\n\n");\r
-\r
- }\r
- }\r
-\r
- SequenceI refSeq = null;\r
-\r
- String refSeqId = null;\r
-\r
- public boolean readAnnotationFile(AlignmentI al, String file,\r
- String protocol)\r
- {\r
- try\r
- {\r
- BufferedReader in = null;\r
- if (protocol.equals(AppletFormatAdapter.FILE))\r
- {\r
- in = new BufferedReader(new FileReader(file));\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.URL))\r
- {\r
- URL url = new URL(file);\r
- in = new BufferedReader(new InputStreamReader(url.openStream()));\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.PASTE))\r
- {\r
- in = new BufferedReader(new StringReader(file));\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))\r
- {\r
- java.io.InputStream is = getClass().getResourceAsStream("/" + file);\r
- if (is != null)\r
- {\r
- in = new BufferedReader(new java.io.InputStreamReader(is));\r
- }\r
- }\r
-\r
- String line, label, description, token;\r
- int graphStyle, index;\r
- int refSeqIndex = 1;\r
- int existingAnnotations = 0;\r
- if (al.getAlignmentAnnotation() != null)\r
- {\r
- existingAnnotations = al.getAlignmentAnnotation().length;\r
- }\r
-\r
- int alWidth = al.getWidth();\r
-\r
- StringTokenizer st;\r
- Annotation[] annotations;\r
- AlignmentAnnotation annotation = null;\r
-\r
- // First confirm this is an Annotation file\r
- boolean jvAnnotationFile = false;\r
- while ((line = in.readLine()) != null)\r
- {\r
- if (line.indexOf("#") == 0)\r
- {\r
- continue;\r
- }\r
-\r
- if (line.indexOf("JALVIEW_ANNOTATION") > -1)\r
- {\r
- jvAnnotationFile = true;\r
- break;\r
- }\r
- }\r
-\r
- if (!jvAnnotationFile)\r
- {\r
- in.close();\r
- return false;\r
- }\r
-\r
- while ((line = in.readLine()) != null)\r
- {\r
- if (line.indexOf("#") == 0\r
- || line.indexOf("JALVIEW_ANNOTATION") > -1\r
- || line.length() == 0)\r
- {\r
- continue;\r
- }\r
-\r
- st = new StringTokenizer(line, "\t");\r
- token = st.nextToken();\r
- if (token.equalsIgnoreCase("COLOUR"))\r
- {\r
- // TODO: use graduated colour def'n here too\r
- colourAnnotations(al, st.nextToken(), st.nextToken());\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("COMBINE"))\r
- {\r
- combineAnnotations(al, st);\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("GRAPHLINE"))\r
- {\r
- addLine(al, st);\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("SEQUENCE_REF"))\r
- {\r
- if (st.hasMoreTokens())\r
- {\r
- refSeq = al.findName(refSeqId = st.nextToken());\r
- if (refSeq == null)\r
- {\r
- refSeqId = null;\r
- }\r
- try\r
- {\r
- refSeqIndex = Integer.parseInt(st.nextToken());\r
- if (refSeqIndex < 1)\r
- {\r
- refSeqIndex = 1;\r
- System.out\r
- .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");\r
- }\r
- } catch (Exception ex)\r
- {\r
- refSeqIndex = 1;\r
- }\r
- }\r
- else\r
- {\r
- refSeq = null;\r
- refSeqId = null;\r
- }\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))\r
- {\r
- addGroup(al, st);\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("PROPERTIES"))\r
- {\r
- addProperties(al, st);\r
- continue;\r
- }\r
-\r
- else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))\r
- {\r
- setBelowAlignment(al, st);\r
- continue;\r
- }\r
- else if (token.equalsIgnoreCase("ALIGNMENT"))\r
- {\r
- addAlignmentDetails(al, st);\r
- continue;\r
- }\r
-\r
- graphStyle = AlignmentAnnotation.getGraphValueFromString(token);\r
- label = st.nextToken();\r
-\r
- index = 0;\r
- annotations = new Annotation[alWidth];\r
- description = null;\r
- float score = Float.NaN;\r
-\r
- if (st.hasMoreTokens())\r
- {\r
- line = st.nextToken();\r
-\r
- if (line.indexOf("|") == -1)\r
- {\r
- description = line;\r
- if (st.hasMoreTokens())\r
- line = st.nextToken();\r
- }\r
-\r
- if (st.hasMoreTokens())\r
- {\r
- // This must be the score\r
- score = Float.valueOf(st.nextToken()).floatValue();\r
- }\r
-\r
- st = new StringTokenizer(line, "|", true);\r
-\r
- boolean emptyColumn = true;\r
- boolean onlyOneElement = (st.countTokens() == 1);\r
-\r
- while (st.hasMoreElements() && index < alWidth)\r
- {\r
- token = st.nextToken().trim();\r
-\r
- if (onlyOneElement)\r
- {\r
- try\r
- {\r
- score = Float.valueOf(token).floatValue();\r
- break;\r
- } catch (NumberFormatException ex)\r
- {\r
- }\r
- }\r
-\r
- if (token.equals("|"))\r
- {\r
- if (emptyColumn)\r
- {\r
- index++;\r
- }\r
-\r
- emptyColumn = true;\r
- }\r
- else\r
- {\r
- annotations[index++] = parseAnnotation(token);\r
- emptyColumn = false;\r
- }\r
- }\r
-\r
- }\r
-\r
- annotation = new AlignmentAnnotation(label, description,\r
- (index == 0) ? null : annotations, 0, 0, graphStyle);\r
-\r
- annotation.score = score;\r
-\r
- if (refSeq != null)\r
- {\r
- annotation.belowAlignment = false;\r
- // make a copy of refSeq so we can find other matches in the alignment\r
- SequenceI referedSeq = refSeq;\r
- do\r
- {\r
- // copy before we do any mapping business.\r
- // TODO: verify that undo/redo with 1:many sequence associated\r
- // annotations can be undone correctly\r
- AlignmentAnnotation ann = new AlignmentAnnotation(annotation);\r
- annotation.createSequenceMapping(referedSeq, refSeqIndex, false);\r
- annotation.adjustForAlignment();\r
- referedSeq.addAlignmentAnnotation(annotation);\r
- al.addAnnotation(annotation);\r
- al.setAnnotationIndex(annotation,\r
- al.getAlignmentAnnotation().length\r
- - existingAnnotations - 1);\r
- // and recover our virgin copy to use again if necessary.\r
- annotation = ann;\r
-\r
- } while (refSeqId != null\r
- && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);\r
- }\r
- else\r
- {\r
- al.addAnnotation(annotation);\r
- al.setAnnotationIndex(annotation,\r
- al.getAlignmentAnnotation().length - existingAnnotations\r
- - 1);\r
- }\r
- }\r
-\r
- } catch (Exception ex)\r
- {\r
- ex.printStackTrace();\r
- System.out.println("Problem reading annotation file: " + ex);\r
- return false;\r
- }\r
- return true;\r
- }\r
-\r
- Annotation parseAnnotation(String string)\r
- {\r
- String desc = null, displayChar = null;\r
- char ss = ' '; // secondaryStructure\r
- float value = 0;\r
- boolean parsedValue = false;\r
-\r
- // find colour here\r
- java.awt.Color colour = null;\r
- int i = string.indexOf("[");\r
- int j = string.indexOf("]");\r
- if (i > -1 && j > -1)\r
- {\r
- UserColourScheme ucs = new UserColourScheme();\r
-\r
- colour = ucs.getColourFromString(string.substring(i + 1, j));\r
-\r
- string = string.substring(0, i) + string.substring(j + 1);\r
- }\r
-\r
- StringTokenizer st = new StringTokenizer(string, ",");\r
- String token;\r
- while (st.hasMoreTokens())\r
- {\r
- token = st.nextToken().trim();\r
- if (token.length() == 0)\r
- {\r
- continue;\r
- }\r
-\r
- if (!parsedValue)\r
- {\r
- try\r
- {\r
- displayChar = token;\r
- value = new Float(token).floatValue();\r
- parsedValue = true;\r
- continue;\r
- } catch (NumberFormatException ex)\r
- {\r
- }\r
- }\r
-\r
- if (token.equals("H") || token.equals("E"))\r
- {\r
- // Either this character represents a helix or sheet\r
- // or an integer which can be displayed\r
- ss = token.charAt(0);\r
- if (displayChar.equals(token.substring(0, 1)))\r
- {\r
- displayChar = "";\r
- }\r
- }\r
- else if (desc == null)\r
- {\r
- desc = token;\r
- }\r
-\r
- }\r
-\r
- if (displayChar != null && displayChar.length() > 1 && desc != null\r
- && desc.length() == 1)\r
- {\r
- String tmp = displayChar;\r
- displayChar = desc;\r
- desc = tmp;\r
- }\r
- /*\r
- * In principle, this code will ensure that the Annotation element generated\r
- * is renderable by any of the applet or application rendering code but\r
- * instead we check for null strings when the display character is rendered.\r
- * if (displayChar==null) { displayChar=""; }\r
- */\r
- Annotation anot = new Annotation(displayChar, desc, ss, value);\r
-\r
- anot.colour = colour;\r
-\r
- return anot;\r
- }\r
-\r
- void colourAnnotations(AlignmentI al, String label, String colour)\r
- {\r
- UserColourScheme ucs = new UserColourScheme(colour);\r
- Annotation[] annotations;\r
- for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
- {\r
- if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))\r
- {\r
- annotations = al.getAlignmentAnnotation()[i].annotations;\r
- for (int j = 0; j < annotations.length; j++)\r
- {\r
- if (annotations[j] != null)\r
- {\r
- annotations[j].colour = ucs.findColour('A');\r
- }\r
- }\r
- }\r
- }\r
- }\r
-\r
- void combineAnnotations(AlignmentI al, StringTokenizer st)\r
- {\r
- int graphGroup = -1;\r
- String group = st.nextToken();\r
- // First make sure we are not overwriting the graphIndex\r
- for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
- {\r
- if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
- {\r
- graphGroup = al.getAlignmentAnnotation()[i].graphGroup + 1;\r
- al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
- break;\r
- }\r
- }\r
-\r
- // Now update groups\r
- while (st.hasMoreTokens())\r
- {\r
- group = st.nextToken();\r
- for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
- {\r
- if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
- {\r
- al.getAlignmentAnnotation()[i].graphGroup = graphGroup;\r
- break;\r
- }\r
- }\r
- }\r
- }\r
-\r
- void addLine(AlignmentI al, StringTokenizer st)\r
- {\r
- String group = st.nextToken();\r
- AlignmentAnnotation annotation = null;\r
-\r
- for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
- {\r
- if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))\r
- {\r
- annotation = al.getAlignmentAnnotation()[i];\r
- break;\r
- }\r
- }\r
-\r
- if (annotation == null)\r
- {\r
- return;\r
- }\r
- float value = new Float(st.nextToken()).floatValue();\r
- String label = st.hasMoreTokens() ? st.nextToken() : null;\r
- java.awt.Color colour = null;\r
- if (st.hasMoreTokens())\r
- {\r
- UserColourScheme ucs = new UserColourScheme(st.nextToken());\r
- colour = ucs.findColour('A');\r
- }\r
-\r
- annotation.setThreshold(new GraphLine(value, label, colour));\r
- }\r
- void addGroup(AlignmentI al, StringTokenizer st)\r
- {\r
- SequenceGroup sg = new SequenceGroup();\r
- sg.setName(st.nextToken());\r
- String rng ="";\r
- try {\r
- rng = st.nextToken();\r
- if (rng.length()>0 && !rng.startsWith("*"))\r
- {\r
- sg.setStartRes(Integer.parseInt(rng) - 1);\r
- } else {\r
- sg.setStartRes(0);\r
- }\r
- rng = st.nextToken();\r
- if (rng.length()>0 && !rng.startsWith("*"))\r
- {\r
- sg.setEndRes(Integer.parseInt(rng) - 1);\r
- } else {\r
- sg.setEndRes(al.getWidth()-1);\r
- }\r
- } catch (Exception e)\r
- {\r
- System.err.println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"+rng+"' - assuming alignment width for group.");\r
- // assume group is full width\r
- sg.setStartRes(0);\r
- sg.setEndRes(al.getWidth()-1);\r
- }\r
-\r
- String index = st.nextToken();\r
- if (index.equals("-1"))\r
- {\r
- while (st.hasMoreElements())\r
- {\r
- sg.addSequence(al.findName(st.nextToken()), false);\r
- }\r
- }\r
- else\r
- {\r
- StringTokenizer st2 = new StringTokenizer(index, ",");\r
-\r
- while (st2.hasMoreTokens())\r
- {\r
- String tmp = st2.nextToken();\r
- if (tmp.equals("*"))\r
- {\r
- for (int i = 0; i < al.getHeight(); i++)\r
- {\r
- sg.addSequence(al.getSequenceAt(i), false);\r
- }\r
- }\r
- else if (tmp.indexOf("-") >= 0)\r
- {\r
- StringTokenizer st3 = new StringTokenizer(tmp, "-");\r
-\r
- int start = (Integer.parseInt(st3.nextToken()));\r
- int end = (Integer.parseInt(st3.nextToken()));\r
-\r
- if (end > start)\r
- {\r
- for (int i = start; i <= end; i++)\r
- {\r
- sg.addSequence(al.getSequenceAt(i - 1), false);\r
- }\r
- }\r
- }\r
- else\r
- {\r
- sg\r
- .addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1),\r
- false);\r
- }\r
- }\r
- }\r
-\r
- if (refSeq != null)\r
- {\r
- sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);\r
- sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);\r
- sg.setSeqrep(refSeq);\r
- }\r
-\r
- if (sg.getSize() > 0)\r
- {\r
- al.addGroup(sg);\r
- }\r
- }\r
-\r
- void addProperties(AlignmentI al, StringTokenizer st)\r
- {\r
-\r
- // So far we have only added groups to the annotationHash,\r
- // the idea is in the future properties can be added to\r
- // alignments, other annotations etc\r
- if (al.getGroups() == null)\r
- {\r
- return;\r
- }\r
- SequenceGroup sg = null;\r
-\r
- String name = st.nextToken();\r
-\r
- Vector groups = al.getGroups();\r
- for (int i = 0; i < groups.size(); i++)\r
- {\r
- sg = (SequenceGroup) groups.elementAt(i);\r
- if (sg.getName().equals(name))\r
- {\r
- break;\r
- }\r
- else\r
- {\r
- sg = null;\r
- }\r
- }\r
-\r
- if (sg != null)\r
- {\r
- String keyValue, key, value;\r
- ColourSchemeI def = sg.cs;\r
- sg.cs = null;\r
- while (st.hasMoreTokens())\r
- {\r
- keyValue = st.nextToken();\r
- key = keyValue.substring(0, keyValue.indexOf("="));\r
- value = keyValue.substring(keyValue.indexOf("=") + 1);\r
-\r
- if (key.equalsIgnoreCase("description"))\r
- {\r
- sg.setDescription(value);\r
- }\r
- else if (key.equalsIgnoreCase("colour"))\r
- {\r
- sg.cs = ColourSchemeProperty.getColour(al, value);\r
- }\r
- else if (key.equalsIgnoreCase("pidThreshold"))\r
- {\r
- sg.cs.setThreshold(Integer.parseInt(value), true);\r
-\r
- }\r
- else if (key.equalsIgnoreCase("consThreshold"))\r
- {\r
- sg.cs.setConservationInc(Integer.parseInt(value));\r
- Conservation c = new Conservation("Group",\r
- ResidueProperties.propHash, 3, sg.getSequences(null), sg\r
- .getStartRes(), sg.getEndRes() + 1);\r
-\r
- c.calculate();\r
- c.verdict(false, 25);\r
-\r
- sg.cs.setConservation(c);\r
-\r
- }\r
- else if (key.equalsIgnoreCase("outlineColour"))\r
- {\r
- sg.setOutlineColour(new UserColourScheme(value).findColour('A'));\r
- }\r
- else if (key.equalsIgnoreCase("displayBoxes"))\r
- {\r
- sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());\r
- }\r
- else if (key.equalsIgnoreCase("showUnconserved"))\r
- {\r
- sg.setShowunconserved(Boolean.valueOf(value).booleanValue());\r
- }\r
- else if (key.equalsIgnoreCase("displayText"))\r
- {\r
- sg.setDisplayText(Boolean.valueOf(value).booleanValue());\r
- }\r
- else if (key.equalsIgnoreCase("colourText"))\r
- {\r
- sg.setColourText(Boolean.valueOf(value).booleanValue());\r
- }\r
- else if (key.equalsIgnoreCase("textCol1"))\r
- {\r
- sg.textColour = new UserColourScheme(value).findColour('A');\r
- }\r
- else if (key.equalsIgnoreCase("textCol2"))\r
- {\r
- sg.textColour2 = new UserColourScheme(value).findColour('A');\r
- }\r
- else if (key.equalsIgnoreCase("textColThreshold"))\r
- {\r
- sg.thresholdTextColour = Integer.parseInt(value);\r
- }\r
- else if (key.equalsIgnoreCase("idColour"))\r
- {\r
- // consider warning if colour doesn't resolve to a real colour\r
- sg.setIdColour((def = new UserColourScheme(value))\r
- .findColour('A'));\r
- }\r
- else if (key.equalsIgnoreCase("hide"))\r
- {\r
- // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
- sg.setHidereps(true);\r
- }\r
- else if (key.equalsIgnoreCase("hidecols"))\r
- {\r
- // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847\r
- sg.setHideCols(true);\r
- }\r
- sg.recalcConservation();\r
- }\r
- if (sg.cs == null)\r
- {\r
- sg.cs = def;\r
- }\r
- }\r
- }\r
-\r
- void setBelowAlignment(AlignmentI al, StringTokenizer st)\r
- {\r
- String token;\r
- AlignmentAnnotation aa;\r
- while (st.hasMoreTokens())\r
- {\r
- token = st.nextToken();\r
- for (int i = 0; i < al.getAlignmentAnnotation().length; i++)\r
- {\r
- aa = al.getAlignmentAnnotation()[i];\r
- if (aa.sequenceRef == refSeq && aa.label.equals(token))\r
- {\r
- aa.belowAlignment = true;\r
- }\r
- }\r
- }\r
- }\r
-\r
- void addAlignmentDetails(AlignmentI al, StringTokenizer st)\r
- {\r
- String keyValue, key, value;\r
- while (st.hasMoreTokens())\r
- {\r
- keyValue = st.nextToken();\r
- key = keyValue.substring(0, keyValue.indexOf("="));\r
- value = keyValue.substring(keyValue.indexOf("=") + 1);\r
- al.setProperty(key, value);\r
- }\r
- }\r
-\r
- /**\r
- * Write annotations as a CSV file of the form 'label, value, value, ...' for\r
- * each row.\r
- * \r
- * @param annotations\r
- * @return CSV file as a string.\r
- */\r
- public String printCSVAnnotations(AlignmentAnnotation[] annotations)\r
- {\r
- StringBuffer sp = new StringBuffer();\r
- for (int i = 0; i < annotations.length; i++)\r
- {\r
- String atos = annotations[i].toString();\r
- int p = 0;\r
- do\r
- {\r
- int cp = atos.indexOf("\n", p);\r
- sp.append(annotations[i].label);\r
- sp.append(",");\r
- if (cp > p)\r
- {\r
- sp.append(atos.substring(p, cp + 1));\r
- }\r
- else\r
- {\r
- sp.append(atos.substring(p));\r
- sp.append("\n");\r
- }\r
- p = cp + 1;\r
- } while (p > 0);\r
- }\r
- return sp.toString();\r
- }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.io;
+
+import jalview.analysis.Conservation;
+import jalview.api.AlignViewportI;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.GraphLine;
+import jalview.datamodel.HiddenSequences;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.PDBEntry.Type;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.gui.Desktop;
+import jalview.schemes.ColourSchemeI;
+import jalview.schemes.ColourSchemeProperty;
+import jalview.structure.StructureSelectionManager;
+import jalview.util.ColorUtils;
+
+import java.awt.Color;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.io.InputStreamReader;
+import java.io.StringReader;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.BitSet;
+import java.util.Enumeration;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Map;
+import java.util.StringTokenizer;
+import java.util.Vector;
+
+public class AnnotationFile
+{
+ public AnnotationFile()
+ {
+ init();
+ }
+
+ /**
+ * character used to write newlines
+ */
+ protected String newline = System.getProperty("line.separator");
+
+ /**
+ * set new line string and reset the output buffer
+ *
+ * @param nl
+ */
+ public void setNewlineString(String nl)
+ {
+ newline = nl;
+ init();
+ }
+
+ public String getNewlineString()
+ {
+ return newline;
+ }
+
+ StringBuffer text;
+
+ private void init()
+ {
+ text = new StringBuffer("JALVIEW_ANNOTATION" + newline + "# Created: "
+ + new java.util.Date() + newline + newline);
+ refSeq = null;
+ refSeqId = null;
+ }
+
+ /**
+ * convenience method for pre-2.9 annotation files which have no view, hidden
+ * columns or hidden row keywords.
+ *
+ * @param annotations
+ * @param list
+ * @param properties
+ * @return annotation file as a string.
+ */
+ public String printAnnotations(AlignmentAnnotation[] annotations,
+ List<SequenceGroup> list, Hashtable properties)
+ {
+ return printAnnotations(annotations, list, properties, null, null, null);
+
+ }
+
+ /**
+ * hold all the information about a particular view definition read from or
+ * written out in an annotations file.
+ */
+ public class ViewDef
+ {
+ public String viewname;
+
+ public HiddenSequences hidseqs;
+
+ public ColumnSelection hiddencols;
+
+ public Vector visibleGroups;
+
+ public Hashtable hiddenRepSeqs;
+
+ public ViewDef(String viewname, HiddenSequences hidseqs,
+ ColumnSelection hiddencols, Hashtable hiddenRepSeqs)
+ {
+ this.viewname = viewname;
+ this.hidseqs = hidseqs;
+ this.hiddencols = hiddencols;
+ this.hiddenRepSeqs = hiddenRepSeqs;
+ }
+ }
+
+ /**
+ * Prepare an annotation file given a set of annotations, groups, alignment
+ * properties and views.
+ *
+ * @param annotations
+ * @param list
+ * @param properties
+ * @param views
+ * @return annotation file
+ */
+ public String printAnnotations(AlignmentAnnotation[] annotations,
+ List<SequenceGroup> list, Hashtable properties,
+ ColumnSelection cs, AlignmentI al, ViewDef view)
+ {
+ if (view != null)
+ {
+ if (view.viewname != null)
+ {
+ text.append("VIEW_DEF\t" + view.viewname + "\n");
+ }
+ if (list == null)
+ {
+ list = view.visibleGroups;
+ }
+ if (cs == null)
+ {
+ cs = view.hiddencols;
+ }
+ if (al == null)
+ {
+ // add hidden rep sequences.
+ }
+ }
+ // first target - store and restore all settings for a view.
+ if (al != null && al.hasSeqrep())
+ {
+ text.append("VIEW_SETREF\t" + al.getSeqrep().getName() + "\n");
+ }
+ if (cs != null && cs.hasHiddenColumns())
+ {
+ text.append("VIEW_HIDECOLS\t");
+ List<int[]> hc = cs.getHiddenColumns();
+ boolean comma = false;
+ for (int[] r : hc)
+ {
+ if (!comma)
+ {
+ comma = true;
+ }
+ else
+ {
+ text.append(",");
+ }
+ text.append(r[0]);
+ text.append("-");
+ text.append(r[1]);
+ }
+ text.append("\n");
+ }
+ // TODO: allow efficient recovery of annotation data shown in several
+ // different views
+ if (annotations != null)
+ {
+ boolean oneColour = true;
+ AlignmentAnnotation row;
+ String comma;
+ SequenceI refSeq = null;
+ SequenceGroup refGroup = null;
+
+ StringBuffer colours = new StringBuffer();
+ StringBuffer graphLine = new StringBuffer();
+ StringBuffer rowprops = new StringBuffer();
+ Hashtable<Integer, String> graphGroup = new Hashtable<Integer, String>();
+ Hashtable<Integer, Object[]> graphGroup_refs = new Hashtable<Integer, Object[]>();
+ BitSet graphGroupSeen = new BitSet();
+
+ java.awt.Color color;
+
+ for (int i = 0; i < annotations.length; i++)
+ {
+ row = annotations[i];
+
+ if (!row.visible
+ && !row.hasScore()
+ && !(row.graphGroup > -1 && graphGroupSeen
+ .get(row.graphGroup)))
+ {
+ continue;
+ }
+
+ color = null;
+ oneColour = true;
+
+ // mark any sequence references for the row
+ writeSequence_Ref(refSeq, row.sequenceRef);
+ refSeq = row.sequenceRef;
+ // mark any group references for the row
+ writeGroup_Ref(refGroup, row.groupRef);
+ refGroup = row.groupRef;
+
+ boolean hasGlyphs = row.hasIcons, hasLabels = row.hasText, hasValues = row.hasScore, hasText = false;
+ // lookahead to check what the annotation row object actually contains.
+ for (int j = 0; row.annotations != null
+ && j < row.annotations.length
+ && (!hasGlyphs || !hasLabels || !hasValues); j++)
+ {
+ if (row.annotations[j] != null)
+ {
+ hasLabels |= (row.annotations[j].displayCharacter != null
+ && row.annotations[j].displayCharacter.length() > 0 && !row.annotations[j].displayCharacter
+ .equals(" "));
+ hasGlyphs |= (row.annotations[j].secondaryStructure != 0 && row.annotations[j].secondaryStructure != ' ');
+ hasValues |= (!Float.isNaN(row.annotations[j].value)); // NaNs can't
+ // be
+ // rendered..
+ hasText |= (row.annotations[j].description != null && row.annotations[j].description
+ .length() > 0);
+ }
+ }
+
+ if (row.graph == AlignmentAnnotation.NO_GRAPH)
+ {
+ text.append("NO_GRAPH\t");
+ hasValues = false; // only secondary structure
+ // hasLabels = false; // and annotation description string.
+ }
+ else
+ {
+ if (row.graph == AlignmentAnnotation.BAR_GRAPH)
+ {
+ text.append("BAR_GRAPH\t");
+ hasGlyphs = false; // no secondary structure
+
+ }
+ else if (row.graph == AlignmentAnnotation.LINE_GRAPH)
+ {
+ hasGlyphs = false; // no secondary structure
+ text.append("LINE_GRAPH\t");
+ }
+
+ if (row.getThreshold() != null)
+ {
+ graphLine.append("GRAPHLINE\t");
+ graphLine.append(row.label);
+ graphLine.append("\t");
+ graphLine.append(row.getThreshold().value);
+ graphLine.append("\t");
+ graphLine.append(row.getThreshold().label);
+ graphLine.append("\t");
+ graphLine.append(jalview.util.Format.getHexString(row
+ .getThreshold().colour));
+ graphLine.append(newline);
+ }
+
+ if (row.graphGroup > -1)
+ {
+ graphGroupSeen.set(row.graphGroup);
+ Integer key = new Integer(row.graphGroup);
+ if (graphGroup.containsKey(key))
+ {
+ graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);
+
+ }
+ else
+ {
+ graphGroup_refs.put(key, new Object[] { refSeq, refGroup });
+ graphGroup.put(key, row.label);
+ }
+ }
+ }
+
+ text.append(row.label + "\t");
+ if (row.description != null)
+ {
+ text.append(row.description + "\t");
+ }
+ for (int j = 0; row.annotations != null
+ && j < row.annotations.length; j++)
+ {
+ if (refSeq != null
+ && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))
+ {
+ continue;
+ }
+
+ if (row.annotations[j] != null)
+ {
+ comma = "";
+ if (hasGlyphs) // could be also hasGlyphs || ...
+ {
+
+ text.append(comma);
+ if (row.annotations[j].secondaryStructure != ' ')
+ {
+ // only write out the field if its not whitespace.
+ text.append(row.annotations[j].secondaryStructure);
+ }
+ comma = ",";
+ }
+ if (hasValues)
+ {
+ if (!Float.isNaN(row.annotations[j].value))
+ {
+ text.append(comma + row.annotations[j].value);
+ }
+ else
+ {
+ // System.err.println("Skipping NaN - not valid value.");
+ text.append(comma + 0f);// row.annotations[j].value);
+ }
+ comma = ",";
+ }
+ if (hasLabels)
+ {
+ // TODO: labels are emitted after values for bar graphs.
+ if // empty labels are allowed, so
+ (row.annotations[j].displayCharacter != null
+ && row.annotations[j].displayCharacter.length() > 0
+ && !row.annotations[j].displayCharacter.equals(" "))
+ {
+ text.append(comma + row.annotations[j].displayCharacter);
+ comma = ",";
+ }
+ }
+ if (hasText)
+ {
+ if (row.annotations[j].description != null
+ && row.annotations[j].description.length() > 0
+ && !row.annotations[j].description
+ .equals(row.annotations[j].displayCharacter))
+ {
+ text.append(comma + row.annotations[j].description);
+ comma = ",";
+ }
+ }
+ if (color != null && !color.equals(row.annotations[j].colour))
+ {
+ oneColour = false;
+ }
+
+ color = row.annotations[j].colour;
+
+ if (row.annotations[j].colour != null
+ && row.annotations[j].colour != java.awt.Color.black)
+ {
+ text.append(comma
+ + "["
+ + jalview.util.Format
+ .getHexString(row.annotations[j].colour)
+ + "]");
+ comma = ",";
+ }
+ }
+ text.append("|");
+ }
+
+ if (row.hasScore())
+ {
+ text.append("\t" + row.score);
+ }
+
+ text.append(newline);
+
+ if (color != null && color != java.awt.Color.black && oneColour)
+ {
+ colours.append("COLOUR\t");
+ colours.append(row.label);
+ colours.append("\t");
+ colours.append(jalview.util.Format.getHexString(color));
+ colours.append(newline);
+ }
+ if (row.scaleColLabel || row.showAllColLabels
+ || row.centreColLabels)
+ {
+ rowprops.append("ROWPROPERTIES\t");
+ rowprops.append(row.label);
+ rowprops.append("\tscaletofit=");
+ rowprops.append(row.scaleColLabel);
+ rowprops.append("\tshowalllabs=");
+ rowprops.append(row.showAllColLabels);
+ rowprops.append("\tcentrelabs=");
+ rowprops.append(row.centreColLabels);
+ rowprops.append(newline);
+ }
+ if (graphLine.length() > 0)
+ {
+ text.append(graphLine.toString());
+ graphLine.setLength(0);
+ }
+ }
+
+ text.append(newline);
+
+ text.append(colours.toString());
+ if (graphGroup.size() > 0)
+ {
+ SequenceI oldRefSeq = refSeq;
+ SequenceGroup oldRefGroup = refGroup;
+ for (Map.Entry<Integer, String> combine_statement : graphGroup
+ .entrySet())
+ {
+ Object[] seqRefAndGroup = graphGroup_refs.get(combine_statement
+ .getKey());
+
+ writeSequence_Ref(refSeq, (SequenceI) seqRefAndGroup[0]);
+ refSeq = (SequenceI) seqRefAndGroup[0];
+
+ writeGroup_Ref(refGroup, (SequenceGroup) seqRefAndGroup[1]);
+ refGroup = (SequenceGroup) seqRefAndGroup[1];
+ text.append("COMBINE\t");
+ text.append(combine_statement.getValue());
+ text.append(newline);
+ }
+ writeSequence_Ref(refSeq, oldRefSeq);
+ refSeq = oldRefSeq;
+
+ writeGroup_Ref(refGroup, oldRefGroup);
+ refGroup = oldRefGroup;
+ }
+ text.append(rowprops.toString());
+ }
+
+ if (list != null)
+ {
+ printGroups(list);
+ }
+
+ if (properties != null)
+ {
+ text.append(newline);
+ text.append(newline);
+ text.append("ALIGNMENT");
+ Enumeration en = properties.keys();
+ while (en.hasMoreElements())
+ {
+ String key = en.nextElement().toString();
+ text.append("\t");
+ text.append(key);
+ text.append("=");
+ text.append(properties.get(key));
+ }
+ // TODO: output alignment visualization settings here if required
+ // iterate through one or more views, defining, marking columns and rows
+ // as visible/hidden, and emmitting view properties.
+ // View specific annotation is
+ }
+
+ return text.toString();
+ }
+
+ private Object writeGroup_Ref(SequenceGroup refGroup,
+ SequenceGroup next_refGroup)
+ {
+ if (next_refGroup == null)
+ {
+
+ if (refGroup != null)
+ {
+ text.append(newline);
+ text.append("GROUP_REF\t");
+ text.append("ALIGNMENT");
+ text.append(newline);
+ }
+ return true;
+ }
+ else
+ {
+ if (refGroup == null || refGroup != next_refGroup)
+ {
+ text.append(newline);
+ text.append("GROUP_REF\t");
+ text.append(next_refGroup.getName());
+ text.append(newline);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private boolean writeSequence_Ref(SequenceI refSeq, SequenceI next_refSeq)
+ {
+
+ if (next_refSeq == null)
+ {
+ if (refSeq != null)
+ {
+ text.append(newline);
+ text.append("SEQUENCE_REF\t");
+ text.append("ALIGNMENT");
+ text.append(newline);
+ return true;
+ }
+ }
+ else
+ {
+ if (refSeq == null || refSeq != next_refSeq)
+ {
+ text.append(newline);
+ text.append("SEQUENCE_REF\t");
+ text.append(next_refSeq.getName());
+ text.append(newline);
+ return true;
+ }
+ }
+ return false;
+ }
+
+ public void printGroups(List<SequenceGroup> list)
+ {
+ SequenceI seqrep = null;
+ for (SequenceGroup sg : list)
+ {
+ if (!sg.hasSeqrep())
+ {
+ text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"
+ + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1)
+ + "\t" + "-1\t");
+ seqrep = null;
+ }
+ else
+ {
+ seqrep = sg.getSeqrep();
+ text.append("SEQUENCE_REF\t");
+ text.append(seqrep.getName());
+ text.append(newline);
+ text.append("SEQUENCE_GROUP\t");
+ text.append(sg.getName());
+ text.append("\t");
+ text.append((seqrep.findPosition(sg.getStartRes())));
+ text.append("\t");
+ text.append((seqrep.findPosition(sg.getEndRes())));
+ text.append("\t");
+ text.append("-1\t");
+ }
+ for (int s = 0; s < sg.getSize(); s++)
+ {
+ text.append(sg.getSequenceAt(s).getName());
+ text.append("\t");
+ }
+ text.append(newline);
+ text.append("PROPERTIES\t");
+ text.append(sg.getName());
+ text.append("\t");
+
+ if (sg.getDescription() != null)
+ {
+ text.append("description=");
+ text.append(sg.getDescription());
+ text.append("\t");
+ }
+ if (sg.cs != null)
+ {
+ text.append("colour=");
+ text.append(sg.cs.toString());
+ text.append("\t");
+ if (sg.cs.getThreshold() != 0)
+ {
+ text.append("pidThreshold=");
+ text.append(sg.cs.getThreshold());
+ }
+ if (sg.cs.conservationApplied())
+ {
+ text.append("consThreshold=");
+ text.append(sg.cs.getConservationInc());
+ text.append("\t");
+ }
+ }
+ text.append("outlineColour=");
+ text.append(jalview.util.Format.getHexString(sg.getOutlineColour()));
+ text.append("\t");
+
+ text.append("displayBoxes=");
+ text.append(sg.getDisplayBoxes());
+ text.append("\t");
+ text.append("displayText=");
+ text.append(sg.getDisplayText());
+ text.append("\t");
+ text.append("colourText=");
+ text.append(sg.getColourText());
+ text.append("\t");
+ text.append("showUnconserved=");
+ text.append(sg.getShowNonconserved());
+ text.append("\t");
+ if (sg.textColour != java.awt.Color.black)
+ {
+ text.append("textCol1=");
+ text.append(jalview.util.Format.getHexString(sg.textColour));
+ text.append("\t");
+ }
+ if (sg.textColour2 != java.awt.Color.white)
+ {
+ text.append("textCol2=");
+ text.append(jalview.util.Format.getHexString(sg.textColour2));
+ text.append("\t");
+ }
+ if (sg.thresholdTextColour != 0)
+ {
+ text.append("textColThreshold=");
+ text.append(sg.thresholdTextColour);
+ text.append("\t");
+ }
+ if (sg.idColour != null)
+ {
+ text.append("idColour=");
+ text.append(jalview.util.Format.getHexString(sg.idColour));
+ text.append("\t");
+ }
+ if (sg.isHidereps())
+ {
+ text.append("hide=true\t");
+ }
+ if (sg.isHideCols())
+ {
+ text.append("hidecols=true\t");
+ }
+ if (seqrep != null)
+ {
+ // terminate the last line and clear the sequence ref for the group
+ text.append(newline);
+ text.append("SEQUENCE_REF");
+ }
+ text.append(newline);
+ text.append(newline);
+
+ }
+ }
+
+ SequenceI refSeq = null;
+
+ String refSeqId = null;
+
+ public boolean annotateAlignmentView(AlignViewportI viewport,
+ String file, DataSourceType protocol)
+ {
+ ColumnSelection colSel = viewport.getColumnSelection();
+ if (colSel == null)
+ {
+ colSel = new ColumnSelection();
+ }
+ boolean rslt = readAnnotationFile(viewport.getAlignment(), colSel,
+ file, protocol);
+ if (rslt && (colSel.hasSelectedColumns() || colSel.hasHiddenColumns()))
+ {
+ viewport.setColumnSelection(colSel);
+ }
+
+ return rslt;
+ }
+
+ public boolean readAnnotationFile(AlignmentI al, String file,
+ DataSourceType sourceType)
+ {
+ return readAnnotationFile(al, null, file, sourceType);
+ }
+
+ public boolean readAnnotationFile(AlignmentI al, ColumnSelection colSel,
+ String file, DataSourceType sourceType)
+ {
+ baseUri = "";
+ BufferedReader in = null;
+ try
+ {
+ if (sourceType == DataSourceType.FILE)
+ {
+ in = new BufferedReader(new FileReader(file));
+ baseUri = new File(file).getParent();
+ if (baseUri == null)
+ {
+ baseUri = "";
+ }
+ else
+ {
+ baseUri += "/";
+ }
+ }
+ else if (sourceType == DataSourceType.URL)
+ {
+ URL url = new URL(file);
+ in = new BufferedReader(new InputStreamReader(url.openStream()));
+ String bs = url.toExternalForm();
+ baseUri = bs.substring(0, bs.indexOf(url.getHost())
+ + url.getHost().length());
+ baseUri += url.toURI().getPath();
+ if (baseUri.lastIndexOf("/") > -1)
+ {
+ baseUri = baseUri.substring(0, baseUri.lastIndexOf("/")) + "/";
+ }
+ }
+ else if (sourceType == DataSourceType.PASTE)
+ {
+ in = new BufferedReader(new StringReader(file));
+ // TODO - support mimencoded PDBs for a paste.. ?
+ baseUri = "";
+ }
+ else if (sourceType == DataSourceType.CLASSLOADER)
+ {
+ java.io.InputStream is = getClass().getResourceAsStream("/" + file);
+ if (is != null)
+ {
+ in = new BufferedReader(new java.io.InputStreamReader(is));
+ // TODO: this probably doesn't work for classloader - needs a test
+ baseUri = new File("/" + file).getParent() + "/";
+ }
+ }
+ if (in != null)
+ {
+ return parseAnnotationFrom(al, colSel, in);
+ }
+
+ } catch (Exception ex)
+ {
+ ex.printStackTrace();
+ System.out.println("Problem reading annotation file: " + ex);
+ if (nlinesread > 0)
+ {
+ System.out.println("Last read line " + nlinesread + ": '"
+ + lastread + "' (first 80 chars) ...");
+ }
+ return false;
+ }
+ return false;
+ }
+
+ long nlinesread = 0;
+
+ String lastread = "";
+
+ /**
+ * used for resolving absolute references to resources relative to
+ * annotationFile location
+ */
+ String baseUri = "";
+
+ private static String GRAPHLINE = "GRAPHLINE", COMBINE = "COMBINE",
+ STRUCTMODEL = "STRUCTMODEL";
+
+ public boolean parseAnnotationFrom(AlignmentI al, ColumnSelection colSel,
+ BufferedReader in) throws Exception
+ {
+ nlinesread = 0;
+ ArrayList<Object[]> combineAnnotation_calls = new ArrayList<Object[]>();
+ ArrayList<Object[]> deferredAnnotation_calls = new ArrayList<Object[]>();
+ boolean modified = false;
+ String groupRef = null;
+ Hashtable groupRefRows = new Hashtable();
+
+ Hashtable autoAnnots = new Hashtable();
+ {
+ String line, label, description, token;
+ int graphStyle, index;
+ int refSeqIndex = 1;
+ int existingAnnotations = 0;
+ // when true - will add new rows regardless of whether they are duplicate
+ // auto-annotation like consensus or conservation graphs
+ boolean overrideAutoAnnot = false;
+ if (al.getAlignmentAnnotation() != null)
+ {
+ existingAnnotations = al.getAlignmentAnnotation().length;
+ if (existingAnnotations > 0)
+ {
+ AlignmentAnnotation[] aa = al.getAlignmentAnnotation();
+ for (int aai = 0; aai < aa.length; aai++)
+ {
+ if (aa[aai].autoCalculated)
+ {
+ // make a note of the name and description
+ autoAnnots.put(
+ autoAnnotsKey(aa[aai], aa[aai].sequenceRef,
+ (aa[aai].groupRef == null ? null
+ : aa[aai].groupRef.getName())),
+ new Integer(1));
+ }
+ }
+ }
+ }
+
+ int alWidth = al.getWidth();
+
+ StringTokenizer st;
+ Annotation[] annotations;
+ AlignmentAnnotation annotation = null;
+
+ // First confirm this is an Annotation file
+ boolean jvAnnotationFile = false;
+ while ((line = in.readLine()) != null)
+ {
+ nlinesread++;
+ lastread = new String(line);
+ if (line.indexOf("#") == 0)
+ {
+ continue;
+ }
+
+ if (line.indexOf("JALVIEW_ANNOTATION") > -1)
+ {
+ jvAnnotationFile = true;
+ break;
+ }
+ }
+
+ if (!jvAnnotationFile)
+ {
+ in.close();
+ return false;
+ }
+
+ while ((line = in.readLine()) != null)
+ {
+ nlinesread++;
+ lastread = new String(line);
+ if (line.indexOf("#") == 0
+ || line.indexOf("JALVIEW_ANNOTATION") > -1
+ || line.length() == 0)
+ {
+ continue;
+ }
+
+ st = new StringTokenizer(line, "\t");
+ token = st.nextToken();
+ if (token.equalsIgnoreCase("COLOUR"))
+ {
+ // TODO: use graduated colour def'n here too
+ colourAnnotations(al, st.nextToken(), st.nextToken());
+ modified = true;
+ continue;
+ }
+
+ else if (token.equalsIgnoreCase(COMBINE))
+ {
+ // keep a record of current state and resolve groupRef at end
+ combineAnnotation_calls
+ .add(new Object[] { st, refSeq, groupRef });
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase("ROWPROPERTIES"))
+ {
+ addRowProperties(al, st);
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase(GRAPHLINE))
+ {
+ // resolve at end
+ deferredAnnotation_calls.add(new Object[] { GRAPHLINE, st,
+ refSeq, groupRef });
+ modified = true;
+ continue;
+ }
+
+ else if (token.equalsIgnoreCase("SEQUENCE_REF"))
+ {
+ if (st.hasMoreTokens())
+ {
+ refSeq = al.findName(refSeqId = st.nextToken());
+ if (refSeq == null)
+ {
+ refSeqId = null;
+ }
+ try
+ {
+ refSeqIndex = Integer.parseInt(st.nextToken());
+ if (refSeqIndex < 1)
+ {
+ refSeqIndex = 1;
+ System.out
+ .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");
+ }
+ } catch (Exception ex)
+ {
+ refSeqIndex = 1;
+ }
+ }
+ else
+ {
+ refSeq = null;
+ refSeqId = null;
+ }
+ continue;
+ }
+ else if (token.equalsIgnoreCase("GROUP_REF"))
+ {
+ // Group references could be forward or backwards, so they are
+ // resolved after the whole file is read in
+ groupRef = null;
+ if (st.hasMoreTokens())
+ {
+ groupRef = st.nextToken();
+ if (groupRef.length() < 1)
+ {
+ groupRef = null; // empty string
+ }
+ else
+ {
+ if (groupRefRows.get(groupRef) == null)
+ {
+ groupRefRows.put(groupRef, new Vector());
+ }
+ }
+ }
+ continue;
+ }
+ else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))
+ {
+ addGroup(al, st);
+ modified = true;
+ continue;
+ }
+
+ else if (token.equalsIgnoreCase("PROPERTIES"))
+ {
+ addProperties(al, st);
+ modified = true;
+ continue;
+ }
+
+ else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))
+ {
+ setBelowAlignment(al, st);
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase("ALIGNMENT"))
+ {
+ addAlignmentDetails(al, st);
+ modified = true;
+ continue;
+ }
+ // else if (token.equalsIgnoreCase("VIEW_DEF"))
+ // {
+ // addOrSetView(al,st);
+ // modified = true;
+ // continue;
+ // }
+ else if (token.equalsIgnoreCase("VIEW_SETREF"))
+ {
+ if (refSeq != null)
+ {
+ al.setSeqrep(refSeq);
+ }
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase("VIEW_HIDECOLS"))
+ {
+ if (st.hasMoreTokens())
+ {
+ if (colSel == null)
+ {
+ colSel = new ColumnSelection();
+ }
+ parseHideCols(colSel, st.nextToken());
+ }
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase("HIDE_INSERTIONS"))
+ {
+ SequenceI sr = refSeq == null ? al.getSeqrep() : refSeq;
+ if (sr == null)
+ {
+ sr = al.getSequenceAt(0);
+ }
+ if (sr != null)
+ {
+ if (colSel == null)
+ {
+ System.err
+ .println("Cannot process HIDE_INSERTIONS without an alignment view: Ignoring line: "
+ + line);
+ }
+ else
+ {
+ // consider deferring this till after the file has been parsed ?
+ colSel.hideInsertionsFor(sr);
+ }
+ }
+ modified = true;
+ continue;
+ }
+ else if (token.equalsIgnoreCase(STRUCTMODEL))
+ {
+ boolean failedtoadd = true;
+ // expect
+ // STRUCTMODEL <Query> <TemplateSeqId> <ModelFile> <FastaMappingFile>
+ // <Confidence> <%.I.D>
+ // <MatchStart> <MatchEnd> <Coverage> [<Other Information>]
+ String querySeqId = !st.hasMoreTokens() ? "" : st.nextToken();
+ SequenceI querySeq = al.findName(querySeqId);
+ if (st.hasMoreTokens()) {
+ refSeq = al.findName(refSeqId = st.nextToken());
+ if (refSeq == null)
+ {
+ System.err.println("Couldn't locate " + refSeqId
+ + " in the alignment for STRUCTMODEL");
+ refSeqId = null;
+ }
+ else
+ {
+ String tempId = st.nextToken();
+ String fastaMapping = st.nextToken();
+ String confidence = !st.hasMoreTokens() ? "" : 100
+ * Double.valueOf(st.nextToken()) + "";
+ String pid = !st.hasMoreTokens() ? "" : st.nextToken();
+ String alignRange = !st.hasMoreTokens() ? "" : st.nextToken()
+ + "-" + st.nextToken();
+ String otherInfo = !st.hasMoreTokens() ? "" : st.nextToken();
+ String coverage = "";
+ if (add_structmodel(al, querySeq, refSeq, tempId,
+ fastaMapping,
+ alignRange, coverage,
+ confidence, pid, otherInfo))
+ {
+ failedtoadd = false;
+ }
+ }
+ }
+ if (failedtoadd)
+ {
+ System.err
+ .println("Need <Query> <TemplateSeqId> <ModelFile> <FastaMappingFile> <Confidence> <%.I.D> <MatchStart> <MatchEnd> <Coverage> [<Other Information>] as tab separated fields after"
+ + STRUCTMODEL
+ + ".\nNote: other information could be provided in html format ");
+ } else {
+ modified = true;
+ }
+ continue;
+ }
+ // Parse out the annotation row
+ graphStyle = AlignmentAnnotation.getGraphValueFromString(token);
+ label = st.nextToken();
+
+ index = 0;
+ annotations = new Annotation[alWidth];
+ description = null;
+ float score = Float.NaN;
+
+ if (st.hasMoreTokens())
+ {
+ line = st.nextToken();
+
+ if (line.indexOf("|") == -1)
+ {
+ description = line;
+ if (st.hasMoreTokens())
+ {
+ line = st.nextToken();
+ }
+ }
+
+ if (st.hasMoreTokens())
+ {
+ // This must be the score
+ score = Float.valueOf(st.nextToken()).floatValue();
+ }
+
+ st = new StringTokenizer(line, "|", true);
+
+ boolean emptyColumn = true;
+ boolean onlyOneElement = (st.countTokens() == 1);
+
+ while (st.hasMoreElements() && index < alWidth)
+ {
+ token = st.nextToken().trim();
+
+ if (onlyOneElement)
+ {
+ try
+ {
+ score = Float.valueOf(token).floatValue();
+ break;
+ } catch (NumberFormatException ex)
+ {
+ }
+ }
+
+ if (token.equals("|"))
+ {
+ if (emptyColumn)
+ {
+ index++;
+ }
+
+ emptyColumn = true;
+ }
+ else
+ {
+ annotations[index++] = parseAnnotation(token, graphStyle);
+ emptyColumn = false;
+ }
+ }
+
+ }
+
+ annotation = new AlignmentAnnotation(label, description,
+ (index == 0) ? null : annotations, 0, 0, graphStyle);
+
+ annotation.score = score;
+ if (!overrideAutoAnnot
+ && autoAnnots.containsKey(autoAnnotsKey(annotation, refSeq,
+ groupRef)))
+ {
+ // skip - we've already got an automatic annotation of this type.
+ continue;
+ }
+ // otherwise add it!
+ if (refSeq != null)
+ {
+
+ annotation.belowAlignment = false;
+ // make a copy of refSeq so we can find other matches in the alignment
+ SequenceI referedSeq = refSeq;
+ do
+ {
+ // copy before we do any mapping business.
+ // TODO: verify that undo/redo with 1:many sequence associated
+ // annotations can be undone correctly
+ AlignmentAnnotation ann = new AlignmentAnnotation(annotation);
+ annotation
+ .createSequenceMapping(referedSeq, refSeqIndex, false);
+ annotation.adjustForAlignment();
+ referedSeq.addAlignmentAnnotation(annotation);
+ al.addAnnotation(annotation);
+ al.setAnnotationIndex(annotation,
+ al.getAlignmentAnnotation().length
+ - existingAnnotations - 1);
+ if (groupRef != null)
+ {
+ ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
+ }
+ // and recover our virgin copy to use again if necessary.
+ annotation = ann;
+
+ } while (refSeqId != null
+ && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);
+ }
+ else
+ {
+ al.addAnnotation(annotation);
+ al.setAnnotationIndex(annotation,
+ al.getAlignmentAnnotation().length - existingAnnotations
+ - 1);
+ if (groupRef != null)
+ {
+ ((Vector) groupRefRows.get(groupRef)).addElement(annotation);
+ }
+ }
+ // and set modification flag
+ modified = true;
+ }
+ // Resolve the groupRefs
+ Hashtable<String, SequenceGroup> groupRefLookup = new Hashtable<String, SequenceGroup>();
+ Enumeration en = groupRefRows.keys();
+
+ while (en.hasMoreElements())
+ {
+ groupRef = (String) en.nextElement();
+ boolean matched = false;
+ // Resolve group: TODO: add a getGroupByName method to alignments
+ for (SequenceGroup theGroup : al.getGroups())
+ {
+ if (theGroup.getName().equals(groupRef))
+ {
+ if (matched)
+ {
+ // TODO: specify and implement duplication of alignment annotation
+ // for multiple group references.
+ System.err
+ .println("Ignoring 1:many group reference mappings for group name '"
+ + groupRef + "'");
+ }
+ else
+ {
+ matched = true;
+ Vector rowset = (Vector) groupRefRows.get(groupRef);
+ groupRefLookup.put(groupRef, theGroup);
+ if (rowset != null && rowset.size() > 0)
+ {
+ AlignmentAnnotation alan = null;
+ for (int elm = 0, elmSize = rowset.size(); elm < elmSize; elm++)
+ {
+ alan = (AlignmentAnnotation) rowset.elementAt(elm);
+ alan.groupRef = theGroup;
+ }
+ }
+ }
+ }
+ }
+ ((Vector) groupRefRows.get(groupRef)).removeAllElements();
+ }
+ // process any deferred attribute settings for each context
+ for (Object[] _deferred_args : deferredAnnotation_calls)
+ {
+ if (_deferred_args[0] == GRAPHLINE)
+ {
+ addLine(al,
+ (StringTokenizer) _deferred_args[1], // st
+ (SequenceI) _deferred_args[2], // refSeq
+ (_deferred_args[3] == null) ? null : groupRefLookup
+ .get(_deferred_args[3]) // the reference
+ // group, or null
+ );
+ }
+ }
+
+ // finally, combine all the annotation rows within each context.
+ /**
+ * number of combine statements in this annotation file. Used to create
+ * new groups for combined annotation graphs without disturbing existing
+ * ones
+ */
+ int combinecount = 0;
+ for (Object[] _combine_args : combineAnnotation_calls)
+ {
+ combineAnnotations(al,
+ ++combinecount,
+ (StringTokenizer) _combine_args[0], // st
+ (SequenceI) _combine_args[1], // refSeq
+ (_combine_args[2] == null) ? null : groupRefLookup
+ .get(_combine_args[2]) // the reference group,
+ // or null
+ );
+ }
+ }
+ return modified;
+ }
+
+ /**
+ * resolve a structural model and generate and add an alignment sequence for
+ * it
+ *
+ * @param refSeq2
+ * @param tempId
+ * @param urlToModel
+ * @param urlToPairwise
+ * @return true if model and sequence was added
+ */
+ private boolean add_structmodel(AlignmentI al, SequenceI querySequence,
+ SequenceI templateSeq,
+ String modelFile, String fastaFile, String aRange,
+ String coverage, String confidence,
+ String pid, String otherInfo)
+ {
+ String warningMessage = null;
+ boolean added = false;
+ try {
+ String structureModelFile = resolveAbsolute(modelFile);
+ String fastaMappingFile = resolveAbsolute(fastaFile.replaceAll(
+ ".fasta.jal", ".fasta"));
+ // System.out.println("Model File >> " + structureModelFile);
+ // System.out.println("Fasta File >> " + fastaMappingFile);
+ PDBEntry phyre2PDBEntry = new PDBEntry(modelFile, null, Type.FILE,
+ structureModelFile);
+ String phyre2ModelDesc = generatePhyre2InfoHTMLTable(aRange,
+ coverage, confidence, pid, otherInfo);
+ phyre2PDBEntry.setProperty("PHYRE2_MODEL_INFO", phyre2ModelDesc);
+ templateSeq.getDatasetSequence().addPDBId(phyre2PDBEntry);
+ if (querySequence != null)
+ {
+ querySequence.getDatasetSequence().addPDBId(phyre2PDBEntry);
+ }
+ StructureSelectionManager ssm = StructureSelectionManager
+ .getStructureSelectionManager(Desktop.instance);
+ ssm.registerPhyre2Template(structureModelFile, fastaMappingFile);
+ added = true;
+
+ } catch (Exception x)
+ {
+ warningMessage = x.toString();
+ } finally {
+ if (warningMessage !=null)
+ {
+ System.err.println("Warnings whilst processing STRUCTMODEL: "+warningMessage);
+ }
+ }
+ return added;
+ }
+
+ private String generatePhyre2InfoHTMLTable(String aRange,
+ String coverage, String confidence, String pid, String otherInfo)
+ {
+ StringBuilder phyre2InfoBuilder = new StringBuilder();
+ phyre2InfoBuilder.append("<html><table border=\"1\" width=100%>");
+ phyre2InfoBuilder
+ .append("<tr><td colspan=\"2\"><strong>Phyre2 Template Info</strong></td></tr>");
+ if (aRange != null && !aRange.isEmpty())
+ {
+ phyre2InfoBuilder.append("<tr><td>").append("Aligned range")
+ .append("</td><td>").append(aRange).append("</td></tr>");
+ }
+ if (coverage != null && !coverage.isEmpty())
+ {
+ phyre2InfoBuilder.append("<tr><td>").append("Coverage")
+ .append("</td><td>").append(coverage).append("</td></tr>");
+ }
+ if (confidence != null && !confidence.isEmpty())
+ {
+ phyre2InfoBuilder.append("<tr><td>").append("Confidence")
+ .append("</td><td>").append(confidence).append("</td></tr>");
+ }
+ if (pid != null && !pid.isEmpty())
+ {
+ phyre2InfoBuilder.append("<tr><td>").append("%.i.d")
+ .append("</td><td>").append(pid).append("</td></tr>");
+ }
+ if (otherInfo != null && !otherInfo.isEmpty())
+ {
+ phyre2InfoBuilder.append("<tr><td>").append("Other information")
+ .append("</td><td>").append(otherInfo).append("</td></tr>");
+ }
+ phyre2InfoBuilder.append("</table></html>");
+ return phyre2InfoBuilder.toString();
+ }
+
+ private String resolveAbsolute(String relURI)
+ {
+ if (relURI.indexOf(":/") > -1 || relURI.startsWith("/")
+ || "".equals(baseUri) || relURI.startsWith(baseUri))
+ {
+ return relURI;
+ }
+ return baseUri + relURI;
+ }
+
+ private void parseHideCols(ColumnSelection colSel, String nextToken)
+ {
+ StringTokenizer inval = new StringTokenizer(nextToken, ",");
+ while (inval.hasMoreTokens())
+ {
+ String range = inval.nextToken().trim();
+ int from, to = range.indexOf("-");
+ if (to == -1)
+ {
+ from = to = Integer.parseInt(range);
+ if (from >= 0)
+ {
+ colSel.hideColumns(from, to);
+ }
+ }
+ else
+ {
+ from = Integer.parseInt(range.substring(0, to));
+ if (to < range.length() - 1)
+ {
+ to = Integer.parseInt(range.substring(to + 1));
+ }
+ else
+ {
+ to = from;
+ }
+ if (from > 0 && to >= from)
+ {
+ colSel.hideColumns(from, to);
+ }
+ }
+ }
+ }
+
+ private Object autoAnnotsKey(AlignmentAnnotation annotation,
+ SequenceI refSeq, String groupRef)
+ {
+ return annotation.graph + "\t" + annotation.label + "\t"
+ + annotation.description + "\t"
+ + (refSeq != null ? refSeq.getDisplayId(true) : "");
+ }
+
+ Annotation parseAnnotation(String string, int graphStyle)
+ {
+ // don't do the glyph test if we don't want secondary structure
+ boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH);
+ String desc = null, displayChar = null;
+ char ss = ' '; // secondaryStructure
+ float value = 0;
+ boolean parsedValue = false, dcset = false;
+
+ // find colour here
+ Color colour = null;
+ int i = string.indexOf("[");
+ int j = string.indexOf("]");
+ if (i > -1 && j > -1)
+ {
+ colour = ColorUtils.parseColourString(string.substring(i + 1,
+ j));
+ if (i > 0 && string.charAt(i - 1) == ',')
+ {
+ // clip the preceding comma as well
+ i--;
+ }
+ string = string.substring(0, i) + string.substring(j + 1);
+ }
+
+ StringTokenizer st = new StringTokenizer(string, ",", true);
+ String token;
+ boolean seenContent = false;
+ int pass = 0;
+ while (st.hasMoreTokens())
+ {
+ pass++;
+ token = st.nextToken().trim();
+ if (token.equals(","))
+ {
+ if (!seenContent && parsedValue && !dcset)
+ {
+ // allow the value below the bar/line to be empty
+ dcset = true;
+ displayChar = " ";
+ }
+ seenContent = false;
+ continue;
+ }
+ else
+ {
+ seenContent = true;
+ }
+
+ if (!parsedValue)
+ {
+ try
+ {
+ displayChar = token;
+ // foo
+ value = new Float(token).floatValue();
+ parsedValue = true;
+ continue;
+ } catch (NumberFormatException ex)
+ {
+ }
+ }
+ else
+ {
+ if (token.length() == 1)
+ {
+ displayChar = token;
+ }
+ }
+ if (hasSymbols
+ && (token.length() == 1 && "()<>[]{}AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"
+ .contains(token)))
+ {
+ // Either this character represents a helix or sheet
+ // or an integer which can be displayed
+ ss = token.charAt(0);
+ if (displayChar.equals(token.substring(0, 1)))
+ {
+ displayChar = "";
+ }
+ }
+ else if (desc == null || (parsedValue && pass > 2))
+ {
+ desc = token;
+ }
+
+ }
+ // if (!dcset && string.charAt(string.length() - 1) == ',')
+ // {
+ // displayChar = " "; // empty display char symbol.
+ // }
+ if (displayChar != null && desc != null && desc.length() == 1)
+ {
+ if (displayChar.length() > 1)
+ {
+ // switch desc and displayChar - legacy support
+ String tmp = displayChar;
+ displayChar = desc;
+ desc = tmp;
+ }
+ else
+ {
+ if (displayChar.equals(desc))
+ {
+ // duplicate label - hangover from the 'robust parser' above
+ desc = null;
+ }
+ }
+ }
+ Annotation anot = new Annotation(displayChar, desc, ss, value);
+
+ anot.colour = colour;
+
+ return anot;
+ }
+
+ void colourAnnotations(AlignmentI al, String label, String colour)
+ {
+ Color awtColour = ColorUtils.parseColourString(colour);
+ Annotation[] annotations;
+ for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
+ {
+ if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))
+ {
+ annotations = al.getAlignmentAnnotation()[i].annotations;
+ for (int j = 0; j < annotations.length; j++)
+ {
+ if (annotations[j] != null)
+ {
+ annotations[j].colour = awtColour;
+ }
+ }
+ }
+ }
+ }
+
+ void combineAnnotations(AlignmentI al, int combineCount,
+ StringTokenizer st, SequenceI seqRef, SequenceGroup groupRef)
+ {
+ String group = st.nextToken();
+ // First make sure we are not overwriting the graphIndex
+ int graphGroup = 0;
+ if (al.getAlignmentAnnotation() != null)
+ {
+ for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
+ {
+ AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
+
+ if (aa.graphGroup > graphGroup)
+ {
+ // try to number graphGroups in order of occurence.
+ graphGroup = aa.graphGroup + 1;
+ }
+ if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
+ && aa.label.equalsIgnoreCase(group))
+ {
+ if (aa.graphGroup > -1)
+ {
+ graphGroup = aa.graphGroup;
+ }
+ else
+ {
+ if (graphGroup <= combineCount)
+ {
+ graphGroup = combineCount + 1;
+ }
+ aa.graphGroup = graphGroup;
+ }
+ break;
+ }
+ }
+
+ // Now update groups
+ while (st.hasMoreTokens())
+ {
+ group = st.nextToken();
+ for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
+ {
+ AlignmentAnnotation aa = al.getAlignmentAnnotation()[i];
+ if (aa.sequenceRef == seqRef && aa.groupRef == groupRef
+ && aa.label.equalsIgnoreCase(group))
+ {
+ aa.graphGroup = graphGroup;
+ break;
+ }
+ }
+ }
+ }
+ else
+ {
+ System.err
+ .println("Couldn't combine annotations. None are added to alignment yet!");
+ }
+ }
+
+ void addLine(AlignmentI al, StringTokenizer st, SequenceI seqRef,
+ SequenceGroup groupRef)
+ {
+ String group = st.nextToken();
+ AlignmentAnnotation[] alannot = al.getAlignmentAnnotation();
+ String nextToken = st.nextToken();
+ float value = 0f;
+ try
+ {
+ value = Float.valueOf(nextToken);
+ } catch (NumberFormatException e)
+ {
+ System.err.println("line " + nlinesread + ": Threshold '" + nextToken
+ + "' invalid, setting to zero");
+ }
+ String label = st.hasMoreTokens() ? st.nextToken() : null;
+ Color colour = null;
+ if (st.hasMoreTokens())
+ {
+ colour = ColorUtils.parseColourString(st.nextToken());
+ }
+ if (alannot != null)
+ {
+ for (int i = 0; i < alannot.length; i++)
+ {
+ if (alannot[i].label.equalsIgnoreCase(group)
+ && (seqRef == null || alannot[i].sequenceRef == seqRef)
+ && (groupRef == null || alannot[i].groupRef == groupRef))
+ {
+ alannot[i].setThreshold(new GraphLine(value, label, colour));
+ }
+ }
+ }
+ }
+
+ void addGroup(AlignmentI al, StringTokenizer st)
+ {
+ SequenceGroup sg = new SequenceGroup();
+ sg.setName(st.nextToken());
+ String rng = "";
+ try
+ {
+ rng = st.nextToken();
+ if (rng.length() > 0 && !rng.startsWith("*"))
+ {
+ sg.setStartRes(Integer.parseInt(rng) - 1);
+ }
+ else
+ {
+ sg.setStartRes(0);
+ }
+ rng = st.nextToken();
+ if (rng.length() > 0 && !rng.startsWith("*"))
+ {
+ sg.setEndRes(Integer.parseInt(rng) - 1);
+ }
+ else
+ {
+ sg.setEndRes(al.getWidth() - 1);
+ }
+ } catch (Exception e)
+ {
+ System.err
+ .println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"
+ + rng + "' - assuming alignment width for group.");
+ // assume group is full width
+ sg.setStartRes(0);
+ sg.setEndRes(al.getWidth() - 1);
+ }
+
+ String index = st.nextToken();
+ if (index.equals("-1"))
+ {
+ while (st.hasMoreElements())
+ {
+ sg.addSequence(al.findName(st.nextToken()), false);
+ }
+ }
+ else
+ {
+ StringTokenizer st2 = new StringTokenizer(index, ",");
+
+ while (st2.hasMoreTokens())
+ {
+ String tmp = st2.nextToken();
+ if (tmp.equals("*"))
+ {
+ for (int i = 0; i < al.getHeight(); i++)
+ {
+ sg.addSequence(al.getSequenceAt(i), false);
+ }
+ }
+ else if (tmp.indexOf("-") >= 0)
+ {
+ StringTokenizer st3 = new StringTokenizer(tmp, "-");
+
+ int start = (Integer.parseInt(st3.nextToken()));
+ int end = (Integer.parseInt(st3.nextToken()));
+
+ if (end > start)
+ {
+ for (int i = start; i <= end; i++)
+ {
+ sg.addSequence(al.getSequenceAt(i - 1), false);
+ }
+ }
+ }
+ else
+ {
+ sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1), false);
+ }
+ }
+ }
+
+ if (refSeq != null)
+ {
+ sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);
+ sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);
+ sg.setSeqrep(refSeq);
+ }
+
+ if (sg.getSize() > 0)
+ {
+ al.addGroup(sg);
+ }
+ }
+
+ void addRowProperties(AlignmentI al, StringTokenizer st)
+ {
+ String label = st.nextToken(), keyValue, key, value;
+ boolean scaletofit = false, centerlab = false, showalllabs = false;
+ while (st.hasMoreTokens())
+ {
+ keyValue = st.nextToken();
+ key = keyValue.substring(0, keyValue.indexOf("="));
+ value = keyValue.substring(keyValue.indexOf("=") + 1);
+ if (key.equalsIgnoreCase("scaletofit"))
+ {
+ scaletofit = Boolean.valueOf(value).booleanValue();
+ }
+ if (key.equalsIgnoreCase("showalllabs"))
+ {
+ showalllabs = Boolean.valueOf(value).booleanValue();
+ }
+ if (key.equalsIgnoreCase("centrelabs"))
+ {
+ centerlab = Boolean.valueOf(value).booleanValue();
+ }
+ AlignmentAnnotation[] alr = al.getAlignmentAnnotation();
+ if (alr != null)
+ {
+ for (int i = 0; i < alr.length; i++)
+ {
+ if (alr[i].label.equalsIgnoreCase(label))
+ {
+ alr[i].centreColLabels = centerlab;
+ alr[i].scaleColLabel = scaletofit;
+ alr[i].showAllColLabels = showalllabs;
+ }
+ }
+ }
+ }
+ }
+
+ void addProperties(AlignmentI al, StringTokenizer st)
+ {
+
+ // So far we have only added groups to the annotationHash,
+ // the idea is in the future properties can be added to
+ // alignments, other annotations etc
+ if (al.getGroups() == null)
+ {
+ return;
+ }
+
+ String name = st.nextToken();
+ SequenceGroup sg = null;
+ for (SequenceGroup _sg : al.getGroups())
+ {
+ if ((sg = _sg).getName().equals(name))
+ {
+ break;
+ }
+ else
+ {
+ sg = null;
+ }
+ }
+
+ if (sg != null)
+ {
+ String keyValue, key, value;
+ ColourSchemeI def = sg.getColourScheme();
+ while (st.hasMoreTokens())
+ {
+ keyValue = st.nextToken();
+ key = keyValue.substring(0, keyValue.indexOf("="));
+ value = keyValue.substring(keyValue.indexOf("=") + 1);
+
+ if (key.equalsIgnoreCase("description"))
+ {
+ sg.setDescription(value);
+ }
+ else if (key.equalsIgnoreCase("colour"))
+ {
+ sg.cs.setColourScheme(ColourSchemeProperty
+ .getColourScheme(al, value));
+ }
+ else if (key.equalsIgnoreCase("pidThreshold"))
+ {
+ sg.cs.setThreshold(Integer.parseInt(value), true);
+
+ }
+ else if (key.equalsIgnoreCase("consThreshold"))
+ {
+ sg.cs.setConservationInc(Integer.parseInt(value));
+ Conservation c = new Conservation("Group", sg.getSequences(null),
+ sg.getStartRes(), sg.getEndRes() + 1);
+
+ c.calculate();
+ c.verdict(false, 25); // TODO: refer to conservation percent threshold
+
+ sg.cs.setConservation(c);
+
+ }
+ else if (key.equalsIgnoreCase("outlineColour"))
+ {
+ sg.setOutlineColour(ColorUtils.parseColourString(value));
+ }
+ else if (key.equalsIgnoreCase("displayBoxes"))
+ {
+ sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());
+ }
+ else if (key.equalsIgnoreCase("showUnconserved"))
+ {
+ sg.setShowNonconserved(Boolean.valueOf(value).booleanValue());
+ }
+ else if (key.equalsIgnoreCase("displayText"))
+ {
+ sg.setDisplayText(Boolean.valueOf(value).booleanValue());
+ }
+ else if (key.equalsIgnoreCase("colourText"))
+ {
+ sg.setColourText(Boolean.valueOf(value).booleanValue());
+ }
+ else if (key.equalsIgnoreCase("textCol1"))
+ {
+ sg.textColour = ColorUtils.parseColourString(value);
+ }
+ else if (key.equalsIgnoreCase("textCol2"))
+ {
+ sg.textColour2 = ColorUtils.parseColourString(value);
+ }
+ else if (key.equalsIgnoreCase("textColThreshold"))
+ {
+ sg.thresholdTextColour = Integer.parseInt(value);
+ }
+ else if (key.equalsIgnoreCase("idColour"))
+ {
+ Color idColour = ColorUtils.parseColourString(value);
+ sg.setIdColour(idColour == null ? Color.black : idColour);
+ }
+ else if (key.equalsIgnoreCase("hide"))
+ {
+ // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
+ sg.setHidereps(true);
+ }
+ else if (key.equalsIgnoreCase("hidecols"))
+ {
+ // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
+ sg.setHideCols(true);
+ }
+ sg.recalcConservation();
+ }
+ if (sg.getColourScheme() == null)
+ {
+ sg.setColourScheme(def);
+ }
+ }
+ }
+
+ void setBelowAlignment(AlignmentI al, StringTokenizer st)
+ {
+ String token;
+ AlignmentAnnotation aa, ala[] = al.getAlignmentAnnotation();
+ if (ala == null)
+ {
+ System.err
+ .print("Warning - no annotation to set below for sequence associated annotation:");
+ }
+ while (st.hasMoreTokens())
+ {
+ token = st.nextToken();
+ if (ala == null)
+ {
+ System.err.print(" " + token);
+ }
+ else
+ {
+ for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
+ {
+ aa = al.getAlignmentAnnotation()[i];
+ if (aa.sequenceRef == refSeq && aa.label.equals(token))
+ {
+ aa.belowAlignment = true;
+ }
+ }
+ }
+ }
+ if (ala == null)
+ {
+ System.err.print("\n");
+ }
+ }
+
+ void addAlignmentDetails(AlignmentI al, StringTokenizer st)
+ {
+ String keyValue, key, value;
+ while (st.hasMoreTokens())
+ {
+ keyValue = st.nextToken();
+ key = keyValue.substring(0, keyValue.indexOf("="));
+ value = keyValue.substring(keyValue.indexOf("=") + 1);
+ al.setProperty(key, value);
+ }
+ }
+
+ /**
+ * Write annotations as a CSV file of the form 'label, value, value, ...' for
+ * each row.
+ *
+ * @param annotations
+ * @return CSV file as a string.
+ */
+ public String printCSVAnnotations(AlignmentAnnotation[] annotations)
+ {
+ if (annotations == null)
+ {
+ return "";
+ }
+ StringBuffer sp = new StringBuffer();
+ for (int i = 0; i < annotations.length; i++)
+ {
+ String atos = annotations[i].toString();
+ int p = 0;
+ do
+ {
+ int cp = atos.indexOf("\n", p);
+ sp.append(annotations[i].label);
+ sp.append(",");
+ if (cp > p)
+ {
+ sp.append(atos.substring(p, cp + 1));
+ }
+ else
+ {
+ sp.append(atos.substring(p));
+ sp.append(newline);
+ }
+ p = cp + 1;
+ } while (p > 0);
+ }
+ return sp.toString();
+ }
+
+ public String printAnnotationsForView(AlignViewportI viewport)
+ {
+ return printAnnotations(viewport.isShowAnnotation() ? viewport
+ .getAlignment().getAlignmentAnnotation() : null, viewport
+ .getAlignment().getGroups(), viewport.getAlignment()
+ .getProperties(), viewport.getColumnSelection(),
+ viewport.getAlignment(), null);
+ }
+
+ public String printAnnotationsForAlignment(AlignmentI al)
+ {
+ return printAnnotations(al.getAlignmentAnnotation(), al.getGroups(),
+ al.getProperties(), null, al, null);
+ }
+}