forester/java/src/org/forester/io/parsers/nhx/NHXParser.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2013 Christian M. Zmasek
   6 //
   7 // This library is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU Lesser General Public
   9 // License as published by the Free Software Foundation; either
  10 // version 2.1 of the License, or (at your option) any later version.
  11 //
  12 // This library is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15 // Lesser General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Lesser General Public
  18 // License along with this library; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  20 //
  21 // Contact: phylosoft @ gmail . com
  22 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  23
  24 package org.forester.io.parsers.nhx;
  25
  26 import java.io.BufferedReader;
  27 import java.io.File;
  28 import java.io.FileNotFoundException;
  29 import java.io.FileReader;
  30 import java.io.IOException;
  31 import java.io.InputStream;
  32 import java.io.InputStreamReader;
  33 import java.util.ArrayList;
  34 import java.util.List;
  35 import java.util.StringTokenizer;
  36 import java.util.regex.Matcher;
  37 import java.util.regex.Pattern;
  38
  39 import org.forester.io.parsers.IteratingPhylogenyParser;
  40 import org.forester.io.parsers.PhylogenyParser;
  41 import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
  42 import org.forester.io.parsers.util.ParserUtils;
  43 import org.forester.io.parsers.util.PhylogenyParserException;
  44 import org.forester.phylogeny.Phylogeny;
  45 import org.forester.phylogeny.PhylogenyMethods;
  46 import org.forester.phylogeny.PhylogenyNode;
  47 import org.forester.phylogeny.data.Accession;
  48 import org.forester.phylogeny.data.Confidence;
  49 import org.forester.phylogeny.data.DomainArchitecture;
  50 import org.forester.phylogeny.data.Event;
  51 import org.forester.phylogeny.data.Identifier;
  52 import org.forester.phylogeny.data.PhylogenyDataUtil;
  53 import org.forester.phylogeny.data.Sequence;
  54 import org.forester.phylogeny.data.Taxonomy;
  55 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  56 import org.forester.util.ForesterUtil;
  57
  58 public final class NHXParser implements PhylogenyParser, IteratingPhylogenyParser {
  59
  60     public static final TAXONOMY_EXTRACTION TAXONOMY_EXTRACTION_DEFAULT = TAXONOMY_EXTRACTION.NO;
  61     public final static Pattern             UC_LETTERS_NUMBERS_PATTERN  = Pattern.compile( "^[A-Z0-9]+$" );
  62     public final static Pattern             NUMBERS_ONLY_PATTERN        = Pattern.compile( "^[0-9\\.]+$" );
  63     public final static Pattern             MB_PROB_PATTERN             = Pattern.compile( "prob=([^,]+)" );
  64     public final static Pattern             MB_PROB_SD_PATTERN          = Pattern.compile( "prob_stddev=([^,]+)" );
  65     public final static Pattern             MB_BL_PATTERN               = Pattern.compile( "length_median=([^,]+)" );
  66     final static private boolean            GUESS_ROOTEDNESS_DEFAULT    = true;
  67     final static private boolean            GUESS_IF_SUPPORT_VALUES     = true;
  68     final static private boolean            IGNORE_QUOTES_DEFAULT       = false;
  69     final static public boolean             REPLACE_UNDERSCORES_DEFAULT = false;
  70     final static private byte               STRING                      = 0;
  71     final static private byte               STRING_BUFFER               = 1;
  72     final static private byte               CHAR_ARRAY                  = 2;
  73     final static private byte               BUFFERED_READER             = 3;
  74     final static private byte               STRING_BUILDER              = 4;
  75     private boolean                         _guess_rootedness;
  76     private boolean                         _ignore_quotes;
  77     private byte                            _input_type;
  78     private int                             _source_length;
  79     private PhylogenyNode                   _current_node;
  80     private StringBuilder                   _current_anotation;
  81     private Object                          _nhx_source;
  82     private int                             _clade_level;
  83     private Phylogeny                       _current_phylogeny;
  84     private TAXONOMY_EXTRACTION             _taxonomy_extraction;
  85     private boolean                         _replace_underscores;
  86     private boolean                         _in_comment                 = false;
  87     private boolean                         _saw_colon                  = false;
  88     private boolean                         _saw_closing_paren;
  89     private boolean                         _saw_open_bracket           = false;
  90     private boolean                         _in_open_bracket            = false;
  91     private boolean                         _in_double_quote            = false;
  92     private boolean                         _in_single_quote            = false;
  93     private String                          _my_source_str              = null;
  94     private StringBuffer                    _my_source_sbuff            = null;
  95     private StringBuilder                   _my_source_sbuil            = null;
  96     private char[]                          _my_source_charary          = null;
  97     private BufferedReader                  _my_source_br               = null;
  98     private int                             _i;
  99     private Phylogeny                       _next;
 100     private Object                          _source;
 101
 102     public NHXParser() {
 103         init();
 104     }
 105
 106     public final TAXONOMY_EXTRACTION getTaxonomyExtraction() {
 107         return _taxonomy_extraction;
 108     }
 109
 110     @Override
 111     public final boolean hasNext() {
 112         return _next != null;
 113     }
 114
 115     @Override
 116     public final Phylogeny next() throws NHXFormatException, IOException {
 117         final Phylogeny phy = _next;
 118         getNext();
 119         return phy;
 120     }
 121
 122     @Override
 123     public final Phylogeny[] parse() throws IOException {
 124         reset();
 125         final List<Phylogeny> l = new ArrayList<Phylogeny>();
 126         while ( hasNext() ) {
 127             l.add( next() );
 128         }
 129         final Phylogeny[] p = new Phylogeny[ l.size() ];
 130         for( int i = 0; i < l.size(); ++i ) {
 131             p[ i ] = l.get( i );
 132         }
 133         return p;
 134     }
 135
 136     @Override
 137     public final void reset() throws NHXFormatException, IOException {
 138         _i = 0;
 139         _next = null;
 140         _in_comment = false;
 141         _saw_colon = false;
 142         _saw_open_bracket = false;
 143         _in_open_bracket = false;
 144         _in_double_quote = false;
 145         _in_single_quote = false;
 146         _clade_level = 0;
 147         _current_anotation = new StringBuilder();
 148         _current_phylogeny = null;
 149         _current_node = null;
 150         _my_source_str = null;
 151         _my_source_sbuff = null;
 152         _my_source_sbuil = null;
 153         _my_source_charary = null;
 154         _my_source_br = null;
 155         determineSourceType( _source );
 156         switch ( _input_type ) {
 157             case STRING:
 158                 _my_source_str = ( String ) _nhx_source;
 159                 break;
 160             case STRING_BUFFER:
 161                 _my_source_sbuff = ( StringBuffer ) _nhx_source;
 162                 break;
 163             case STRING_BUILDER:
 164                 _my_source_sbuil = ( StringBuilder ) _nhx_source;
 165                 break;
 166             case CHAR_ARRAY:
 167                 _my_source_charary = ( char[] ) _nhx_source;
 168                 break;
 169             case BUFFERED_READER:
 170                 if ( _my_source_br != null ) {
 171                     try {
 172                         _my_source_br.close();
 173                     }
 174                     catch ( final IOException e ) {
 175                         //do nothing
 176                     }
 177                 }
 178                 _my_source_br = ( BufferedReader ) _nhx_source;
 179                 break;
 180             default:
 181                 throw new RuntimeException( "unknown input type" );
 182         }
 183         getNext();
 184     }
 185
 186     public final void setGuessRootedness( final boolean guess_rootedness ) {
 187         _guess_rootedness = guess_rootedness;
 188     }
 189
 190     public final void setIgnoreQuotes( final boolean ignore_quotes ) {
 191         _ignore_quotes = ignore_quotes;
 192     }
 193
 194     public final void setReplaceUnderscores( final boolean replace_underscores ) {
 195         _replace_underscores = replace_underscores;
 196     }
 197
 198     @Override
 199     public final void setSource( final Object nhx_source ) throws NHXFormatException, IOException {
 200         _source = nhx_source;
 201         reset();
 202     }
 203
 204     public final void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
 205         _taxonomy_extraction = taxonomy_extraction;
 206     }
 207
 208     private final void determineSourceType( final Object nhx_source ) throws PhylogenyParserException,
 209             FileNotFoundException {
 210         if ( nhx_source == null ) {
 211             throw new PhylogenyParserException( getClass() + ": attempt to parse null object." );
 212         }
 213         else if ( nhx_source instanceof String ) {
 214             _input_type = NHXParser.STRING;
 215             _source_length = ( ( String ) nhx_source ).length();
 216             _nhx_source = nhx_source;
 217         }
 218         else if ( nhx_source instanceof StringBuilder ) {
 219             _input_type = NHXParser.STRING_BUILDER;
 220             _source_length = ( ( StringBuilder ) nhx_source ).length();
 221             _nhx_source = nhx_source;
 222         }
 223         else if ( nhx_source instanceof StringBuffer ) {
 224             _input_type = NHXParser.STRING_BUFFER;
 225             _source_length = ( ( StringBuffer ) nhx_source ).length();
 226             _nhx_source = nhx_source;
 227         }
 228         else if ( nhx_source instanceof StringBuilder ) {
 229             _input_type = NHXParser.STRING_BUILDER;
 230             _source_length = ( ( StringBuilder ) nhx_source ).length();
 231             _nhx_source = nhx_source;
 232         }
 233         else if ( nhx_source instanceof char[] ) {
 234             _input_type = NHXParser.CHAR_ARRAY;
 235             _source_length = ( ( char[] ) nhx_source ).length;
 236             _nhx_source = nhx_source;
 237         }
 238         else if ( nhx_source instanceof File ) {
 239             _input_type = NHXParser.BUFFERED_READER;
 240             _source_length = 0;
 241             final File f = ( File ) nhx_source;
 242             final String error = ForesterUtil.isReadableFile( f );
 243             if ( !ForesterUtil.isEmpty( error ) ) {
 244                 throw new PhylogenyParserException( error );
 245             }
 246             _nhx_source = new BufferedReader( new FileReader( f ) );
 247         }
 248         else if ( nhx_source instanceof InputStream ) {
 249             _input_type = NHXParser.BUFFERED_READER;
 250             _source_length = 0;
 251             final InputStreamReader isr = new InputStreamReader( ( InputStream ) nhx_source );
 252             _nhx_source = new BufferedReader( isr );
 253         }
 254         else {
 255             throw new IllegalArgumentException( getClass() + " can only parse objects of type String,"
 256                     + " StringBuffer, StringBuilder, char[], File," + " or InputStream "
 257                     + " [attempt to parse object of " + nhx_source.getClass() + "]." );
 258         }
 259     }
 260
 261     private final Phylogeny finishPhylogeny() throws PhylogenyParserException, NHXFormatException,
 262             PhyloXmlDataFormatException {
 263         if ( _current_phylogeny != null ) {
 264             parseNHX( _current_anotation != null ? _current_anotation.toString() : "",
 265                       _current_phylogeny.getRoot(),
 266                       getTaxonomyExtraction(),
 267                       isReplaceUnderscores() );
 268             if ( GUESS_IF_SUPPORT_VALUES ) {
 269                 if ( isBranchLengthsLikeBootstrapValues( _current_phylogeny ) ) {
 270                     moveBranchLengthsToConfidenceValues( _current_phylogeny );
 271                 }
 272             }
 273             if ( isGuessRootedness() ) {
 274                 final PhylogenyNode root = _current_phylogeny.getRoot();
 275                 if ( ( root.getDistanceToParent() >= 0.0 ) || !ForesterUtil.isEmpty( root.getName() )
 276                         || !ForesterUtil.isEmpty( PhylogenyMethods.getSpecies( root ) ) || root.isHasAssignedEvent() ) {
 277                     _current_phylogeny.setRooted( true );
 278                 }
 279             }
 280             return _current_phylogeny;
 281         }
 282         return null;
 283     }
 284
 285     private final Phylogeny finishSingleNodePhylogeny() throws PhylogenyParserException, NHXFormatException,
 286             PhyloXmlDataFormatException {
 287         final PhylogenyNode new_node = new PhylogenyNode();
 288         parseNHX( _current_anotation.toString(), new_node, getTaxonomyExtraction(), isReplaceUnderscores() );
 289         _current_phylogeny = new Phylogeny();
 290         _current_phylogeny.setRoot( new_node );
 291         return _current_phylogeny;
 292     }
 293
 294     private final void getNext() throws IOException, NHXFormatException {
 295         while ( true ) {
 296             char c = '\b';
 297             if ( _input_type == BUFFERED_READER ) {
 298                 final int ci = _my_source_br.read();
 299                 if ( ci >= 0 ) {
 300                     c = ( char ) ci;
 301                 }
 302                 else {
 303                     break;
 304                 }
 305             }
 306             else {
 307                 if ( _i >= _source_length ) {
 308                     break;
 309                 }
 310                 else {
 311                     switch ( _input_type ) {
 312                         case STRING:
 313                             c = _my_source_str.charAt( _i );
 314                             break;
 315                         case STRING_BUFFER:
 316                             c = _my_source_sbuff.charAt( _i );
 317                             break;
 318                         case STRING_BUILDER:
 319                             c = _my_source_sbuil.charAt( _i );
 320                             break;
 321                         case CHAR_ARRAY:
 322                             c = _my_source_charary[ _i ];
 323                             break;
 324                     }
 325                 }
 326             }
 327             if ( !_in_single_quote && !_in_double_quote ) {
 328                 if ( c == ':' ) {
 329                     _saw_colon = true;
 330                 }
 331                 else if ( !( ( c < 33 ) || ( c > 126 ) ) && _saw_colon
 332                         && ( ( c != '[' ) && ( c != '.' ) && ( ( c < 48 ) || ( c > 57 ) ) ) ) {
 333                     _saw_colon = false;
 334                 }
 335                 if ( _in_open_bracket && ( c == ']' ) ) {
 336                     _in_open_bracket = false;
 337                 }
 338             }
 339             // \n\t is always ignored,
 340             // as is " (34) and ' (39) (space is 32):
 341             if ( ( isIgnoreQuotes() && ( ( c < 33 ) || ( c > 126 ) || ( c == 34 ) || ( c == 39 ) || ( ( _clade_level == 0 ) && ( c == ';' ) ) ) )
 342                     || ( !isIgnoreQuotes() && ( ( c < 32 ) || ( c > 126 ) || ( ( _clade_level == 0 ) && ( c == ';' ) ) ) ) ) {
 343                 //do nothing
 344             }
 345             else if ( ( c == 32 ) && ( !_in_single_quote && !_in_double_quote ) ) {
 346                 //do nothing
 347             }
 348             else if ( _in_comment ) {
 349                 if ( c == ']' ) {
 350                     _in_comment = false;
 351                 }
 352             }
 353             else if ( _in_double_quote ) {
 354                 if ( c == '"' ) {
 355                     _in_double_quote = false;
 356                 }
 357                 else {
 358                     _current_anotation.append( c );
 359                 }
 360             }
 361             else if ( c == '"' ) {
 362                 _in_double_quote = true;
 363             }
 364             else if ( _in_single_quote ) {
 365                 if ( c == 39 ) {
 366                     _in_single_quote = false;
 367                 }
 368                 else {
 369                     _current_anotation.append( c );
 370                 }
 371             }
 372             else if ( c == 39 ) {
 373                 _in_single_quote = true;
 374             }
 375             else if ( c == '[' ) {
 376                 _saw_open_bracket = true;
 377                 _in_open_bracket = true;
 378             }
 379             else if ( _saw_open_bracket ) {
 380                 if ( c != ']' ) {
 381                     // everything not starting with "[&" is considered a comment
 382                     // unless ":digits and/or . [bootstrap]":
 383                     if ( c == '&' ) {
 384                         _current_anotation.append( "[&" );
 385                     }
 386                     else if ( _saw_colon ) {
 387                         _current_anotation.append( "[" + c );
 388                     }
 389                     else {
 390                         _in_comment = true;
 391                     }
 392                 }
 393                 // comment consisting just of "[]":
 394                 _saw_open_bracket = false;
 395             }
 396             else if ( ( c == '(' ) && !_in_open_bracket ) {
 397                 final Phylogeny phy = processOpenParen();
 398                 if ( phy != null ) {
 399                     ++_i;
 400                     //  return phy;
 401                     _next = phy;
 402                     return;
 403                 }
 404             }
 405             else if ( ( c == ')' ) && !_in_open_bracket ) {
 406                 processCloseParen();
 407             }
 408             else if ( ( c == ',' ) && !_in_open_bracket ) {
 409                 processComma();
 410             }
 411             else {
 412                 _current_anotation.append( c );
 413             }
 414             ++_i;
 415         } //  while ( true )
 416         if ( _clade_level != 0 ) {
 417             throw new PhylogenyParserException( "error in NH (Newick) formatted data: most likely cause: number of open parens does not equal number of close parens" );
 418         }
 419         if ( _current_phylogeny != null ) {
 420             _next = finishPhylogeny();
 421             _current_phylogeny = null;
 422             _current_anotation = null;
 423         }
 424         else if ( ( _current_anotation != null ) && ( _current_anotation.length() > 0 ) ) {
 425             _next = finishSingleNodePhylogeny();
 426             _current_anotation = null;
 427         }
 428         else {
 429             _next = null;
 430         }
 431     }
 432
 433     private final void init() {
 434         setTaxonomyExtraction( TAXONOMY_EXTRACTION_DEFAULT );
 435         setReplaceUnderscores( REPLACE_UNDERSCORES_DEFAULT );
 436         setGuessRootedness( GUESS_ROOTEDNESS_DEFAULT );
 437         setIgnoreQuotes( IGNORE_QUOTES_DEFAULT );
 438     }
 439
 440     private final boolean isGuessRootedness() {
 441         return _guess_rootedness;
 442     }
 443
 444     private final boolean isIgnoreQuotes() {
 445         return _ignore_quotes;
 446     }
 447
 448     private final boolean isReplaceUnderscores() {
 449         return _replace_underscores;
 450     }
 451
 452     private final void processCloseParen() throws PhylogenyParserException, NHXFormatException,
 453             PhyloXmlDataFormatException {
 454         if ( _clade_level < 0 ) {
 455             throw new PhylogenyParserException( "error in NH (Newick)/NHX formatted data: most likely cause: number of close parens is larger than number of open parens" );
 456         }
 457         --_clade_level;
 458         if ( !_saw_closing_paren ) {
 459             final PhylogenyNode new_node = new PhylogenyNode();
 460             parseNHX( _current_anotation.toString(), new_node, getTaxonomyExtraction(), isReplaceUnderscores() );
 461             _current_anotation = new StringBuilder();
 462             _current_node.addAsChild( new_node );
 463         }
 464         else {
 465             parseNHX( _current_anotation.toString(),
 466                       _current_node.getLastChildNode(),
 467                       getTaxonomyExtraction(),
 468                       isReplaceUnderscores() );
 469             _current_anotation = new StringBuilder();
 470         }
 471         if ( !_current_node.isRoot() ) {
 472             _current_node = _current_node.getParent();
 473         }
 474         _saw_closing_paren = true;
 475     }
 476
 477     private final void processComma() throws PhylogenyParserException, NHXFormatException, PhyloXmlDataFormatException {
 478         if ( !_saw_closing_paren ) {
 479             final PhylogenyNode new_node = new PhylogenyNode();
 480             parseNHX( _current_anotation.toString(), new_node, getTaxonomyExtraction(), isReplaceUnderscores() );
 481             if ( _current_node == null ) {
 482                 throw new NHXFormatException( "format might not be NH or NHX" );
 483             }
 484             _current_node.addAsChild( new_node );
 485         }
 486         else {
 487             parseNHX( _current_anotation.toString(),
 488                       _current_node.getLastChildNode(),
 489                       getTaxonomyExtraction(),
 490                       isReplaceUnderscores() );
 491         }
 492         _current_anotation = new StringBuilder();
 493         _saw_closing_paren = false;
 494     }
 495
 496     private final Phylogeny processOpenParen() throws PhylogenyParserException, NHXFormatException,
 497             PhyloXmlDataFormatException {
 498         Phylogeny phy = null;
 499         final PhylogenyNode new_node = new PhylogenyNode();
 500         if ( _clade_level == 0 ) {
 501             if ( _current_phylogeny != null ) {
 502                 phy = finishPhylogeny();
 503             }
 504             _clade_level = 1;
 505             _current_anotation = new StringBuilder();
 506             _current_phylogeny = new Phylogeny();
 507             _current_phylogeny.setRoot( new_node );
 508         }
 509         else {
 510             ++_clade_level;
 511             _current_node.addAsChild( new_node );
 512         }
 513         _current_node = new_node;
 514         _saw_closing_paren = false;
 515         return phy;
 516     }
 517
 518     public final static void parseNHX( String s,
 519                                        final PhylogenyNode node_to_annotate,
 520                                        final TAXONOMY_EXTRACTION taxonomy_extraction,
 521                                        final boolean replace_underscores ) throws NHXFormatException,
 522             PhyloXmlDataFormatException {
 523         if ( ( taxonomy_extraction != TAXONOMY_EXTRACTION.NO ) && replace_underscores ) {
 524             throw new IllegalArgumentException( "cannot extract taxonomies and replace under scores at the same time" );
 525         }
 526         if ( ( s != null ) && ( s.length() > 0 ) ) {
 527             if ( replace_underscores ) {
 528                 s = s.replaceAll( "_+", " " );
 529             }
 530             boolean is_nhx = false;
 531             final int ob = s.indexOf( "[" );
 532             if ( ob > -1 ) {
 533                 String b = "";
 534                 is_nhx = true;
 535                 final int cb = s.indexOf( "]" );
 536                 if ( cb < 0 ) {
 537                     throw new NHXFormatException( "error in NHX formatted data: no closing \"]\" in \"" + s + "\"" );
 538                 }
 539                 if ( s.indexOf( "&&NHX" ) == ( ob + 1 ) ) {
 540                     b = s.substring( ob + 6, cb );
 541                 }
 542                 else {
 543                     // No &&NHX and digits only: is likely to be a support value.
 544                     final String bracketed = s.substring( ob + 1, cb );
 545                     final Matcher numbers_only = NUMBERS_ONLY_PATTERN.matcher( bracketed );
 546                     if ( numbers_only.matches() ) {
 547                         b = ":" + NHXtags.SUPPORT + bracketed;
 548                     }
 549                     else if ( s.indexOf( "prob=" ) > -1 ) {
 550                         processMrBayes3Data( s, node_to_annotate );
 551                     }
 552                 }
 553                 s = s.substring( 0, ob ) + b;
 554                 if ( ( s.indexOf( "[" ) > -1 ) || ( s.indexOf( "]" ) > -1 ) ) {
 555                     throw new NHXFormatException( "error in NHX formatted data: more than one \"]\" or \"[\"" );
 556                 }
 557             }
 558             final StringTokenizer t = new StringTokenizer( s, ":" );
 559             if ( t.countTokens() > 0 ) {
 560                 if ( !s.startsWith( ":" ) ) {
 561                     node_to_annotate.setName( t.nextToken() );
 562                     if ( !replace_underscores && ( !is_nhx && ( taxonomy_extraction != TAXONOMY_EXTRACTION.NO ) ) ) {
 563                         ParserUtils.extractTaxonomyDataFromNodeName( node_to_annotate, taxonomy_extraction );
 564                     }
 565                 }
 566                 while ( t.hasMoreTokens() ) {
 567                     s = t.nextToken();
 568                     if ( s.startsWith( NHXtags.SPECIES_NAME ) ) {
 569                         if ( !node_to_annotate.getNodeData().isHasTaxonomy() ) {
 570                             node_to_annotate.getNodeData().setTaxonomy( new Taxonomy() );
 571                         }
 572                         node_to_annotate.getNodeData().getTaxonomy().setScientificName( s.substring( 2 ) );
 573                     }
 574                     else if ( s.startsWith( NHXtags.IS_DUPLICATION ) ) {
 575                         if ( ( s.charAt( 2 ) == 'Y' ) || ( s.charAt( 2 ) == 'T' ) ) {
 576                             node_to_annotate.getNodeData().setEvent( Event.createSingleDuplicationEvent() );
 577                         }
 578                         else if ( ( s.charAt( 2 ) == 'N' ) || ( s.charAt( 2 ) == 'F' ) ) {
 579                             node_to_annotate.getNodeData().setEvent( Event.createSingleSpeciationEvent() );
 580                         }
 581                         else if ( s.charAt( 2 ) == '?' ) {
 582                             node_to_annotate.getNodeData().setEvent( Event.createSingleSpeciationOrDuplicationEvent() );
 583                         }
 584                         else {
 585                             throw new NHXFormatException( "error in NHX formatted data: :D=Y or :D=N or :D=?" );
 586                         }
 587                     }
 588                     else if ( s.startsWith( NHXtags.SUPPORT ) ) {
 589                         PhylogenyMethods.setConfidence( node_to_annotate, doubleValue( s.substring( 2 ) ) );
 590                     }
 591                     else if ( s.startsWith( NHXtags.TAXONOMY_ID ) ) {
 592                         if ( !node_to_annotate.getNodeData().isHasTaxonomy() ) {
 593                             node_to_annotate.getNodeData().setTaxonomy( new Taxonomy() );
 594                         }
 595                         node_to_annotate.getNodeData().getTaxonomy().setIdentifier( new Identifier( s.substring( 2 ) ) );
 596                     }
 597                     else if ( s.startsWith( NHXtags.DOMAIN_STRUCTURE ) ) {
 598                         if ( !node_to_annotate.getNodeData().isHasSequence() ) {
 599                             node_to_annotate.getNodeData().setSequence( new Sequence() );
 600                         }
 601                         node_to_annotate.getNodeData().getSequence()
 602                                 .setDomainArchitecture( new DomainArchitecture( s.substring( 3 ) ) );
 603                     }
 604                     else if ( s.startsWith( NHXtags.SEQUENCE_ACCESSION ) ) {
 605                         if ( !node_to_annotate.getNodeData().isHasSequence() ) {
 606                             node_to_annotate.getNodeData().setSequence( new Sequence() );
 607                         }
 608                         node_to_annotate.getNodeData().getSequence()
 609                                 .setAccession( new Accession( s.substring( 3 ), "?" ) );
 610                     }
 611                     else if ( s.startsWith( NHXtags.GENE_NAME ) ) {
 612                         if ( !node_to_annotate.getNodeData().isHasSequence() ) {
 613                             node_to_annotate.getNodeData().setSequence( new Sequence() );
 614                         }
 615                         node_to_annotate.getNodeData().getSequence().setName( s.substring( 3 ) );
 616                     }
 617                     else if ( s.indexOf( '=' ) < 0 ) {
 618                         if ( node_to_annotate.getDistanceToParent() != PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) {
 619                             throw new NHXFormatException( "error in NHX formatted data: more than one distance to parent:"
 620                                     + "\"" + s + "\"" );
 621                         }
 622                         node_to_annotate.setDistanceToParent( doubleValue( s ) );
 623                     }
 624                 } // while ( t.hasMoreTokens() )
 625             }
 626         }
 627     }
 628
 629     private final static double doubleValue( final String str ) throws NHXFormatException {
 630         try {
 631             return Double.valueOf( str ).doubleValue();
 632         }
 633         catch ( final NumberFormatException ex ) {
 634             throw new NHXFormatException( "error in NH/NHX formatted data: failed to parse number from " + "\"" + str
 635                     + "\"" );
 636         }
 637     }
 638
 639     private final static boolean isBranchLengthsLikeBootstrapValues( final Phylogeny p ) {
 640         final PhylogenyNodeIterator it = p.iteratorExternalForward();
 641         final double d0 = it.next().getDistanceToParent();
 642         if ( ( d0 < 10 ) || !it.hasNext() ) {
 643             return false;
 644         }
 645         while ( it.hasNext() ) {
 646             final double d = it.next().getDistanceToParent();
 647             if ( ( d != d0 ) || ( d < 10 ) ) {
 648                 return false;
 649             }
 650         }
 651         return true;
 652     }
 653
 654     private final static void moveBranchLengthsToConfidenceValues( final Phylogeny p ) {
 655         final PhylogenyNodeIterator it = p.iteratorPostorder();
 656         while ( it.hasNext() ) {
 657             final PhylogenyNode n = it.next();
 658             PhylogenyMethods.setBootstrapConfidence( n, n.getDistanceToParent() );
 659             n.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
 660         }
 661     }
 662
 663     private final static void processMrBayes3Data( final String s, final PhylogenyNode node_to_annotate )
 664             throws NHXFormatException {
 665         double sd = -1;
 666         final Matcher mb_prob_sd_matcher = MB_PROB_SD_PATTERN.matcher( s );
 667         if ( mb_prob_sd_matcher.find() ) {
 668             try {
 669                 sd = Double.parseDouble( mb_prob_sd_matcher.group( 1 ) );
 670             }
 671             catch ( final NumberFormatException e ) {
 672                 throw new NHXFormatException( "failed to parse probability standard deviation (Mr Bayes output) from \""
 673                         + s + "\"" );
 674             }
 675         }
 676         final Matcher mb_prob_matcher = MB_PROB_PATTERN.matcher( s );
 677         if ( mb_prob_matcher.find() ) {
 678             double prob = -1;
 679             try {
 680                 prob = Double.parseDouble( mb_prob_matcher.group( 1 ) );
 681             }
 682             catch ( final NumberFormatException e ) {
 683                 throw new NHXFormatException( "failed to parse probability (Mr Bayes output) from \"" + s + "\"" );
 684             }
 685             if ( prob >= 0.0 ) {
 686                 if ( sd >= 0.0 ) {
 687                     node_to_annotate.getBranchData()
 688                             .addConfidence( new Confidence( prob, "posterior probability", sd ) );
 689                 }
 690                 else {
 691                     node_to_annotate.getBranchData().addConfidence( new Confidence( prob, "posterior probability" ) );
 692                 }
 693             }
 694         }
 695         final Matcher mb_bl_matcher = MB_BL_PATTERN.matcher( s );
 696         if ( mb_bl_matcher.find() ) {
 697             double bl = -1;
 698             try {
 699                 bl = Double.parseDouble( mb_bl_matcher.group( 1 ) );
 700             }
 701             catch ( final NumberFormatException e ) {
 702                 throw new NHXFormatException( "failed to parse median branch length (Mr Bayes output) from \"" + s
 703                         + "\"" );
 704             }
 705             if ( bl >= 0.0 ) {
 706                 node_to_annotate.setDistanceToParent( bl );
 707             }
 708         }
 709     }
 710
 711     public static enum TAXONOMY_EXTRACTION {
 712         NO, YES, PFAM_STYLE_ONLY;
 713     }
 714 }