inprogress
[jalview.git] / forester / java / src / org / forester / phylogeny / PhylogenyNode.java
index b41da60..05876e7 100644 (file)
@@ -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;
 
@@ -47,11 +47,14 @@ import org.forester.util.ForesterUtil;
  * to unexpected behavior.
  *
  */
-public final class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode> {
+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;
@@ -69,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!!)
@@ -88,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 );
     }
@@ -281,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." );
@@ -356,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;
     }
@@ -487,12 +486,10 @@ 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;
     }
 
-    @Override
     final public String getName() {
         return getNodeData().getNodeName();
     }
@@ -860,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;
     }
@@ -897,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 );
     }
@@ -907,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)" );
         }
@@ -917,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;
     }
@@ -1103,6 +1097,10 @@ public final class PhylogenyNode implements PhylogenyNodeI, Comparable<Phylogeny
                 sb.append( getNodeData().getSequence().getSymbol() );
                 sb.append( " " );
             }
+            if ( !ForesterUtil.isEmpty( getNodeData().getSequence().getGeneName() ) ) {
+                sb.append( getNodeData().getSequence().getGeneName() );
+                sb.append( " " );
+            }
             if ( getNodeData().getSequence().getAccession() != null ) {
                 sb.append( getNodeData().getSequence().getAccession().toString() );
                 sb.append( " " );
@@ -1124,57 +1122,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,
             PhyloXmlDataFormatException {
-        return new PhylogenyNode( nhx, PhylogenyMethods.TAXONOMY_EXTRACTION.NO, false );
+        return new PhylogenyNode( nhx, NHXParser.TAXONOMY_EXTRACTION.NO, false );
     }
 
     public static PhylogenyNode createInstanceFromNhxString( final String nhx,
-                                                             final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction )
+                                                             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, PhyloXmlDataFormatException {
         return new PhylogenyNode( nhx, taxonomy_extraction, replace_underscores );
     }
 
     private PhylogenyNode( final String nhx,
-                           final PhylogenyMethods.TAXONOMY_EXTRACTION taxonomy_extraction,
+                           final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction,
                            final boolean replace_underscores ) throws NHXFormatException, PhyloXmlDataFormatException {
-        //  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!!)
+        setSumExtNodes( 1 ); // For ext node, this number is 1 (not 0!!).
     }
 }