org.cateproject.controller.description
Class DescriptionListController

java.lang.Object
  org.cateproject.controller.GenericController<T,IDENTIFIER,SERVICE>
      org.cateproject.controller.GenericListController<T,UUID,SERVICE>
          org.cateproject.controller.common.VersionableListController<T,SERVICE>
              org.cateproject.controller.common.IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>
                  org.cateproject.controller.description.DescriptionListController

All Implemented Interfaces:

org.springframework.context.ApplicationContextAware

@Controller
@RequestMapping(value="/description")
public class DescriptionListController
extends IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>

Field Summary

static String	DEFAULT_FRAGMENT_SEPARATOR
static Integer	DEFAULT_MAX_FRAGMENTS
static Integer	DEFAULT_TEXT_FRAGMENT_SIZE

Fields inherited from class org.cateproject.controller.common.VersionableListController

auditEventService, logger

Fields inherited from class org.cateproject.controller.GenericController

applicationContext, collectionsMapper, DEFAULT_LIMIT, DEFAULT_PAGE, DEFAULT_SORT, LIST_KEY, ORDER_HINTS_KEY, propertiesMapper, RESOURCE_KEY, service, type, validator

Constructor Summary

DescriptionListController()

Method Summary

org.springframework.web.servlet.ModelAndView	filter(Class<eu.etaxonomy.cdm.model.description.DescriptionBase> clazz, Integer page, Integer limit, List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints, Boolean media, Boolean textData, UUID featureTreeUuid)
org.springframework.web.servlet.ModelAndView	get(Class<? extends eu.etaxonomy.cdm.model.description.DescriptionBase> clazz, Integer page, Integer limit, List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)
org.springframework.web.servlet.ModelAndView	getDescription(String queryString, Integer page, Integer limit, List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints) Search for descriptions & highlight the terms TODO Refactor highlighting into a separate bean TODO Should we pass query objects? how else can we highlight?
org.springframework.web.servlet.ModelAndView	getDistribution(List<UUID> counts, List<UUID> regs, List<UUID> conts, UUID presenceAbsenceTermBaseUuid, Integer page, Integer limit, List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)
protected List<String>	getPropertyPaths()
org.springframework.web.servlet.ModelAndView	getSearch(Class<? extends eu.etaxonomy.cdm.model.description.DescriptionBase> clazz, String query, Integer page, Integer limit, List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)
org.springframework.web.servlet.ModelAndView	getSummary()
org.springframework.web.servlet.ModelAndView	post(eu.etaxonomy.cdm.model.description.DescriptionBase object)
void	setFeatureTreeService(eu.etaxonomy.cdm.api.service.IFeatureTreeService featureTreeService)
void	setService(eu.etaxonomy.cdm.api.service.IDescriptionService service)
void	setTermService(eu.etaxonomy.cdm.api.service.ITermService termService)
void	setWebRevisionService(WebRevisionService webRevisionService)

Methods inherited from class org.cateproject.controller.common.IdentifiableListController

doPost, download

Methods inherited from class org.cateproject.controller.common.VersionableListController

get, initBinder, setAuditEventService

Methods inherited from class org.cateproject.controller.GenericController

handleFind, handleLoad, handleLoad, setApplicationContext, setCollectionsMapper, setPropertiesMapper, setValidator

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEXT_FRAGMENT_SIZE

public static Integer DEFAULT_TEXT_FRAGMENT_SIZE

DEFAULT_MAX_FRAGMENTS

public static Integer DEFAULT_MAX_FRAGMENTS

DEFAULT_FRAGMENT_SEPARATOR

public static String DEFAULT_FRAGMENT_SEPARATOR

Constructor Detail

DescriptionListController

public DescriptionListController()

Method Detail

setService

public void setService(eu.etaxonomy.cdm.api.service.IDescriptionService service)

Specified by:

setService in class GenericController<eu.etaxonomy.cdm.model.description.DescriptionBase,UUID,eu.etaxonomy.cdm.api.service.IDescriptionService>

setFeatureTreeService

public void setFeatureTreeService(eu.etaxonomy.cdm.api.service.IFeatureTreeService featureTreeService)

setTermService

public void setTermService(eu.etaxonomy.cdm.api.service.ITermService termService)

setWebRevisionService

public void setWebRevisionService(WebRevisionService webRevisionService)

getPropertyPaths

protected List<String> getPropertyPaths()

Overrides:

getPropertyPaths in class IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>

filter

@RequestMapping(method=GET)
public org.springframework.web.servlet.ModelAndView filter(@RequestParam(value="class",required=false)
                                                                          Class<eu.etaxonomy.cdm.model.description.DescriptionBase> clazz,
                                                                          @RequestParam(value="page",required=false,defaultValue="0")
                                                                          Integer page,
                                                                          @RequestParam(value="limit",required=false,defaultValue="20")
                                                                          Integer limit,
                                                                          @RequestParam(value="sort",required=false,defaultValue="titleCache_asc")
                                                                          List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints,
                                                                          @RequestParam(value="media",required=false)
                                                                          Boolean media,
                                                                          @RequestParam(value="textData",required=false)
                                                                          Boolean textData,
                                                                          @RequestParam(value="featureTree",required=false)
                                                                          UUID featureTreeUuid)

getDescription

@RequestMapping(params="search=textData",
                method=GET)
public org.springframework.web.servlet.ModelAndView getDescription(@RequestParam(value="query",required=false)
                                                                                  String queryString,
                                                                                  @RequestParam(value="page",required=false,defaultValue="0")
                                                                                  Integer page,
                                                                                  @RequestParam(value="limit",required=false,defaultValue="20")
                                                                                  Integer limit,
                                                                                  @RequestParam(value="sort",required=false,defaultValue="inDescription.titleCache_asc")
                                                                                  List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)
                                                            throws Exception

Search for descriptions & highlight the terms TODO Refactor highlighting into a separate bean TODO Should we pass query objects? how else can we highlight?

Parameters:

request -

response -

Returns:

Throws:

Exception

getDistribution

@RequestMapping(params="search=distribution",
                method=GET)
public org.springframework.web.servlet.ModelAndView getDistribution(@RequestParam(value="country",required=false)
                                                                                   List<UUID> counts,
                                                                                   @RequestParam(value="region",required=false)
                                                                                   List<UUID> regs,
                                                                                   @RequestParam(value="continent",required=false)
                                                                                   List<UUID> conts,
                                                                                   @RequestParam(value="status",required=false)
                                                                                   UUID presenceAbsenceTermBaseUuid,
                                                                                   @RequestParam(value="page",required=false,defaultValue="0")
                                                                                   Integer page,
                                                                                   @RequestParam(value="limit",required=false,defaultValue="20")
                                                                                   Integer limit,
                                                                                   @RequestParam(value="sort",required=false,defaultValue="titleCache_asc")
                                                                                   List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)

getSummary

@RequestMapping(method=GET,
                params="summary")
public org.springframework.web.servlet.ModelAndView getSummary()

Overrides:

getSummary in class IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>

get

@RequestMapping(method=GET,
                params={"!search","!summary","!media","!textData","!featureTree"})
public org.springframework.web.servlet.ModelAndView get(@RequestParam(value="class",required=false)
                                                                       Class<? extends eu.etaxonomy.cdm.model.description.DescriptionBase> clazz,
                                                                       @RequestParam(value="page",required=false,defaultValue="0")
                                                                       Integer page,
                                                                       @RequestParam(value="limit",required=false,defaultValue="20")
                                                                       Integer limit,
                                                                       @RequestParam(value="sort",required=false,defaultValue="titleCache_asc")
                                                                       List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)

Overrides:

get in class IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>

getSearch

@RequestMapping(params="search=quick",
                method=GET)
public org.springframework.web.servlet.ModelAndView getSearch(@RequestParam(value="class",required=false)
                                                                             Class<? extends eu.etaxonomy.cdm.model.description.DescriptionBase> clazz,
                                                                             @RequestParam(value="query",required=false)
                                                                             String query,
                                                                             @RequestParam(value="page",required=false)
                                                                             Integer page,
                                                                             @RequestParam(value="limit",required=false,defaultValue="20")
                                                                             Integer limit,
                                                                             @RequestParam(value="sort",required=false,defaultValue="titleCache_asc")
                                                                             List<eu.etaxonomy.cdm.persistence.query.OrderHint> orderHints)

Overrides:

getSearch in class IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>

post

@ResponseStatus(value=CREATED)
@RequestMapping(method=POST)
public org.springframework.web.servlet.ModelAndView post(@RequestBody
                                                                                       eu.etaxonomy.cdm.model.description.DescriptionBase object)

Specified by:

post in class IdentifiableListController<eu.etaxonomy.cdm.model.description.DescriptionBase,eu.etaxonomy.cdm.api.service.IDescriptionService>