au.org.ala.biocache.service

Interface SpeciesLookupService

All Known Implementing Classes:

SpeciesLookupIndexService, SpeciesLookupRestService

public interface SpeciesLookupService

Service layer interface for accessing species lookups.

Author:

"Nick dos Remedios "

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcceptedNameForGuid(String guid) Lookup the accepted name for a GUID
String	getGuidForName(String name) Lookup a GUID for a given scientific name (returns best match/accepted concept)
String[]	getHeaderDetails(String field, boolean includeCounts, boolean includeSynonyms) Returns the header fields to use based on the species lookup service.
List<String>	getNamesForGuids(List<String> guids) Lookup service for list of guids to names
List<String[]>	getSpeciesDetails(List<String> guids, List<Long> counts, boolean includeCounts, boolean includeSynonyms) Retrieves an list of arrays that contains the information that need to be included in the CSV details.

Method Detail

getGuidForName

String getGuidForName(String name)

Lookup a GUID for a given scientific name (returns best match/accepted concept)

Parameters:

name -

Returns:

getAcceptedNameForGuid

String getAcceptedNameForGuid(String guid)

Lookup the accepted name for a GUID

Returns:

getNamesForGuids

List<String> getNamesForGuids(List<String> guids)

Lookup service for list of guids to names

Parameters:

guids -

Returns:

getSpeciesDetails

List<String[]> getSpeciesDetails(List<String> guids,
                               List<Long> counts,
                               boolean includeCounts,
                               boolean includeSynonyms)

Retrieves an list of arrays that contains the information that need to be included in the CSV details.

Parameters:

guids - The guild/lsids for the species to get the details about

counts - The corresponding counts

includeCounts - whether or not to included the count in the details row

includeSynonyms - whether or not whether or not synonyms should be included in the details row

Returns:

a list of arrays to use as rows for the CSV species list download

getHeaderDetails

String[] getHeaderDetails(String field,
                        boolean includeCounts,
                        boolean includeSynonyms)

Returns the header fields to use based on the species lookup service. Different implementations may include different fields.

Parameters:

field - The field name that is causing the lookup to occur.

includeCounts - whether or not counts should be included in the header

includeSynonyms - whether or not synonyms should be included in the header

Returns:

The header row to be used in a CSV species list