au.org.ala.names.ws.resources

Class NameSearchResource

java.lang.Object

au.org.ala.names.ws.resources.NameSearchResource

All Implemented Interfaces:

au.org.ala.names.ws.api.NameMatchService, Closeable, AutoCloseable

@Produces(value="application/json")
 @Path(value="/api")
 @Singleton
public class NameSearchResource
extends Object
implements au.org.ala.names.ws.api.NameMatchService

TODO add diagnostics to payload - similar to GBIF

Constructor Summary

Constructors

Constructor and Description
NameSearchResource(NameSearchConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
List<Map>	autocomplete(String query, Integer max, Boolean includeSynonyms)
boolean	check() Make sure that the system is still operating.
Boolean	check(String name, String rank)
void	close() Close the resource.
au.org.ala.names.ws.api.NameUsageMatch	get(String taxonID)
Set<String>	getCommonNamesForLSID(String lsid, Integer max)
List<String>	getGuidsForTaxa(List<String> taxa)
au.org.ala.names.ws.api.NameUsageMatch	match(au.org.ala.names.ws.api.NameSearch search)
au.org.ala.names.ws.api.NameUsageMatch	match(String name)
au.org.ala.names.ws.api.NameUsageMatch	match(String scientificName, String kingdom, String phylum, String clazz, String order, String family, String genus, String specificEpithet, String infraspecificEpithet, String rank)
au.org.ala.names.ws.api.NameUsageMatch	matchVernacular(String vernacularName)
String	searchForLSID(String name)
String	searchForLsidById(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

NameSearchResource

public NameSearchResource(NameSearchConfiguration configuration)

Method Detail

check

public boolean check()

Make sure that the system is still operating.

Returns:

True if things can still be found, the species groups are still working, etc.

match

@POST
 @Timed
 @Path(value="/searchByClassification")
public au.org.ala.names.ws.api.NameUsageMatch match(au.org.ala.names.ws.api.NameSearch search)

Specified by:

match in interface au.org.ala.names.ws.api.NameMatchService

match

@GET
 @Timed
 @Path(value="/searchByClassification")
public au.org.ala.names.ws.api.NameUsageMatch match(@QueryParam(value="scientificName")
                                                                                                         String scientificName,
                                                                                                         @QueryParam(value="kingdom")
                                                                                                         String kingdom,
                                                                                                         @QueryParam(value="phylum")
                                                                                                         String phylum,
                                                                                                         @QueryParam(value="class")
                                                                                                         String clazz,
                                                                                                         @QueryParam(value="order")
                                                                                                         String order,
                                                                                                         @QueryParam(value="family")
                                                                                                         String family,
                                                                                                         @QueryParam(value="genus")
                                                                                                         String genus,
                                                                                                         @QueryParam(value="specificEpithet")
                                                                                                         String specificEpithet,
                                                                                                         @QueryParam(value="infraspecificEpithet")
                                                                                                         String infraspecificEpithet,
                                                                                                         @QueryParam(value="rank")
                                                                                                         String rank)

Specified by:

match in interface au.org.ala.names.ws.api.NameMatchService

match

@GET
 @Timed
 @Path(value="/search")
public au.org.ala.names.ws.api.NameUsageMatch match(@QueryParam(value="q")
                                                                                         String name)

Specified by:

match in interface au.org.ala.names.ws.api.NameMatchService

matchVernacular

@GET
 @Timed
 @Path(value="/searchByVernacularName")
public au.org.ala.names.ws.api.NameUsageMatch matchVernacular(@QueryParam(value="vernacularName")
                                                                                                                   String vernacularName)

Specified by:

matchVernacular in interface au.org.ala.names.ws.api.NameMatchService

get

@GET
 @Timed
 @Path(value="/getByTaxonID")
public au.org.ala.names.ws.api.NameUsageMatch get(@QueryParam(value="taxonID")
                                                                                             String taxonID)

Specified by:

get in interface au.org.ala.names.ws.api.NameMatchService

check

@GET
 @Timed
 @Path(value="/check")
public Boolean check(@QueryParam(value="name")
                                                         String name,
                                                         @QueryParam(value="rank")
                                                         String rank)

Specified by:

check in interface au.org.ala.names.ws.api.NameMatchService

autocomplete

@GET
 @Timed
 @Path(value="/autocomplete")
public List<Map> autocomplete(@QueryParam(value="q")
                                                                         String query,
                                                                         @QueryParam(value="max")
                                                                         Integer max,
                                                                         @QueryParam(value="includeSynonyms")
                                                                         Boolean includeSynonyms)

Specified by:

autocomplete in interface au.org.ala.names.ws.api.NameMatchService

searchForLsidById

@GET
 @Produces(value="text/plain")
 @Timed
 @Path(value="/searchForLsidById")
public String searchForLsidById(@QueryParam(value="id")
                                                                                                               String id)

Specified by:

searchForLsidById in interface au.org.ala.names.ws.api.NameMatchService

searchForLSID

@GET
 @Produces(value="text/plain")
 @Timed
 @Path(value="/searchForLSID")
public String searchForLSID(@QueryParam(value="name")
                                                                                                       String name)

Specified by:

searchForLSID in interface au.org.ala.names.ws.api.NameMatchService

getGuidsForTaxa

@POST
 @Timed
 @Path(value="/getGuidsForTaxa")
public List<String> getGuidsForTaxa(List<String> taxa)

Specified by:

getGuidsForTaxa in interface au.org.ala.names.ws.api.NameMatchService

getCommonNamesForLSID

@GET
 @Timed
 @Path(value="/getCommonNamesForLSID")
public Set<String> getCommonNamesForLSID(@QueryParam(value="lsid")
                                                                                             String lsid,
                                                                                             @QueryParam(value="max")
                                                                                             Integer max)

Specified by:

getCommonNamesForLSID in interface au.org.ala.names.ws.api.NameMatchService

close

public void close()

Close the resource.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable