in progress
[jalview.git] / forester / java / src / org / forester / phylogeny / PhylogenyNode.java
index 3858ea9..7bf60ef 100644 (file)
@@ -7,7 +7,7 @@
 // Copyright (C) 2000-2001 Washington University School of Medicine
 // and Howard Hughes Medical Institute
 // All rights reserved
-// 
+//
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
@@ -17,7 +17,7 @@
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 // Lesser General Public License for more details.
-// 
+//
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
@@ -32,7 +32,6 @@ import java.util.List;
 
 import org.forester.io.parsers.nhx.NHXFormatException;
 import org.forester.io.parsers.nhx.NHXParser;
-import org.forester.io.parsers.util.PhylogenyParserException;
 import org.forester.phylogeny.data.BranchData;
 import org.forester.phylogeny.data.NodeData;
 import org.forester.phylogeny.iterators.ChildNodeIteratorForward;
@@ -70,39 +69,6 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
         setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
     }
 
-    public PhylogenyNode( final String nhx ) throws NHXFormatException {
-        this( nhx, ForesterUtil.TAXONOMY_EXTRACTION.NO );
-    }
-
-    public PhylogenyNode( final String nhx, final ForesterUtil.TAXONOMY_EXTRACTION taxonomy_extraction )
-            throws NHXFormatException {
-        init();
-        NHXParser.parseNHX( nhx, this, taxonomy_extraction, false );
-        setId( PhylogenyNode.getNodeCount() );
-        PhylogenyNode.increaseNodeCount();
-        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
-    }
-
-    /**
-     * Constructor for PhylogenyNode.
-     * <p>
-     * 
-     * @param s
-     *            String representing one PhylogenyNode in New Hampshire (NH) or
-     *            New Hampshire X (NHX) format.
-     * @throws NHXFormatException
-     * @throws PhylogenyParserException
-     */
-    public PhylogenyNode( final String nhx,
-                          final ForesterUtil.TAXONOMY_EXTRACTION taxonomy_extraction,
-                          final boolean replace_underscores ) throws NHXFormatException {
-        init();
-        NHXParser.parseNHX( nhx, this, taxonomy_extraction, replace_underscores );
-        setId( PhylogenyNode.getNodeCount() );
-        PhylogenyNode.increaseNodeCount();
-        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
-    }
-
     /**
      * Adds PhylogenyNode n to the list of child nodes and sets the _parent of n
      * to this.
@@ -110,6 +76,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
      * @param n
      *            the PhylogenyNode to add
      */
+    @Override
     final public void addAsChild( final PhylogenyNodeI node ) {
         final PhylogenyNode n = ( PhylogenyNode ) node;
         addChildNode( n );
@@ -128,6 +95,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
         getDescendants().add( child );
     }
 
+    @Override
     final public int compareTo( final PhylogenyNode o ) {
         final PhylogenyNode n = o;
         if ( ( getName() == null ) || ( n.getName() == null ) ) {
@@ -300,6 +268,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
      * @throws IllegalArgumentException
      *             if n is out of bounds
      */
+    @Override
     final public PhylogenyNode getChildNode( final int i ) {
         if ( isExternal() ) {
             throw new UnsupportedOperationException( "attempt to get the child node of an external node." );
@@ -371,6 +340,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
      * Returns the length of the branch leading to the _parent of this
      * PhylogenyNode (double).
      */
+    @Override
     final public double getDistanceToParent() {
         return _distance_parent;
     }
@@ -441,6 +411,49 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
         return current_node;
     }
 
+    public final PhylogenyNode getNextExternalNodeWhileTakingIntoAccountCollapsedNodes() {
+        //TODO work on me ~~
+        if ( isInternal() && !isCollapse() ) {
+            throw new UnsupportedOperationException( "attempt to get next external node of an uncollapsed internal node" );
+        }
+        if ( isRoot() ) {
+            return null;
+        }
+        if ( getParent().isCollapse() ) {
+            throw new UnsupportedOperationException( "attempt to get next external node of node with a collapsed parent" );
+        }
+        // This checks if last node.
+        PhylogenyNode n = this;
+        boolean last = true;
+        while ( !n.isRoot() ) {
+            if ( !n.isLastChildNode() ) {
+                last = false;
+                break;
+            }
+            n = n.getParent();
+        }
+        if ( last ) {
+            return null;
+        }
+        int index = getChildNodeIndex();
+        PhylogenyNode previous_node = this;
+        PhylogenyNode current_node = getParent();
+        while ( !current_node.isRoot()
+                && ( current_node.isCollapse() || ( current_node.getNumberOfDescendants() == 1 ) || previous_node
+                        .isLastChildNode() ) ) {
+            index = current_node.getChildNodeIndex();
+            previous_node = current_node;
+            current_node = current_node.getParent();
+        }
+        if ( index < current_node.getNumberOfDescendants() - 1 ) {
+            current_node = current_node.getChildNode( index + 1 );
+        }
+        while ( current_node.isInternal() && !current_node.isCollapse() ) {
+            current_node = current_node.getFirstChildNode();
+        }
+        return current_node;
+    }
+
     public final NodeData getNodeData() {
         if ( _node_data == null ) {
             _node_data = new NodeData();
@@ -458,6 +471,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
     /**
      * Returns the ID (int) of this PhylogenyNode.
      */
+    @Override
     final public int getId() {
         return _id;
     }
@@ -465,6 +479,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
     /**
      * Returns the name of this node.
      */
+    @Override
     final public String getName() {
         return getNodeData().getNodeName();
     }
@@ -809,6 +824,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
      * Sets the length of the branch leading to the _parent of this
      * PhylogenyNode to double d.
      */
+    @Override
     final public void setDistanceToParent( final double d ) {
         _distance_parent = d;
     }
@@ -845,6 +861,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
     /**
      * Sets the name of this node.
      */
+    @Override
     final public void setName( final String node_name ) {
         getNodeData().setNodeName( node_name );
     }
@@ -864,6 +881,7 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
     /**
      * Sets the _parent PhylogenyNode of this PhylogenyNode to n.
      */
+    @Override
     final public void setParent( final PhylogenyNode n ) {
         _parent = n;
     }
@@ -1029,4 +1047,31 @@ public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode>
     synchronized final static void setNodeCount( final int i ) {
         PhylogenyNode._node_count = i;
     }
+
+    public static PhylogenyNode createInstanceFromNhxString( final String nhx ) throws NHXFormatException {
+        return new PhylogenyNode( nhx, PhylogenyMethods.TAXONOMY_EXTRACTION.NO, false );
+    }
+
+    public static PhylogenyNode createInstanceFromNhxString( final String nhx,
+                                                             final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction )
+            throws NHXFormatException {
+        return new PhylogenyNode( nhx, taxonomy_extraction, false );
+    }
+
+    public static PhylogenyNode createInstanceFromNhxString( final String nhx,
+                                                             final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction,
+                                                             final boolean replace_underscores )
+            throws NHXFormatException {
+        return new PhylogenyNode( nhx, taxonomy_extraction, replace_underscores );
+    }
+
+    private PhylogenyNode( final String nhx,
+                           final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction,
+                           final boolean replace_underscores ) throws NHXFormatException {
+        init();
+        NHXParser.parseNHX( nhx, this, taxonomy_extraction, replace_underscores );
+        setId( PhylogenyNode.getNodeCount() );
+        PhylogenyNode.increaseNodeCount();
+        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
+    }
 }