org.genesys2.gringlobal.taxonomy.component

Interface TaxonomyDatabase

All Known Implementing Classes:

InMemoryTaxonomyDatabase

public interface TaxonomyDatabase

Defines searches possible against a database of taxonomic data.

Method Summary

Modifier and Type	Method and Description
boolean	containsGenus(String genus) Does the database contain at least one record that exactly matches specified genus?.
boolean	containsSpecies(String genus, String species) Does the database contain at least one record that exactly matches specified genus and species?.
List<String>	findSimilarGenus(String genus, int maxSize) Return a list of genera close to the specified genus.
List<String>	findSimilarSpecies(String genus, String species, int maxSize) Return a list of species close to the specified genus and species.
String	getSpeciesAuthority(String genus, String species) Return the species authority for the specified species within genus.

Method Detail

containsGenus

boolean containsGenus(String genus)

Does the database contain at least one record that exactly matches specified genus?.

Parameters:

genus - the genus

Returns:

true if there is at least one record

findSimilarGenus

List<String> findSimilarGenus(String genus,
                              int maxSize)

Return a list of genera close to the specified genus.

Parameters:

genus - genus

maxSize - TODO

Returns:

list of suggestions, ordered by preference (best first), never null.

containsSpecies

boolean containsSpecies(String genus,
                        String species)

Does the database contain at least one record that exactly matches specified genus and species?.

Parameters:

genus - the genus

species - the species

Returns:

true if there is at least one record

findSimilarSpecies

List<String> findSimilarSpecies(String genus,
                                String species,
                                int maxSize)

Return a list of species close to the specified genus and species.

Parameters:

genus - valid genus

species - species

maxSize - TODO

Returns:

list of suggestions, ordered by preference (best first), never null.

getSpeciesAuthority

String getSpeciesAuthority(String genus,
                           String species)

Return the species authority for the specified species within genus.

Parameters:

genus - the genus

species - the species

Returns:

the authority or null