forester/java/src/org/forester/phylogeny/Phylogeny.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 // Copyright (C) 2000-2001 Washington University School of Medicine
   8 // and Howard Hughes Medical Institute
   9 // All rights reserved
  10 //
  11 // This library is free software; you can redistribute it and/or
  12 // modify it under the terms of the GNU Lesser General Public
  13 // License as published by the Free Software Foundation; either
  14 // version 2.1 of the License, or (at your option) any later version.
  15 //
  16 // This library is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 // Lesser General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU Lesser General Public
  22 // License along with this library; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  24 //
  25 // Contact: phylosoft @ gmail . com
  26 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  27
  28 package org.forester.phylogeny;
  29
  30 import java.io.IOException;
  31 import java.util.ArrayList;
  32 import java.util.Arrays;
  33 import java.util.Collection;
  34 import java.util.HashMap;
  35 import java.util.Iterator;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.NoSuchElementException;
  39 import java.util.Vector;
  40
  41 import org.forester.io.writers.PhylogenyWriter;
  42 import org.forester.phylogeny.PhylogenyNode.NH_CONVERSION_SUPPORT_VALUE_STYLE;
  43 import org.forester.phylogeny.data.BranchData;
  44 import org.forester.phylogeny.data.Confidence;
  45 import org.forester.phylogeny.data.Identifier;
  46 import org.forester.phylogeny.data.PhylogenyDataUtil;
  47 import org.forester.phylogeny.data.Sequence;
  48 import org.forester.phylogeny.data.SequenceRelation;
  49 import org.forester.phylogeny.data.SequenceRelation.SEQUENCE_RELATION_TYPE;
  50 import org.forester.phylogeny.iterators.ExternalForwardIterator;
  51 import org.forester.phylogeny.iterators.LevelOrderTreeIterator;
  52 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  53 import org.forester.phylogeny.iterators.PostorderTreeIterator;
  54 import org.forester.phylogeny.iterators.PreorderTreeIterator;
  55 import org.forester.util.FailedConditionCheckException;
  56 import org.forester.util.ForesterUtil;
  57
  58 public class Phylogeny {
  59
  60     public final static boolean                                 ALLOW_MULTIPLE_PARENTS_DEFAULT = false;
  61     private PhylogenyNode                                       _root;
  62     private boolean                                             _rooted;
  63     private boolean                                             _allow_multiple_parents;
  64     private String                                              _name;
  65     private String                                              _type;
  66     private String                                              _description;
  67     private String                                              _distance_unit;
  68     private Confidence                                          _confidence;
  69     private Identifier                                          _identifier;
  70     private boolean                                             _rerootable;
  71     private HashMap<Long, PhylogenyNode>                        _id_to_node_map;
  72     private List<PhylogenyNode>                                 _external_nodes_set;
  73     private Collection<Sequence>                                _sequenceRelationQueries;
  74     private Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> _relevant_sequence_relation_types;
  75
  76     /**
  77      * Default Phylogeny constructor. Constructs an empty Phylogeny.
  78      */
  79     public Phylogeny() {
  80         init();
  81     }
  82
  83     /**
  84      * Adds this Phylogeny to the list of child nodes of PhylogenyNode parent
  85      * and sets the parent of this to parent.
  86      *
  87      * @param n
  88      *            the PhylogenyNode to add
  89      */
  90     public void addAsChild( final PhylogenyNode parent ) {
  91         if ( isEmpty() ) {
  92             throw new IllegalArgumentException( "Attempt to add an empty tree." );
  93         }
  94         if ( !isRooted() ) {
  95             throw new IllegalArgumentException( "Attempt to add an unrooted tree." );
  96         }
  97         parent.addAsChild( getRoot() );
  98         externalNodesHaveChanged();
  99     }
 100
 101     public void addAsSibling( final PhylogenyNode sibling ) {
 102         if ( isEmpty() ) {
 103             throw new IllegalArgumentException( "Attempt to add an empty tree." );
 104         }
 105         if ( !isRooted() ) {
 106             throw new IllegalArgumentException( "Attempt to add an unrooted tree." );
 107         }
 108         final int sibling_index = sibling.getChildNodeIndex();
 109         final PhylogenyNode new_node = new PhylogenyNode();
 110         final PhylogenyNode sibling_parent = sibling.getParent();
 111         new_node.setChild1( sibling );
 112         new_node.setChild2( getRoot() );
 113         new_node.setParent( sibling_parent );
 114         sibling.setParent( new_node );
 115         sibling_parent.setChildNode( sibling_index, new_node );
 116         final double new_dist = sibling.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ? PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT
 117                 : sibling.getDistanceToParent() / 2;
 118         new_node.setDistanceToParent( new_dist );
 119         sibling.setDistanceToParent( new_dist );
 120         externalNodesHaveChanged();
 121     }
 122
 123     /**
 124      * This calculates the height of the subtree emanating at n for rooted,
 125      * tree-shaped phylogenies
 126      *
 127      * @param n
 128      *            the root-node of a subtree
 129      * @return the height of the subtree emanating at n
 130      */
 131     public double calculateSubtreeHeight( final PhylogenyNode n ) {
 132         if ( n.isExternal() || n.isCollapse() ) {
 133             return ForesterUtil.isLargerOrEqualToZero( n.getDistanceToParent() );
 134         }
 135         else {
 136             double max = -Double.MAX_VALUE;
 137             for( int i = 0; i < n.getNumberOfDescendants(); ++i ) {
 138                 final double l = calculateSubtreeHeight( n.getChildNode( i ) );
 139                 if ( l > max ) {
 140                     max = l;
 141                 }
 142             }
 143             return max + ForesterUtil.isLargerOrEqualToZero( n.getDistanceToParent() );
 144         }
 145     }
 146
 147     public void clearHashIdToNodeMap() {
 148         setIdToNodeMap( null );
 149     }
 150
 151     /**
 152      * Returns a deep copy of this Phylogeny.
 153      * <p>
 154      * (The resulting Phylogeny has its references in the external nodes
 155      * corrected, if they are lacking/obsolete in this.)
 156      */
 157     public Phylogeny copy() {
 158         return copy( _root );
 159     }
 160
 161     /**
 162      * Returns a deep copy of this Phylogeny.
 163      * <p>
 164      * (The resulting Phylogeny has its references in the external nodes
 165      * corrected, if they are lacking/obsolete in this.)
 166      */
 167     public Phylogeny copy( final PhylogenyNode source ) {
 168         final Phylogeny tree = new Phylogeny();
 169         if ( isEmpty() ) {
 170             tree.init();
 171             return tree;
 172         }
 173         tree._rooted = _rooted;
 174         tree._name = new String( _name );
 175         tree._description = new String( _description );
 176         tree._type = new String( _type );
 177         tree._rerootable = _rerootable;
 178         tree._distance_unit = new String( _distance_unit );
 179         if ( _confidence != null ) {
 180             tree._confidence = ( Confidence ) _confidence.copy();
 181         }
 182         if ( _identifier != null ) {
 183             tree._identifier = ( Identifier ) _identifier.copy();
 184         }
 185         tree.setAllowMultipleParents( isAllowMultipleParents() );
 186         tree._root = PhylogenyMethods.copySubTree( source );
 187         return tree;
 188     }
 189
 190     /**
 191      * Returns a shallow copy of this Phylogeny.
 192      * <p>
 193      * (The resulting Phylogeny has its references in the external nodes
 194      * corrected, if they are lacking/obsolete in this.)
 195      */
 196     public Phylogeny copyShallow() {
 197         return copyShallow( _root );
 198     }
 199
 200     public Phylogeny copyShallow( final PhylogenyNode source ) {
 201         final Phylogeny tree = new Phylogeny();
 202         if ( isEmpty() ) {
 203             tree.init();
 204             return tree;
 205         }
 206         tree._rooted = _rooted;
 207         tree._name = _name;
 208         tree._description = _description;
 209         tree._type = _type;
 210         tree._rerootable = _rerootable;
 211         tree._distance_unit = _distance_unit;
 212         tree._confidence = _confidence;
 213         tree._identifier = _identifier;
 214         tree.setAllowMultipleParents( isAllowMultipleParents() );
 215         tree._root = PhylogenyMethods.copySubTreeShallow( source );
 216         return tree;
 217     }
 218
 219     /**
 220      * Need to call clearHashIdToNodeMap() afterwards (not done automatically
 221      * to allow client multiple deletions in linear time).
 222      * Need to call 'recalculateNumberOfExternalDescendants(boolean)' after this
 223      * if tree is to be displayed.
 224      *
 225      * @param remove_us the parent node of the subtree to be deleted
 226      */
 227     public void deleteSubtree( final PhylogenyNode remove_us, final boolean collapse_resulting_node_with_one_desc ) {
 228         if ( isEmpty() || ( remove_us.isRoot() && ( getNumberOfExternalNodes() != 1 ) ) ) {
 229             return;
 230         }
 231         if ( remove_us.isRoot() && ( getNumberOfExternalNodes() == 1 ) ) {
 232             init();
 233         }
 234         else if ( !collapse_resulting_node_with_one_desc ) {
 235             remove_us.getParent().removeChildNode( remove_us );
 236         }
 237         else {
 238             final PhylogenyNode removed_node = remove_us;
 239             final PhylogenyNode p = remove_us.getParent();
 240             if ( p.isRoot() ) {
 241                 if ( p.getNumberOfDescendants() == 2 ) {
 242                     if ( removed_node.isFirstChildNode() ) {
 243                         setRoot( getRoot().getChildNode( 1 ) );
 244                         getRoot().setParent( null );
 245                     }
 246                     else {
 247                         setRoot( getRoot().getChildNode( 0 ) );
 248                         getRoot().setParent( null );
 249                     }
 250                 }
 251                 else {
 252                     p.removeChildNode( removed_node.getChildNodeIndex() );
 253                 }
 254             }
 255             else {
 256                 final PhylogenyNode pp = removed_node.getParent().getParent();
 257                 if ( p.getNumberOfDescendants() == 2 ) {
 258                     final int pi = p.getChildNodeIndex();
 259                     if ( removed_node.isFirstChildNode() ) {
 260                         p.getChildNode( 1 ).setDistanceToParent( PhylogenyMethods.addPhylogenyDistances( p
 261                                 .getDistanceToParent(), p.getChildNode( 1 ).getDistanceToParent() ) );
 262                         pp.setChildNode( pi, p.getChildNode( 1 ) );
 263                     }
 264                     else {
 265                         p.getChildNode( 0 ).setDistanceToParent( PhylogenyMethods.addPhylogenyDistances( p
 266                                 .getDistanceToParent(), p.getChildNode( 0 ).getDistanceToParent() ) );
 267                         pp.setChildNode( pi, p.getChildNode( 0 ) );
 268                     }
 269                 }
 270                 else {
 271                     p.removeChildNode( removed_node.getChildNodeIndex() );
 272                 }
 273             }
 274         }
 275         remove_us.removeConnections();
 276         externalNodesHaveChanged();
 277     }
 278
 279     public void externalNodesHaveChanged() {
 280         _external_nodes_set = null;
 281     }
 282
 283     public String[] getAllExternalNodeNames() {
 284         int i = 0;
 285         if ( isEmpty() ) {
 286             return null;
 287         }
 288         final String[] names = new String[ getNumberOfExternalNodes() ];
 289         for( final PhylogenyNodeIterator iter = iteratorExternalForward(); iter.hasNext(); ) {
 290             names[ i++ ] = new String( iter.next().getName() );
 291         }
 292         return names;
 293     }
 294
 295     public Confidence getConfidence() {
 296         return _confidence;
 297     }
 298
 299     public String getDescription() {
 300         return _description;
 301     }
 302
 303     public String getDistanceUnit() {
 304         return _distance_unit;
 305     }
 306
 307     /**
 308      *
 309      * Warning. The order of the returned nodes is random
 310      * -- and hence cannot be relied on.
 311      *
 312      * @return Unordered set of PhylogenyNode
 313      */
 314     public List<PhylogenyNode> getExternalNodes() {
 315         if ( _external_nodes_set == null ) {
 316             _external_nodes_set = new ArrayList<PhylogenyNode>();
 317             for( final PhylogenyNodeIterator it = iteratorPostorder(); it.hasNext(); ) {
 318                 final PhylogenyNode n = it.next();
 319                 if ( n.isExternal() ) {
 320                     _external_nodes_set.add( n );
 321                 }
 322             }
 323         }
 324         return _external_nodes_set;
 325     }
 326
 327     /**
 328      * Returns the number of duplications of this Phylogeny (int). A return
 329      * value of -1 indicates that the number of duplications is unknown.
 330      */
 331     // public int getNumberOfDuplications() {
 332     // return _number_of_duplications;
 333     // } // getNumberOfDuplications()
 334     /**
 335      * Sets the number of duplications of this Phylogeny (int). A value of -1
 336      * indicates that the number of duplications is unknown.
 337      *
 338      * @param clean_nh
 339      *            set to true for clean NH format
 340      */
 341     // public void setNumberOfDuplications( int i ) {
 342     // if ( i < 0 ) {
 343     // _number_of_duplications = -1;
 344     // }
 345     // else {
 346     // _number_of_duplications = i;
 347     // }
 348     // } // setNumberOfDuplications( int )
 349     /**
 350      * Returns the first external PhylogenyNode.
 351      */
 352     public PhylogenyNode getFirstExternalNode() {
 353         if ( isEmpty() ) {
 354             throw new FailedConditionCheckException( "attempt to obtain first external node of empty phylogeney" );
 355         }
 356         PhylogenyNode node = getRoot();
 357         while ( node.isInternal() ) {
 358             node = node.getFirstChildNode();
 359         }
 360         return node;
 361     }
 362
 363     /**
 364      * This calculates the height for rooted, tree-shaped phylogenies. The
 365      * height is the longest distance from the root to an external node. Please
 366      * note. Child nodes of collapsed nodes are ignored -- which is useful for
 367      * display purposes but might be misleading for other applications.
 368      *
 369      * @return the height for rooted, tree-shaped phylogenies
 370      */
 371     public double getHeight() {
 372         if ( isEmpty() ) {
 373             return 0.0;
 374         }
 375         return calculateSubtreeHeight( getRoot() );
 376     }
 377
 378     public Identifier getIdentifier() {
 379         return _identifier;
 380     }
 381
 382     /**
 383      * Returns the name of this Phylogeny.
 384      */
 385     public String getName() {
 386         return _name;
 387     }
 388
 389     /**
 390      * Finds the PhylogenyNode of this Phylogeny which has a matching ID number.
 391      * @return PhylogenyNode with matching ID, null if not found
 392      */
 393     public PhylogenyNode getNode( final long id ) throws NoSuchElementException {
 394         if ( isEmpty() ) {
 395             throw new NoSuchElementException( "attempt to get node in an empty phylogeny" );
 396         }
 397         if ( ( getIdToNodeMap() == null ) || getIdToNodeMap().isEmpty() ) {
 398             reHashIdToNodeMap();
 399         }
 400         return getIdToNodeMap().get( id );
 401     }
 402
 403     /**
 404      * Returns a PhylogenyNode of this Phylogeny which has a matching name.
 405      * Throws an Exception if seqname is not present in this or not unique.
 406      *
 407      * @param name
 408      *            name (String) of PhylogenyNode to find
 409      * @return PhylogenyNode with matchin name
 410      */
 411     public PhylogenyNode getNode( final String name ) {
 412         if ( isEmpty() ) {
 413             return null;
 414         }
 415         final List<PhylogenyNode> nodes = getNodes( name );
 416         if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
 417             throw new IllegalArgumentException( "node named \"" + name + "\" not found" );
 418         }
 419         if ( nodes.size() > 1 ) {
 420             throw new IllegalArgumentException( "node named \"" + name + "\" not unique" );
 421         }
 422         return nodes.get( 0 );
 423     }
 424
 425     /**
 426      * This is time-inefficient since it runs a iterator each time it is called.
 427      *
 428      */
 429     public int getNodeCount() {
 430         if ( isEmpty() ) {
 431             return 0;
 432         }
 433         int c = 0;
 434         for( final PhylogenyNodeIterator it = iteratorPreorder(); it.hasNext(); it.next() ) {
 435             ++c;
 436         }
 437         return c;
 438     }
 439
 440     /**
 441      * Returns a List with references to all Nodes of this Phylogeny which have
 442      * a matching name.
 443      *
 444      * @param name
 445      *            name (String) of Nodes to find
 446      * @return Vector of references to Nodes of this Phylogeny with matching
 447      *         names
 448      * @see #getNodesWithMatchingSpecies(String)
 449      */
 450     public List<PhylogenyNode> getNodes( final String name ) {
 451         if ( isEmpty() ) {
 452             return null;
 453         }
 454         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 455         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 456             final PhylogenyNode n = iter.next();
 457             if ( n.getName().equals( name ) ) {
 458                 nodes.add( n );
 459             }
 460         }
 461         return nodes;
 462     }
 463
 464     public List<PhylogenyNode> getNodesViaSequenceName( final String seq_name ) {
 465         if ( isEmpty() ) {
 466             return null;
 467         }
 468         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 469         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 470             final PhylogenyNode n = iter.next();
 471             if ( n.getNodeData().isHasSequence() && n.getNodeData().getSequence().getName().equals( seq_name ) ) {
 472                 nodes.add( n );
 473             }
 474         }
 475         return nodes;
 476     }
 477
 478     public List<PhylogenyNode> getNodesViaSequenceSymbol( final String seq_name ) {
 479         if ( isEmpty() ) {
 480             return null;
 481         }
 482         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 483         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 484             final PhylogenyNode n = iter.next();
 485             if ( n.getNodeData().isHasSequence() && n.getNodeData().getSequence().getSymbol().equals( seq_name ) ) {
 486                 nodes.add( n );
 487             }
 488         }
 489         return nodes;
 490     }
 491
 492     public List<PhylogenyNode> getNodesViaTaxonomyCode( final String taxonomy_code ) {
 493         if ( isEmpty() ) {
 494             return null;
 495         }
 496         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 497         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 498             final PhylogenyNode n = iter.next();
 499             if ( n.getNodeData().isHasTaxonomy()
 500                     && n.getNodeData().getTaxonomy().getTaxonomyCode().equals( taxonomy_code ) ) {
 501                 nodes.add( n );
 502             }
 503         }
 504         return nodes;
 505     }
 506
 507     /**
 508      * Returns a Vector with references to all Nodes of this Phylogeny which
 509      * have a matching species name.
 510      *
 511      * @param specname
 512      *            species name (String) of Nodes to find
 513      * @return Vector of references to Nodes of this Phylogeny with matching
 514      *         species names.
 515      * @see #getNodes(String)
 516      */
 517     public List<PhylogenyNode> getNodesWithMatchingSpecies( final String specname ) {
 518         if ( isEmpty() ) {
 519             return null;
 520         }
 521         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 522         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 523             final PhylogenyNode n = iter.next();
 524             if ( PhylogenyMethods.getSpecies( n ).equals( specname ) ) {
 525                 nodes.add( n );
 526             }
 527         }
 528         return nodes;
 529     }
 530
 531     public PhylogenyNode getNodeViaSequenceName( final String seq_name ) {
 532         if ( isEmpty() ) {
 533             return null;
 534         }
 535         final List<PhylogenyNode> nodes = getNodesViaSequenceName( seq_name );
 536         if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
 537             throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not found" );
 538         }
 539         if ( nodes.size() > 1 ) {
 540             throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not unique" );
 541         }
 542         return nodes.get( 0 );
 543     }
 544
 545     public PhylogenyNode getNodeViaTaxonomyCode( final String taxonomy_code ) {
 546         if ( isEmpty() ) {
 547             return null;
 548         }
 549         final List<PhylogenyNode> nodes = getNodesViaTaxonomyCode( taxonomy_code );
 550         if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
 551             throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not found" );
 552         }
 553         if ( nodes.size() > 1 ) {
 554             throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not unique" );
 555         }
 556         return nodes.get( 0 );
 557     }
 558
 559     public int getNumberOfBranches() {
 560         if ( isEmpty() ) {
 561             return 0;
 562         }
 563         int c = 0;
 564         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); iter.next() ) {
 565             ++c;
 566         }
 567         if ( !isRooted() ) {
 568             --c;
 569         }
 570         return c;
 571     }
 572
 573     public int getNumberOfInternalNodes() {
 574         if ( isEmpty() ) {
 575             return 0;
 576         }
 577         int c = 0;
 578         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 579             if ( iter.next().isInternal() ) {
 580                 ++c;
 581             }
 582         }
 583         if ( !isRooted() ) {
 584             --c;
 585         }
 586         return c;
 587     }
 588
 589     /**
 590      * Returns the sum of external Nodes of this Phylogeny (int).
 591      */
 592     public int getNumberOfExternalNodes() {
 593         if ( isEmpty() ) {
 594             return 0;
 595         }
 596         return getExternalNodes().size();
 597     }
 598
 599     /**
 600      * Returns all paralogs of the external PhylogenyNode n of this Phylogeny.
 601      * paralog are returned as List of node references.
 602      * <p>
 603      * PRECONDITION: This tree must be binary and rooted, and speciation -
 604      * duplication need to be assigned for each of its internal Nodes.
 605      * <p>
 606      * Returns null if this Phylogeny is empty or if n is internal.
 607      * <p>
 608      * (Last modified: 11/22/00) Olivier CHABROL :
 609      * olivier.chabrol@univ-provence.fr
 610      *
 611      * @param n
 612      *            external PhylogenyNode whose orthologs are to be returned
 613      * @return Vector of references to all orthologous Nodes of PhylogenyNode n
 614      *         of this Phylogeny, null if this Phylogeny is empty or if n is
 615      *         internal
 616      */
 617     public List<PhylogenyNode> getParalogousNodes( final PhylogenyNode n, final String[] taxonomyCodeRange ) {
 618         PhylogenyNode node = n;
 619         PhylogenyNode prev = null;
 620         final List<PhylogenyNode> v = new ArrayList<PhylogenyNode>();
 621         final Map<PhylogenyNode, List<String>> map = new HashMap<PhylogenyNode, List<String>>();
 622         getTaxonomyMap( getRoot(), map );
 623         if ( !node.isExternal() || isEmpty() ) {
 624             return null;
 625         }
 626         final String searchNodeSpeciesId = PhylogenyMethods.getTaxonomyIdentifier( n );
 627         if ( !node.isExternal() || isEmpty() ) {
 628             return null;
 629         }
 630         List<String> taxIdList = null;
 631         final List<String> taxonomyCodeRangeList = Arrays.asList( taxonomyCodeRange );
 632         while ( !node.isRoot() ) {
 633             prev = node;
 634             node = node.getParent();
 635             taxIdList = map.get( node );
 636             if ( node.isDuplication() && isContains( taxIdList, taxonomyCodeRangeList ) ) {
 637                 if ( node.getChildNode1() == prev ) {
 638                     v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode2()
 639                             .getAllExternalDescendants() ) );
 640                 }
 641                 else {
 642                     v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode1()
 643                             .getAllExternalDescendants() ) );
 644                 }
 645             }
 646         }
 647         return v;
 648     }
 649
 650     public Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> getRelevantSequenceRelationTypes() {
 651         if ( _relevant_sequence_relation_types == null ) {
 652             _relevant_sequence_relation_types = new Vector<SEQUENCE_RELATION_TYPE>();
 653         }
 654         return _relevant_sequence_relation_types;
 655     }
 656
 657     /**
 658      * Returns the root PhylogenyNode of this Phylogeny.
 659      */
 660     public PhylogenyNode getRoot() {
 661         return _root;
 662     }
 663
 664     public Collection<Sequence> getSequenceRelationQueries() {
 665         return _sequenceRelationQueries;
 666     }
 667
 668     public String getType() {
 669         return _type;
 670     }
 671
 672     /**
 673      * Deletes this Phylogeny.
 674      */
 675     public void init() {
 676         _root = null;
 677         _rooted = false;
 678         _name = "";
 679         _description = "";
 680         _type = "";
 681         _distance_unit = "";
 682         _id_to_node_map = null;
 683         _confidence = null;
 684         _identifier = null;
 685         _rerootable = true;
 686         setAllowMultipleParents( Phylogeny.ALLOW_MULTIPLE_PARENTS_DEFAULT );
 687     }
 688
 689     /**
 690      * Returns whether this is a completely binary tree (i.e. all internal nodes
 691      * are bifurcations).
 692      *
 693      */
 694     public boolean isCompletelyBinary() {
 695         if ( isEmpty() ) {
 696             return false;
 697         }
 698         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 699             final PhylogenyNode node = iter.next();
 700             if ( node.isInternal() && ( node.getNumberOfDescendants() != 2 ) ) {
 701                 return false;
 702             }
 703         }
 704         return true;
 705     }
 706
 707     /**
 708      * Checks whether a Phylogeny object is deleted (or empty).
 709      *
 710      * @return true if the tree is deleted (or empty), false otherwise
 711      */
 712     public boolean isEmpty() {
 713         return ( getRoot() == null );
 714     }
 715
 716     public boolean isRerootable() {
 717         return _rerootable;
 718     }
 719
 720     /**
 721      * Returns true is this Phylogeny is rooted.
 722      */
 723     public boolean isRooted() {
 724         return _rooted;
 725     } // isRooted()
 726
 727     public boolean isTree() {
 728         return true;
 729     }
 730
 731     public PhylogenyNodeIterator iteratorExternalForward() {
 732         return new ExternalForwardIterator( this );
 733     }
 734
 735     public PhylogenyNodeIterator iteratorLevelOrder() {
 736         return new LevelOrderTreeIterator( this );
 737     }
 738
 739     public PhylogenyNodeIterator iteratorPostorder() {
 740         return new PostorderTreeIterator( this );
 741     }
 742
 743     public PhylogenyNodeIterator iteratorPreorder() {
 744         return new PreorderTreeIterator( this );
 745     }
 746
 747     /**
 748      * Resets the ID numbers of the nodes of this Phylogeny in level order,
 749      * starting with start_label (for the root). <br>
 750      * WARNING. After this method has been called, node IDs are no longer
 751      * unique.
 752      */
 753     public void levelOrderReID() {
 754         if ( isEmpty() ) {
 755             return;
 756         }
 757         _id_to_node_map = null;
 758         long max = 0;
 759         for( final PhylogenyNodeIterator it = iteratorPreorder(); it.hasNext(); ) {
 760             final PhylogenyNode node = it.next();
 761             if ( node.isRoot() ) {
 762                 node.setId( PhylogenyNode.getNodeCount() );
 763             }
 764             else {
 765                 node.setId( node.getParent().getId() + 1 );
 766                 if ( node.getId() > max ) {
 767                     max = node.getId();
 768                 }
 769             }
 770         }
 771         PhylogenyNode.setNodeCount( max + 1 );
 772     }
 773
 774     /**
 775      * Prints descriptions of all external Nodes of this Phylogeny to
 776      * System.out.
 777      */
 778     public void printExtNodes() {
 779         if ( isEmpty() ) {
 780             return;
 781         }
 782         for( final PhylogenyNodeIterator iter = iteratorExternalForward(); iter.hasNext(); ) {
 783             System.out.println( iter.next() + "\n" );
 784         }
 785     }
 786
 787     /**
 788      * (Re)counts the number of children for each PhylogenyNode of this
 789      * Phylogeny. As an example, this method needs to be called after a
 790      * Phylogeny has been reRooted and it is to be displayed.
 791      *
 792      * @param consider_collapsed_nodes
 793      *            set to true to take into account collapsed nodes (collapsed
 794      *            nodes have 1 child).
 795      */
 796     public void recalculateNumberOfExternalDescendants( final boolean consider_collapsed_nodes ) {
 797         if ( isEmpty() ) {
 798             return;
 799         }
 800         for( final PhylogenyNodeIterator iter = iteratorPostorder(); iter.hasNext(); ) {
 801             final PhylogenyNode node = iter.next();
 802             if ( node.isExternal() || ( consider_collapsed_nodes && node.isCollapse() ) ) {
 803                 node.setSumExtNodes( 1 );
 804             }
 805             else {
 806                 int sum = 0;
 807                 for( int i = 0; i < node.getNumberOfDescendants(); ++i ) {
 808                     sum += node.getChildNode( i ).getNumberOfExternalNodes();
 809                 }
 810                 node.setSumExtNodes( sum );
 811             }
 812         }
 813     }
 814
 815     /**
 816      * Places the root of this Phylogeny on the parent branch of the
 817      * PhylogenyNode with a corresponding ID. The new root is always placed on
 818      * the middle of the branch. If the resulting reRooted Phylogeny is to be
 819      * used any further, in most cases the following methods have to be called
 820      * on the resulting Phylogeny:
 821      * <p>
 822      * <li>recalculateNumberOfExternalDescendants(boolean)
 823      * <li>recalculateAndReset()
 824      *
 825      * @param id
 826      *            ID (int) of PhylogenyNode of this Phylogeny
 827      */
 828     public void reRoot( final long id ) {
 829         reRoot( getNode( id ) );
 830     }
 831
 832     /**
 833      * Places the root of this Phylogeny on the parent branch PhylogenyNode n.
 834      * The new root is always placed on the middle of the branch.
 835      * <p>
 836      * If the resulting reRooted Phylogeny is to be used any further, in most
 837      * cases the following three methods have to be called on the resulting
 838      * Phylogeny:
 839      * <ul>
 840      * <li>recalculateNumberOfExternalDescendants(boolean) <li>recalculateAndReset()
 841      * </ul>
 842      * <p>
 843      * (Last modified: 10/01/01)
 844      *
 845      * @param n
 846      *            PhylogenyNode of this Phylogeny\
 847      */
 848     public void reRoot( final PhylogenyNode n ) {
 849         reRoot( n, -1 );
 850     }
 851
 852     public void reRoot( final PhylogenyNode n, final double distance_n_to_parent ) {
 853         if ( isEmpty() || ( getNumberOfExternalNodes() < 2 ) ) {
 854             return;
 855         }
 856         setRooted( true );
 857         if ( n.isRoot() ) {
 858             return;
 859         }
 860         else if ( n.getParent().isRoot() ) {
 861             if ( ( n.getParent().getNumberOfDescendants() == 2 ) && ( distance_n_to_parent >= 0 ) ) {
 862                 final double d = n.getParent().getChildNode1().getDistanceToParent()
 863                         + n.getParent().getChildNode2().getDistanceToParent();
 864                 PhylogenyNode other;
 865                 if ( n.getChildNodeIndex() == 0 ) {
 866                     other = n.getParent().getChildNode2();
 867                 }
 868                 else {
 869                     other = n.getParent().getChildNode1();
 870                 }
 871                 n.setDistanceToParent( distance_n_to_parent );
 872                 final double dm = d - distance_n_to_parent;
 873                 if ( dm >= 0 ) {
 874                     other.setDistanceToParent( dm );
 875                 }
 876                 else {
 877                     other.setDistanceToParent( 0 );
 878                 }
 879             }
 880             if ( n.getParent().getNumberOfDescendants() > 2 ) {
 881                 final int index = n.getChildNodeIndex();
 882                 final double dn = n.getDistanceToParent();
 883                 final PhylogenyNode prev_root = getRoot();
 884                 prev_root.getDescendants().remove( index );
 885                 final PhylogenyNode new_root = new PhylogenyNode();
 886                 new_root.setChildNode( 0, n );
 887                 new_root.setChildNode( 1, prev_root );
 888                 if ( n.getBranchDataDirectly() != null ) {
 889                     prev_root.setBranchData( ( BranchData ) n.getBranchDataDirectly().copy() );
 890                 }
 891                 setRoot( new_root );
 892                 if ( distance_n_to_parent >= 0 ) {
 893                     n.setDistanceToParent( distance_n_to_parent );
 894                     final double d = dn - distance_n_to_parent;
 895                     if ( d >= 0 ) {
 896                         prev_root.setDistanceToParent( d );
 897                     }
 898                     else {
 899                         prev_root.setDistanceToParent( 0 );
 900                     }
 901                 }
 902                 else {
 903                     if ( dn >= 0 ) {
 904                         final double d = dn / 2.0;
 905                         n.setDistanceToParent( d );
 906                         prev_root.setDistanceToParent( d );
 907                     }
 908                 }
 909             }
 910         }
 911         else {
 912             PhylogenyNode a = n;
 913             PhylogenyNode b = null;
 914             PhylogenyNode c = null;
 915             final PhylogenyNode new_root = new PhylogenyNode();
 916             double distance1 = 0.0;
 917             double distance2 = 0.0;
 918             BranchData branch_data_1 = null;
 919             BranchData branch_data_2 = null;
 920             b = a.getParent();
 921             c = b.getParent();
 922             new_root.setChildNode( 0, a );
 923             new_root.setChildNode( 1, b );
 924             distance1 = c.getDistanceToParent();
 925             if ( c.getBranchDataDirectly() != null ) {
 926                 branch_data_1 = ( BranchData ) c.getBranchDataDirectly().copy();
 927             }
 928             c.setDistanceToParent( b.getDistanceToParent() );
 929             if ( b.getBranchDataDirectly() != null ) {
 930                 c.setBranchData( ( BranchData ) b.getBranchDataDirectly().copy() );
 931             }
 932             if ( a.getBranchDataDirectly() != null ) {
 933                 b.setBranchData( ( BranchData ) a.getBranchDataDirectly().copy() );
 934             }
 935             // New root is always placed in the middle of the branch:
 936             if ( a.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) {
 937                 b.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
 938             }
 939             else {
 940                 if ( distance_n_to_parent >= 0.0 ) {
 941                     final double diff = a.getDistanceToParent() - distance_n_to_parent;
 942                     a.setDistanceToParent( distance_n_to_parent );
 943                     b.setDistanceToParent( diff >= 0.0 ? diff : 0.0 );
 944                 }
 945                 else {
 946                     final double d = a.getDistanceToParent() / 2.0;
 947                     a.setDistanceToParent( d );
 948                     b.setDistanceToParent( d );
 949                 }
 950             }
 951             b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
 952             // moving to the old root, swapping references:
 953             while ( !c.isRoot() ) {
 954                 a = b;
 955                 b = c;
 956                 c = c.getParent();
 957                 b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
 958                 b.setParent( a );
 959                 distance2 = c.getDistanceToParent();
 960                 branch_data_2 = c.getBranchDataDirectly();
 961                 c.setDistanceToParent( distance1 );
 962                 c.setBranchData( branch_data_1 );
 963                 distance1 = distance2;
 964                 branch_data_1 = branch_data_2;
 965             }
 966             // removing the old root:
 967             if ( c.getNumberOfDescendants() == 2 ) {
 968                 final PhylogenyNode node = c.getChildNode( 1 - b.getChildNodeIndex( c ) );
 969                 node.setParent( b );
 970                 if ( ( c.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT )
 971                         && ( node.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) ) {
 972                     node.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
 973                 }
 974                 else {
 975                     node.setDistanceToParent( ( c.getDistanceToParent() >= 0.0 ? c.getDistanceToParent() : 0.0 )
 976                             + ( node.getDistanceToParent() >= 0.0 ? node.getDistanceToParent() : 0.0 ) );
 977                 }
 978                 if ( c.getBranchDataDirectly() != null ) {
 979                     node.setBranchData( ( BranchData ) c.getBranchDataDirectly().copy() );
 980                 }
 981                 for( int i = 0; i < b.getNumberOfDescendants(); ++i ) {
 982                     if ( b.getChildNode( i ) == c ) {
 983                         b.setChildNodeOnly( i, node );
 984                         break;
 985                     }
 986                 }
 987             }
 988             else {
 989                 c.setParent( b );
 990                 c.removeChildNode( b.getChildNodeIndex( c ) );
 991             }
 992             setRoot( new_root );
 993         }
 994     }
 995
 996     /**
 997      * Sets all Nodes of this Phylogeny to not-collapsed.
 998      * <p>
 999      * In most cases methods adjustNodeCount(false) and recalculateAndReset()
1000      * need to be called after this method has been called.
1001      */
1002     public void setAllNodesToNotCollapse() {
1003         if ( isEmpty() ) {
1004             return;
1005         }
1006         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1007             final PhylogenyNode node = iter.next();
1008             node.setCollapse( false );
1009         }
1010     }
1011
1012     public void setConfidence( final Confidence confidence ) {
1013         _confidence = confidence;
1014     }
1015
1016     public void setDescription( final String description ) {
1017         _description = description;
1018     }
1019
1020     public void setDistanceUnit( final String _distance_unit ) {
1021         this._distance_unit = _distance_unit;
1022     }
1023
1024     public void setIdentifier( final Identifier identifier ) {
1025         _identifier = identifier;
1026     }
1027
1028     public void setIdToNodeMap( final HashMap<Long, PhylogenyNode> idhash ) {
1029         _id_to_node_map = idhash;
1030     }
1031
1032     /**
1033      * Sets the indicators of all Nodes of this Phylogeny to 0.
1034      */
1035     public void setIndicatorsToZero() {
1036         if ( isEmpty() ) {
1037             return;
1038         }
1039         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1040             iter.next().setIndicator( ( byte ) 0 );
1041         }
1042     } // setIndicatorsToZero()
1043
1044     /**
1045      * Sets the name of this Phylogeny to s.
1046      */
1047     public void setName( final String s ) {
1048         _name = s;
1049     }
1050
1051     public void setRelevantSequenceRelationTypes( final Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> types ) {
1052         _relevant_sequence_relation_types = types;
1053     }
1054
1055     public void setRerootable( final boolean rerootable ) {
1056         _rerootable = rerootable;
1057     }
1058
1059     public void setRoot( final PhylogenyNode n ) {
1060         _root = n;
1061     }
1062
1063     /**
1064      * Sets whether this Phylogeny is rooted or not.
1065      */
1066     public void setRooted( final boolean b ) {
1067         _rooted = b;
1068     } // setRooted( boolean )
1069
1070     public void setSequenceRelationQueries( final Collection<Sequence> sequencesByName ) {
1071         _sequenceRelationQueries = sequencesByName;
1072     }
1073
1074     public void setType( final String type ) {
1075         _type = type;
1076     }
1077
1078     public String toNewHampshire() {
1079         return toNewHampshire( false, NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1080     }
1081
1082     public String toNewHampshire( final boolean simple_nh,
1083                                   final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_style ) {
1084         try {
1085             return new PhylogenyWriter().toNewHampshire( this, simple_nh, true, nh_conversion_support_style )
1086                     .toString();
1087         }
1088         catch ( final IOException e ) {
1089             throw new Error( "this should not have happend: " + e.getMessage() );
1090         }
1091     }
1092
1093     public String toNewHampshireX() {
1094         try {
1095             return new PhylogenyWriter().toNewHampshireX( this ).toString();
1096         }
1097         catch ( final IOException e ) {
1098             throw new Error( "this should not have happend: " + e.getMessage() );
1099         }
1100     }
1101
1102     public String toNexus() {
1103         return toNexus( NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1104     }
1105
1106     public String toNexus( final NH_CONVERSION_SUPPORT_VALUE_STYLE svs ) {
1107         try {
1108             return new PhylogenyWriter().toNexus( this, svs ).toString();
1109         }
1110         catch ( final IOException e ) {
1111             throw new Error( "this should not have happend: " + e.getMessage() );
1112         }
1113     }
1114
1115     public String toPhyloXML( final int phyloxml_level ) {
1116         try {
1117             return new PhylogenyWriter().toPhyloXML( this, phyloxml_level ).toString();
1118         }
1119         catch ( final IOException e ) {
1120             throw new Error( "this should not have happend: " + e.getMessage() );
1121         }
1122     }
1123
1124     // ---------------------------------------------------------
1125     // Writing of Phylogeny to Strings
1126     // ---------------------------------------------------------
1127     /**
1128      * Converts this Phylogeny to a New Hampshire X (String) representation.
1129      *
1130      * @return New Hampshire X (String) representation of this
1131      * @see #toNewHampshireX()
1132      */
1133     @Override
1134     public String toString() {
1135         return toNewHampshireX();
1136     }
1137
1138     /**
1139      * Removes the root PhylogenyNode this Phylogeny.
1140      */
1141     public void unRoot() throws RuntimeException {
1142         if ( !isTree() ) {
1143             throw new FailedConditionCheckException( "Attempt to unroot a phylogeny which is not tree-like." );
1144         }
1145         if ( isEmpty() ) {
1146             return;
1147         }
1148         setIndicatorsToZero();
1149         if ( !isRooted() || ( getNumberOfExternalNodes() <= 1 ) ) {
1150             return;
1151         }
1152         setRooted( false );
1153         return;
1154     } // unRoot()
1155
1156     private HashMap<Long, PhylogenyNode> getIdToNodeMap() {
1157         return _id_to_node_map;
1158     }
1159
1160     /**
1161      * Return Node by TaxonomyId Olivier CHABROL :
1162      * olivier.chabrol@univ-provence.fr
1163      *
1164      * @param taxonomyID
1165      *            search taxonomy identifier
1166      * @param nodes
1167      *            sublist node to search
1168      * @return List node with the same taxonomy identifier
1169      */
1170     private List<PhylogenyNode> getNodeByTaxonomyID( final String taxonomyID, final List<PhylogenyNode> nodes ) {
1171         final List<PhylogenyNode> retour = new ArrayList<PhylogenyNode>();
1172         for( final PhylogenyNode node : nodes ) {
1173             if ( taxonomyID.equals( PhylogenyMethods.getTaxonomyIdentifier( node ) ) ) {
1174                 retour.add( node );
1175             }
1176         }
1177         return retour;
1178     }
1179
1180     /**
1181      * List all species contains in all leaf under a node Olivier CHABROL :
1182      * olivier.chabrol@univ-provence.fr
1183      *
1184      * @param node
1185      *            PhylogenyNode whose sub node species are returned
1186      * @return species contains in all leaf under the param node
1187      */
1188     private List<String> getSubNodeTaxonomy( final PhylogenyNode node ) {
1189         final List<String> taxonomyList = new ArrayList<String>();
1190         final List<PhylogenyNode> childs = node.getAllExternalDescendants();
1191         String speciesId = null;
1192         for( final PhylogenyNode phylogenyNode : childs ) {
1193             // taxId = new Long(phylogenyNode.getTaxonomyID());
1194             speciesId = PhylogenyMethods.getTaxonomyIdentifier( phylogenyNode );
1195             if ( !taxonomyList.contains( speciesId ) ) {
1196                 taxonomyList.add( speciesId );
1197             }
1198         }
1199         return taxonomyList;
1200     }
1201
1202     /**
1203      * Create a map [<PhylogenyNode, List<String>], the list contains the
1204      * species contains in all leaf under phylogeny node Olivier CHABROL :
1205      * olivier.chabrol@univ-provence.fr
1206      *
1207      * @param node
1208      *            the tree root node
1209      * @param map
1210      *            map to fill
1211      */
1212     private void getTaxonomyMap( final PhylogenyNode node, final Map<PhylogenyNode, List<String>> map ) {
1213         // node is leaf
1214         if ( node.isExternal() ) {
1215             return;
1216         }
1217         map.put( node, getSubNodeTaxonomy( node ) );
1218         getTaxonomyMap( node.getChildNode1(), map );
1219         getTaxonomyMap( node.getChildNode2(), map );
1220     }
1221
1222     private boolean isAllowMultipleParents() {
1223         return _allow_multiple_parents;
1224     }
1225
1226     /**
1227      * Util method to check if all element of a list is contains in the
1228      * rangeList. Olivier CHABROL : olivier.chabrol@univ-provence.fr
1229      *
1230      * @param list
1231      *            list to be check
1232      * @param rangeList
1233      *            the range list to compare
1234      * @return <code>true</code> if all param list element are contains in param
1235      *         rangeList, <code>false</code> otherwise.
1236      */
1237     private boolean isContains( final List<String> list, final List<String> rangeList ) {
1238         if ( list.size() > rangeList.size() ) {
1239             return false;
1240         }
1241         String l = null;
1242         for( final Iterator<String> iterator = list.iterator(); iterator.hasNext(); ) {
1243             l = iterator.next();
1244             if ( !rangeList.contains( l ) ) {
1245                 return false;
1246             }
1247         }
1248         return true;
1249     }
1250
1251     /**
1252      * Hashes the ID number of each PhylogenyNode of this Phylogeny to its
1253      * corresponding PhylogenyNode, in order to make method getNode( id ) run in
1254      * constant time. Important: The user is responsible for calling this method
1255      * (again) after this Phylogeny has been changed/created/renumbered.
1256      */
1257     private void reHashIdToNodeMap() {
1258         if ( isEmpty() ) {
1259             return;
1260         }
1261         setIdToNodeMap( new HashMap<Long, PhylogenyNode>() );
1262         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1263             final PhylogenyNode node = iter.next();
1264             getIdToNodeMap().put( node.getId(), node );
1265         }
1266     }
1267
1268     private void setAllowMultipleParents( final boolean allow_multiple_parents ) {
1269         _allow_multiple_parents = allow_multiple_parents;
1270     }
1271 }