org.jscience.biology.taxonomy
Class ItisTaxon

java.lang.Object
  extended by org.jscience.biology.taxonomy.AbstractTaxon
      extended by org.jscience.biology.taxonomy.SimpleTaxon
          extended by org.jscience.biology.taxonomy.ItisTaxon
All Implemented Interfaces:
Taxon

public class ItisTaxon
extends SimpleTaxon

A taxonomic entity, represented by a scientific name and corresponding to a particular taxonomic serial numer (tsn) from ITIS. See: "http://sis.agr.gc.ca/itis" for details.


Field Summary
 
Fields inherited from class org.jscience.biology.taxonomy.SimpleTaxon
children, parent
 
Constructor Summary
ItisTaxon()
          construct an instance of the Taxon class, manually setting the attributes instead of getting them from an XML stream
ItisTaxon(java.lang.String scientificName, java.lang.String commonName)
          construct an instance of the Taxon class, manually setting the attributes instead of getting them from an XML stream
 
Method Summary
 void addChildTsn(long childTsn)
          method to add to the list of child TSNs
 void addSynonymTsn(long synonymTsn)
          method to add to the list of synonym TSNs
 void addVernacularName(java.lang.String name)
          method to add to the list of vernacular names
 java.util.Vector getChildTsn()
          Accessor method to return Vector of child TSNs
 java.lang.String getCommonName()
          DOCUMENT ME!
 long getParentTsn()
          Accessor method to return the parent taxon
 java.util.Vector getSynonymTsn()
          Accessor method to return Vector of synonym TSNs
 java.lang.String getTaxonAuthor()
          Accessor method to return the author name
 java.lang.String getTaxonRank()
          Accessor method to return the taxon rank
 long getTsn()
          Accessor method to return the tsn
 java.util.Vector getVernacularNames()
          Accessor method to return Vector of vernacular names
 boolean hasChildList()
          Accessor method to return hasChildList flag
 boolean isDataComplete()
          Accessor method to return dataComplete flag
 void setCommonName(java.lang.String commonName)
          DOCUMENT ME!
 void setDataComplete(boolean isComplete)
          method to set the dataComplete flag
 void setHasChildList(boolean hasChildList)
          method to set the hasChildList flag
 void setParentTsn(long parentTsn)
          method to set the parent taxon
 void setTaxonAuthor(java.lang.String taxonAuthor)
          method to set the author name
 void setTaxonRank(java.lang.String taxonRank)
          method to set the taxon rank
 void setTsn(long tsn)
          method to set the tsn of this taxon
 
Methods inherited from class org.jscience.biology.taxonomy.SimpleTaxon
getChildren, getParent, isLeaf, isRoot
 
Methods inherited from class org.jscience.biology.taxonomy.AbstractTaxon
equals, getAppearance, getExtendedName, getExtinction, getScientificName, setAppearance, setExtinction, setScientificName, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ItisTaxon

public ItisTaxon()
construct an instance of the Taxon class, manually setting the attributes instead of getting them from an XML stream


ItisTaxon

public ItisTaxon(java.lang.String scientificName,
                 java.lang.String commonName)
construct an instance of the Taxon class, manually setting the attributes instead of getting them from an XML stream

Method Detail

getCommonName

public java.lang.String getCommonName()
DOCUMENT ME!

Specified by:
getCommonName in interface Taxon
Overrides:
getCommonName in class AbstractTaxon
Returns:
DOCUMENT ME!

setCommonName

public void setCommonName(java.lang.String commonName)
DOCUMENT ME!

Overrides:
setCommonName in class AbstractTaxon
Parameters:
commonName - DOCUMENT ME!
Throws:
java.lang.UnsupportedOperationException - DOCUMENT ME!

getTsn

public long getTsn()
Accessor method to return the tsn

Returns:
DOCUMENT ME!

setTsn

public void setTsn(long tsn)
method to set the tsn of this taxon

Parameters:
tsn - DOCUMENT ME!

getTaxonRank

public java.lang.String getTaxonRank()
Accessor method to return the taxon rank

Returns:
DOCUMENT ME!

setTaxonRank

public void setTaxonRank(java.lang.String taxonRank)
method to set the taxon rank

Parameters:
taxonRank - DOCUMENT ME!

getParentTsn

public long getParentTsn()
Accessor method to return the parent taxon

Returns:
DOCUMENT ME!

setParentTsn

public void setParentTsn(long parentTsn)
method to set the parent taxon

Parameters:
parentTsn - DOCUMENT ME!

getChildTsn

public java.util.Vector getChildTsn()
Accessor method to return Vector of child TSNs

Returns:
DOCUMENT ME!

addChildTsn

public void addChildTsn(long childTsn)
method to add to the list of child TSNs

Parameters:
childTsn - DOCUMENT ME!

getSynonymTsn

public java.util.Vector getSynonymTsn()
Accessor method to return Vector of synonym TSNs

Returns:
DOCUMENT ME!

addSynonymTsn

public void addSynonymTsn(long synonymTsn)
method to add to the list of synonym TSNs

Parameters:
synonymTsn - DOCUMENT ME!

isDataComplete

public boolean isDataComplete()
Accessor method to return dataComplete flag

Returns:
DOCUMENT ME!

setDataComplete

public void setDataComplete(boolean isComplete)
method to set the dataComplete flag

Parameters:
isComplete - DOCUMENT ME!

hasChildList

public boolean hasChildList()
Accessor method to return hasChildList flag

Returns:
DOCUMENT ME!

setHasChildList

public void setHasChildList(boolean hasChildList)
method to set the hasChildList flag

Parameters:
hasChildList - DOCUMENT ME!

getVernacularNames

public java.util.Vector getVernacularNames()
Accessor method to return Vector of vernacular names

Returns:
DOCUMENT ME!

addVernacularName

public void addVernacularName(java.lang.String name)
method to add to the list of vernacular names

Parameters:
name - DOCUMENT ME!

getTaxonAuthor

public java.lang.String getTaxonAuthor()
Accessor method to return the author name

Returns:
DOCUMENT ME!

setTaxonAuthor

public void setTaxonAuthor(java.lang.String taxonAuthor)
method to set the author name

Parameters:
taxonAuthor - DOCUMENT ME!