com.hfg.bio.taxonomy.ncbi

Interface NCBITaxonomyDataSource

All Known Implementing Classes:

NCBIRemoteTaxonomyDataSource, NCBITaxonomyDataSourceImpl

public interface NCBITaxonomyDataSource

Interface for an NCBI taxonomy data source used with NCBITaxon.

Method Summary

Modifier and Type	Method and Description
Set<NCBITaxon>	getByName(String inValue) Retrieves the NCBITaxon for the specified common name, scientific name, or GenBank common name.
NCBITaxon	getByTaxonId(int inValue) Retrieves the taxon for the specified NCBI taxon id.

Method Detail

getByTaxonId

NCBITaxon getByTaxonId(int inValue)

Retrieves the taxon for the specified NCBI taxon id.

Parameters:

inValue - the taxon id for the taxon object to retrieve

Returns:

the taxon object corresponding to the specified id. Returns null if the taxon cannot be found.

getByName

Set<NCBITaxon> getByName(String inValue)

Retrieves the NCBITaxon for the specified common name, scientific name, or GenBank common name. Generally there will be a single taxon found for a given name, but there are instances where multiple taxons may be found.

Parameters:

inValue - the species name (common or scientific) for the taxon object to return

Returns:

a Set of taxon objects corresponding to the specified name. Returns null if a match cannot be found.