org.biojavax.bio.taxa

Class SimpleNCBITaxonName

java.lang.Object

org.biojavax.bio.taxa.SimpleNCBITaxonName

All Implemented Interfaces:

java.lang.Comparable

public class SimpleNCBITaxonName
extends java.lang.Object
implements java.lang.Comparable

Represents a name class plus name combination for an NCBITaxon object.

Since:

1.5

Author:

Richard Holland

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleNCBITaxonName()
	SimpleNCBITaxonName(java.lang.String nameClass, java.lang.String name) Creates a new taxon name based on the given class and name, both of which cannot be null.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Taxon names are sorted by class first, then name.
boolean	equals(java.lang.Object o) Two taxon names are equal if their name and class match.
java.lang.String	getName() Returns this name.
java.lang.String	getNameClass() Returns the class of this name.
int	hashCode()
void	setName(java.lang.String name) Changes the name.
void	setNameClass(java.lang.String nameClass) Changes the class of this name.
java.lang.String	toString() Form: "class:name"

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleNCBITaxonName

protected SimpleNCBITaxonName()

SimpleNCBITaxonName

public SimpleNCBITaxonName(java.lang.String nameClass,
                   java.lang.String name)

Creates a new taxon name based on the given class and name, both of which cannot be null.

Parameters:

nameClass - the class of the new name. Use one of the constants from NCBITaxon (for example NCBITaxon.SCIENTIFIC).

name - the name itself

Method Detail

setNameClass

public void setNameClass(java.lang.String nameClass)

Changes the class of this name.

Parameters:

nameClass - the new class for this name.

getNameClass

public java.lang.String getNameClass()

Returns the class of this name.

Returns:

the class of this name.

setName

public void setName(java.lang.String name)

Changes the name.

Parameters:

name - the new name.

getName

public java.lang.String getName()

Returns this name.

Returns:

this name.

equals

public boolean equals(java.lang.Object o)

Two taxon names are equal if their name and class match.

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Taxon names are sorted by class first, then name.

Specified by:

compareTo in interface java.lang.Comparable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Form: "class:name"

Overrides:

toString in class java.lang.Object