gov.usda.gdpc
Class Taxon

java.lang.Object
  gov.usda.gdpc.AbstractDBElement
      gov.usda.gdpc.Taxon

All Implemented Interfaces:

java.lang.Comparable, DBElement, java.util.Map

public class Taxon

extends AbstractDBElement

This is a database element representing a taxon.

Author:

terryc

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String

TYPE

Fields inherited from class gov.usda.gdpc.AbstractDBElement

myProperties

Method Summary

static java.lang.String	buildKey(java.util.Map properties) This builds the unique key for this taxon based on the TaxonPropery.ID and TaxonProperty.DATA_SOURCE.
static java.lang.String	buildKey(java.lang.String dataSource, Identifier id) This builds the unique key for this taxon based on the TaxonPropery.ID and TaxonProperty.DATA_SOURCE.
static Taxon	getCachedInstance(java.util.Map properties) This returns the taxon instance from the cache that matches the specified id and source.
java.lang.String	getDataSource() Returns the data source of this taxon.
Identifier	getID() Returns identifier of this taxon.
static Taxon	getInstance(java.util.Map properties) This returns the taxon instance given the specified list of properties.
java.lang.String	getName() Returns the name of this taxon.
java.lang.String	getType() Get type of this element.
java.lang.String	toString() Returns the string representation of this database element.

Methods inherited from class gov.usda.gdpc.AbstractDBElement

clear, compareTo, containsKey, containsValue, entrySet, equals, get, getKey, getProperty, isEmpty, keySet, numProperties, properties, propsEqual, put, putAll, remove, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

hashCode

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

getInstance

public static Taxon getInstance(java.util.Map properties)

This returns the taxon instance given the specified list of properties. A new taxon will be created if its not found in the cache.

Parameters:

properties - properties of this taxon. The keys are the properties (type: TaxonProperty) and the values are the corresponding value. Properties can not have a value equal to null. It is not allowed to have two keys that are the same. The TaxonProperty.ID, TaxonProperty.DATA_SOURCE, and TaxonProperty.NAME properties must be defined.

Returns:

taxon

getCachedInstance

public static Taxon getCachedInstance(java.util.Map properties)

This returns the taxon instance from the cache that matches the specified id and source. Null will be returned if its not found in the cache.

Parameters:

properties - properties of this taxon. The keys are the properties (type: TaxonProperty) and the values are the corresponding value. Properties can not have a value equal to null. Only the TaxonProperty.ID and TaxonProperty.DATA_SOURCE are used to find a matching taxon in the cache.

Returns:

cached taxon or null if not in cache.

buildKey

public static java.lang.String buildKey(java.util.Map properties)

This builds the unique key for this taxon based on the TaxonPropery.ID and TaxonProperty.DATA_SOURCE.

Parameters:

properties - properties map

Returns:

key

buildKey

public static java.lang.String buildKey(java.lang.String dataSource,
                                        Identifier id)

This builds the unique key for this taxon based on the TaxonPropery.ID and TaxonProperty.DATA_SOURCE.

Parameters:

dataSource - data source

id - identifier

Returns:

key

getName

public java.lang.String getName()

Returns the name of this taxon.

Specified by:

getName in interface DBElement

Overrides:

getName in class AbstractDBElement

Returns:

the name

getDataSource

public java.lang.String getDataSource()

Returns the data source of this taxon.

Specified by:

getDataSource in interface DBElement

Overrides:

getDataSource in class AbstractDBElement

Returns:

data source

getID

public Identifier getID()

Returns identifier of this taxon.

Specified by:

getID in interface DBElement

Overrides:

getID in class AbstractDBElement

Returns:

identifier

getType

public java.lang.String getType()

Get type of this element.

Returns:

type

toString

public java.lang.String toString()

Description copied from class: AbstractDBElement

Returns the string representation of this database element.

Overrides:

toString in class AbstractDBElement

Returns:

string representation