// 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
// 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
import org.forester.io.parsers.nhx.NHXFormatException;
import org.forester.io.parsers.nhx.NHXParser;
-import org.forester.io.parsers.util.PhylogenyParserException;
+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;
public class PhylogenyNode implements PhylogenyNodeI, Comparable<PhylogenyNode> {
- /** Value of -99.0 is used as default value. */
- public final static double DISTANCE_DEFAULT = -1024.0;
- private static int _node_count = 0;
+ private static int _node_count = 0;
private byte _indicator;
private int _id;
private int _sum_ext_nodes;
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.
* @param n
* the PhylogenyNode to add
*/
+ @Override
final public void addAsChild( final PhylogenyNodeI node ) {
final PhylogenyNode n = ( PhylogenyNode ) node;
addChildNode( n );
getDescendants().add( child );
}
+ @Override
final public int compareTo( final PhylogenyNode o ) {
final PhylogenyNode n = o;
if ( ( getName() == null ) || ( n.getName() == null ) ) {
* @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." );
* Returns the length of the branch leading to the _parent of this
* PhylogenyNode (double).
*/
+ @Override
final public double getDistanceToParent() {
return _distance_parent;
}
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();
/**
* Returns the ID (int) of this PhylogenyNode.
*/
+ @Override
final public int getId() {
return _id;
}
/**
* Returns the name of this node.
*/
+ @Override
final public String getName() {
return getNodeData().getNodeName();
}
_x = 0;
_y = 0;
//_node_name = "";
- _distance_parent = PhylogenyNode.DISTANCE_DEFAULT;
+ _distance_parent = PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT;
_collapse = false;
_link = null;
_branch_data = null;
* 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;
}
/**
* Sets the name of this node.
*/
+ @Override
final public void setName( final String node_name ) {
getNodeData().setNodeName( node_name );
}
/**
* Sets the _parent PhylogenyNode of this PhylogenyNode to n.
*/
+ @Override
final public void setParent( final PhylogenyNode n ) {
_parent = n;
}
// ---------------------------------------------------------
// Writing of Nodes to Strings
// ---------------------------------------------------------
- final public String toNewHampshire( final boolean simple_nh, final boolean write_distance_to_parent ) {
+ final public String toNewHampshire( final boolean simple_nh,
+ final boolean write_distance_to_parent,
+ final NH_CONVERSION_SUPPORT_VALUE_STYLE svs ) {
final StringBuilder sb = new StringBuilder();
String data = "";
- if ( !ForesterUtil.isEmpty( getName() ) ) {
+ if ( ( svs == NH_CONVERSION_SUPPORT_VALUE_STYLE.AS_INTERNAL_NODE_NAMES ) && !isExternal() ) {
+ if ( getBranchData().isHasConfidences()
+ && ( getBranchData().getConfidence( 0 ).getValue() != Confidence.CONFIDENCE_DEFAULT_VALUE ) ) {
+ data = Confidence.FORMATTER.format( ForesterUtil
+ .round( getBranchData().getConfidence( 0 ).getValue(),
+ PhyloXmlUtil.ROUNDING_DIGITS_FOR_PHYLOXML_DOUBLE_OUTPUT ) );
+ }
+ }
+ else if ( !ForesterUtil.isEmpty( getName() ) ) {
data = getName();
}
else if ( getNodeData().isHasTaxonomy() ) {
sb.append( data );
}
}
- if ( ( getDistanceToParent() != PhylogenyNode.DISTANCE_DEFAULT ) && write_distance_to_parent ) {
+ if ( write_distance_to_parent && ( getDistanceToParent() != PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) ) {
sb.append( ":" );
sb.append( getDistanceToParent() );
}
+ if ( ( svs == NH_CONVERSION_SUPPORT_VALUE_STYLE.IN_SQUARE_BRACKETS ) && !isExternal()
+ && getBranchData().isHasConfidences()
+ && ( getBranchData().getConfidence( 0 ).getValue() != Confidence.CONFIDENCE_DEFAULT_VALUE ) ) {
+ sb.append( "[" );
+ sb.append( Confidence.FORMATTER.format( ForesterUtil
+ .round( getBranchData().getConfidence( 0 ).getValue(),
+ PhyloXmlUtil.ROUNDING_DIGITS_FOR_PHYLOXML_DOUBLE_OUTPUT ) ) );
+ sb.append( "]" );
+ }
return sb.toString();
}
/**
+ * Swaps the the two childern of a PhylogenyNode node of this Phylogeny.
+ */
+ public void swapChildren() throws RuntimeException {
+ if ( isExternal() ) {
+ throw new RuntimeException( "attempt to swap descendants of external node" );
+ }
+ if ( getNumberOfDescendants() != 2 ) {
+ throw new RuntimeException( "attempt to swap descendants of node with " + getNumberOfDescendants()
+ + " descendants" );
+ }
+ final PhylogenyNode a = getChildNode( 0 );
+ final PhylogenyNode b = getChildNode( 1 );
+ setChildNode( 0, b );
+ setChildNode( 1, a );
+ }
+
+ /**
* Converts this PhylogenyNode to a New Hampshire X (NHX) String
* representation.
*/
sb.append( name );
}
}
- if ( getDistanceToParent() != PhylogenyNode.DISTANCE_DEFAULT ) {
+ if ( getDistanceToParent() != PhylogenyDataUtil.BRANCH_LENGTH_DEFAULT ) {
sb.append( ":" );
sb.append( getDistanceToParent() );
}
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!!)
+ }
}
git://source.jalview.org / jalview.git / blobdiff