X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=forester%2Fjava%2Fsrc%2Forg%2Fforester%2Fphylogeny%2FPhylogenyNode.java;h=3994605538573e570a5a3c9874752ac313afb395;hb=7e2a839d55608212fed645ce9ffe3a3f4952fb17;hp=d8dd2988c0d7490a089e53efdc8da6a5fbe30774;hpb=e9760b195d1eedcf55ddc4c9bbe0f8a15fc18d6a;p=jalview.git

diff --git a/forester/java/src/org/forester/phylogeny/PhylogenyNode.java b/forester/java/src/org/forester/phylogeny/PhylogenyNode.java
index d8dd298..3994605 100644
--- a/forester/java/src/org/forester/phylogeny/PhylogenyNode.java
+++ b/forester/java/src/org/forester/phylogeny/PhylogenyNode.java
@@ -23,7 +23,7 @@
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 //
 // Contact: phylosoft @ gmail . com
-// WWW: www.phylosoft.org/forester
+// WWW: https://sites.google.com/site/cmzmasek/home/software/forester
 
 package org.forester.phylogeny;
 
@@ -32,21 +32,29 @@ import java.util.List;
 
 import org.forester.io.parsers.nhx.NHXFormatException;
 import org.forester.io.parsers.nhx.NHXParser;
+import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
 import org.forester.io.parsers.phyloxml.PhyloXmlUtil;
 import org.forester.phylogeny.data.BranchData;
 import org.forester.phylogeny.data.Confidence;
 import org.forester.phylogeny.data.NodeData;
 import org.forester.phylogeny.data.PhylogenyDataUtil;
-import org.forester.phylogeny.iterators.ChildNodeIteratorForward;
-import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
 import org.forester.phylogeny.iterators.PreorderTreeIterator;
 import org.forester.util.ForesterUtil;
 
-public final class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode> {
+/**
+ * Warning. Implementation of method 'compareTo' only looks at 
+ * node name. Thus, use of this class in SortedSets might lead
+ * to unexpected behavior.
+ *
+ */
+public final class PhylogenyNode implements Comparable<PhylogenyNode> {
 
-    private static int               _node_count      = 0;
+    public enum NH_CONVERSION_SUPPORT_VALUE_STYLE {
+        NONE, IN_SQUARE_BRACKETS, AS_INTERNAL_NODE_NAMES;
+    }
+    private static long              NODE_COUNT       = 0;
     private byte                     _indicator;
-    private int                      _id;
+    private long                     _id;
     private int                      _sum_ext_nodes;
     private float                    _x;
     private float                    _y;
@@ -64,7 +72,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * Default constructor for PhylogenyNode.
      */
     public PhylogenyNode() {
-        //  init();
         setId( PhylogenyNode.getNodeCount() );
         PhylogenyNode.increaseNodeCount();
         setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
@@ -83,9 +90,8 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * @param n
      *            the PhylogenyNode to add
      */
-    @Override
-    final public void addAsChild( final PhylogenyNodeI node ) {
-        final PhylogenyNode n = ( PhylogenyNode ) node;
+    final public void addAsChild( final PhylogenyNode node ) {
+        final PhylogenyNode n = node;
         addChildNode( n );
         n.setParent( this );
     }
@@ -276,7 +282,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * @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." );
@@ -351,7 +356,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * Returns the length of the branch leading to the _parent of this
      * PhylogenyNode (double).
      */
-    @Override
     final public double getDistanceToParent() {
         return _distance_parent;
     }
@@ -456,7 +460,7 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
             previous_node = current_node;
             current_node = current_node.getParent();
         }
-        if ( index < current_node.getNumberOfDescendants() - 1 ) {
+        if ( index < ( current_node.getNumberOfDescendants() - 1 ) ) {
             current_node = current_node.getChildNode( index + 1 );
         }
         while ( current_node.isInternal() && !current_node.isCollapse() ) {
@@ -482,19 +486,18 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
     /**
      * Returns the ID (int) of this PhylogenyNode.
      */
-    @Override
-    final public int getId() {
+    final public long getId() {
         return _id;
     }
 
-    /**
-     * Returns the name of this node.
-     */
-    @Override
     final public String getName() {
         return getNodeData().getNodeName();
     }
 
+    final public List<PhylogenyNode> getAllDescendants() {
+        return _descendants;
+    }
+
     final public int getNumberOfDescendants() {
         if ( _descendants == null ) {
             return 0;
@@ -729,6 +732,28 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
         return true;
     }
 
+    public final int calculateDepth() {
+        PhylogenyNode n = this;
+        int steps = 0;
+        while ( n._parent != null ) {
+            steps++;
+            n = n._parent;
+        }
+        return steps;
+    }
+
+    public final double calculateDistanceToRoot() {
+        PhylogenyNode n = this;
+        double d = 0.0;
+        while ( n._parent != null ) {
+            if ( n._distance_parent > 0.0 ) {
+                d += n._distance_parent;
+            }
+            n = n._parent;
+        }
+        return d;
+    }
+
     /**
      * Checks whether this PhylogenyNode is a root.
      * 
@@ -743,13 +768,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
     }
 
     // ---------------------------------------------------------
-    // Iterator
-    // ---------------------------------------------------------
-    final public PhylogenyNodeIterator iterateChildNodesForward() {
-        return new ChildNodeIteratorForward( this );
-    }
-
-    // ---------------------------------------------------------
     // Basic printing
     // ---------------------------------------------------------
     /**
@@ -839,7 +857,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * 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;
     }
@@ -876,7 +893,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
     /**
      * Sets the name of this node.
      */
-    @Override
     final public void setName( final String node_name ) {
         getNodeData().setNodeName( node_name );
     }
@@ -886,7 +902,7 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * should not be set to values lower than getNodeCount() -- which this method
      * does not allow.
      */
-    synchronized final protected void setId( final int i ) {
+    synchronized final protected void setId( final long i ) {
         if ( i < getNodeCount() ) {
             throw new IllegalArgumentException( "attempt to set node id to a value less than total node count (thus violating the uniqueness of node ids)" );
         }
@@ -896,7 +912,6 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
     /**
      * Sets the _parent PhylogenyNode of this PhylogenyNode to n.
      */
-    @Override
     final public void setParent( final PhylogenyNode n ) {
         _parent = n;
     }
@@ -1058,17 +1073,13 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
 
     @Override
     final public String toString() {
-        StringBuilder sb = new StringBuilder();
-        if ( ForesterUtil.isEmpty( getName() ) ) {
-            sb.append( getName() );
-            sb.append( " " );
-        }
+        final StringBuilder sb = new StringBuilder();
         if ( getNodeData().isHasTaxonomy() ) {
             if ( !ForesterUtil.isEmpty( getNodeData().getTaxonomy().getScientificName() ) ) {
                 sb.append( getNodeData().getTaxonomy().getScientificName() );
                 sb.append( " " );
             }
-            else if ( !ForesterUtil.isEmpty( getNodeData().getTaxonomy().getTaxonomyCode() ) ) {
+            else if ( ( sb.length() <= 1 ) && !ForesterUtil.isEmpty( getNodeData().getTaxonomy().getTaxonomyCode() ) ) {
                 sb.append( getNodeData().getTaxonomy().getTaxonomyCode() );
                 sb.append( " " );
             }
@@ -1082,15 +1093,19 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
                 sb.append( getNodeData().getSequence().getName() );
                 sb.append( " " );
             }
-            else if ( !ForesterUtil.isEmpty( getNodeData().getSequence().getSymbol() ) ) {
+            if ( !ForesterUtil.isEmpty( getNodeData().getSequence().getSymbol() ) ) {
                 sb.append( getNodeData().getSequence().getSymbol() );
                 sb.append( " " );
             }
-            else if ( getNodeData().getSequence().getAccession() != null ) {
-                sb.append( getNodeData().getTaxonomy().getIdentifier().toString() );
+            if ( getNodeData().getSequence().getAccession() != null ) {
+                sb.append( getNodeData().getSequence().getAccession().toString() );
                 sb.append( " " );
             }
         }
+        if ( ( sb.length() <= 1 ) && !ForesterUtil.isEmpty( getName() ) ) {
+            sb.append( getName() );
+            sb.append( " " );
+        }
         if ( sb.length() <= 1 ) {
             sb.append( "[" );
             sb.append( getId() );
@@ -1103,56 +1118,56 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
      * Decreases the total number of all Nodes created so far by one.
      */
     final static synchronized void decreaseNodeCount() {
-        --PhylogenyNode._node_count;
+        --NODE_COUNT;
     }
 
     /**
      * Returns the total number of all Nodes created so far.
      * 
-     * @return total number of Nodes (int)
+     * @return total number of Nodes (long)
      */
-    synchronized final public static int getNodeCount() {
-        return PhylogenyNode._node_count;
+    synchronized final public static long getNodeCount() {
+        return NODE_COUNT;
     }
 
     /**
      * Increases the total number of all Nodes created so far by one.
      */
     synchronized final private static void increaseNodeCount() {
-        ++PhylogenyNode._node_count;
+        ++NODE_COUNT;
     }
 
     /**
-     * Sets the total number of all Nodes created so far to i (int).
+     * Sets the total number of all Nodes created so far to i.
      */
-    synchronized final static void setNodeCount( final int i ) {
-        PhylogenyNode._node_count = i;
+    synchronized final static void setNodeCount( final long 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 ) throws NHXFormatException,
+            PhyloXmlDataFormatException {
+        return new PhylogenyNode( nhx, NHXParser.TAXONOMY_EXTRACTION.NO, false );
     }
 
     public static PhylogenyNode createInstanceFromNhxString( final String nhx,
-                                                             final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction )
-            throws NHXFormatException {
+                                                             final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction )
+            throws NHXFormatException, PhyloXmlDataFormatException {
         return new PhylogenyNode( nhx, taxonomy_extraction, false );
     }
 
     public static PhylogenyNode createInstanceFromNhxString( final String nhx,
-                                                             final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction,
+                                                             final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction,
                                                              final boolean replace_underscores )
-            throws NHXFormatException {
+            throws NHXFormatException, PhyloXmlDataFormatException {
         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();
+                           final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction,
+                           final boolean replace_underscores ) throws NHXFormatException, PhyloXmlDataFormatException {
         NHXParser.parseNHX( nhx, this, taxonomy_extraction, replace_underscores );
         setId( PhylogenyNode.getNodeCount() );
         PhylogenyNode.increaseNodeCount();
-        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!)
+        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!).
     }
 }