eu.etaxonomy.cdm.remote.controller
Class OccurrenceListController

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<SpecimenOrObservationBase,IOccurrenceService>
                  eu.etaxonomy.cdm.remote.controller.OccurrenceListController

@Controller
@RequestMapping(value="/occurrence")
public class OccurrenceListController
extends IdentifiableListController<SpecimenOrObservationBase,IOccurrenceService>

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

OccurrenceListController()

Method Summary

Pager<SearchResult<SpecimenOrObservationBase>>	dofindByFullText(Class<? extends SpecimenOrObservationBase<?>> clazz, String queryString, org.hibernate.search.spatial.impl.Rectangle boundingBox, List<Language> languages, Boolean highlighting, Integer pageNumber, Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Pager<SpecimenOrObservationBase>	doListByAssociatedTaxon(UUID taxonUuid, UuidList relationshipUuids, UuidList relationshipInversUuids, Integer maxDepth, Integer pageNumber, Integer pageSize, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	initBinder(org.springframework.web.bind.WebDataBinder binder)
void	setService(IOccurrenceService service)

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

doFindByTitle

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

doList, doPage

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

OccurrenceListController

public OccurrenceListController()

Method Detail

setService

@Autowired
public void setService(IOccurrenceService service)

Specified by:

setService in class AbstractController<SpecimenOrObservationBase,IOccurrenceService>

initBinder

@InitBinder
public void initBinder(org.springframework.web.bind.WebDataBinder binder)

Overrides:

initBinder in class BaseListController<SpecimenOrObservationBase,IOccurrenceService>

doListByAssociatedTaxon

@RequestMapping(value="byAssociatedTaxon",
                method=GET)
public Pager<SpecimenOrObservationBase> doListByAssociatedTaxon(@RequestParam(value="taxonUuid",required=true)
                                                                               UUID taxonUuid,
                                                                               @RequestParam(value="relationships",required=false)
                                                                               UuidList relationshipUuids,
                                                                               @RequestParam(value="relationshipsInvers",required=false)
                                                                               UuidList relationshipInversUuids,
                                                                               @RequestParam(value="maxDepth",required=false)
                                                                               Integer maxDepth,
                                                                               @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

Parameters:

taxonUuid -

relationshipUuids - a comma separated list of uuids e.g. CongruentTo; "60974c98-64ab-4574-bb5c-c110f6db634d"

relationshipInversUuids - a comma separated list of uuids

maxDepth - null for unlimited

pageNumber -

pageSize -

request -

response -

Returns:

Throws:

IOException

dofindByFullText

@RequestMapping(method=GET,
                value="findByFullText")
public Pager<SearchResult<SpecimenOrObservationBase>> dofindByFullText(@RequestParam(value="clazz",required=false)
                                                                                      Class<? extends SpecimenOrObservationBase<?>> clazz,
                                                                                      @RequestParam(value="query",required=false)
                                                                                      String queryString,
                                                                                      @RequestParam(value="bbox",required=false)
                                                                                      org.hibernate.search.spatial.impl.Rectangle boundingBox,
                                                                                      @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 -

boundingBox - as minx(minlongitute),miny(minlatitute),maxx(maxlongitute),max( maxlatitute), e.g. 13.112,52.374,13.681,52.641 for the Berlin area

languages -

highlighting -

pageNumber -

pageSize -

request -

response -

Returns:

Throws:

IOException

org.apache.lucene.queryParser.ParseException