-/*
-* Jalview - A Sequence Alignment Editor and Viewer
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
-*
-* This program 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 2
-* of the License, or (at your option) any later version.
-*
-* This program 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 this program; if not, write to the Free Software
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
-*/\r
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2007 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
\r
// NewickFile.java\r
// Tree I/O\r
// http://evolution.genetics.washington.edu/phylip/newick_doc.html\r
+// TODO: Implement Basic NHX tag parsing and preservation\r
+// TODO: http://evolution.genetics.wustl.edu/eddy/forester/NHX.html\r
+// TODO: Extended SequenceNodeI to hold parsed NHX strings\r
package jalview.io;\r
\r
-import jalview.datamodel.*;\r
-\r
import java.io.*;\r
\r
-import java.util.*;\r
-\r
-\r
-public class NewickFile extends FileParse {\r
- SequenceNode root;\r
- private boolean HasBootstrap = false;\r
- private boolean HasDistances = false;\r
- private boolean RootHasDistance = false;\r
-\r
- // File IO Flags\r
- boolean ReplaceUnderscores = false;\r
- boolean printRootInfo = false;\r
- private com.stevesoft.pat.Regex[] NodeSafeName = new com.stevesoft.pat.Regex[] {\r
- new com.stevesoft.pat.Regex().perlCode("m/[\\[,:'()]/"), // test for requiring quotes\r
- new com.stevesoft.pat.Regex().perlCode("s/'/''/"), // escaping quote characters\r
- new com.stevesoft.pat.Regex().perlCode("s/\\/w/_/") // unqoted whitespace transformation\r
- };\r
- char QuoteChar = '\'';\r
-\r
- public NewickFile(String inStr) throws IOException {\r
- super(inStr, "Paste");\r
- }\r
-\r
- public NewickFile(String inFile, String type) throws IOException {\r
- super(inFile, type);\r
- }\r
-\r
- public NewickFile(SequenceNode newtree) {\r
- root = newtree;\r
- }\r
-\r
- public NewickFile(SequenceNode newtree, boolean bootstrap) {\r
- HasBootstrap = bootstrap;\r
- root = newtree;\r
- }\r
-\r
- public NewickFile(SequenceNode newtree, boolean bootstrap, boolean distances) {\r
- root = newtree;\r
- HasBootstrap = bootstrap;\r
- HasDistances = distances;\r
- }\r
-\r
- public NewickFile(SequenceNode newtree, boolean bootstrap,\r
- boolean distances, boolean rootdistance) {\r
- root = newtree;\r
- HasBootstrap = bootstrap;\r
- HasDistances = distances;\r
- RootHasDistance = rootdistance;\r
- }\r
+import jalview.datamodel.*;\r
\r
- private String ErrorStringrange(String Error, String Er, int r, int p,\r
- String s) {\r
- return ((Error == null) ? "" : Error) + Er + " at position " + p +\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class NewickFile\r
+ extends FileParse\r
+{\r
+ SequenceNode root;\r
+ private boolean HasBootstrap = false;\r
+ private boolean HasDistances = false;\r
+ private boolean RootHasDistance = false;\r
+\r
+ // File IO Flags\r
+ boolean ReplaceUnderscores = false;\r
+ boolean printRootInfo = false;\r
+ private com.stevesoft.pat.Regex[] NodeSafeName = new com.stevesoft.pat.Regex[]\r
+ {\r
+ new com.stevesoft.pat.Regex().perlCode("m/[\\[,:'()]/"), // test for requiring quotes\r
+ new com.stevesoft.pat.Regex().perlCode("s/'/''/"), // escaping quote characters\r
+ new com.stevesoft.pat.Regex().perlCode("s/\\/w/_/") // unqoted whitespace transformation\r
+ };\r
+ char QuoteChar = '\'';\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param inStr DOCUMENT ME!\r
+ *\r
+ * @throws IOException DOCUMENT ME!\r
+ */\r
+ public NewickFile(String inStr)\r
+ throws IOException\r
+ {\r
+ super(inStr, "Paste");\r
+ }\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param inFile DOCUMENT ME!\r
+ * @param type DOCUMENT ME!\r
+ *\r
+ * @throws IOException DOCUMENT ME!\r
+ */\r
+ public NewickFile(String inFile, String type)\r
+ throws IOException\r
+ {\r
+ super(inFile, type);\r
+ }\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param newtree DOCUMENT ME!\r
+ */\r
+ public NewickFile(SequenceNode newtree)\r
+ {\r
+ root = newtree;\r
+ }\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param newtree DOCUMENT ME!\r
+ * @param bootstrap DOCUMENT ME!\r
+ */\r
+ public NewickFile(SequenceNode newtree, boolean bootstrap)\r
+ {\r
+ HasBootstrap = bootstrap;\r
+ root = newtree;\r
+ }\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param newtree DOCUMENT ME!\r
+ * @param bootstrap DOCUMENT ME!\r
+ * @param distances DOCUMENT ME!\r
+ */\r
+ public NewickFile(SequenceNode newtree, boolean bootstrap, boolean distances)\r
+ {\r
+ root = newtree;\r
+ HasBootstrap = bootstrap;\r
+ HasDistances = distances;\r
+ }\r
+\r
+ /**\r
+ * Creates a new NewickFile object.\r
+ *\r
+ * @param newtree DOCUMENT ME!\r
+ * @param bootstrap DOCUMENT ME!\r
+ * @param distances DOCUMENT ME!\r
+ * @param rootdistance DOCUMENT ME!\r
+ */\r
+ public NewickFile(SequenceNode newtree, boolean bootstrap,\r
+ boolean distances, boolean rootdistance)\r
+ {\r
+ root = newtree;\r
+ HasBootstrap = bootstrap;\r
+ HasDistances = distances;\r
+ RootHasDistance = rootdistance;\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @param Error DOCUMENT ME!\r
+ * @param Er DOCUMENT ME!\r
+ * @param r DOCUMENT ME!\r
+ * @param p DOCUMENT ME!\r
+ * @param s DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ private String ErrorStringrange(String Error, String Er, int r, int p,\r
+ String s)\r
+ {\r
+ return ( (Error == null) ? "" : Error) + Er + " at position " + p +\r
" ( " +\r
- s.substring(((p - r) < 0) ? 0 : (p - r),\r
- ((p + r) > s.length()) ? s.length() : (p + r)) + " )\n";\r
+ s.substring( ( (p - r) < 0) ? 0 : (p - r),\r
+ ( (p + r) > s.length()) ? s.length() : (p + r)) + " )\n";\r
+ }\r
+\r
+ // @tree annotations\r
+ // These are set automatically by the reader\r
+ public boolean HasBootstrap()\r
+ {\r
+ return HasBootstrap;\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ public boolean HasDistances()\r
+ {\r
+ return HasDistances;\r
+ }\r
+\r
+ public boolean HasRootDistance()\r
+ {\r
+ return RootHasDistance;\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @throws IOException DOCUMENT ME!\r
+ */\r
+ public void parse()\r
+ throws IOException\r
+ {\r
+ String nf;\r
+\r
+ { // fill nf with complete tree file\r
+\r
+ StringBuffer file = new StringBuffer();\r
+\r
+ while ( (nf = nextLine()) != null)\r
+ {\r
+ file.append(nf);\r
+ }\r
+\r
+ nf = file.toString();\r
}\r
\r
- // @tree annotations\r
- // These are set automatically by the reader\r
- public boolean HasBootstrap() {\r
- return HasBootstrap;\r
- }\r
+ root = new SequenceNode();\r
\r
- public boolean HasDistances() {\r
- return HasDistances;\r
- }\r
+ SequenceNode realroot = null;\r
+ SequenceNode c = root;\r
\r
- public void parse() throws IOException {\r
- String nf;\r
+ int d = -1;\r
+ int cp = 0;\r
+ //int flen = nf.length();\r
\r
- { // fill nf with complete tree file\r
+ String Error = null;\r
+ String nodename = null;\r
\r
- StringBuffer file = new StringBuffer();\r
+ float DefDistance = (float) 0.001; // @param Default distance for a node - very very small\r
+ int DefBootstrap = 0; // @param Default bootstrap for a node\r
\r
- while ((nf = nextLine()) != null) {\r
- file.append(nf);\r
- }\r
+ float distance = DefDistance;\r
+ int bootstrap = DefBootstrap;\r
\r
- nf = file.toString();\r
- }\r
-\r
- root = new SequenceNode();\r
-\r
- SequenceNode realroot = null;\r
- SequenceNode c = root;\r
+ boolean ascending = false; // flag indicating that we are leaving the current node\r
\r
- int d = -1;\r
- int cp = 0;\r
- int flen = nf.length();\r
+ com.stevesoft.pat.Regex majorsyms = new com.stevesoft.pat.Regex(\r
+ "[(\\['),;]");\r
\r
- String Error = null;\r
- String nodename = null;\r
+ while (majorsyms.searchFrom(nf, cp) && (Error == null))\r
+ {\r
+ int fcp = majorsyms.matchedFrom();\r
\r
- float DefDistance = (float) 0.00001; // @param Default distance for a node - very very small\r
- int DefBootstrap = 0; // @param Default bootstrap for a node\r
+ switch (nf.charAt(fcp))\r
+ {\r
+ case '[': // Comment or structured/extended NH format info\r
\r
- float distance = DefDistance;\r
- int bootstrap = DefBootstrap;\r
+ com.stevesoft.pat.Regex comment = new com.stevesoft.pat.Regex(\r
+ "]");\r
\r
- boolean ascending = false; // flag indicating that we are leaving the current node\r
+ if (comment.searchFrom(nf, fcp))\r
+ {\r
+ // Skip the comment field\r
+ cp = 1 + comment.matchedFrom();\r
+ }\r
+ else\r
+ {\r
+ Error = ErrorStringrange(Error, "Unterminated comment", 3,\r
+ fcp, nf);\r
+ }\r
\r
- com.stevesoft.pat.Regex majorsyms = new com.stevesoft.pat.Regex(\r
- "[(\\['),;]");\r
+ ;\r
\r
- while (majorsyms.searchFrom(nf, cp) && (Error == null)) {\r
- int fcp = majorsyms.matchedFrom();\r
+ break;\r
\r
- switch (nf.charAt(fcp)) {\r
- case '[': // Comment or structured/extended NH format info\r
-\r
- com.stevesoft.pat.Regex comment = new com.stevesoft.pat.Regex(\r
- "]");\r
-\r
- if (comment.searchFrom(nf, fcp)) {\r
- // Skip the comment field\r
- cp = 1 + comment.matchedFrom();\r
- } else {\r
- Error = ErrorStringrange(Error, "Unterminated comment", 3,\r
- fcp, nf);\r
- }\r
+ case '(':\r
\r
- ;\r
+ // ascending should not be set\r
+ // New Internal node\r
+ if (ascending)\r
+ {\r
+ Error = ErrorStringrange(Error, "Unexpected '('", 7, fcp, nf);\r
\r
- break;\r
+ continue;\r
+ }\r
\r
- case '(':\r
+ ;\r
+ d++;\r
\r
- // ascending should not be set\r
- // New Internal node\r
- if (ascending) {\r
- Error = ErrorStringrange(Error, "Unexpected '('", 7, fcp, nf);\r
-\r
- continue;\r
- }\r
-\r
- ;\r
- d++;\r
-\r
- if (c.right() == null) {\r
- c.setRight(new SequenceNode(null, c, null, DefDistance,\r
- DefBootstrap, false));\r
- c = (SequenceNode) c.right();\r
- } else {\r
- if (c.left() != null) {\r
- // Dummy node for polytomy - keeps c.left free for new node\r
- SequenceNode tmpn = new SequenceNode(null, c, null, 0,\r
- 0, true);\r
- tmpn.SetChildren(c.left(), c.right());\r
- c.setRight(tmpn);\r
- }\r
-\r
- c.setLeft(new SequenceNode(null, c, null, DefDistance,\r
- DefBootstrap, false));\r
- c = (SequenceNode) c.left();\r
- }\r
-\r
- if (realroot == null) {\r
- realroot = c;\r
- }\r
-\r
- nodename = null;\r
- distance = DefDistance;\r
- bootstrap = DefBootstrap;\r
- cp = fcp + 1;\r
-\r
- break;\r
-\r
- // Deal with quoted fields\r
- case '\'':\r
-\r
- com.stevesoft.pat.Regex qnodename = new com.stevesoft.pat.Regex(\r
- "([^']|'')+'");\r
-\r
- if (qnodename.searchFrom(nf, fcp)) {\r
- int nl = qnodename.stringMatched().length();\r
- nodename = new String(qnodename.stringMatched().substring(0,\r
- nl - 1));\r
- cp = fcp + nl + 1;\r
- } else {\r
- Error = ErrorStringrange(Error,\r
- "Unterminated quotes for nodename", 7, fcp, nf);\r
- }\r
-\r
- break;\r
-\r
- case ';':\r
-\r
- if (d != -1) {\r
- Error = ErrorStringrange(Error,\r
- "Wayward semicolon (depth=" + d + ")", 7, fcp, nf);\r
- }\r
-\r
- // cp advanced at the end of default\r
- default:\r
-\r
- // Parse simpler field strings\r
- String fstring = nf.substring(cp, fcp);\r
- com.stevesoft.pat.Regex uqnodename = new com.stevesoft.pat.Regex(\r
- "\\b([^' :;\\](),]+)");\r
- com.stevesoft.pat.Regex nbootstrap = new com.stevesoft.pat.Regex(\r
- "\\S+([0-9+]+)\\S*:");\r
- com.stevesoft.pat.Regex ndist = new com.stevesoft.pat.Regex(\r
- ":([-0-9.+]+)");\r
-\r
- if (uqnodename.search(fstring) &&\r
- ((uqnodename.matchedFrom(1) == 0) ||\r
- (fstring.charAt(uqnodename.matchedFrom(1) - 1) != ':'))) // JBPNote HACK!\r
- {\r
- if (nodename == null) {\r
- if (ReplaceUnderscores) {\r
- nodename = uqnodename.stringMatched(1).replace('_',\r
- ' ');\r
- } else {\r
- nodename = uqnodename.stringMatched(1);\r
- }\r
- } else {\r
- Error = ErrorStringrange(Error,\r
- "File has broken algorithm - overwritten nodename",\r
- 10, fcp, nf);\r
- }\r
- }\r
-\r
- if (nbootstrap.search(fstring) &&\r
- (nbootstrap.matchedFrom(1) > (uqnodename.matchedFrom(1) +\r
- uqnodename.stringMatched().length()))) {\r
- try {\r
- bootstrap = (new Integer(nbootstrap.stringMatched(1))).intValue();\r
- HasBootstrap = true;\r
- } catch (Exception e) {\r
- Error = ErrorStringrange(Error,\r
- "Can't parse bootstrap value", 4,\r
- cp + nbootstrap.matchedFrom(), nf);\r
- }\r
- }\r
-\r
- boolean nodehasdistance = false;\r
-\r
- if (ndist.search(fstring)) {\r
- try {\r
- distance = (new Float(ndist.stringMatched(1))).floatValue();\r
- HasDistances = true;\r
- nodehasdistance = true;\r
- } catch (Exception e) {\r
- Error = ErrorStringrange(Error,\r
- "Can't parse node distance value", 7,\r
- cp + ndist.matchedFrom(), nf);\r
- }\r
- }\r
-\r
- if (ascending) {\r
- // Write node info here\r
- c.setName(nodename);\r
- c.dist = (HasDistances) ? distance : 0;\r
- c.setBootstrap((HasBootstrap) ? bootstrap : 0);\r
-\r
- if (c == realroot) {\r
- RootHasDistance = nodehasdistance; // JBPNote This is really UGLY!!!\r
- }\r
- } else {\r
- // Find a place to put the leaf\r
- SequenceNode newnode = new SequenceNode(null, c, nodename,\r
- (HasDistances) ? distance : DefDistance,\r
- (HasBootstrap) ? bootstrap : DefBootstrap, false);\r
-\r
- if (c.right() == null) {\r
- c.setRight(newnode);\r
- } else {\r
- if (c.left() == null) {\r
- c.setLeft(newnode);\r
- } else {\r
- // Insert a dummy node for polytomy\r
- SequenceNode newdummy = new SequenceNode(null, c,\r
- null, 0, 0, true);\r
- newdummy.SetChildren(c.left(), newnode);\r
- c.setLeft(newdummy);\r
- }\r
- }\r
- }\r
+ if (c.right() == null)\r
+ {\r
+ c.setRight(new SequenceNode(null, c, null, DefDistance,\r
+ DefBootstrap, false));\r
+ c = (SequenceNode) c.right();\r
+ }\r
+ else\r
+ {\r
+ if (c.left() != null)\r
+ {\r
+ // Dummy node for polytomy - keeps c.left free for new node\r
+ SequenceNode tmpn = new SequenceNode(null, c, null, 0,\r
+ 0, true);\r
+ tmpn.SetChildren(c.left(), c.right());\r
+ c.setRight(tmpn);\r
+ }\r
\r
- if (ascending) {\r
- // move back up the tree from preceding closure\r
- c = c.AscendTree();\r
+ c.setLeft(new SequenceNode(null, c, null, DefDistance,\r
+ DefBootstrap, false));\r
+ c = (SequenceNode) c.left();\r
+ }\r
+\r
+ if (realroot == null)\r
+ {\r
+ realroot = c;\r
+ }\r
+\r
+ nodename = null;\r
+ distance = DefDistance;\r
+ bootstrap = DefBootstrap;\r
+ cp = fcp + 1;\r
+\r
+ break;\r
+\r
+ // Deal with quoted fields\r
+ case '\'':\r
+\r
+ com.stevesoft.pat.Regex qnodename = new com.stevesoft.pat.Regex(\r
+ "([^']|'')+'");\r
+\r
+ if (qnodename.searchFrom(nf, fcp))\r
+ {\r
+ int nl = qnodename.stringMatched().length();\r
+ nodename = new String(qnodename.stringMatched().substring(0,\r
+ nl - 1));\r
+ cp = fcp + nl + 1;\r
+ }\r
+ else\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "Unterminated quotes for nodename", 7, fcp,\r
+ nf);\r
+ }\r
+\r
+ break;\r
+\r
+ case ';':\r
+\r
+ if (d != -1)\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "Wayward semicolon (depth=" + d + ")", 7,\r
+ fcp, nf);\r
+ }\r
+\r
+ // cp advanced at the end of default\r
+ default:\r
+\r
+ // Parse simpler field strings\r
+ String fstring = nf.substring(cp, fcp);\r
+ com.stevesoft.pat.Regex uqnodename = new com.stevesoft.pat.Regex(\r
+ "\\b([^' :;\\](),]+)");\r
+ com.stevesoft.pat.Regex nbootstrap = new com.stevesoft.pat.Regex(\r
+ "\\S+([0-9+]+)\\S*:");\r
+ com.stevesoft.pat.Regex ndist = new com.stevesoft.pat.Regex(\r
+ ":([-0-9Ee.+]+)");\r
+\r
+ if (uqnodename.search(fstring) &&\r
+ ( (uqnodename.matchedFrom(1) == 0) ||\r
+ (fstring.charAt(uqnodename.matchedFrom(1) - 1) != ':'))) // JBPNote HACK!\r
+ {\r
+ if (nodename == null)\r
+ {\r
+ if (ReplaceUnderscores)\r
+ {\r
+ nodename = uqnodename.stringMatched(1).replace('_',\r
+ ' ');\r
+ }\r
+ else\r
+ {\r
+ nodename = uqnodename.stringMatched(1);\r
+ }\r
+ }\r
+ else\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "File has broken algorithm - overwritten nodename",\r
+ 10, fcp, nf);\r
+ }\r
+ }\r
+\r
+ if (nbootstrap.search(fstring) &&\r
+ (nbootstrap.matchedFrom(1) > (uqnodename.matchedFrom(1) +\r
+ uqnodename.stringMatched().length())))\r
+ {\r
+ try\r
+ {\r
+ bootstrap = (new Integer(nbootstrap.stringMatched(1))).intValue();\r
+ HasBootstrap = true;\r
+ }\r
+ catch (Exception e)\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "Can't parse bootstrap value", 4,\r
+ cp + nbootstrap.matchedFrom(), nf);\r
+ }\r
+ }\r
\r
- if ((d > -1) && (c == null)) {\r
- Error = ErrorStringrange(Error,\r
- "File broke algorithm: Lost place in tree (is there an extra ')' ?)",\r
- 7, fcp, nf);\r
- }\r
- }\r
+ boolean nodehasdistance = false;\r
\r
- if (nf.charAt(fcp) == ')') {\r
- d--;\r
- ascending = true;\r
- } else {\r
- if (nf.charAt(fcp) == ',') {\r
- if (ascending) {\r
- ascending = false;\r
- } else {\r
- // Just advance focus, if we need to\r
- if ((c.left() != null) && (!c.left().isLeaf())) {\r
- c = (SequenceNode) c.left();\r
- }\r
- }\r
- }\r
- // else : We do nothing if ';' is encountered.\r
+ if (ndist.search(fstring))\r
+ {\r
+ try\r
+ {\r
+ distance = (new Float(ndist.stringMatched(1))).floatValue();\r
+ HasDistances = true;\r
+ nodehasdistance = true;\r
+ }\r
+ catch (Exception e)\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "Can't parse node distance value", 7,\r
+ cp + ndist.matchedFrom(), nf);\r
+ }\r
+ }\r
+\r
+ if (ascending)\r
+ {\r
+ // Write node info here\r
+ c.setName(nodename);\r
+ // Trees without distances still need a render distance\r
+ c.dist = (HasDistances) ? distance : DefDistance;\r
+ // be consistent for internal bootstrap defaults too\r
+ c.setBootstrap( (HasBootstrap) ? bootstrap : DefBootstrap);\r
+ if (c == realroot)\r
+ {\r
+ RootHasDistance = nodehasdistance; // JBPNote This is really UGLY!!! Ensure root node gets its given distance\r
+ }\r
+ }\r
+ else\r
+ {\r
+ // Find a place to put the leaf\r
+ SequenceNode newnode = new SequenceNode(null, c, nodename,\r
+ (HasDistances) ? distance : DefDistance,\r
+ (HasBootstrap) ? bootstrap : DefBootstrap, false);\r
+\r
+ if (c.right() == null)\r
+ {\r
+ c.setRight(newnode);\r
+ }\r
+ else\r
+ {\r
+ if (c.left() == null)\r
+ {\r
+ c.setLeft(newnode);\r
+ }\r
+ else\r
+ {\r
+ // Insert a dummy node for polytomy\r
+ // dummy nodes have distances\r
+ SequenceNode newdummy = new SequenceNode(null, c,\r
+ null, (HasDistances ? 0 : DefDistance), 0, true);\r
+ newdummy.SetChildren(c.left(), newnode);\r
+ c.setLeft(newdummy);\r
+ }\r
+ }\r
+ }\r
+\r
+ if (ascending)\r
+ {\r
+ // move back up the tree from preceding closure\r
+ c = c.AscendTree();\r
+\r
+ if ( (d > -1) && (c == null))\r
+ {\r
+ Error = ErrorStringrange(Error,\r
+ "File broke algorithm: Lost place in tree (is there an extra ')' ?)",\r
+ 7, fcp, nf);\r
+ }\r
+ }\r
+\r
+ if (nf.charAt(fcp) == ')')\r
+ {\r
+ d--;\r
+ ascending = true;\r
+ }\r
+ else\r
+ {\r
+ if (nf.charAt(fcp) == ',')\r
+ {\r
+ if (ascending)\r
+ {\r
+ ascending = false;\r
+ }\r
+ else\r
+ {\r
+ // Just advance focus, if we need to\r
+ if ( (c.left() != null) && (!c.left().isLeaf()))\r
+ {\r
+ c = (SequenceNode) c.left();\r
}\r
-\r
- // Reset new node properties to obvious fakes\r
- nodename = null;\r
- distance = DefDistance;\r
- bootstrap = DefBootstrap;\r
-\r
- cp = fcp + 1;\r
+ }\r
}\r
- }\r
\r
- if (Error != null) {\r
- throw (new IOException("NewickFile: " + Error + "\n"));\r
- }\r
+ // else : We do nothing if ';' is encountered.\r
+ }\r
\r
- root = (SequenceNode) root.right().detach(); // remove the imaginary root.\r
+ // Reset new node properties to obvious fakes\r
+ nodename = null;\r
+ distance = DefDistance;\r
+ bootstrap = DefBootstrap;\r
\r
- if (!RootHasDistance) {\r
- root.dist = 0;\r
- }\r
+ cp = fcp + 1;\r
+ }\r
}\r
\r
- public SequenceNode getTree() {\r
- return root;\r
+ if (Error != null)\r
+ {\r
+ throw (new IOException("NewickFile: " + Error + "\n"));\r
}\r
\r
- public String print() {\r
- synchronized (this) {\r
- StringBuffer tf = new StringBuffer();\r
- print(tf, root);\r
-\r
- return (tf.append(";").toString());\r
- }\r
- }\r
-\r
- public String print(boolean withbootstraps) {\r
- synchronized (this) {\r
- boolean boots = this.HasBootstrap;\r
- this.HasBootstrap = withbootstraps;\r
-\r
- String rv = print();\r
- this.HasBootstrap = boots;\r
+ root = (SequenceNode) root.right().detach(); // remove the imaginary root.\r
\r
- return rv;\r
- }\r
- }\r
-\r
- public String print(boolean withbootstraps, boolean withdists) {\r
- synchronized (this) {\r
- boolean dists = this.HasDistances;\r
- this.HasDistances = withdists;\r
-\r
- String rv = print(withbootstraps);\r
- this.HasDistances = dists;\r
-\r
- return rv;\r
- }\r
+ if (!RootHasDistance)\r
+ {\r
+ root.dist = (HasDistances) ? 0 : DefDistance;\r
}\r
-\r
- public String print(boolean withbootstraps, boolean withdists,\r
- boolean printRootInfo) {\r
- synchronized (this) {\r
- boolean rootinfo = printRootInfo;\r
- this.printRootInfo = printRootInfo;\r
-\r
- String rv = print(withbootstraps, withdists);\r
- this.printRootInfo = rootinfo;\r
-\r
- return rv;\r
- }\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ public SequenceNode getTree()\r
+ {\r
+ return root;\r
+ }\r
+\r
+ /**\r
+ * Generate a newick format tree according to internal flags\r
+ * for bootstraps, distances and root distances.\r
+ *\r
+ * @return new hampshire tree in a single line\r
+ */\r
+ public String print()\r
+ {\r
+ synchronized (this)\r
+ {\r
+ StringBuffer tf = new StringBuffer();\r
+ print(tf, root);\r
+\r
+ return (tf.append(";").toString());\r
}\r
-\r
- char getQuoteChar() {\r
- return QuoteChar;\r
+ }\r
+\r
+ /**\r
+ *\r
+ *\r
+ * Generate a newick format tree according to internal flags\r
+ * for distances and root distances and user specificied writing of\r
+ * bootstraps.\r
+ * @param withbootstraps controls if bootstrap values are explicitly written.\r
+ *\r
+ * @return new hampshire tree in a single line\r
+ */\r
+ public String print(boolean withbootstraps)\r
+ {\r
+ synchronized (this)\r
+ {\r
+ boolean boots = this.HasBootstrap;\r
+ this.HasBootstrap = withbootstraps;\r
+\r
+ String rv = print();\r
+ this.HasBootstrap = boots;\r
+\r
+ return rv;\r
}\r
-\r
- char setQuoteChar(char c) {\r
- char old = QuoteChar;\r
- QuoteChar = c;\r
-\r
- return old;\r
+ }\r
+\r
+ /**\r
+ *\r
+ * Generate newick format tree according to internal flags\r
+ * for writing root node distances.\r
+ *\r
+ * @param withbootstraps explicitly write bootstrap values\r
+ * @param withdists explicitly write distances\r
+ *\r
+ * @return new hampshire tree in a single line\r
+ */\r
+ public String print(boolean withbootstraps, boolean withdists)\r
+ {\r
+ synchronized (this)\r
+ {\r
+ boolean dists = this.HasDistances;\r
+ this.HasDistances = withdists;\r
+\r
+ String rv = print(withbootstraps);\r
+ this.HasDistances = dists;\r
+\r
+ return rv;\r
}\r
-\r
- private String nodeName(String name) {\r
- if (NodeSafeName[0].search(name)) {\r
- return QuoteChar + NodeSafeName[1].replaceAll(name) + QuoteChar;\r
- } else {\r
- return NodeSafeName[2].replaceAll(name);\r
- }\r
+ }\r
+\r
+ /**\r
+ * Generate newick format tree according to user specified flags\r
+ *\r
+ * @param withbootstraps explicitly write bootstrap values\r
+ * @param withdists explicitly write distances\r
+ * @param printRootInfo explicitly write root distance\r
+ *\r
+ * @return new hampshire tree in a single line\r
+ */\r
+ public String print(boolean withbootstraps, boolean withdists,\r
+ boolean printRootInfo)\r
+ {\r
+ synchronized (this)\r
+ {\r
+ boolean rootinfo = printRootInfo;\r
+ this.printRootInfo = printRootInfo;\r
+\r
+ String rv = print(withbootstraps, withdists);\r
+ this.printRootInfo = rootinfo;\r
+\r
+ return rv;\r
}\r
-\r
- private String printNodeField(SequenceNode c) {\r
- return ((c.getName() == null) ? "" : nodeName(c.getName())) +\r
- ((HasBootstrap)\r
- ? ((c.getBootstrap() > -1) ? (" " + c.getBootstrap()) : "") : "") +\r
- ((HasDistances) ? (":" + c.dist) : "");\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ char getQuoteChar()\r
+ {\r
+ return QuoteChar;\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @param c DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ char setQuoteChar(char c)\r
+ {\r
+ char old = QuoteChar;\r
+ QuoteChar = c;\r
+\r
+ return old;\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @param name DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ private String nodeName(String name)\r
+ {\r
+ if (NodeSafeName[0].search(name))\r
+ {\r
+ return QuoteChar + NodeSafeName[1].replaceAll(name) + QuoteChar;\r
}\r
-\r
- private String printRootField(SequenceNode root) {\r
- return (printRootInfo)\r
- ? (((root.getName() == null) ? "" : nodeName(root.getName())) +\r
- ((HasBootstrap)\r
- ? ((root.getBootstrap() > -1) ? (" " + root.getBootstrap()) : "") : "") +\r
- ((RootHasDistance) ? (":" + root.dist) : "")) : "";\r
+ else\r
+ {\r
+ return NodeSafeName[2].replaceAll(name);\r
}\r
-\r
- // Non recursive call deals with root node properties\r
- public void print(StringBuffer tf, SequenceNode root) {\r
- if (root != null) {\r
- if (root.isLeaf() && printRootInfo) {\r
- tf.append(printRootField(root));\r
- } else {\r
- if (root.isDummy()) {\r
- _print(tf, (SequenceNode) root.right());\r
- _print(tf, (SequenceNode) root.left());\r
- } else {\r
- tf.append("(");\r
- _print(tf, (SequenceNode) root.right());\r
-\r
- if (root.left() != null) {\r
- tf.append(",");\r
- }\r
-\r
- _print(tf, (SequenceNode) root.left());\r
- tf.append(")" + printRootField(root));\r
- }\r
- }\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @param c DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ private String printNodeField(SequenceNode c)\r
+ {\r
+ return ( (c.getName() == null) ? "" : nodeName(c.getName())) +\r
+ ( (HasBootstrap)\r
+ ? ( (c.getBootstrap() > -1) ? (" " + c.getBootstrap()) : "") : "") +\r
+ ( (HasDistances) ? (":" + c.dist) : "");\r
+ }\r
+\r
+ /**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @param root DOCUMENT ME!\r
+ *\r
+ * @return DOCUMENT ME!\r
+ */\r
+ private String printRootField(SequenceNode root)\r
+ {\r
+ return (printRootInfo)\r
+ ? ( ( (root.getName() == null) ? "" : nodeName(root.getName())) +\r
+ ( (HasBootstrap)\r
+ ? ( (root.getBootstrap() > -1) ? (" " + root.getBootstrap()) : "") :\r
+ "") +\r
+ ( (RootHasDistance) ? (":" + root.dist) : "")) : "";\r
+ }\r
+\r
+ // Non recursive call deals with root node properties\r
+ public void print(StringBuffer tf, SequenceNode root)\r
+ {\r
+ if (root != null)\r
+ {\r
+ if (root.isLeaf() && printRootInfo)\r
+ {\r
+ tf.append(printRootField(root));\r
+ }\r
+ else\r
+ {\r
+ if (root.isDummy())\r
+ {\r
+ _print(tf, (SequenceNode) root.right());\r
+ _print(tf, (SequenceNode) root.left());\r
}\r
- }\r
-\r
- // Recursive call for non-root nodes\r
- public void _print(StringBuffer tf, SequenceNode c) {\r
- if (c != null) {\r
- if (c.isLeaf()) {\r
- tf.append(printNodeField(c));\r
- } else {\r
- if (c.isDummy()) {\r
- _print(tf, (SequenceNode) c.right());\r
- _print(tf, (SequenceNode) c.left());\r
- } else {\r
- tf.append("(");\r
- _print(tf, (SequenceNode) c.right());\r
-\r
- if (c.left() != null) {\r
- tf.append(",");\r
- }\r
-\r
- _print(tf, (SequenceNode) c.left());\r
- tf.append(")" + printNodeField(c));\r
- }\r
- }\r
+ else\r
+ {\r
+ tf.append("(");\r
+ _print(tf, (SequenceNode) root.right());\r
+\r
+ if (root.left() != null)\r
+ {\r
+ tf.append(",");\r
+ }\r
+\r
+ _print(tf, (SequenceNode) root.left());\r
+ tf.append(")" + printRootField(root));\r
}\r
+ }\r
}\r
-\r
- // Test\r
- public static void main(String[] args) {\r
- try {\r
- File fn = new File(args[0]);\r
-\r
- StringBuffer newickfile = new StringBuffer();\r
- BufferedReader treefile = new BufferedReader(new FileReader(fn));\r
- String l;\r
-\r
- while ((l = treefile.readLine()) != null) {\r
- newickfile.append(l);\r
- }\r
-\r
- treefile.close();\r
- System.out.println("Read file :\n");\r
-\r
- NewickFile trf = new NewickFile(args[0], "File");\r
- trf.parse();\r
- System.out.println("Original file :\n");\r
-\r
- com.stevesoft.pat.Regex nonl = new com.stevesoft.pat.Regex("\n+", "");\r
- System.out.println(nonl.replaceAll(newickfile.toString()) + "\n");\r
-\r
- System.out.println("Parsed file.\n");\r
- System.out.println("Default output type for original input.\n");\r
- System.out.println(trf.print());\r
- System.out.println("Without bootstraps.\n");\r
- System.out.println(trf.print(false));\r
- System.out.println("Without distances.\n");\r
- System.out.println(trf.print(true, false));\r
- System.out.println("Without bootstraps but with distanecs.\n");\r
- System.out.println(trf.print(false, true));\r
- System.out.println("Without bootstraps or distanecs.\n");\r
- System.out.println(trf.print(false, false));\r
- System.out.println("With bootstraps and with distances.\n");\r
- System.out.println(trf.print(true, true));\r
- } catch (java.io.IOException e) {\r
- System.err.println("Exception\n" + e);\r
- e.printStackTrace();\r
+ }\r
+\r
+ // Recursive call for non-root nodes\r
+ public void _print(StringBuffer tf, SequenceNode c)\r
+ {\r
+ if (c != null)\r
+ {\r
+ if (c.isLeaf())\r
+ {\r
+ tf.append(printNodeField(c));\r
+ }\r
+ else\r
+ {\r
+ if (c.isDummy())\r
+ {\r
+ _print(tf, (SequenceNode) c.left());\r
+ if (c.left() != null)\r
+ {\r
+ tf.append(",");\r
+ }\r
+ _print(tf, (SequenceNode) c.right());\r
}\r
+ else\r
+ {\r
+ tf.append("(");\r
+ _print(tf, (SequenceNode) c.right());\r
+\r
+ if (c.left() != null)\r
+ {\r
+ tf.append(",");\r
+ }\r
+\r
+ _print(tf, (SequenceNode) c.left());\r
+ tf.append(")" + printNodeField(c));\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ // Test\r
+ public static void main(String[] args)\r
+ {\r
+ try\r
+ {\r
+ if (args == null || args.length != 1)\r
+ {\r
+ System.err.println(\r
+ "Takes one argument - file name of a newick tree file.");\r
+ System.exit(0);\r
+ }\r
+\r
+ File fn = new File(args[0]);\r
+\r
+ StringBuffer newickfile = new StringBuffer();\r
+ BufferedReader treefile = new BufferedReader(new FileReader(fn));\r
+ String l;\r
+\r
+ while ( (l = treefile.readLine()) != null)\r
+ {\r
+ newickfile.append(l);\r
+ }\r
+\r
+ treefile.close();\r
+ System.out.println("Read file :\n");\r
+\r
+ NewickFile trf = new NewickFile(args[0], "File");\r
+ trf.parse();\r
+ System.out.println("Original file :\n");\r
+\r
+ com.stevesoft.pat.Regex nonl = new com.stevesoft.pat.Regex("\n+", "");\r
+ System.out.println(nonl.replaceAll(newickfile.toString()) + "\n");\r
+\r
+ System.out.println("Parsed file.\n");\r
+ System.out.println("Default output type for original input.\n");\r
+ System.out.println(trf.print());\r
+ System.out.println("Without bootstraps.\n");\r
+ System.out.println(trf.print(false));\r
+ System.out.println("Without distances.\n");\r
+ System.out.println(trf.print(true, false));\r
+ System.out.println("Without bootstraps but with distanecs.\n");\r
+ System.out.println(trf.print(false, true));\r
+ System.out.println("Without bootstraps or distanecs.\n");\r
+ System.out.println(trf.print(false, false));\r
+ System.out.println("With bootstraps and with distances.\n");\r
+ System.out.println(trf.print(true, true));\r
+ }\r
+ catch (java.io.IOException e)\r
+ {\r
+ System.err.println("Exception\n" + e);\r
+ e.printStackTrace();\r
}\r
+ }\r
}\r