eu.etaxonomy.cdm.remote.controller
Class TaxonListController

java.lang.Object
  eu.etaxonomy.cdm.remote.controller.AbstractController<T,SERVICE>
      eu.etaxonomy.cdm.remote.controller.AbstractListController<T,SERVICE>
          eu.etaxonomy.cdm.remote.controller.BaseListController<T,SERVICE>
              eu.etaxonomy.cdm.remote.controller.IdentifiableListController<TaxonBase,ITaxonService>
                  eu.etaxonomy.cdm.remote.controller.TaxonListController

@Controller
@RequestMapping(value="/taxon")
public class TaxonListController
extends IdentifiableListController<TaxonBase,ITaxonService>

TODO write controller documentation

Author:

a.kohlbecker

Field Summary

Fields inherited from class eu.etaxonomy.cdm.remote.controller.BaseListController

logger

Fields inherited from class eu.etaxonomy.cdm.remote.controller.AbstractController

DEFAULT_INIT_STRATEGY, DEFAULT_PAGE_SIZE, initializationStrategy, service

Constructor Summary

TaxonListController()

Method Summary

Pager<SearchResult<TaxonBase>>	dofindByDescriptionElementFullText(Class<? extends DescriptionElementBase> clazz, String queryString, UUID treeUuid, UuidList featureUuids, List<Language> languages, Boolean highlighting, Integer pageNumber, Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Pager<SearchResult<TaxonBase>>	dofindByEverythingFullText(Class<? extends TaxonBase> clazz, String queryString, UUID treeUuid, List<Language> languages, Boolean highlighting, Integer pageNumber, Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Pager<SearchResult<TaxonBase>>	dofindByFullText(Class<? extends TaxonBase> clazz, String queryString, UUID treeUuid, List<Language> languages, Boolean highlighting, Integer pageNumber, Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Pager<IdentifiableEntity>	doFindTaxaAndNames(String query, UUID treeUuid, Set<NamedArea> areas, Integer pageNumber, Integer pageSize, Boolean doTaxa, Boolean doSynonyms, Boolean doMisappliedNames, Boolean doTaxaByCommonNames, MatchMode matchMode, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.
void	setService(ITaxonService service)

Methods inherited from class eu.etaxonomy.cdm.remote.controller.IdentifiableListController

doFindByTitle

Methods inherited from class eu.etaxonomy.cdm.remote.controller.BaseListController

doList, doPage, initBinder

Methods inherited from class eu.etaxonomy.cdm.remote.controller.AbstractController

requestPathAndQuery, setInitializationStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonListController

public TaxonListController()

Method Detail

setService

@Autowired
public void setService(ITaxonService service)

Specified by:

setService in class AbstractController<TaxonBase,ITaxonService>

doFindTaxaAndNames

@RequestMapping(method=GET,
                value="findTaxaAndNames")
public Pager<IdentifiableEntity> doFindTaxaAndNames(@RequestParam(value="query",required=true)
                                                                   String query,
                                                                   @RequestParam(value="tree",required=false)
                                                                   UUID treeUuid,
                                                                   @RequestParam(value="area",required=false)
                                                                   Set<NamedArea> areas,
                                                                   @RequestParam(value="pageNumber",required=false)
                                                                   Integer pageNumber,
                                                                   @RequestParam(value="pageSize",required=false)
                                                                   Integer pageSize,
                                                                   @RequestParam(value="doTaxa",required=false)
                                                                   Boolean doTaxa,
                                                                   @RequestParam(value="doSynonyms",required=false)
                                                                   Boolean doSynonyms,
                                                                   @RequestParam(value="doMisappliedNames",required=false)
                                                                   Boolean doMisappliedNames,
                                                                   @RequestParam(value="doTaxaByCommonNames",required=false)
                                                                   Boolean doTaxaByCommonNames,
                                                                   @RequestParam(value="matchMode",required=false)
                                                                   MatchMode matchMode,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response)
                                             throws IOException

Find Taxa, Synonyms, Common Names by name, either globally or in a specific geographic area.

URI: /{datasource-name}/portal/taxon/find

Parameters:

query - the string to query for. Since the wildcard character '*' internally always is appended to the query string, a search always compares the query string with the beginning of a name. - required parameter

treeUuid - the UUID of a Classification to which the search is to be restricted. - optional parameter

areas - restrict the search to a set of geographic NamedAreas. The parameter currently takes a list of TDWG area labels. - optional parameter

pageNumber - the number of the page to be returned, the first page has the pageNumber = 1 - optional parameter

pageSize - the maximum number of entities returned per page (can be -1 to return all entities in a single page) - optional parameter

doTaxa - weather to search for instances of Taxon - optional parameter

doSynonyms - weather to search for instances of Synonym - optional parameter

doTaxaByCommonNames - for instances of Taxon by a common name used - optional parameter

matchMode - valid values are "EXACT", "BEGINNING", "ANYWHERE", "END" (case sensitive !!!)

Returns:

a Pager on a list of IdentifiableEntitys initialized by the following strategy #SIMPLE_TAXON_INIT_STRATEGY

Throws:

IOException

dofindByDescriptionElementFullText

@RequestMapping(method=GET,
                value="findByDescriptionElementFullText")
public Pager<SearchResult<TaxonBase>> dofindByDescriptionElementFullText(@RequestParam(value="clazz",required=false)
                                                                                        Class<? extends DescriptionElementBase> clazz,
                                                                                        @RequestParam(value="query",required=true)
                                                                                        String queryString,
                                                                                        @RequestParam(value="tree",required=false)
                                                                                        UUID treeUuid,
                                                                                        @RequestParam(value="features",required=false)
                                                                                        UuidList featureUuids,
                                                                                        @RequestParam(value="languages",required=false)
                                                                                        List<Language> languages,
                                                                                        @RequestParam(value="hl",required=false)
                                                                                        Boolean highlighting,
                                                                                        @RequestParam(value="pageNumber",required=false)
                                                                                        Integer pageNumber,
                                                                                        @RequestParam(value="pageSize",required=false)
                                                                                        Integer pageSize,
                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                        javax.servlet.http.HttpServletResponse response)
                                                                  throws IOException,
                                                                         org.apache.lucene.queryParser.ParseException

Parameters:

clazz -

queryString -

treeUuid - TODO unimplemented in TaxonServiceImpl !!!!

languages -

pageNumber -

pageSize -

request -

response -

Returns:

Throws:

IOException

org.apache.lucene.queryParser.ParseException

dofindByFullText

@RequestMapping(method=GET,
                value="findByFullText")
public Pager<SearchResult<TaxonBase>> dofindByFullText(@RequestParam(value="clazz",required=false)
                                                                      Class<? extends TaxonBase> clazz,
                                                                      @RequestParam(value="query",required=true)
                                                                      String queryString,
                                                                      @RequestParam(value="tree",required=false)
                                                                      UUID treeUuid,
                                                                      @RequestParam(value="languages",required=false)
                                                                      List<Language> languages,
                                                                      @RequestParam(value="hl",required=false)
                                                                      Boolean highlighting,
                                                                      @RequestParam(value="pageNumber",required=false)
                                                                      Integer pageNumber,
                                                                      @RequestParam(value="pageSize",required=false)
                                                                      Integer pageSize,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                throws IOException,
                                                       org.apache.lucene.queryParser.ParseException

Throws:

IOException

org.apache.lucene.queryParser.ParseException

dofindByEverythingFullText

@RequestMapping(method=GET,
                value="findByEverythingFullText")
public Pager<SearchResult<TaxonBase>> dofindByEverythingFullText(@RequestParam(value="clazz",required=false)
                                                                                Class<? extends TaxonBase> clazz,
                                                                                @RequestParam(value="query",required=true)
                                                                                String queryString,
                                                                                @RequestParam(value="tree",required=false)
                                                                                UUID treeUuid,
                                                                                @RequestParam(value="languages",required=false)
                                                                                List<Language> languages,
                                                                                @RequestParam(value="hl",required=false)
                                                                                Boolean highlighting,
                                                                                @RequestParam(value="pageNumber",required=false)
                                                                                Integer pageNumber,
                                                                                @RequestParam(value="pageSize",required=false)
                                                                                Integer pageSize,
                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                javax.servlet.http.HttpServletResponse response)
                                                          throws IOException,
                                                                 org.apache.lucene.queryParser.ParseException

Throws:

IOException

org.apache.lucene.queryParser.ParseException