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

Class ClassificationCapability

java.lang.Object

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

All Implemented Interfaces:

org.gcube.data.spd.model.PropertySupport, Searchable<org.gcube.data.spd.model.products.TaxonomyItem>

public abstract class ClassificationCapability
extends Object
implements org.gcube.data.spd.model.PropertySupport, Searchable<org.gcube.data.spd.model.products.TaxonomyItem>

Constructor Summary

Constructors

Constructor and Description
ClassificationCapability()

Method Summary

Methods

Modifier and Type	Method and Description
Class<org.gcube.data.spd.model.products.TaxonomyItem>	getHandledClass()
void	getSynonymnsById(ObjectWriter<org.gcube.data.spd.model.products.TaxonomyItem> writer, String id) retrieve a list of synonyms
abstract org.gcube.data.spd.model.products.TaxonomyItem	retrieveTaxonById(String id) retrieves taxon by id
abstract void	retrieveTaxonByIds(Iterator<String> ids, ClosableWriter<org.gcube.data.spd.model.products.TaxonomyItem> writer) retrieves taxon by ids
abstract List<org.gcube.data.spd.model.products.TaxonomyItem>	retrieveTaxonChildrenByTaxonId(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.model.PropertySupport

getSupportedProperties

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

searchByScientificName

Constructor Detail

ClassificationCapability

public ClassificationCapability()

Method Detail

retrieveTaxonChildrenByTaxonId

public abstract List<org.gcube.data.spd.model.products.TaxonomyItem> retrieveTaxonChildrenByTaxonId(String taxonId)
                                                                                             throws org.gcube.data.spd.model.exceptions.IdNotValidException,
                                                                                                    org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieves all children giving a taxon id

Parameters:

taxonId - the taxon id

Returns:

a list of taxon

Throws:

org.gcube.data.spd.model.exceptions.IdNotValidException

org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieveTaxonByIds

public abstract void retrieveTaxonByIds(Iterator<String> ids,
                      ClosableWriter<org.gcube.data.spd.model.products.TaxonomyItem> writer)
                                 throws org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieves taxon by ids

Parameters:

ids - the taxon ids

Throws:

org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieveTaxonById

public abstract org.gcube.data.spd.model.products.TaxonomyItem retrieveTaxonById(String id)
                                                                          throws org.gcube.data.spd.model.exceptions.IdNotValidException,
                                                                                 org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieves taxon by id

Parameters:

taxonId - the taxon id

Returns:

a taxon

Throws:

org.gcube.data.spd.model.exceptions.IdNotValidException

org.gcube.data.spd.model.exceptions.ExternalRepositoryException

getSynonymnsById

public void getSynonymnsById(ObjectWriter<org.gcube.data.spd.model.products.TaxonomyItem> writer,
                    String id)
                      throws org.gcube.data.spd.model.exceptions.IdNotValidException,
                             org.gcube.data.spd.model.exceptions.MethodNotSupportedException,
                             org.gcube.data.spd.model.exceptions.ExternalRepositoryException

retrieve a list of synonyms

Parameters:

writer -

ids -

Throws:

org.gcube.data.spd.model.exceptions.IdNotValidException

org.gcube.data.spd.model.exceptions.MethodNotSupportedException

org.gcube.data.spd.model.exceptions.ExternalRepositoryException

getHandledClass

public Class<org.gcube.data.spd.model.products.TaxonomyItem> getHandledClass()

Specified by:

getHandledClass in interface Searchable<org.gcube.data.spd.model.products.TaxonomyItem>