org.gcube.data.spd.plugin.fwk.capabilities
Class ClassificationCapability

java.lang.Object
  org.gcube.data.spd.plugin.fwk.capabilities.ClassificationCapability

All Implemented Interfaces:

Searchable<TaxonomyItem>, PropertySupport

public abstract class ClassificationCapability
extends Object
implements PropertySupport, Searchable<TaxonomyItem>

Constructor Summary

ClassificationCapability()

Method Summary

Class<TaxonomyItem>	getHandledClass()
void	getSynonymnsById(ObjectWriter<TaxonomyItem> writer, String id) retrieve a list of synonyms
abstract TaxonomyItem	retrieveTaxonById(String id) retrieves taxon by id
abstract void	retrieveTaxonByIds(Iterator<String> ids, ObjectWriter<TaxonomyItem> writer) retrieves taxon by ids
abstract List<TaxonomyItem>	retrieveTaxonChildsByTaxonId(String taxonId) retrieves all children giving a taxon id

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gcube.data.spd.plugin.fwk.PropertySupport

getSupportedProperties

Methods inherited from interface org.gcube.data.spd.plugin.fwk.model.Searchable

searchByCommonName, searchByScientificName

Constructor Detail

ClassificationCapability

public ClassificationCapability()

Method Detail

retrieveTaxonChildsByTaxonId

public abstract List<TaxonomyItem> retrieveTaxonChildsByTaxonId(String taxonId)
                                                         throws IdNotValidException

retrieves all children giving a taxon id

Parameters:

taxonId - the taxon id

Returns:

a list of taxon

Throws:

IdNotValidException

retrieveTaxonByIds

public abstract void retrieveTaxonByIds(Iterator<String> ids,
                                        ObjectWriter<TaxonomyItem> writer)

retrieves taxon by ids

Parameters:

ids - the taxon ids

retrieveTaxonById

public abstract TaxonomyItem retrieveTaxonById(String id)
                                        throws IdNotValidException,
                                               ExternalRepositoryException

retrieves taxon by id

Parameters:

taxonId - the taxon id

Returns:

a taxon

Throws:

IdNotValidException

ExternalRepositoryException

getSynonymnsById

public void getSynonymnsById(ObjectWriter<TaxonomyItem> writer,
                             String id)
                      throws IdNotValidException,
                             MethodNotSupportedException,
                             ExternalRepositoryException

retrieve a list of synonyms

Parameters:

writer -

ids -

Throws:

IdNotValidException

MethodNotSupportedException

ExternalRepositoryException

getHandledClass

public Class<TaxonomyItem> getHandledClass()

Specified by:

getHandledClass in interface Searchable<TaxonomyItem>