org.gbif.api.service.checklistbank

Interface NameUsageMatchingService

public interface NameUsageMatchingService

A lookup service that fuzzy matches classified scientific names against a body of names. In GBIF this is in particular used for a Nub Lookup service that binds occurrence names and other external records with a scientific name to the nub.

Several match signatures for essentially the same matching are provided.

Method Summary

Modifier and Type	Method and Description
NameUsageMatch	match(String scientificName, Rank rank, LinneanClassification classification, boolean strict, boolean verbose) Tries to match a scientific name with an optional classification given as individual parameters.

Method Detail

match

NameUsageMatch match(String scientificName,
                     @Nullable
                     Rank rank,
                     @Nullable
                     LinneanClassification classification,
                     boolean strict,
                     boolean verbose)

Tries to match a scientific name with an optional classification given as individual parameters.

Parameters:

scientificName - the name to match against

rank - of the name to match

classification - optional classification of the name to match

strict - if true only tries to match the scientific name, if false (the default) the matching service tries also to match the lowest possible taxon from the given classification

verbose - if true adds verbose matching information, i.e. list of alternative matches

Returns:

a match which is never null, but might have a usageKey=null if nothing could be matched