au.org.ala.biocache.service

Class SpeciesLookupIndexService

java.lang.Object

au.org.ala.biocache.service.SpeciesLookupIndexService

All Implemented Interfaces:

SpeciesLookupService

public class SpeciesLookupIndexService
extends Object
implements SpeciesLookupService

Index based lookup index serice

Field Summary

Fields

Modifier and Type	Field and Description
protected String	nameIndexLocation

Constructor Summary

Constructors

Constructor and Description
SpeciesLookupIndexService()

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.
void	setMessageSource(org.springframework.context.support.AbstractMessageSource messageSource)
void	setNameIndexLocation(String nameIndexLocation)

Methods inherited from class java.lang.Object

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

Field Detail

nameIndexLocation

protected String nameIndexLocation

Constructor Detail

SpeciesLookupIndexService

public SpeciesLookupIndexService()

Method Detail

getGuidForName

public String getGuidForName(String name)

Description copied from interface: SpeciesLookupService

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

Specified by:

getGuidForName in interface SpeciesLookupService

Returns:

getAcceptedNameForGuid

public String getAcceptedNameForGuid(String guid)

Description copied from interface: SpeciesLookupService

Lookup the accepted name for a GUID

Specified by:

getAcceptedNameForGuid in interface SpeciesLookupService

Returns:

getNamesForGuids

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

Description copied from interface: SpeciesLookupService

Lookup service for list of guids to names

Specified by:

getNamesForGuids in interface SpeciesLookupService

Returns:

getSpeciesDetails

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

Description copied from interface: SpeciesLookupService

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

Specified by:

getSpeciesDetails in interface SpeciesLookupService

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

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

Description copied from interface: SpeciesLookupService

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

Specified by:

getHeaderDetails in interface SpeciesLookupService

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

setMessageSource

public void setMessageSource(org.springframework.context.support.AbstractMessageSource messageSource)

setNameIndexLocation

public void setNameIndexLocation(String nameIndexLocation)