forester/java/src/org/forester/phylogeny/PhylogenyMethods.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.phylogeny;
  27
  28 import java.awt.Color;
  29 import java.io.File;
  30 import java.io.IOException;
  31 import java.util.ArrayList;
  32 import java.util.Arrays;
  33 import java.util.Collections;
  34 import java.util.Comparator;
  35 import java.util.HashSet;
  36 import java.util.Iterator;
  37 import java.util.List;
  38 import java.util.Set;
  39 import java.util.SortedMap;
  40 import java.util.TreeMap;
  41
  42 import org.forester.io.parsers.PhylogenyParser;
  43 import org.forester.io.parsers.phyloxml.PhyloXmlUtil;
  44 import org.forester.io.parsers.util.PhylogenyParserException;
  45 import org.forester.phylogeny.data.BranchColor;
  46 import org.forester.phylogeny.data.BranchWidth;
  47 import org.forester.phylogeny.data.Confidence;
  48 import org.forester.phylogeny.data.DomainArchitecture;
  49 import org.forester.phylogeny.data.Identifier;
  50 import org.forester.phylogeny.data.PhylogenyDataUtil;
  51 import org.forester.phylogeny.data.Sequence;
  52 import org.forester.phylogeny.data.Taxonomy;
  53 import org.forester.phylogeny.factories.ParserBasedPhylogenyFactory;
  54 import org.forester.phylogeny.factories.PhylogenyFactory;
  55 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  56 import org.forester.util.BasicDescriptiveStatistics;
  57 import org.forester.util.DescriptiveStatistics;
  58 import org.forester.util.FailedConditionCheckException;
  59 import org.forester.util.ForesterUtil;
  60
  61 public class PhylogenyMethods {
  62
  63     private static PhylogenyMethods _instance      = null;
  64     private final Set<Integer>      _temp_hash_set = new HashSet<Integer>();
  65     private PhylogenyNode           _farthest_1    = null;
  66     private PhylogenyNode           _farthest_2    = null;
  67
  68     private PhylogenyMethods() {
  69         // Hidden constructor.
  70     }
  71
  72     /**
  73      * Calculates the distance between PhylogenyNodes node1 and node2.
  74      *
  75      *
  76      * @param node1
  77      * @param node2
  78      * @return distance between node1 and node2
  79      */
  80     public double calculateDistance( final PhylogenyNode node1, final PhylogenyNode node2 ) {
  81         final PhylogenyNode lca = obtainLCA( node1, node2 );
  82         final PhylogenyNode n1 = node1;
  83         final PhylogenyNode n2 = node2;
  84         return ( PhylogenyMethods.getDistance( n1, lca ) + PhylogenyMethods.getDistance( n2, lca ) );
  85     }
  86
  87     public double calculateFurthestDistance( final Phylogeny phylogeny ) {
  88         if ( phylogeny.getNumberOfExternalNodes() < 2 ) {
  89             return 0.0;
  90         }
  91         _farthest_1 = null;
  92         _farthest_2 = null;
  93         PhylogenyNode node_1 = null;
  94         PhylogenyNode node_2 = null;
  95         double farthest_d = -Double.MAX_VALUE;
  96         final PhylogenyMethods methods = PhylogenyMethods.getInstance();
  97         final List<PhylogenyNode> ext_nodes = phylogeny.getRoot().getAllExternalDescendants();
  98         for( int i = 1; i < ext_nodes.size(); ++i ) {
  99             for( int j = 0; j < i; ++j ) {
 100                 final double d = methods.calculateDistance( ext_nodes.get( i ), ext_nodes.get( j ) );
 101                 if ( d < 0.0 ) {
 102                     throw new RuntimeException( "distance cannot be negative" );
 103                 }
 104                 if ( d > farthest_d ) {
 105                     farthest_d = d;
 106                     node_1 = ext_nodes.get( i );
 107                     node_2 = ext_nodes.get( j );
 108                 }
 109             }
 110         }
 111         _farthest_1 = node_1;
 112         _farthest_2 = node_2;
 113         return farthest_d;
 114     }
 115
 116     @Override
 117     public Object clone() throws CloneNotSupportedException {
 118         throw new CloneNotSupportedException();
 119     }
 120
 121     public PhylogenyNode getFarthestNode1() {
 122         return _farthest_1;
 123     }
 124
 125     public PhylogenyNode getFarthestNode2() {
 126         return _farthest_2;
 127     }
 128
 129     /**
 130      * Returns the LCA of PhylogenyNodes node1 and node2.
 131      *
 132      *
 133      * @param node1
 134      * @param node2
 135      * @return LCA of node1 and node2
 136      */
 137     public PhylogenyNode obtainLCA( final PhylogenyNode node1, final PhylogenyNode node2 ) {
 138         _temp_hash_set.clear();
 139         PhylogenyNode n1 = node1;
 140         PhylogenyNode n2 = node2;
 141         _temp_hash_set.add( n1.getId() );
 142         while ( !n1.isRoot() ) {
 143             n1 = n1.getParent();
 144             _temp_hash_set.add( n1.getId() );
 145         }
 146         while ( !_temp_hash_set.contains( n2.getId() ) && !n2.isRoot() ) {
 147             n2 = n2.getParent();
 148         }
 149         if ( !_temp_hash_set.contains( n2.getId() ) ) {
 150             throw new IllegalArgumentException( "attempt to get LCA of two nodes which do not share a common root" );
 151         }
 152         return n2;
 153     }
 154
 155     /**
 156      * Returns all orthologs of the external PhylogenyNode n of this Phylogeny.
 157      * Orthologs are returned as List of node references.
 158      * <p>
 159      * PRECONDITION: This tree must be binary and rooted, and speciation -
 160      * duplication need to be assigned for each of its internal Nodes.
 161      * <p>
 162      * Returns null if this Phylogeny is empty or if n is internal.
 163      * @param n
 164      *            external PhylogenyNode whose orthologs are to be returned
 165      * @return Vector of references to all orthologous Nodes of PhylogenyNode n
 166      *         of this Phylogeny, null if this Phylogeny is empty or if n is
 167      *         internal
 168      */
 169     public List<PhylogenyNode> getOrthologousNodes( final Phylogeny phy, final PhylogenyNode node ) {
 170         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 171         final PhylogenyNodeIterator it = phy.iteratorExternalForward();
 172         while ( it.hasNext() ) {
 173             final PhylogenyNode temp_node = it.next();
 174             if ( ( temp_node != node ) && isAreOrthologous( node, temp_node ) ) {
 175                 nodes.add( temp_node );
 176             }
 177         }
 178         return nodes;
 179     }
 180
 181     public boolean isAreOrthologous( final PhylogenyNode node1, final PhylogenyNode node2 ) {
 182         return !obtainLCA( node1, node2 ).isDuplication();
 183     }
 184
 185     public final static Phylogeny[] readPhylogenies( final PhylogenyParser parser, final File file ) throws IOException {
 186         final PhylogenyFactory factory = ParserBasedPhylogenyFactory.getInstance();
 187         final Phylogeny[] trees = factory.create( file, parser );
 188         if ( ( trees == null ) || ( trees.length == 0 ) ) {
 189             throw new PhylogenyParserException( "Unable to parse phylogeny from file: " + file );
 190         }
 191         return trees;
 192     }
 193
 194     final static public void transferInternalNodeNamesToConfidence( final Phylogeny phy ) {
 195         final PhylogenyNodeIterator it = phy.iteratorPostorder();
 196         while ( it.hasNext() ) {
 197             final PhylogenyNode n = it.next();
 198             if ( !n.isExternal() && !n.getBranchData().isHasConfidences() ) {
 199                 if ( !ForesterUtil.isEmpty( n.getName() ) ) {
 200                     double d = -1.0;
 201                     try {
 202                         d = Double.parseDouble( n.getName() );
 203                     }
 204                     catch ( final Exception e ) {
 205                         d = -1.0;
 206                     }
 207                     if ( d >= 0.0 ) {
 208                         n.getBranchData().addConfidence( new Confidence( d, "" ) );
 209                         n.setName( "" );
 210                     }
 211                 }
 212             }
 213         }
 214     }
 215
 216     final static public void transferInternalNamesToBootstrapSupport( final Phylogeny phy ) {
 217         final PhylogenyNodeIterator it = phy.iteratorPostorder();
 218         while ( it.hasNext() ) {
 219             final PhylogenyNode n = it.next();
 220             if ( !n.isExternal() && !ForesterUtil.isEmpty( n.getName() ) ) {
 221                 double value = -1;
 222                 try {
 223                     value = Double.parseDouble( n.getName() );
 224                 }
 225                 catch ( final NumberFormatException e ) {
 226                     throw new IllegalArgumentException( "failed to parse number from [" + n.getName() + "]: "
 227                             + e.getLocalizedMessage() );
 228                 }
 229                 if ( value >= 0.0 ) {
 230                     n.getBranchData().addConfidence( new Confidence( value, "bootstrap" ) );
 231                     n.setName( "" );
 232                 }
 233             }
 234         }
 235     }
 236
 237     final static public void sortNodeDescendents( final PhylogenyNode node, final DESCENDANT_SORT_PRIORITY pri ) {
 238         class PhylogenyNodeSortTaxonomyPriority implements Comparator<PhylogenyNode> {
 239
 240             @Override
 241             public int compare( final PhylogenyNode n1, final PhylogenyNode n2 ) {
 242                 if ( n1.getNodeData().isHasTaxonomy() && n2.getNodeData().isHasTaxonomy() ) {
 243                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getScientificName() ) )
 244                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getScientificName() ) ) ) {
 245                         return n1.getNodeData().getTaxonomy().getScientificName().toLowerCase()
 246                                 .compareTo( n2.getNodeData().getTaxonomy().getScientificName().toLowerCase() );
 247                     }
 248                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getTaxonomyCode() ) )
 249                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getTaxonomyCode() ) ) ) {
 250                         return n1.getNodeData().getTaxonomy().getTaxonomyCode()
 251                                 .compareTo( n2.getNodeData().getTaxonomy().getTaxonomyCode() );
 252                     }
 253                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getCommonName() ) )
 254                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getCommonName() ) ) ) {
 255                         return n1.getNodeData().getTaxonomy().getCommonName().toLowerCase()
 256                                 .compareTo( n2.getNodeData().getTaxonomy().getCommonName().toLowerCase() );
 257                     }
 258                 }
 259                 if ( n1.getNodeData().isHasSequence() && n2.getNodeData().isHasSequence() ) {
 260                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getName() ) )
 261                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getName() ) ) ) {
 262                         return n1.getNodeData().getSequence().getName().toLowerCase()
 263                                 .compareTo( n2.getNodeData().getSequence().getName().toLowerCase() );
 264                     }
 265                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getSymbol() ) )
 266                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getSymbol() ) ) ) {
 267                         return n1.getNodeData().getSequence().getSymbol()
 268                                 .compareTo( n2.getNodeData().getSequence().getSymbol() );
 269                     }
 270                     if ( ( n1.getNodeData().getSequence().getAccession() != null )
 271                             && ( n2.getNodeData().getSequence().getAccession() != null )
 272                             && !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getAccession().getValue() )
 273                             && !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getAccession().getValue() ) ) {
 274                         return n1.getNodeData().getSequence().getAccession().getValue()
 275                                 .compareTo( n2.getNodeData().getSequence().getAccession().getValue() );
 276                     }
 277                 }
 278                 if ( ( !ForesterUtil.isEmpty( n1.getName() ) ) && ( !ForesterUtil.isEmpty( n2.getName() ) ) ) {
 279                     return n1.getName().toLowerCase().compareTo( n2.getName().toLowerCase() );
 280                 }
 281                 return 0;
 282             }
 283         }
 284         class PhylogenyNodeSortSequencePriority implements Comparator<PhylogenyNode> {
 285
 286             @Override
 287             public int compare( final PhylogenyNode n1, final PhylogenyNode n2 ) {
 288                 if ( n1.getNodeData().isHasSequence() && n2.getNodeData().isHasSequence() ) {
 289                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getName() ) )
 290                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getName() ) ) ) {
 291                         return n1.getNodeData().getSequence().getName().toLowerCase()
 292                                 .compareTo( n2.getNodeData().getSequence().getName().toLowerCase() );
 293                     }
 294                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getSymbol() ) )
 295                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getSymbol() ) ) ) {
 296                         return n1.getNodeData().getSequence().getSymbol()
 297                                 .compareTo( n2.getNodeData().getSequence().getSymbol() );
 298                     }
 299                     if ( ( n1.getNodeData().getSequence().getAccession() != null )
 300                             && ( n2.getNodeData().getSequence().getAccession() != null )
 301                             && !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getAccession().getValue() )
 302                             && !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getAccession().getValue() ) ) {
 303                         return n1.getNodeData().getSequence().getAccession().getValue()
 304                                 .compareTo( n2.getNodeData().getSequence().getAccession().getValue() );
 305                     }
 306                 }
 307                 if ( n1.getNodeData().isHasTaxonomy() && n2.getNodeData().isHasTaxonomy() ) {
 308                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getScientificName() ) )
 309                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getScientificName() ) ) ) {
 310                         return n1.getNodeData().getTaxonomy().getScientificName().toLowerCase()
 311                                 .compareTo( n2.getNodeData().getTaxonomy().getScientificName().toLowerCase() );
 312                     }
 313                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getTaxonomyCode() ) )
 314                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getTaxonomyCode() ) ) ) {
 315                         return n1.getNodeData().getTaxonomy().getTaxonomyCode()
 316                                 .compareTo( n2.getNodeData().getTaxonomy().getTaxonomyCode() );
 317                     }
 318                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getCommonName() ) )
 319                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getCommonName() ) ) ) {
 320                         return n1.getNodeData().getTaxonomy().getCommonName().toLowerCase()
 321                                 .compareTo( n2.getNodeData().getTaxonomy().getCommonName().toLowerCase() );
 322                     }
 323                 }
 324                 if ( ( !ForesterUtil.isEmpty( n1.getName() ) ) && ( !ForesterUtil.isEmpty( n2.getName() ) ) ) {
 325                     return n1.getName().toLowerCase().compareTo( n2.getName().toLowerCase() );
 326                 }
 327                 return 0;
 328             }
 329         }
 330         class PhylogenyNodeSortNodeNamePriority implements Comparator<PhylogenyNode> {
 331
 332             @Override
 333             public int compare( final PhylogenyNode n1, final PhylogenyNode n2 ) {
 334                 if ( ( !ForesterUtil.isEmpty( n1.getName() ) ) && ( !ForesterUtil.isEmpty( n2.getName() ) ) ) {
 335                     return n1.getName().toLowerCase().compareTo( n2.getName().toLowerCase() );
 336                 }
 337                 if ( n1.getNodeData().isHasTaxonomy() && n2.getNodeData().isHasTaxonomy() ) {
 338                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getScientificName() ) )
 339                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getScientificName() ) ) ) {
 340                         return n1.getNodeData().getTaxonomy().getScientificName().toLowerCase()
 341                                 .compareTo( n2.getNodeData().getTaxonomy().getScientificName().toLowerCase() );
 342                     }
 343                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getTaxonomyCode() ) )
 344                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getTaxonomyCode() ) ) ) {
 345                         return n1.getNodeData().getTaxonomy().getTaxonomyCode()
 346                                 .compareTo( n2.getNodeData().getTaxonomy().getTaxonomyCode() );
 347                     }
 348                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getTaxonomy().getCommonName() ) )
 349                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getTaxonomy().getCommonName() ) ) ) {
 350                         return n1.getNodeData().getTaxonomy().getCommonName().toLowerCase()
 351                                 .compareTo( n2.getNodeData().getTaxonomy().getCommonName().toLowerCase() );
 352                     }
 353                 }
 354                 if ( n1.getNodeData().isHasSequence() && n2.getNodeData().isHasSequence() ) {
 355                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getName() ) )
 356                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getName() ) ) ) {
 357                         return n1.getNodeData().getSequence().getName().toLowerCase()
 358                                 .compareTo( n2.getNodeData().getSequence().getName().toLowerCase() );
 359                     }
 360                     if ( ( !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getSymbol() ) )
 361                             && ( !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getSymbol() ) ) ) {
 362                         return n1.getNodeData().getSequence().getSymbol()
 363                                 .compareTo( n2.getNodeData().getSequence().getSymbol() );
 364                     }
 365                     if ( ( n1.getNodeData().getSequence().getAccession() != null )
 366                             && ( n2.getNodeData().getSequence().getAccession() != null )
 367                             && !ForesterUtil.isEmpty( n1.getNodeData().getSequence().getAccession().getValue() )
 368                             && !ForesterUtil.isEmpty( n2.getNodeData().getSequence().getAccession().getValue() ) ) {
 369                         return n1.getNodeData().getSequence().getAccession().getValue()
 370                                 .compareTo( n2.getNodeData().getSequence().getAccession().getValue() );
 371                     }
 372                 }
 373                 return 0;
 374             }
 375         }
 376         Comparator<PhylogenyNode> c;
 377         switch ( pri ) {
 378             case SEQUENCE:
 379                 c = new PhylogenyNodeSortSequencePriority();
 380                 break;
 381             case NODE_NAME:
 382                 c = new PhylogenyNodeSortNodeNamePriority();
 383                 break;
 384             default:
 385                 c = new PhylogenyNodeSortTaxonomyPriority();
 386         }
 387         final List<PhylogenyNode> descs = node.getDescendants();
 388         Collections.sort( descs, c );
 389         int i = 0;
 390         for( final PhylogenyNode desc : descs ) {
 391             node.setChildNode( i++, desc );
 392         }
 393     }
 394
 395     final static public void transferNodeNameToField( final Phylogeny phy,
 396                                                       final PhylogenyMethods.PhylogenyNodeField field ) {
 397         final PhylogenyNodeIterator it = phy.iteratorPostorder();
 398         while ( it.hasNext() ) {
 399             final PhylogenyNode n = it.next();
 400             final String name = n.getName().trim();
 401             if ( !ForesterUtil.isEmpty( name ) ) {
 402                 switch ( field ) {
 403                     case TAXONOMY_CODE:
 404                         //temp hack
 405                         //                        if ( name.length() > 5 ) {
 406                         //                            n.setName( "" );
 407                         //                            if ( !n.getNodeData().isHasTaxonomy() ) {
 408                         //                                n.getNodeData().setTaxonomy( new Taxonomy() );
 409                         //                            }
 410                         //                            n.getNodeData().getTaxonomy().setScientificName( name );
 411                         //                            break;
 412                         //                        }
 413                         //
 414                         n.setName( "" );
 415                         setTaxonomyCode( n, name );
 416                         break;
 417                     case TAXONOMY_SCIENTIFIC_NAME:
 418                         n.setName( "" );
 419                         if ( !n.getNodeData().isHasTaxonomy() ) {
 420                             n.getNodeData().setTaxonomy( new Taxonomy() );
 421                         }
 422                         n.getNodeData().getTaxonomy().setScientificName( name );
 423                         break;
 424                     case TAXONOMY_COMMON_NAME:
 425                         n.setName( "" );
 426                         if ( !n.getNodeData().isHasTaxonomy() ) {
 427                             n.getNodeData().setTaxonomy( new Taxonomy() );
 428                         }
 429                         n.getNodeData().getTaxonomy().setCommonName( name );
 430                         break;
 431                     case SEQUENCE_SYMBOL:
 432                         n.setName( "" );
 433                         if ( !n.getNodeData().isHasSequence() ) {
 434                             n.getNodeData().setSequence( new Sequence() );
 435                         }
 436                         n.getNodeData().getSequence().setSymbol( name );
 437                         break;
 438                     case SEQUENCE_NAME:
 439                         n.setName( "" );
 440                         if ( !n.getNodeData().isHasSequence() ) {
 441                             n.getNodeData().setSequence( new Sequence() );
 442                         }
 443                         n.getNodeData().getSequence().setName( name );
 444                         break;
 445                     case TAXONOMY_ID_UNIPROT_1: {
 446                         if ( !n.getNodeData().isHasTaxonomy() ) {
 447                             n.getNodeData().setTaxonomy( new Taxonomy() );
 448                         }
 449                         String id = name;
 450                         final int i = name.indexOf( '_' );
 451                         if ( i > 0 ) {
 452                             id = name.substring( 0, i );
 453                         }
 454                         else {
 455                             n.setName( "" );
 456                         }
 457                         n.getNodeData().getTaxonomy()
 458                                 .setIdentifier( new Identifier( id, PhyloXmlUtil.UNIPROT_TAX_PROVIDER ) );
 459                         break;
 460                     }
 461                     case TAXONOMY_ID_UNIPROT_2: {
 462                         if ( !n.getNodeData().isHasTaxonomy() ) {
 463                             n.getNodeData().setTaxonomy( new Taxonomy() );
 464                         }
 465                         String id = name;
 466                         final int i = name.indexOf( '_' );
 467                         if ( i > 0 ) {
 468                             id = name.substring( i + 1, name.length() );
 469                         }
 470                         else {
 471                             n.setName( "" );
 472                         }
 473                         n.getNodeData().getTaxonomy()
 474                                 .setIdentifier( new Identifier( id, PhyloXmlUtil.UNIPROT_TAX_PROVIDER ) );
 475                         break;
 476                     }
 477                 }
 478             }
 479         }
 480     }
 481
 482     static double addPhylogenyDistances( final double a, final double b ) {
 483         if ( ( a >= 0.0 ) && ( b >= 0.0 ) ) {
 484             return a + b;
 485         }
 486         else if ( a >= 0.0 ) {
 487             return a;
 488         }
 489         else if ( b >= 0.0 ) {
 490             return b;
 491         }
 492         return PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT;
 493     }
 494
 495     // Helper for getUltraParalogousNodes( PhylogenyNode ).
 496     public static boolean areAllChildrenDuplications( final PhylogenyNode n ) {
 497         if ( n.isExternal() ) {
 498             return false;
 499         }
 500         else {
 501             if ( n.isDuplication() ) {
 502                 //FIXME test me!
 503                 for( final PhylogenyNode desc : n.getDescendants() ) {
 504                     if ( !areAllChildrenDuplications( desc ) ) {
 505                         return false;
 506                     }
 507                 }
 508                 return true;
 509             }
 510             else {
 511                 return false;
 512             }
 513         }
 514     }
 515
 516     public static int calculateDepth( final PhylogenyNode node ) {
 517         PhylogenyNode n = node;
 518         int steps = 0;
 519         while ( !n.isRoot() ) {
 520             steps++;
 521             n = n.getParent();
 522         }
 523         return steps;
 524     }
 525
 526     public static double calculateDistanceToRoot( final PhylogenyNode node ) {
 527         PhylogenyNode n = node;
 528         double d = 0.0;
 529         while ( !n.isRoot() ) {
 530             if ( n.getDistanceToParent() > 0.0 ) {
 531                 d += n.getDistanceToParent();
 532             }
 533             n = n.getParent();
 534         }
 535         return d;
 536     }
 537
 538     public static short calculateMaxBranchesToLeaf( final PhylogenyNode node ) {
 539         if ( node.isExternal() ) {
 540             return 0;
 541         }
 542         short max = 0;
 543         for( PhylogenyNode d : node.getAllExternalDescendants() ) {
 544             short steps = 0;
 545             while ( d != node ) {
 546                 if ( d.isCollapse() ) {
 547                     steps = 0;
 548                 }
 549                 else {
 550                     steps++;
 551                 }
 552                 d = d.getParent();
 553             }
 554             if ( max < steps ) {
 555                 max = steps;
 556             }
 557         }
 558         return max;
 559     }
 560
 561     public static int calculateMaxDepth( final Phylogeny phy ) {
 562         int max = 0;
 563         for( final PhylogenyNodeIterator iter = phy.iteratorExternalForward(); iter.hasNext(); ) {
 564             final PhylogenyNode node = iter.next();
 565             final int steps = calculateDepth( node );
 566             if ( steps > max ) {
 567                 max = steps;
 568             }
 569         }
 570         return max;
 571     }
 572
 573     public static double calculateMaxDistanceToRoot( final Phylogeny phy ) {
 574         double max = 0.0;
 575         for( final PhylogenyNodeIterator iter = phy.iteratorExternalForward(); iter.hasNext(); ) {
 576             final PhylogenyNode node = iter.next();
 577             final double d = calculateDistanceToRoot( node );
 578             if ( d > max ) {
 579                 max = d;
 580             }
 581         }
 582         return max;
 583     }
 584
 585     public static DescriptiveStatistics calculatNumberOfDescendantsPerNodeStatistics( final Phylogeny phy ) {
 586         final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
 587         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
 588             final PhylogenyNode n = iter.next();
 589             if ( !n.isExternal() ) {
 590                 stats.addValue( n.getNumberOfDescendants() );
 591             }
 592         }
 593         return stats;
 594     }
 595
 596     public static DescriptiveStatistics calculatConfidenceStatistics( final Phylogeny phy ) {
 597         final DescriptiveStatistics stats = new BasicDescriptiveStatistics();
 598         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
 599             final PhylogenyNode n = iter.next();
 600             if ( !n.isExternal() ) {
 601                 if ( n.getBranchData().isHasConfidences() ) {
 602                     stats.addValue( n.getBranchData().getConfidence( 0 ).getValue() );
 603                 }
 604             }
 605         }
 606         return stats;
 607     }
 608
 609     /**
 610      * Returns the set of distinct taxonomies of
 611      * all external nodes of node.
 612      * If at least one the external nodes has no taxonomy,
 613      * null is returned.
 614      *
 615      */
 616     public static Set<Taxonomy> obtainDistinctTaxonomies( final PhylogenyNode node ) {
 617         final List<PhylogenyNode> descs = node.getAllExternalDescendants();
 618         final Set<Taxonomy> tax_set = new HashSet<Taxonomy>();
 619         for( final PhylogenyNode n : descs ) {
 620             if ( !n.getNodeData().isHasTaxonomy() || n.getNodeData().getTaxonomy().isEmpty() ) {
 621                 return null;
 622             }
 623             tax_set.add( n.getNodeData().getTaxonomy() );
 624         }
 625         return tax_set;
 626     }
 627
 628     /**
 629      * Returns a map of distinct taxonomies of
 630      * all external nodes of node.
 631      * If at least one of the external nodes has no taxonomy,
 632      * null is returned.
 633      *
 634      */
 635     public static SortedMap<Taxonomy, Integer> obtainDistinctTaxonomyCounts( final PhylogenyNode node ) {
 636         final List<PhylogenyNode> descs = node.getAllExternalDescendants();
 637         final SortedMap<Taxonomy, Integer> tax_map = new TreeMap<Taxonomy, Integer>();
 638         for( final PhylogenyNode n : descs ) {
 639             if ( !n.getNodeData().isHasTaxonomy() || n.getNodeData().getTaxonomy().isEmpty() ) {
 640                 return null;
 641             }
 642             final Taxonomy t = n.getNodeData().getTaxonomy();
 643             if ( tax_map.containsKey( t ) ) {
 644                 tax_map.put( t, tax_map.get( t ) + 1 );
 645             }
 646             else {
 647                 tax_map.put( t, 1 );
 648             }
 649         }
 650         return tax_map;
 651     }
 652
 653     public static int calculateNumberOfExternalNodesWithoutTaxonomy( final PhylogenyNode node ) {
 654         final List<PhylogenyNode> descs = node.getAllExternalDescendants();
 655         int x = 0;
 656         for( final PhylogenyNode n : descs ) {
 657             if ( !n.getNodeData().isHasTaxonomy() || n.getNodeData().getTaxonomy().isEmpty() ) {
 658                 x++;
 659             }
 660         }
 661         return x;
 662     }
 663
 664     /**
 665      * Deep copies the phylogeny originating from this node.
 666      */
 667     static PhylogenyNode copySubTree( final PhylogenyNode source ) {
 668         if ( source == null ) {
 669             return null;
 670         }
 671         else {
 672             final PhylogenyNode newnode = source.copyNodeData();
 673             if ( !source.isExternal() ) {
 674                 for( int i = 0; i < source.getNumberOfDescendants(); ++i ) {
 675                     newnode.setChildNode( i, PhylogenyMethods.copySubTree( source.getChildNode( i ) ) );
 676                 }
 677             }
 678             return newnode;
 679         }
 680     }
 681
 682     /**
 683      * Shallow copies the phylogeny originating from this node.
 684      */
 685     static PhylogenyNode copySubTreeShallow( final PhylogenyNode source ) {
 686         if ( source == null ) {
 687             return null;
 688         }
 689         else {
 690             final PhylogenyNode newnode = source.copyNodeDataShallow();
 691             if ( !source.isExternal() ) {
 692                 for( int i = 0; i < source.getNumberOfDescendants(); ++i ) {
 693                     newnode.setChildNode( i, PhylogenyMethods.copySubTreeShallow( source.getChildNode( i ) ) );
 694                 }
 695             }
 696             return newnode;
 697         }
 698     }
 699
 700     public static void deleteExternalNodesNegativeSelection( final Set<Integer> to_delete, final Phylogeny phy ) {
 701         phy.hashIDs();
 702         for( final Integer id : to_delete ) {
 703             phy.deleteSubtree( phy.getNode( id ), true );
 704         }
 705         phy.hashIDs();
 706     }
 707
 708     public static void deleteExternalNodesNegativeSelection( final String[] node_names_to_delete, final Phylogeny p )
 709             throws IllegalArgumentException {
 710         for( int i = 0; i < node_names_to_delete.length; ++i ) {
 711             if ( ForesterUtil.isEmpty( node_names_to_delete[ i ] ) ) {
 712                 continue;
 713             }
 714             List<PhylogenyNode> nodes = null;
 715             nodes = p.getNodes( node_names_to_delete[ i ] );
 716             final Iterator<PhylogenyNode> it = nodes.iterator();
 717             while ( it.hasNext() ) {
 718                 final PhylogenyNode n = it.next();
 719                 if ( !n.isExternal() ) {
 720                     throw new IllegalArgumentException( "attempt to delete non-external node \""
 721                             + node_names_to_delete[ i ] + "\"" );
 722                 }
 723                 p.deleteSubtree( n, true );
 724             }
 725         }
 726     }
 727
 728     public static void deleteExternalNodesPositiveSelection( final Set<Taxonomy> species_to_keep, final Phylogeny phy ) {
 729         //   final Set<Integer> to_delete = new HashSet<Integer>();
 730         for( final PhylogenyNodeIterator it = phy.iteratorExternalForward(); it.hasNext(); ) {
 731             final PhylogenyNode n = it.next();
 732             if ( n.getNodeData().isHasTaxonomy() ) {
 733                 if ( !species_to_keep.contains( n.getNodeData().getTaxonomy() ) ) {
 734                     //to_delete.add( n.getNodeId() );
 735                     phy.deleteSubtree( n, true );
 736                 }
 737             }
 738             else {
 739                 throw new IllegalArgumentException( "node " + n.getId() + " has no taxonomic data" );
 740             }
 741         }
 742         phy.hashIDs();
 743         phy.externalNodesHaveChanged();
 744         //  deleteExternalNodesNegativeSelection( to_delete, phy );
 745     }
 746
 747     public static List<String> deleteExternalNodesPositiveSelection( final String[] node_names_to_keep,
 748                                                                      final Phylogeny p ) {
 749         final PhylogenyNodeIterator it = p.iteratorExternalForward();
 750         final String[] to_delete = new String[ p.getNumberOfExternalNodes() ];
 751         int i = 0;
 752         Arrays.sort( node_names_to_keep );
 753         while ( it.hasNext() ) {
 754             final String curent_name = it.next().getName();
 755             if ( Arrays.binarySearch( node_names_to_keep, curent_name ) < 0 ) {
 756                 to_delete[ i++ ] = curent_name;
 757             }
 758         }
 759         PhylogenyMethods.deleteExternalNodesNegativeSelection( to_delete, p );
 760         final List<String> deleted = new ArrayList<String>();
 761         for( final String n : to_delete ) {
 762             if ( !ForesterUtil.isEmpty( n ) ) {
 763                 deleted.add( n );
 764             }
 765         }
 766         return deleted;
 767     }
 768
 769     public static List<PhylogenyNode> getAllDescendants( final PhylogenyNode node ) {
 770         final List<PhylogenyNode> descs = new ArrayList<PhylogenyNode>();
 771         final Set<Integer> encountered = new HashSet<Integer>();
 772         if ( !node.isExternal() ) {
 773             final List<PhylogenyNode> exts = node.getAllExternalDescendants();
 774             for( PhylogenyNode current : exts ) {
 775                 descs.add( current );
 776                 while ( current != node ) {
 777                     current = current.getParent();
 778                     if ( encountered.contains( current.getId() ) ) {
 779                         continue;
 780                     }
 781                     descs.add( current );
 782                     encountered.add( current.getId() );
 783                 }
 784             }
 785         }
 786         return descs;
 787     }
 788
 789     /**
 790      *
 791      * Convenience method
 792      *
 793      * @param node
 794      * @return
 795      */
 796     public static Color getBranchColorValue( final PhylogenyNode node ) {
 797         if ( node.getBranchData().getBranchColor() == null ) {
 798             return null;
 799         }
 800         return node.getBranchData().getBranchColor().getValue();
 801     }
 802
 803     /**
 804      * Convenience method
 805      */
 806     public static double getBranchWidthValue( final PhylogenyNode node ) {
 807         if ( !node.getBranchData().isHasBranchWidth() ) {
 808             return BranchWidth.BRANCH_WIDTH_DEFAULT_VALUE;
 809         }
 810         return node.getBranchData().getBranchWidth().getValue();
 811     }
 812
 813     /**
 814      * Convenience method
 815      */
 816     public static double getConfidenceValue( final PhylogenyNode node ) {
 817         if ( !node.getBranchData().isHasConfidences() ) {
 818             return Confidence.CONFIDENCE_DEFAULT_VALUE;
 819         }
 820         return node.getBranchData().getConfidence( 0 ).getValue();
 821     }
 822
 823     /**
 824      * Convenience method
 825      */
 826     public static double[] getConfidenceValuesAsArray( final PhylogenyNode node ) {
 827         if ( !node.getBranchData().isHasConfidences() ) {
 828             return new double[ 0 ];
 829         }
 830         final double[] values = new double[ node.getBranchData().getConfidences().size() ];
 831         int i = 0;
 832         for( final Confidence c : node.getBranchData().getConfidences() ) {
 833             values[ i++ ] = c.getValue();
 834         }
 835         return values;
 836     }
 837
 838     /**
 839      * Calculates the distance between PhylogenyNodes n1 and n2.
 840      * PRECONDITION: n1 is a descendant of n2.
 841      *
 842      * @param n1
 843      *            a descendant of n2
 844      * @param n2
 845      * @return distance between n1 and n2
 846      */
 847     private static double getDistance( PhylogenyNode n1, final PhylogenyNode n2 ) {
 848         double d = 0.0;
 849         while ( n1 != n2 ) {
 850             if ( n1.getDistanceToParent() > 0.0 ) {
 851                 d += n1.getDistanceToParent();
 852             }
 853             n1 = n1.getParent();
 854         }
 855         return d;
 856     }
 857
 858     /**
 859      * Returns taxonomy t if all external descendants have
 860      * the same taxonomy t, null otherwise.
 861      *
 862      */
 863     public static Taxonomy getExternalDescendantsTaxonomy( final PhylogenyNode node ) {
 864         final List<PhylogenyNode> descs = node.getAllExternalDescendants();
 865         Taxonomy tax = null;
 866         for( final PhylogenyNode n : descs ) {
 867             if ( !n.getNodeData().isHasTaxonomy() || n.getNodeData().getTaxonomy().isEmpty() ) {
 868                 return null;
 869             }
 870             else if ( tax == null ) {
 871                 tax = n.getNodeData().getTaxonomy();
 872             }
 873             else if ( n.getNodeData().getTaxonomy().isEmpty() || !tax.isEqual( n.getNodeData().getTaxonomy() ) ) {
 874                 return null;
 875             }
 876         }
 877         return tax;
 878     }
 879
 880     public static PhylogenyNode getFurthestDescendant( final PhylogenyNode node ) {
 881         final List<PhylogenyNode> children = node.getAllExternalDescendants();
 882         PhylogenyNode farthest = null;
 883         double longest = -Double.MAX_VALUE;
 884         for( final PhylogenyNode child : children ) {
 885             if ( PhylogenyMethods.getDistance( child, node ) > longest ) {
 886                 farthest = child;
 887                 longest = PhylogenyMethods.getDistance( child, node );
 888             }
 889         }
 890         return farthest;
 891     }
 892
 893     public static PhylogenyMethods getInstance() {
 894         if ( PhylogenyMethods._instance == null ) {
 895             PhylogenyMethods._instance = new PhylogenyMethods();
 896         }
 897         return PhylogenyMethods._instance;
 898     }
 899
 900     /**
 901      * Returns the largest confidence value found on phy.
 902      */
 903     static public double getMaximumConfidenceValue( final Phylogeny phy ) {
 904         double max = -Double.MAX_VALUE;
 905         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
 906             final double s = PhylogenyMethods.getConfidenceValue( iter.next() );
 907             if ( ( s != Confidence.CONFIDENCE_DEFAULT_VALUE ) && ( s > max ) ) {
 908                 max = s;
 909             }
 910         }
 911         return max;
 912     }
 913
 914     static public int getMinimumDescendentsPerInternalNodes( final Phylogeny phy ) {
 915         int min = Integer.MAX_VALUE;
 916         int d = 0;
 917         PhylogenyNode n;
 918         for( final PhylogenyNodeIterator it = phy.iteratorPreorder(); it.hasNext(); ) {
 919             n = it.next();
 920             if ( n.isInternal() ) {
 921                 d = n.getNumberOfDescendants();
 922                 if ( d < min ) {
 923                     min = d;
 924                 }
 925             }
 926         }
 927         return min;
 928     }
 929
 930     /**
 931      * Convenience method for display purposes.
 932      * Not intended for algorithms.
 933      */
 934     public static String getSpecies( final PhylogenyNode node ) {
 935         if ( !node.getNodeData().isHasTaxonomy() ) {
 936             return "";
 937         }
 938         if ( !ForesterUtil.isEmpty( node.getNodeData().getTaxonomy().getTaxonomyCode() ) ) {
 939             return node.getNodeData().getTaxonomy().getTaxonomyCode();
 940         }
 941         else if ( !ForesterUtil.isEmpty( node.getNodeData().getTaxonomy().getScientificName() ) ) {
 942             return node.getNodeData().getTaxonomy().getScientificName();
 943         }
 944         else {
 945             return node.getNodeData().getTaxonomy().getCommonName();
 946         }
 947     }
 948
 949     /**
 950      * Returns all Nodes which are connected to external PhylogenyNode n of this
 951      * Phylogeny by a path containing only speciation events. We call these
 952      * "super orthologs". Nodes are returned as Vector of references to Nodes.
 953      * <p>
 954      * PRECONDITION: This tree must be binary and rooted, and speciation -
 955      * duplication need to be assigned for each of its internal Nodes.
 956      * <p>
 957      * Returns null if this Phylogeny is empty or if n is internal.
 958      * @param n
 959      *            external PhylogenyNode whose strictly speciation related Nodes
 960      *            are to be returned
 961      * @return Vector of references to all strictly speciation related Nodes of
 962      *         PhylogenyNode n of this Phylogeny, null if this Phylogeny is
 963      *         empty or if n is internal
 964      */
 965     public static List<PhylogenyNode> getSuperOrthologousNodes( final PhylogenyNode n ) {
 966         // FIXME
 967         PhylogenyNode node = n, deepest = null;
 968         final List<PhylogenyNode> v = new ArrayList<PhylogenyNode>();
 969         if ( !node.isExternal() ) {
 970             return null;
 971         }
 972         while ( !node.isRoot() && !node.getParent().isDuplication() ) {
 973             node = node.getParent();
 974         }
 975         deepest = node;
 976         deepest.setIndicatorsToZero();
 977         do {
 978             if ( !node.isExternal() ) {
 979                 if ( node.getIndicator() == 0 ) {
 980                     node.setIndicator( ( byte ) 1 );
 981                     if ( !node.isDuplication() ) {
 982                         node = node.getChildNode1();
 983                     }
 984                 }
 985                 if ( node.getIndicator() == 1 ) {
 986                     node.setIndicator( ( byte ) 2 );
 987                     if ( !node.isDuplication() ) {
 988                         node = node.getChildNode2();
 989                     }
 990                 }
 991                 if ( ( node != deepest ) && ( node.getIndicator() == 2 ) ) {
 992                     node = node.getParent();
 993                 }
 994             }
 995             else {
 996                 if ( node != n ) {
 997                     v.add( node );
 998                 }
 999                 if ( node != deepest ) {
1000                     node = node.getParent();
1001                 }
1002                 else {
1003                     node.setIndicator( ( byte ) 2 );
1004                 }
1005             }
1006         } while ( ( node != deepest ) || ( deepest.getIndicator() != 2 ) );
1007         return v;
1008     }
1009
1010     /**
1011      * Convenience method for display purposes.
1012      * Not intended for algorithms.
1013      */
1014     public static String getTaxonomyIdentifier( final PhylogenyNode node ) {
1015         if ( !node.getNodeData().isHasTaxonomy() || ( node.getNodeData().getTaxonomy().getIdentifier() == null ) ) {
1016             return "";
1017         }
1018         return node.getNodeData().getTaxonomy().getIdentifier().getValue();
1019     }
1020
1021     /**
1022      * Returns all Nodes which are connected to external PhylogenyNode n of this
1023      * Phylogeny by a path containing, and leading to, only duplication events.
1024      * We call these "ultra paralogs". Nodes are returned as Vector of
1025      * references to Nodes.
1026      * <p>
1027      * PRECONDITION: This tree must be binary and rooted, and speciation -
1028      * duplication need to be assigned for each of its internal Nodes.
1029      * <p>
1030      * Returns null if this Phylogeny is empty or if n is internal.
1031      * <p>
1032      * (Last modified: 10/06/01)
1033      *
1034      * @param n
1035      *            external PhylogenyNode whose ultra paralogs are to be returned
1036      * @return Vector of references to all ultra paralogs of PhylogenyNode n of
1037      *         this Phylogeny, null if this Phylogeny is empty or if n is
1038      *         internal
1039      */
1040     public static List<PhylogenyNode> getUltraParalogousNodes( final PhylogenyNode n ) {
1041         // FIXME test me
1042         PhylogenyNode node = n;
1043         if ( !node.isExternal() ) {
1044             return null;
1045         }
1046         while ( !node.isRoot() && node.getParent().isDuplication() && areAllChildrenDuplications( node.getParent() ) ) {
1047             node = node.getParent();
1048         }
1049         final List<PhylogenyNode> nodes = node.getAllExternalDescendants();
1050         nodes.remove( n );
1051         return nodes;
1052     }
1053
1054     public static String inferCommonPartOfScientificNameOfDescendants( final PhylogenyNode node ) {
1055         final List<PhylogenyNode> descs = node.getDescendants();
1056         String sn = null;
1057         for( final PhylogenyNode n : descs ) {
1058             if ( !n.getNodeData().isHasTaxonomy()
1059                     || ForesterUtil.isEmpty( n.getNodeData().getTaxonomy().getScientificName() ) ) {
1060                 return null;
1061             }
1062             else if ( sn == null ) {
1063                 sn = n.getNodeData().getTaxonomy().getScientificName().trim();
1064             }
1065             else {
1066                 String sn_current = n.getNodeData().getTaxonomy().getScientificName().trim();
1067                 if ( !sn.equals( sn_current ) ) {
1068                     boolean overlap = false;
1069                     while ( ( sn.indexOf( ' ' ) >= 0 ) || ( sn_current.indexOf( ' ' ) >= 0 ) ) {
1070                         if ( ForesterUtil.countChars( sn, ' ' ) > ForesterUtil.countChars( sn_current, ' ' ) ) {
1071                             sn = sn.substring( 0, sn.lastIndexOf( ' ' ) ).trim();
1072                         }
1073                         else {
1074                             sn_current = sn_current.substring( 0, sn_current.lastIndexOf( ' ' ) ).trim();
1075                         }
1076                         if ( sn.equals( sn_current ) ) {
1077                             overlap = true;
1078                             break;
1079                         }
1080                     }
1081                     if ( !overlap ) {
1082                         return null;
1083                     }
1084                 }
1085             }
1086         }
1087         return sn;
1088     }
1089
1090     public static boolean isHasExternalDescendant( final PhylogenyNode node ) {
1091         for( int i = 0; i < node.getNumberOfDescendants(); ++i ) {
1092             if ( node.getChildNode( i ).isExternal() ) {
1093                 return true;
1094             }
1095         }
1096         return false;
1097     }
1098
1099     /*
1100      * This is case insensitive.
1101      *
1102      */
1103     public synchronized static boolean isTaxonomyHasIdentifierOfGivenProvider( final Taxonomy tax,
1104                                                                                final String[] providers ) {
1105         if ( ( tax.getIdentifier() != null ) && !ForesterUtil.isEmpty( tax.getIdentifier().getProvider() ) ) {
1106             final String my_tax_prov = tax.getIdentifier().getProvider();
1107             for( final String provider : providers ) {
1108                 if ( provider.equalsIgnoreCase( my_tax_prov ) ) {
1109                     return true;
1110                 }
1111             }
1112             return false;
1113         }
1114         else {
1115             return false;
1116         }
1117     }
1118
1119     private static boolean match( final String s,
1120                                   final String query,
1121                                   final boolean case_sensitive,
1122                                   final boolean partial ) {
1123         if ( ForesterUtil.isEmpty( s ) || ForesterUtil.isEmpty( query ) ) {
1124             return false;
1125         }
1126         String my_s = s.trim();
1127         String my_query = query.trim();
1128         if ( !case_sensitive ) {
1129             my_s = my_s.toLowerCase();
1130             my_query = my_query.toLowerCase();
1131         }
1132         if ( partial ) {
1133             return my_s.indexOf( my_query ) >= 0;
1134         }
1135         else {
1136             return my_s.equals( my_query );
1137         }
1138     }
1139
1140     public static void midpointRoot( final Phylogeny phylogeny ) {
1141         if ( phylogeny.getNumberOfExternalNodes() < 2 ) {
1142             return;
1143         }
1144         final PhylogenyMethods methods = getInstance();
1145         final double farthest_d = methods.calculateFurthestDistance( phylogeny );
1146         final PhylogenyNode f1 = methods.getFarthestNode1();
1147         final PhylogenyNode f2 = methods.getFarthestNode2();
1148         if ( farthest_d <= 0.0 ) {
1149             return;
1150         }
1151         double x = farthest_d / 2.0;
1152         PhylogenyNode n = f1;
1153         if ( PhylogenyMethods.getDistance( f1, phylogeny.getRoot() ) < PhylogenyMethods.getDistance( f2, phylogeny
1154                 .getRoot() ) ) {
1155             n = f2;
1156         }
1157         while ( ( x > n.getDistanceToParent() ) && !n.isRoot() ) {
1158             x -= ( n.getDistanceToParent() > 0 ? n.getDistanceToParent() : 0 );
1159             n = n.getParent();
1160         }
1161         phylogeny.reRoot( n, x );
1162         phylogeny.recalculateNumberOfExternalDescendants( true );
1163         final PhylogenyNode a = getFurthestDescendant( phylogeny.getRoot().getChildNode1() );
1164         final PhylogenyNode b = getFurthestDescendant( phylogeny.getRoot().getChildNode2() );
1165         final double da = getDistance( a, phylogeny.getRoot() );
1166         final double db = getDistance( b, phylogeny.getRoot() );
1167         if ( Math.abs( da - db ) > 0.000001 ) {
1168             throw new FailedConditionCheckException( "this should not have happened: midpoint rooting failed:  da="
1169                     + da + ",  db=" + db + ",  diff=" + Math.abs( da - db ) );
1170         }
1171     }
1172
1173     public static void normalizeBootstrapValues( final Phylogeny phylogeny,
1174                                                  final double max_bootstrap_value,
1175                                                  final double max_normalized_value ) {
1176         for( final PhylogenyNodeIterator iter = phylogeny.iteratorPreorder(); iter.hasNext(); ) {
1177             final PhylogenyNode node = iter.next();
1178             if ( node.isInternal() ) {
1179                 final double confidence = getConfidenceValue( node );
1180                 if ( confidence != Confidence.CONFIDENCE_DEFAULT_VALUE ) {
1181                     if ( confidence >= max_bootstrap_value ) {
1182                         setBootstrapConfidence( node, max_normalized_value );
1183                     }
1184                     else {
1185                         setBootstrapConfidence( node, ( confidence * max_normalized_value ) / max_bootstrap_value );
1186                     }
1187                 }
1188             }
1189         }
1190     }
1191
1192     public static List<PhylogenyNode> obtainAllNodesAsList( final Phylogeny phy ) {
1193         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
1194         if ( phy.isEmpty() ) {
1195             return nodes;
1196         }
1197         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
1198             nodes.add( iter.next() );
1199         }
1200         return nodes;
1201     }
1202
1203     public static void postorderBranchColorAveragingExternalNodeBased( final Phylogeny p ) {
1204         for( final PhylogenyNodeIterator iter = p.iteratorPostorder(); iter.hasNext(); ) {
1205             final PhylogenyNode node = iter.next();
1206             double red = 0.0;
1207             double green = 0.0;
1208             double blue = 0.0;
1209             int n = 0;
1210             if ( node.isInternal() ) {
1211                 for( final PhylogenyNodeIterator iterator = node.iterateChildNodesForward(); iterator.hasNext(); ) {
1212                     final PhylogenyNode child_node = iterator.next();
1213                     final Color child_color = getBranchColorValue( child_node );
1214                     if ( child_color != null ) {
1215                         ++n;
1216                         red += child_color.getRed();
1217                         green += child_color.getGreen();
1218                         blue += child_color.getBlue();
1219                     }
1220                 }
1221                 setBranchColorValue( node,
1222                                      new Color( ForesterUtil.roundToInt( red / n ),
1223                                                 ForesterUtil.roundToInt( green / n ),
1224                                                 ForesterUtil.roundToInt( blue / n ) ) );
1225             }
1226         }
1227     }
1228
1229     public static void removeNode( final PhylogenyNode remove_me, final Phylogeny phylogeny ) {
1230         if ( remove_me.isRoot() ) {
1231             throw new IllegalArgumentException( "ill advised attempt to remove root node" );
1232         }
1233         if ( remove_me.isExternal() ) {
1234             phylogeny.deleteSubtree( remove_me, false );
1235         }
1236         else {
1237             final PhylogenyNode parent = remove_me.getParent();
1238             final List<PhylogenyNode> descs = remove_me.getDescendants();
1239             parent.removeChildNode( remove_me );
1240             for( final PhylogenyNode desc : descs ) {
1241                 parent.addAsChild( desc );
1242                 desc.setDistanceToParent( addPhylogenyDistances( remove_me.getDistanceToParent(),
1243                                                                  desc.getDistanceToParent() ) );
1244             }
1245             remove_me.setParent( null );
1246             phylogeny.setIdHash( null );
1247             phylogeny.externalNodesHaveChanged();
1248         }
1249     }
1250
1251     public static List<PhylogenyNode> searchData( final String query,
1252                                                   final Phylogeny phy,
1253                                                   final boolean case_sensitive,
1254                                                   final boolean partial ) {
1255         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
1256         if ( phy.isEmpty() || ( query == null ) ) {
1257             return nodes;
1258         }
1259         if ( ForesterUtil.isEmpty( query ) ) {
1260             return nodes;
1261         }
1262         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
1263             final PhylogenyNode node = iter.next();
1264             boolean match = false;
1265             if ( match( node.getName(), query, case_sensitive, partial ) ) {
1266                 match = true;
1267             }
1268             else if ( node.getNodeData().isHasTaxonomy()
1269                     && match( node.getNodeData().getTaxonomy().getTaxonomyCode(), query, case_sensitive, partial ) ) {
1270                 match = true;
1271             }
1272             else if ( node.getNodeData().isHasTaxonomy()
1273                     && match( node.getNodeData().getTaxonomy().getCommonName(), query, case_sensitive, partial ) ) {
1274                 match = true;
1275             }
1276             else if ( node.getNodeData().isHasTaxonomy()
1277                     && match( node.getNodeData().getTaxonomy().getScientificName(), query, case_sensitive, partial ) ) {
1278                 match = true;
1279             }
1280             else if ( node.getNodeData().isHasTaxonomy()
1281                     && ( node.getNodeData().getTaxonomy().getIdentifier() != null )
1282                     && match( node.getNodeData().getTaxonomy().getIdentifier().getValue(),
1283                               query,
1284                               case_sensitive,
1285                               partial ) ) {
1286                 match = true;
1287             }
1288             else if ( node.getNodeData().isHasTaxonomy() && !node.getNodeData().getTaxonomy().getSynonyms().isEmpty() ) {
1289                 final List<String> syns = node.getNodeData().getTaxonomy().getSynonyms();
1290                 I: for( final String syn : syns ) {
1291                     if ( match( syn, query, case_sensitive, partial ) ) {
1292                         match = true;
1293                         break I;
1294                     }
1295                 }
1296             }
1297             if ( !match && node.getNodeData().isHasSequence()
1298                     && match( node.getNodeData().getSequence().getName(), query, case_sensitive, partial ) ) {
1299                 match = true;
1300             }
1301             if ( !match && node.getNodeData().isHasSequence()
1302                     && match( node.getNodeData().getSequence().getSymbol(), query, case_sensitive, partial ) ) {
1303                 match = true;
1304             }
1305             if ( !match
1306                     && node.getNodeData().isHasSequence()
1307                     && ( node.getNodeData().getSequence().getAccession() != null )
1308                     && match( node.getNodeData().getSequence().getAccession().getValue(),
1309                               query,
1310                               case_sensitive,
1311                               partial ) ) {
1312                 match = true;
1313             }
1314             if ( !match && node.getNodeData().isHasSequence()
1315                     && ( node.getNodeData().getSequence().getDomainArchitecture() != null ) ) {
1316                 final DomainArchitecture da = node.getNodeData().getSequence().getDomainArchitecture();
1317                 I: for( int i = 0; i < da.getNumberOfDomains(); ++i ) {
1318                     if ( match( da.getDomain( i ).getName(), query, case_sensitive, partial ) ) {
1319                         match = true;
1320                         break I;
1321                     }
1322                 }
1323             }
1324             if ( !match && ( node.getNodeData().getBinaryCharacters() != null ) ) {
1325                 Iterator<String> it = node.getNodeData().getBinaryCharacters().getPresentCharacters().iterator();
1326                 I: while ( it.hasNext() ) {
1327                     if ( match( it.next(), query, case_sensitive, partial ) ) {
1328                         match = true;
1329                         break I;
1330                     }
1331                 }
1332                 it = node.getNodeData().getBinaryCharacters().getGainedCharacters().iterator();
1333                 I: while ( it.hasNext() ) {
1334                     if ( match( it.next(), query, case_sensitive, partial ) ) {
1335                         match = true;
1336                         break I;
1337                     }
1338                 }
1339             }
1340             if ( match ) {
1341                 nodes.add( node );
1342             }
1343         }
1344         return nodes;
1345     }
1346
1347     public static List<PhylogenyNode> searchDataLogicalAnd( final String[] queries,
1348                                                             final Phylogeny phy,
1349                                                             final boolean case_sensitive,
1350                                                             final boolean partial ) {
1351         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
1352         if ( phy.isEmpty() || ( queries == null ) || ( queries.length < 1 ) ) {
1353             return nodes;
1354         }
1355         for( final PhylogenyNodeIterator iter = phy.iteratorPreorder(); iter.hasNext(); ) {
1356             final PhylogenyNode node = iter.next();
1357             boolean all_matched = true;
1358             for( final String query : queries ) {
1359                 boolean match = false;
1360                 if ( ForesterUtil.isEmpty( query ) ) {
1361                     continue;
1362                 }
1363                 if ( match( node.getName(), query, case_sensitive, partial ) ) {
1364                     match = true;
1365                 }
1366                 else if ( node.getNodeData().isHasTaxonomy()
1367                         && match( node.getNodeData().getTaxonomy().getTaxonomyCode(), query, case_sensitive, partial ) ) {
1368                     match = true;
1369                 }
1370                 else if ( node.getNodeData().isHasTaxonomy()
1371                         && match( node.getNodeData().getTaxonomy().getCommonName(), query, case_sensitive, partial ) ) {
1372                     match = true;
1373                 }
1374                 else if ( node.getNodeData().isHasTaxonomy()
1375                         && match( node.getNodeData().getTaxonomy().getScientificName(), query, case_sensitive, partial ) ) {
1376                     match = true;
1377                 }
1378                 else if ( node.getNodeData().isHasTaxonomy()
1379                         && ( node.getNodeData().getTaxonomy().getIdentifier() != null )
1380                         && match( node.getNodeData().getTaxonomy().getIdentifier().getValue(),
1381                                   query,
1382                                   case_sensitive,
1383                                   partial ) ) {
1384                     match = true;
1385                 }
1386                 else if ( node.getNodeData().isHasTaxonomy()
1387                         && !node.getNodeData().getTaxonomy().getSynonyms().isEmpty() ) {
1388                     final List<String> syns = node.getNodeData().getTaxonomy().getSynonyms();
1389                     I: for( final String syn : syns ) {
1390                         if ( match( syn, query, case_sensitive, partial ) ) {
1391                             match = true;
1392                             break I;
1393                         }
1394                     }
1395                 }
1396                 if ( !match && node.getNodeData().isHasSequence()
1397                         && match( node.getNodeData().getSequence().getName(), query, case_sensitive, partial ) ) {
1398                     match = true;
1399                 }
1400                 if ( !match && node.getNodeData().isHasSequence()
1401                         && match( node.getNodeData().getSequence().getSymbol(), query, case_sensitive, partial ) ) {
1402                     match = true;
1403                 }
1404                 if ( !match
1405                         && node.getNodeData().isHasSequence()
1406                         && ( node.getNodeData().getSequence().getAccession() != null )
1407                         && match( node.getNodeData().getSequence().getAccession().getValue(),
1408                                   query,
1409                                   case_sensitive,
1410                                   partial ) ) {
1411                     match = true;
1412                 }
1413                 if ( !match && node.getNodeData().isHasSequence()
1414                         && ( node.getNodeData().getSequence().getDomainArchitecture() != null ) ) {
1415                     final DomainArchitecture da = node.getNodeData().getSequence().getDomainArchitecture();
1416                     I: for( int i = 0; i < da.getNumberOfDomains(); ++i ) {
1417                         if ( match( da.getDomain( i ).getName(), query, case_sensitive, partial ) ) {
1418                             match = true;
1419                             break I;
1420                         }
1421                     }
1422                 }
1423                 if ( !match && ( node.getNodeData().getBinaryCharacters() != null ) ) {
1424                     Iterator<String> it = node.getNodeData().getBinaryCharacters().getPresentCharacters().iterator();
1425                     I: while ( it.hasNext() ) {
1426                         if ( match( it.next(), query, case_sensitive, partial ) ) {
1427                             match = true;
1428                             break I;
1429                         }
1430                     }
1431                     it = node.getNodeData().getBinaryCharacters().getGainedCharacters().iterator();
1432                     I: while ( it.hasNext() ) {
1433                         if ( match( it.next(), query, case_sensitive, partial ) ) {
1434                             match = true;
1435                             break I;
1436                         }
1437                     }
1438                     //                    final String[] bcp_ary = node.getNodeData().getBinaryCharacters()
1439                     //                            .getPresentCharactersAsStringArray();
1440                     //                    I: for( final String bc : bcp_ary ) {
1441                     //                        if ( match( bc, query, case_sensitive, partial ) ) {
1442                     //                            match = true;
1443                     //                            break I;
1444                     //                        }
1445                     //                    }
1446                     //                    final String[] bcg_ary = node.getNodeData().getBinaryCharacters()
1447                     //                            .getGainedCharactersAsStringArray();
1448                     //                    I: for( final String bc : bcg_ary ) {
1449                     //                        if ( match( bc, query, case_sensitive, partial ) ) {
1450                     //                            match = true;
1451                     //                            break I;
1452                     //                        }
1453                     //                    }
1454                 }
1455                 if ( !match ) {
1456                     all_matched = false;
1457                     break;
1458                 }
1459             }
1460             if ( all_matched ) {
1461                 nodes.add( node );
1462             }
1463         }
1464         return nodes;
1465     }
1466
1467     /**
1468      * Convenience method.
1469      * Sets value for the first confidence value (created if not present, values overwritten otherwise).
1470      */
1471     public static void setBootstrapConfidence( final PhylogenyNode node, final double bootstrap_confidence_value ) {
1472         setConfidence( node, bootstrap_confidence_value, "bootstrap" );
1473     }
1474
1475     public static void setBranchColorValue( final PhylogenyNode node, final Color color ) {
1476         if ( node.getBranchData().getBranchColor() == null ) {
1477             node.getBranchData().setBranchColor( new BranchColor() );
1478         }
1479         node.getBranchData().getBranchColor().setValue( color );
1480     }
1481
1482     /**
1483      * Convenience method
1484      */
1485     public static void setBranchWidthValue( final PhylogenyNode node, final double branch_width_value ) {
1486         node.getBranchData().setBranchWidth( new BranchWidth( branch_width_value ) );
1487     }
1488
1489     /**
1490      * Convenience method.
1491      * Sets value for the first confidence value (created if not present, values overwritten otherwise).
1492      */
1493     public static void setConfidence( final PhylogenyNode node, final double confidence_value ) {
1494         setConfidence( node, confidence_value, "" );
1495     }
1496
1497     /**
1498      * Convenience method.
1499      * Sets value for the first confidence value (created if not present, values overwritten otherwise).
1500      */
1501     public static void setConfidence( final PhylogenyNode node, final double confidence_value, final String type ) {
1502         Confidence c = null;
1503         if ( node.getBranchData().getNumberOfConfidences() > 0 ) {
1504             c = node.getBranchData().getConfidence( 0 );
1505         }
1506         else {
1507             c = new Confidence();
1508             node.getBranchData().addConfidence( c );
1509         }
1510         c.setType( type );
1511         c.setValue( confidence_value );
1512     }
1513
1514     public static void setScientificName( final PhylogenyNode node, final String scientific_name ) {
1515         if ( !node.getNodeData().isHasTaxonomy() ) {
1516             node.getNodeData().setTaxonomy( new Taxonomy() );
1517         }
1518         node.getNodeData().getTaxonomy().setScientificName( scientific_name );
1519     }
1520
1521     /**
1522      * Convenience method to set the taxonomy code of a phylogeny node.
1523      *
1524      *
1525      * @param node
1526      * @param taxonomy_code
1527      */
1528     public static void setTaxonomyCode( final PhylogenyNode node, final String taxonomy_code ) {
1529         if ( !node.getNodeData().isHasTaxonomy() ) {
1530             node.getNodeData().setTaxonomy( new Taxonomy() );
1531         }
1532         node.getNodeData().getTaxonomy().setTaxonomyCode( taxonomy_code );
1533     }
1534
1535     /**
1536      * Removes from Phylogeny to_be_stripped all external Nodes which are
1537      * associated with a species NOT found in Phylogeny reference.
1538      *
1539      * @param reference
1540      *            a reference Phylogeny
1541      * @param to_be_stripped
1542      *            Phylogeny to be stripped
1543      * @return number of external nodes removed from to_be_stripped
1544      */
1545     public static int taxonomyBasedDeletionOfExternalNodes( final Phylogeny reference, final Phylogeny to_be_stripped ) {
1546         final Set<String> ref_ext_taxo = new HashSet<String>();
1547         final ArrayList<PhylogenyNode> nodes_to_delete = new ArrayList<PhylogenyNode>();
1548         for( final PhylogenyNodeIterator it = reference.iteratorExternalForward(); it.hasNext(); ) {
1549             ref_ext_taxo.add( getSpecies( it.next() ) );
1550         }
1551         for( final PhylogenyNodeIterator it = to_be_stripped.iteratorExternalForward(); it.hasNext(); ) {
1552             final PhylogenyNode n = it.next();
1553             if ( !ref_ext_taxo.contains( getSpecies( n ) ) ) {
1554                 nodes_to_delete.add( n );
1555             }
1556         }
1557         for( final PhylogenyNode phylogenyNode : nodes_to_delete ) {
1558             to_be_stripped.deleteSubtree( phylogenyNode, true );
1559         }
1560         return nodes_to_delete.size();
1561     }
1562
1563     public static enum PhylogenyNodeField {
1564         CLADE_NAME,
1565         TAXONOMY_CODE,
1566         TAXONOMY_SCIENTIFIC_NAME,
1567         TAXONOMY_COMMON_NAME,
1568         SEQUENCE_SYMBOL,
1569         SEQUENCE_NAME,
1570         TAXONOMY_ID_UNIPROT_1,
1571         TAXONOMY_ID_UNIPROT_2;
1572     }
1573
1574     public static enum TAXONOMY_EXTRACTION {
1575         NO, YES, PFAM_STYLE_ONLY;
1576     }
1577
1578     public static enum DESCENDANT_SORT_PRIORITY {
1579         TAXONOMY, SEQUENCE, NODE_NAME;
1580     }
1581 }