au.org.ala.biocache.service

Class SpeciesLookupRestService

java.lang.Object

au.org.ala.biocache.service.SpeciesLookupRestService

All Implemented Interfaces:

SpeciesLookupService

public class SpeciesLookupRestService
extends Object
implements SpeciesLookupService

Implementation of SpeciesLookupService.java that calls the bie-service application via JSON REST web services.

Author:

"Nick dos Remedios "

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bieUriPrefix
protected Boolean	enabled

Constructor Summary

Constructors

Constructor and Description
SpeciesLookupRestService()

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	setBieUriPrefix(String bieUriPrefix)
void	setEnabled(Boolean enabled)
void	setMessageSource(org.springframework.context.support.AbstractMessageSource messageSource)
void	setRestTemplate(org.springframework.web.client.RestOperations restTemplate)

Methods inherited from class java.lang.Object

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

Field Detail

bieUriPrefix

protected String bieUriPrefix

enabled

protected Boolean enabled

Constructor Detail

SpeciesLookupRestService

public SpeciesLookupRestService()

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

Parameters:

name -

Returns:

guid

See Also:

SpeciesLookupService.getGuidForName(String)

getAcceptedNameForGuid

public String getAcceptedNameForGuid(String guid)

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

Parameters:

guids -

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

setBieUriPrefix

public void setBieUriPrefix(String bieUriPrefix)

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestOperations restTemplate)

setEnabled

public void setEnabled(Boolean enabled)

setMessageSource

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