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: www.phylosoft.org/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<Integer, 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 int 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> getNodesViaTaxonomyCode( final String taxonomy_code ) {
 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().isHasTaxonomy()
 486                     && n.getNodeData().getTaxonomy().getTaxonomyCode().equals( taxonomy_code ) ) {
 487                 nodes.add( n );
 488             }
 489         }
 490         return nodes;
 491     }
 492
 493     /**
 494      * Returns a Vector with references to all Nodes of this Phylogeny which
 495      * have a matching species name.
 496      *
 497      * @param specname
 498      *            species name (String) of Nodes to find
 499      * @return Vector of references to Nodes of this Phylogeny with matching
 500      *         species names.
 501      * @see #getNodes(String)
 502      */
 503     public List<PhylogenyNode> getNodesWithMatchingSpecies( final String specname ) {
 504         if ( isEmpty() ) {
 505             return null;
 506         }
 507         final List<PhylogenyNode> nodes = new ArrayList<PhylogenyNode>();
 508         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 509             final PhylogenyNode n = iter.next();
 510             if ( PhylogenyMethods.getSpecies( n ).equals( specname ) ) {
 511                 nodes.add( n );
 512             }
 513         }
 514         return nodes;
 515     }
 516
 517     public PhylogenyNode getNodeViaSequenceName( final String seq_name ) {
 518         if ( isEmpty() ) {
 519             return null;
 520         }
 521         final List<PhylogenyNode> nodes = getNodesViaSequenceName( seq_name );
 522         if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
 523             throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not found" );
 524         }
 525         if ( nodes.size() > 1 ) {
 526             throw new IllegalArgumentException( "node with sequence named [" + seq_name + "] not unique" );
 527         }
 528         return nodes.get( 0 );
 529     }
 530
 531     public PhylogenyNode getNodeViaTaxonomyCode( final String taxonomy_code ) {
 532         if ( isEmpty() ) {
 533             return null;
 534         }
 535         final List<PhylogenyNode> nodes = getNodesViaTaxonomyCode( taxonomy_code );
 536         if ( ( nodes == null ) || ( nodes.size() < 1 ) ) {
 537             throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not found" );
 538         }
 539         if ( nodes.size() > 1 ) {
 540             throw new IllegalArgumentException( "node with taxonomy code \"" + taxonomy_code + "\" not unique" );
 541         }
 542         return nodes.get( 0 );
 543     }
 544
 545     public int getNumberOfBranches() {
 546         if ( isEmpty() ) {
 547             return 0;
 548         }
 549         int c = 0;
 550         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); iter.next() ) {
 551             ++c;
 552         }
 553         if ( !isRooted() ) {
 554             --c;
 555         }
 556         return c;
 557     }
 558
 559     /**
 560      * Returns the sum of external Nodes of this Phylogeny (int).
 561      */
 562     public int getNumberOfExternalNodes() {
 563         if ( isEmpty() ) {
 564             return 0;
 565         }
 566         return getExternalNodes().size();
 567     }
 568
 569     /**
 570      * Returns all paralogs of the external PhylogenyNode n of this Phylogeny.
 571      * paralog are returned as List of node references.
 572      * <p>
 573      * PRECONDITION: This tree must be binary and rooted, and speciation -
 574      * duplication need to be assigned for each of its internal Nodes.
 575      * <p>
 576      * Returns null if this Phylogeny is empty or if n is internal.
 577      * <p>
 578      * (Last modified: 11/22/00) Olivier CHABROL :
 579      * olivier.chabrol@univ-provence.fr
 580      *
 581      * @param n
 582      *            external PhylogenyNode whose orthologs are to be returned
 583      * @return Vector of references to all orthologous Nodes of PhylogenyNode n
 584      *         of this Phylogeny, null if this Phylogeny is empty or if n is
 585      *         internal
 586      */
 587     public List<PhylogenyNode> getParalogousNodes( final PhylogenyNode n, final String[] taxonomyCodeRange ) {
 588         PhylogenyNode node = n;
 589         PhylogenyNode prev = null;
 590         final List<PhylogenyNode> v = new ArrayList<PhylogenyNode>();
 591         final Map<PhylogenyNode, List<String>> map = new HashMap<PhylogenyNode, List<String>>();
 592         getTaxonomyMap( getRoot(), map );
 593         if ( !node.isExternal() || isEmpty() ) {
 594             return null;
 595         }
 596         final String searchNodeSpeciesId = PhylogenyMethods.getTaxonomyIdentifier( n );
 597         if ( !node.isExternal() || isEmpty() ) {
 598             return null;
 599         }
 600         List<String> taxIdList = null;
 601         final List<String> taxonomyCodeRangeList = Arrays.asList( taxonomyCodeRange );
 602         while ( !node.isRoot() ) {
 603             prev = node;
 604             node = node.getParent();
 605             taxIdList = map.get( node );
 606             if ( node.isDuplication() && isContains( taxIdList, taxonomyCodeRangeList ) ) {
 607                 if ( node.getChildNode1() == prev ) {
 608                     v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode2()
 609                             .getAllExternalDescendants() ) );
 610                 }
 611                 else {
 612                     v.addAll( getNodeByTaxonomyID( searchNodeSpeciesId, node.getChildNode1()
 613                             .getAllExternalDescendants() ) );
 614                 }
 615             }
 616         }
 617         return v;
 618     }
 619
 620     public Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> getRelevantSequenceRelationTypes() {
 621         if ( _relevant_sequence_relation_types == null ) {
 622             _relevant_sequence_relation_types = new Vector<SEQUENCE_RELATION_TYPE>();
 623         }
 624         return _relevant_sequence_relation_types;
 625     }
 626
 627     /**
 628      * Returns the root PhylogenyNode of this Phylogeny.
 629      */
 630     public PhylogenyNode getRoot() {
 631         return _root;
 632     }
 633
 634     public Collection<Sequence> getSequenceRelationQueries() {
 635         return _sequenceRelationQueries;
 636     }
 637
 638     public String getType() {
 639         return _type;
 640     }
 641
 642     /**
 643      * Deletes this Phylogeny.
 644      */
 645     public void init() {
 646         _root = null;
 647         _rooted = false;
 648         _name = "";
 649         _description = "";
 650         _type = "";
 651         _distance_unit = "";
 652         _id_to_node_map = null;
 653         _confidence = null;
 654         _identifier = null;
 655         _rerootable = true;
 656         setAllowMultipleParents( Phylogeny.ALLOW_MULTIPLE_PARENTS_DEFAULT );
 657     }
 658
 659     /**
 660      * Returns whether this is a completely binary tree (i.e. all internal nodes
 661      * are bifurcations).
 662      *
 663      */
 664     public boolean isCompletelyBinary() {
 665         if ( isEmpty() ) {
 666             return false;
 667         }
 668         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
 669             final PhylogenyNode node = iter.next();
 670             if ( node.isInternal() && ( node.getNumberOfDescendants() != 2 ) ) {
 671                 return false;
 672             }
 673         }
 674         return true;
 675     }
 676
 677     /**
 678      * Checks whether a Phylogeny object is deleted (or empty).
 679      *
 680      * @return true if the tree is deleted (or empty), false otherwise
 681      */
 682     public boolean isEmpty() {
 683         return ( getRoot() == null );
 684     }
 685
 686     public boolean isRerootable() {
 687         return _rerootable;
 688     }
 689
 690     /**
 691      * Returns true is this Phylogeny is rooted.
 692      */
 693     public boolean isRooted() {
 694         return _rooted;
 695     } // isRooted()
 696
 697     public boolean isTree() {
 698         return true;
 699     }
 700
 701     public PhylogenyNodeIterator iteratorExternalForward() {
 702         return new ExternalForwardIterator( this );
 703     }
 704
 705     public PhylogenyNodeIterator iteratorLevelOrder() {
 706         return new LevelOrderTreeIterator( this );
 707     }
 708
 709     public PhylogenyNodeIterator iteratorPostorder() {
 710         return new PostorderTreeIterator( this );
 711     }
 712
 713     public PhylogenyNodeIterator iteratorPreorder() {
 714         return new PreorderTreeIterator( this );
 715     }
 716
 717     /**
 718      * Resets the ID numbers of the nodes of this Phylogeny in level order,
 719      * starting with start_label (for the root). <br>
 720      * WARNING. After this method has been called, node IDs are no longer
 721      * unique.
 722      */
 723     public void levelOrderReID() {
 724         if ( isEmpty() ) {
 725             return;
 726         }
 727         _id_to_node_map = null;
 728         int max = 0;
 729         for( final PhylogenyNodeIterator it = iteratorPreorder(); it.hasNext(); ) {
 730             final PhylogenyNode node = it.next();
 731             if ( node.isRoot() ) {
 732                 node.setId( PhylogenyNode.getNodeCount() );
 733             }
 734             else {
 735                 node.setId( node.getParent().getId() + 1 );
 736                 if ( node.getId() > max ) {
 737                     max = node.getId();
 738                 }
 739             }
 740         }
 741         PhylogenyNode.setNodeCount( max + 1 );
 742     }
 743
 744     /**
 745      * Prints descriptions of all external Nodes of this Phylogeny to
 746      * System.out.
 747      */
 748     public void printExtNodes() {
 749         if ( isEmpty() ) {
 750             return;
 751         }
 752         for( final PhylogenyNodeIterator iter = iteratorExternalForward(); iter.hasNext(); ) {
 753             System.out.println( iter.next() + "\n" );
 754         }
 755     }
 756
 757     /**
 758      * (Re)counts the number of children for each PhylogenyNode of this
 759      * Phylogeny. As an example, this method needs to be called after a
 760      * Phylogeny has been reRooted and it is to be displayed.
 761      *
 762      * @param consider_collapsed_nodes
 763      *            set to true to take into account collapsed nodes (collapsed
 764      *            nodes have 1 child).
 765      */
 766     public void recalculateNumberOfExternalDescendants( final boolean consider_collapsed_nodes ) {
 767         if ( isEmpty() ) {
 768             return;
 769         }
 770         for( final PhylogenyNodeIterator iter = iteratorPostorder(); iter.hasNext(); ) {
 771             final PhylogenyNode node = iter.next();
 772             if ( node.isExternal() || ( consider_collapsed_nodes && node.isCollapse() ) ) {
 773                 node.setSumExtNodes( 1 );
 774             }
 775             else {
 776                 int sum = 0;
 777                 for( int i = 0; i < node.getNumberOfDescendants(); ++i ) {
 778                     sum += node.getChildNode( i ).getNumberOfExternalNodes();
 779                 }
 780                 node.setSumExtNodes( sum );
 781             }
 782         }
 783     }
 784
 785     /**
 786      * Places the root of this Phylogeny on the parent branch of the
 787      * PhylogenyNode with a corresponding ID. The new root is always placed on
 788      * the middle of the branch. If the resulting reRooted Phylogeny is to be
 789      * used any further, in most cases the following methods have to be called
 790      * on the resulting Phylogeny:
 791      * <p>
 792      * <li>recalculateNumberOfExternalDescendants(boolean)
 793      * <li>recalculateAndReset()
 794      *
 795      * @param id
 796      *            ID (int) of PhylogenyNode of this Phylogeny
 797      */
 798     public void reRoot( final int id ) {
 799         reRoot( getNode( id ) );
 800     }
 801
 802     /**
 803      * Places the root of this Phylogeny on Branch b. The new root is always
 804      * placed on the middle of the branch b.
 805      *
 806      */
 807     public void reRoot( final PhylogenyBranch b ) {
 808         final PhylogenyNode n1 = b.getFirstNode();
 809         final PhylogenyNode n2 = b.getSecondNode();
 810         if ( n1.isExternal() ) {
 811             reRoot( n1 );
 812         }
 813         else if ( n2.isExternal() ) {
 814             reRoot( n2 );
 815         }
 816         else if ( ( n2 == n1.getChildNode1() ) || ( n2 == n1.getChildNode2() ) ) {
 817             reRoot( n2 );
 818         }
 819         else if ( ( n1 == n2.getChildNode1() ) || ( n1 == n2.getChildNode2() ) ) {
 820             reRoot( n1 );
 821         }
 822         else if ( ( n1.getParent() != null ) && n1.getParent().isRoot()
 823                 && ( ( n1.getParent().getChildNode1() == n2 ) || ( n1.getParent().getChildNode2() == n2 ) ) ) {
 824             reRoot( n1 );
 825         }
 826         else {
 827             throw new IllegalArgumentException( "reRoot( Branch b ): b is not a branch." );
 828         }
 829     }
 830
 831     /**
 832      * Places the root of this Phylogeny on the parent branch PhylogenyNode n.
 833      * The new root is always placed on the middle of the branch.
 834      * <p>
 835      * If the resulting reRooted Phylogeny is to be used any further, in most
 836      * cases the following three methods have to be called on the resulting
 837      * Phylogeny:
 838      * <ul>
 839      * <li>recalculateNumberOfExternalDescendants(boolean) <li>recalculateAndReset()
 840      * </ul>
 841      * <p>
 842      * (Last modified: 10/01/01)
 843      *
 844      * @param n
 845      *            PhylogenyNode of this Phylogeny\
 846      */
 847     public void reRoot( final PhylogenyNode n ) {
 848         reRoot( n, -1 );
 849     }
 850
 851     public void reRoot( final PhylogenyNode n, final double distance_n_to_parent ) {
 852         if ( isEmpty() || ( getNumberOfExternalNodes() < 2 ) ) {
 853             return;
 854         }
 855         setRooted( true );
 856         if ( n.isRoot() ) {
 857             return;
 858         }
 859         else if ( n.getParent().isRoot() ) {
 860             if ( ( n.getParent().getNumberOfDescendants() == 2 ) && ( distance_n_to_parent >= 0 ) ) {
 861                 final double d = n.getParent().getChildNode1().getDistanceToParent()
 862                         + n.getParent().getChildNode2().getDistanceToParent();
 863                 PhylogenyNode other;
 864                 if ( n.getChildNodeIndex() == 0 ) {
 865                     other = n.getParent().getChildNode2();
 866                 }
 867                 else {
 868                     other = n.getParent().getChildNode1();
 869                 }
 870                 n.setDistanceToParent( distance_n_to_parent );
 871                 final double dm = d - distance_n_to_parent;
 872                 if ( dm >= 0 ) {
 873                     other.setDistanceToParent( dm );
 874                 }
 875                 else {
 876                     other.setDistanceToParent( 0 );
 877                 }
 878             }
 879             if ( n.getParent().getNumberOfDescendants() > 2 ) {
 880                 final int index = n.getChildNodeIndex();
 881                 final double dn = n.getDistanceToParent();
 882                 final PhylogenyNode prev_root = getRoot();
 883                 prev_root.getDescendants().remove( index );
 884                 final PhylogenyNode new_root = new PhylogenyNode();
 885                 new_root.setChildNode( 0, n );
 886                 new_root.setChildNode( 1, prev_root );
 887                 if ( n.getBranchDataDirectly() != null ) {
 888                     prev_root.setBranchData( ( BranchData ) n.getBranchDataDirectly().copy() );
 889                 }
 890                 setRoot( new_root );
 891                 if ( distance_n_to_parent >= 0 ) {
 892                     n.setDistanceToParent( distance_n_to_parent );
 893                     final double d = dn - distance_n_to_parent;
 894                     if ( d >= 0 ) {
 895                         prev_root.setDistanceToParent( d );
 896                     }
 897                     else {
 898                         prev_root.setDistanceToParent( 0 );
 899                     }
 900                 }
 901                 else {
 902                     if ( dn >= 0 ) {
 903                         final double d = dn / 2.0;
 904                         n.setDistanceToParent( d );
 905                         prev_root.setDistanceToParent( d );
 906                     }
 907                 }
 908             }
 909         }
 910         else {
 911             PhylogenyNode a = n;
 912             PhylogenyNode b = null;
 913             PhylogenyNode c = null;
 914             final PhylogenyNode new_root = new PhylogenyNode();
 915             double distance1 = 0.0;
 916             double distance2 = 0.0;
 917             BranchData branch_data_1 = null;
 918             BranchData branch_data_2 = null;
 919             b = a.getParent();
 920             c = b.getParent();
 921             new_root.setChildNode( 0, a );
 922             new_root.setChildNode( 1, b );
 923             distance1 = c.getDistanceToParent();
 924             if ( c.getBranchDataDirectly() != null ) {
 925                 branch_data_1 = ( BranchData ) c.getBranchDataDirectly().copy();
 926             }
 927             c.setDistanceToParent( b.getDistanceToParent() );
 928             if ( b.getBranchDataDirectly() != null ) {
 929                 c.setBranchData( ( BranchData ) b.getBranchDataDirectly().copy() );
 930             }
 931             if ( a.getBranchDataDirectly() != null ) {
 932                 b.setBranchData( ( BranchData ) a.getBranchDataDirectly().copy() );
 933             }
 934             // New root is always placed in the middle of the branch:
 935             if ( a.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) {
 936                 b.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
 937             }
 938             else {
 939                 if ( distance_n_to_parent >= 0.0 ) {
 940                     final double diff = a.getDistanceToParent() - distance_n_to_parent;
 941                     a.setDistanceToParent( distance_n_to_parent );
 942                     b.setDistanceToParent( diff >= 0.0 ? diff : 0.0 );
 943                 }
 944                 else {
 945                     final double d = a.getDistanceToParent() / 2.0;
 946                     a.setDistanceToParent( d );
 947                     b.setDistanceToParent( d );
 948                 }
 949             }
 950             b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
 951             // moving to the old root, swapping references:
 952             while ( !c.isRoot() ) {
 953                 a = b;
 954                 b = c;
 955                 c = c.getParent();
 956                 b.setChildNodeOnly( a.getChildNodeIndex( b ), c );
 957                 b.setParent( a );
 958                 distance2 = c.getDistanceToParent();
 959                 branch_data_2 = c.getBranchDataDirectly();
 960                 c.setDistanceToParent( distance1 );
 961                 c.setBranchData( branch_data_1 );
 962                 distance1 = distance2;
 963                 branch_data_1 = branch_data_2;
 964             }
 965             // removing the old root:
 966             if ( c.getNumberOfDescendants() == 2 ) {
 967                 final PhylogenyNode node = c.getChildNode( 1 - b.getChildNodeIndex( c ) );
 968                 node.setParent( b );
 969                 if ( ( c.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT )
 970                         && ( node.getDistanceToParent() == PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) ) {
 971                     node.setDistanceToParent( PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT );
 972                 }
 973                 else {
 974                     node.setDistanceToParent( ( c.getDistanceToParent() >= 0.0 ? c.getDistanceToParent() : 0.0 )
 975                             + ( node.getDistanceToParent() >= 0.0 ? node.getDistanceToParent() : 0.0 ) );
 976                 }
 977                 if ( c.getBranchDataDirectly() != null ) {
 978                     node.setBranchData( ( BranchData ) c.getBranchDataDirectly().copy() );
 979                 }
 980                 for( int i = 0; i < b.getNumberOfDescendants(); ++i ) {
 981                     if ( b.getChildNode( i ) == c ) {
 982                         b.setChildNodeOnly( i, node );
 983                         break;
 984                     }
 985                 }
 986             }
 987             else {
 988                 c.setParent( b );
 989                 c.removeChildNode( b.getChildNodeIndex( c ) );
 990             }
 991             setRoot( new_root );
 992         }
 993     }
 994
 995     /**
 996      * Sets all Nodes of this Phylogeny to not-collapsed.
 997      * <p>
 998      * In most cases methods adjustNodeCount(false) and recalculateAndReset()
 999      * need to be called after this method has been called.
1000      */
1001     public void setAllNodesToNotCollapse() {
1002         if ( isEmpty() ) {
1003             return;
1004         }
1005         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1006             final PhylogenyNode node = iter.next();
1007             node.setCollapse( false );
1008         }
1009     }
1010
1011     public void setConfidence( final Confidence confidence ) {
1012         _confidence = confidence;
1013     }
1014
1015     public void setDescription( final String description ) {
1016         _description = description;
1017     }
1018
1019     public void setDistanceUnit( final String _distance_unit ) {
1020         this._distance_unit = _distance_unit;
1021     }
1022
1023     public void setIdentifier( final Identifier identifier ) {
1024         _identifier = identifier;
1025     }
1026
1027     public void setIdToNodeMap( final HashMap<Integer, PhylogenyNode> idhash ) {
1028         _id_to_node_map = idhash;
1029     }
1030
1031     /**
1032      * Sets the indicators of all Nodes of this Phylogeny to 0.
1033      */
1034     public void setIndicatorsToZero() {
1035         if ( isEmpty() ) {
1036             return;
1037         }
1038         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1039             iter.next().setIndicator( ( byte ) 0 );
1040         }
1041     } // setIndicatorsToZero()
1042
1043     /**
1044      * Sets the name of this Phylogeny to s.
1045      */
1046     public void setName( final String s ) {
1047         _name = s;
1048     }
1049
1050     public void setRelevantSequenceRelationTypes( final Collection<SequenceRelation.SEQUENCE_RELATION_TYPE> types ) {
1051         _relevant_sequence_relation_types = types;
1052     }
1053
1054     public void setRerootable( final boolean rerootable ) {
1055         _rerootable = rerootable;
1056     }
1057
1058     public void setRoot( final PhylogenyNode n ) {
1059         _root = n;
1060     } // setRoot( PhylogenyNode )
1061
1062     /**
1063      * Sets whether this Phylogeny is rooted or not.
1064      */
1065     public void setRooted( final boolean b ) {
1066         _rooted = b;
1067     } // setRooted( boolean )
1068
1069     public void setSequenceRelationQueries( final Collection<Sequence> sequencesByName ) {
1070         _sequenceRelationQueries = sequencesByName;
1071     }
1072
1073     public void setType( final String type ) {
1074         _type = type;
1075     }
1076
1077     public String toNewHampshire() {
1078         return toNewHampshire( false, NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1079     }
1080
1081     public String toNewHampshire( final boolean simple_nh,
1082                                   final NH_CONVERSION_SUPPORT_VALUE_STYLE nh_conversion_support_style ) {
1083         try {
1084             return new PhylogenyWriter().toNewHampshire( this, simple_nh, true, nh_conversion_support_style )
1085                     .toString();
1086         }
1087         catch ( final IOException e ) {
1088             throw new Error( "this should not have happend: " + e.getMessage() );
1089         }
1090     }
1091
1092     public String toNewHampshireX() {
1093         try {
1094             return new PhylogenyWriter().toNewHampshireX( this ).toString();
1095         }
1096         catch ( final IOException e ) {
1097             throw new Error( "this should not have happend: " + e.getMessage() );
1098         }
1099     }
1100
1101     public String toNexus() {
1102         return toNexus( NH_CONVERSION_SUPPORT_VALUE_STYLE.NONE );
1103     }
1104
1105     public String toNexus( final NH_CONVERSION_SUPPORT_VALUE_STYLE svs ) {
1106         try {
1107             return new PhylogenyWriter().toNexus( this, svs ).toString();
1108         }
1109         catch ( final IOException e ) {
1110             throw new Error( "this should not have happend: " + e.getMessage() );
1111         }
1112     }
1113
1114     public String toPhyloXML( final int phyloxml_level ) {
1115         try {
1116             return new PhylogenyWriter().toPhyloXML( this, phyloxml_level ).toString();
1117         }
1118         catch ( final IOException e ) {
1119             throw new Error( "this should not have happend: " + e.getMessage() );
1120         }
1121     }
1122
1123     // ---------------------------------------------------------
1124     // Writing of Phylogeny to Strings
1125     // ---------------------------------------------------------
1126     /**
1127      * Converts this Phylogeny to a New Hampshire X (String) representation.
1128      *
1129      * @return New Hampshire X (String) representation of this
1130      * @see #toNewHampshireX()
1131      */
1132     @Override
1133     public String toString() {
1134         return toNewHampshireX();
1135     }
1136
1137     /**
1138      * Removes the root PhylogenyNode this Phylogeny.
1139      */
1140     public void unRoot() throws RuntimeException {
1141         if ( !isTree() ) {
1142             throw new FailedConditionCheckException( "Attempt to unroot a phylogeny which is not tree-like." );
1143         }
1144         if ( isEmpty() ) {
1145             return;
1146         }
1147         setIndicatorsToZero();
1148         if ( !isRooted() || ( getNumberOfExternalNodes() <= 1 ) ) {
1149             return;
1150         }
1151         setRooted( false );
1152         return;
1153     } // unRoot()
1154
1155     private HashMap<Integer, PhylogenyNode> getIdToNodeMap() {
1156         return _id_to_node_map;
1157     }
1158
1159     /**
1160      * Return Node by TaxonomyId Olivier CHABROL :
1161      * olivier.chabrol@univ-provence.fr
1162      *
1163      * @param taxonomyID
1164      *            search taxonomy identifier
1165      * @param nodes
1166      *            sublist node to search
1167      * @return List node with the same taxonomy identifier
1168      */
1169     private List<PhylogenyNode> getNodeByTaxonomyID( final String taxonomyID, final List<PhylogenyNode> nodes ) {
1170         final List<PhylogenyNode> retour = new ArrayList<PhylogenyNode>();
1171         for( final PhylogenyNode node : nodes ) {
1172             if ( taxonomyID.equals( PhylogenyMethods.getTaxonomyIdentifier( node ) ) ) {
1173                 retour.add( node );
1174             }
1175         }
1176         return retour;
1177     }
1178
1179     /**
1180      * List all species contains in all leaf under a node Olivier CHABROL :
1181      * olivier.chabrol@univ-provence.fr
1182      *
1183      * @param node
1184      *            PhylogenyNode whose sub node species are returned
1185      * @return species contains in all leaf under the param node
1186      */
1187     private List<String> getSubNodeTaxonomy( final PhylogenyNode node ) {
1188         final List<String> taxonomyList = new ArrayList<String>();
1189         final List<PhylogenyNode> childs = node.getAllExternalDescendants();
1190         String speciesId = null;
1191         for( final PhylogenyNode phylogenyNode : childs ) {
1192             // taxId = new Long(phylogenyNode.getTaxonomyID());
1193             speciesId = PhylogenyMethods.getTaxonomyIdentifier( phylogenyNode );
1194             if ( !taxonomyList.contains( speciesId ) ) {
1195                 taxonomyList.add( speciesId );
1196             }
1197         }
1198         return taxonomyList;
1199     }
1200
1201     /**
1202      * Create a map [<PhylogenyNode, List<String>], the list contains the
1203      * species contains in all leaf under phylogeny node Olivier CHABROL :
1204      * olivier.chabrol@univ-provence.fr
1205      *
1206      * @param node
1207      *            the tree root node
1208      * @param map
1209      *            map to fill
1210      */
1211     private void getTaxonomyMap( final PhylogenyNode node, final Map<PhylogenyNode, List<String>> map ) {
1212         // node is leaf
1213         if ( node.isExternal() ) {
1214             return;
1215         }
1216         map.put( node, getSubNodeTaxonomy( node ) );
1217         getTaxonomyMap( node.getChildNode1(), map );
1218         getTaxonomyMap( node.getChildNode2(), map );
1219     }
1220
1221     private boolean isAllowMultipleParents() {
1222         return _allow_multiple_parents;
1223     }
1224
1225     /**
1226      * Util method to check if all element of a list is contains in the
1227      * rangeList. Olivier CHABROL : olivier.chabrol@univ-provence.fr
1228      *
1229      * @param list
1230      *            list to be check
1231      * @param rangeList
1232      *            the range list to compare
1233      * @return <code>true</code> if all param list element are contains in param
1234      *         rangeList, <code>false</code> otherwise.
1235      */
1236     private boolean isContains( final List<String> list, final List<String> rangeList ) {
1237         if ( list.size() > rangeList.size() ) {
1238             return false;
1239         }
1240         String l = null;
1241         for( final Iterator<String> iterator = list.iterator(); iterator.hasNext(); ) {
1242             l = iterator.next();
1243             if ( !rangeList.contains( l ) ) {
1244                 return false;
1245             }
1246         }
1247         return true;
1248     }
1249
1250     /**
1251      * Hashes the ID number of each PhylogenyNode of this Phylogeny to its
1252      * corresponding PhylogenyNode, in order to make method getNode( id ) run in
1253      * constant time. Important: The user is responsible for calling this method
1254      * (again) after this Phylogeny has been changed/created/renumbered.
1255      */
1256     private void reHashIdToNodeMap() {
1257         if ( isEmpty() ) {
1258             return;
1259         }
1260         setIdToNodeMap( new HashMap<Integer, PhylogenyNode>() );
1261         for( final PhylogenyNodeIterator iter = iteratorPreorder(); iter.hasNext(); ) {
1262             final PhylogenyNode node = iter.next();
1263             getIdToNodeMap().put( node.getId(), node );
1264         }
1265     }
1266
1267     private void setAllowMultipleParents( final boolean allow_multiple_parents ) {
1268         _allow_multiple_parents = allow_multiple_parents;
1269     }
1270 }