org.forester.phylogeny.data

Class BranchWidth

java.lang.Object

org.forester.phylogeny.data.BranchWidth

All Implemented Interfaces:

PhylogenyData

public class BranchWidth
extends java.lang.Object
implements PhylogenyData

Field Summary

Fields

Modifier and Type	Field and Description
static double	BRANCH_WIDTH_DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
BranchWidth()
BranchWidth(double value)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.StringBuffer	asSimpleText()
java.lang.StringBuffer	asText()
PhylogenyData	copy() Creates a new PhylogenyData object with identical values as this PhylogenyData.
double	getValue()
boolean	isEqual(PhylogenyData data) Compares this PhylogenyData to PhylogenyData data.
java.lang.StringBuffer	toNHX()
void	toPhyloXML(java.io.Writer w, int level, java.lang.String indentation) Writes a phyloXML representation of this phylogeny data.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BRANCH_WIDTH_DEFAULT_VALUE

public static final double BRANCH_WIDTH_DEFAULT_VALUE

See Also:

Constant Field Values

Constructor Detail

BranchWidth

public BranchWidth()

BranchWidth

public BranchWidth(double value)

Method Detail

asSimpleText

public java.lang.StringBuffer asSimpleText()

Specified by:

asSimpleText in interface PhylogenyData

asText

public java.lang.StringBuffer asText()

Specified by:

asText in interface PhylogenyData

copy

public PhylogenyData copy()

Description copied from interface: PhylogenyData

Creates a new PhylogenyData object with identical values as this PhylogenyData. This ~should~ return a deep copy, but not there yet.

Specified by:

copy in interface PhylogenyData

Returns:

a ~deep~ copy of this PhylogenyData

getValue

public double getValue()

isEqual

public boolean isEqual(PhylogenyData data)

Description copied from interface: PhylogenyData

Compares this PhylogenyData to PhylogenyData data. In general, this should return true if and only if all fiels are exactly identical.

Specified by:

isEqual in interface PhylogenyData

Returns:

in general, true if and only if all fiels are exactly identical, false otherwise

toNHX

public java.lang.StringBuffer toNHX()

Specified by:

toNHX in interface PhylogenyData

toPhyloXML

public void toPhyloXML(java.io.Writer w,
              int level,
              java.lang.String indentation)
                throws java.io.IOException

Description copied from interface: PhylogenyData

Writes a phyloXML representation of this phylogeny data.

Specified by:

toPhyloXML in interface PhylogenyData

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object