org.forester.phylogeny.data
Class Point

java.lang.Object
  extended by org.forester.phylogeny.data.Point
All Implemented Interfaces:
PhylogenyData

public class Point
extends java.lang.Object
implements PhylogenyData


Field Summary
static java.lang.String UNKNOWN_GEODETIC_DATUM
           
 
Constructor Summary
Point()
           
Point(java.lang.String geodetic_datum, java.math.BigDecimal lat, java.math.BigDecimal longitude)
           
Point(java.lang.String geodetic_datum, java.math.BigDecimal lat, java.math.BigDecimal longitude, java.math.BigDecimal alt, java.lang.String alt_unit)
           
 
Method Summary
 java.lang.StringBuffer asSimpleText()
           
 java.lang.StringBuffer asText()
           
 PhylogenyData copy()
          Creates a new PhylogenyData object with identical values as this PhylogenyData.
 java.math.BigDecimal getAltitude()
           
 java.lang.String getAltiudeUnit()
           
 java.lang.String getGeodeticDatum()
           
 java.math.BigDecimal getLatitude()
           
 java.math.BigDecimal getLongitude()
           
 boolean isEmpty()
           
 boolean isEqual(PhylogenyData point)
          Compares this PhylogenyData to PhylogenyData data.
 java.lang.StringBuffer toNHX()
           
 void toPhyloXML(java.io.Writer writer, 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

UNKNOWN_GEODETIC_DATUM

public static final java.lang.String UNKNOWN_GEODETIC_DATUM
See Also:
Constant Field Values
Constructor Detail

Point

public Point()

Point

public Point(java.lang.String geodetic_datum,
             java.math.BigDecimal lat,
             java.math.BigDecimal longitude)

Point

public Point(java.lang.String geodetic_datum,
             java.math.BigDecimal lat,
             java.math.BigDecimal longitude,
             java.math.BigDecimal alt,
             java.lang.String alt_unit)
Method Detail

isEmpty

public boolean isEmpty()

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

getAltitude

public java.math.BigDecimal getAltitude()

getAltiudeUnit

public java.lang.String getAltiudeUnit()

getGeodeticDatum

public java.lang.String getGeodeticDatum()

getLatitude

public java.math.BigDecimal getLatitude()

getLongitude

public java.math.BigDecimal getLongitude()

isEqual

public boolean isEqual(PhylogenyData point)
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 writer,
                       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