eu.etaxonomy.cdm.remote.controller
Class BaseListController<T extends CdmBase,SERVICE extends IService<T>>

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>

Type Parameters:

T -

SERVICE -

Direct Known Subclasses:

IdentifiableListController, PolytomousKeyNodeListController, TaxonNodeListController

public abstract class BaseListController<T extends CdmBase,SERVICE extends IService<T>>
extends AbstractListController<T,SERVICE>

Author:

a.kohlbecker

Field Summary

static Logger

logger

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

DEFAULT_INIT_STRATEGY, DEFAULT_PAGE_SIZE, initializationStrategy, service

Constructor Summary

BaseListController()

Method Summary

List<T>	doList(Integer start, Integer limit, Class<T> type, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Pager<T>	doPage(Integer pageIndex, Integer pageSize, Class type, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) NOTE: The indices for pages are 0-based see Pager
void	initBinder(org.springframework.web.bind.WebDataBinder binder)

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

requestPathAndQuery, setInitializationStrategy, setService

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

Constructor Detail

BaseListController

public BaseListController()

Method Detail

initBinder

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

doPage

@RequestMapping(method=GET)
public Pager<T> doPage(@RequestParam(value="pageNumber",required=false)
                                      Integer pageIndex,
                                      @RequestParam(value="pageSize",required=false)
                                      Integer pageSize,
                                      @RequestParam(value="class",required=false)
                                      Class type,
                                      javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)
                                throws IOException

NOTE: The indices for pages are 0-based see Pager

Parameters:

pageIndex - the index of the page to be returned, the first page has the pageIndex = 0 - optional parameter

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

type - Further restricts the type of entities to be returned. If null the base type <T> is being used. - optional parameter

Returns:

Throws:

IOException

doList

@RequestMapping(method=GET,
                params="start")
public List<T> doList(@RequestParam(value="start",required=true)
                                     Integer start,
                                     @RequestParam(value="limit",required=false)
                                     Integer limit,
                                     @RequestParam(value="class",required=false)
                                     Class<T> type,
                                     javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)

Parameters:

start - The offset index from the start of the list. The first entity has the index = 0 - required parameter

limit - The maximum number of entities returned. - optional parameter If limit is set to a value < 1 all entities will be returned

type - Further restricts the type of entities to be returned. If null the base type <T> is being used. - optional parameter

Returns:

a List of entities