org.forester.phylogeny.data

Class Property

java.lang.Object

org.forester.phylogeny.data.Property

All Implemented Interfaces:

PhylogenyData

public class Property
extends java.lang.Object
implements PhylogenyData

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.AppliesTo

Constructor Summary

Constructors

Constructor and Description
Property(java.lang.String ref, java.lang.String value, java.lang.String unit, java.lang.String datatype, Property.AppliesTo applies_to)
Property(java.lang.String ref, java.lang.String value, java.lang.String unit, java.lang.String datatype, Property.AppliesTo applies_to, java.lang.String id_ref)

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.
static Property	createFromNhxString(java.lang.String nhx)
Property.AppliesTo	getAppliesTo()
java.lang.String	getDataType()
java.lang.String	getIdRef()
java.lang.String	getRef()
java.lang.String	getUnit()
java.lang.String	getValue()
boolean	isEqual(PhylogenyData data) Compares this PhylogenyData to PhylogenyData data.
void	setValue(java.lang.String value)
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

Constructor Detail

Property

public Property(java.lang.String ref,
        java.lang.String value,
        java.lang.String unit,
        java.lang.String datatype,
        Property.AppliesTo applies_to)

Property

public Property(java.lang.String ref,
        java.lang.String value,
        java.lang.String unit,
        java.lang.String datatype,
        Property.AppliesTo applies_to,
        java.lang.String id_ref)

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

getAppliesTo

public Property.AppliesTo getAppliesTo()

getDataType

public java.lang.String getDataType()

getIdRef

public java.lang.String getIdRef()

getRef

public java.lang.String getRef()

getUnit

public java.lang.String getUnit()

getValue

public java.lang.String 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

setValue

public void setValue(java.lang.String value)

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

createFromNhxString

public static Property createFromNhxString(java.lang.String nhx)
                                    throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException