Package ubic.gemma.web.controller

Class GeneralSearchControllerImpl

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.BaseCommandController

org.springframework.web.servlet.mvc.AbstractFormController

org.springframework.web.servlet.mvc.SimpleFormController

ubic.gemma.web.controller.BaseFormController

ubic.gemma.web.controller.GeneralSearchControllerImpl

All Implemented Interfaces:

Aware, ApplicationContextAware, ServletContextAware, Controller, GeneralSearchController

@Controller
public class GeneralSearchControllerImpl
extends BaseFormController
implements GeneralSearchController

Note: do not use parametrized collections as parameters for ajax methods in this class! Type information is lost during proxy creation so DWR can't figure out what type of collection the method should take. See bug 2756. Use arrays instead.

Author:

klc

Nested Class Summary

Nested classes/interfaces inherited from interface ubic.gemma.web.controller.GeneralSearchController

GeneralSearchController.SearchResultValueObject<T extends IdentifiableValueObject<?>>

Field Summary

Fields inherited from class ubic.gemma.web.controller.BaseFormController

log

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor	Description
GeneralSearchControllerImpl()

Method Summary

Modifier and Type	Method	Description
JsonReaderResponse<GeneralSearchController.SearchResultValueObject<?>>	ajaxSearch(SearchSettingsValueObject settingsValueObject)	AJAX-flavoured search.
ModelAndView	doSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SearchSettings command, BindException errors)
protected SearchSettings	formBackingObject(javax.servlet.http.HttpServletRequest request)	This is needed or you will have to specify a commandClass in the DispatcherServlet's context
protected void	initBinder(WebDataBinder binder)	Set up a custom property editor for converting form inputs to real objects.
ModelAndView	processFormSubmission(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SearchSettings command, BindException errors)
protected Map<String,List<?>>	referenceData(javax.servlet.http.HttpServletRequest request)
ModelAndView	showForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, BindException errors)	Deprecated.

Methods inherited from class ubic.gemma.web.controller.BaseFormController

getCancelView, getMessageUtil, getText, processErrors, processFormSubmission, saveMessage, saveMessage, saveMessage, saveMessage, saveMessage, setMailEngine, setMessageUtil

Methods inherited from class org.springframework.web.servlet.mvc.SimpleFormController

doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, isFormChangeRequest, onFormChange, onFormChange, onSubmit, onSubmit, onSubmit, referenceData, setFormView, setSuccessView, showForm, suppressValidation

Methods inherited from class org.springframework.web.servlet.mvc.AbstractFormController

currentFormObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleInvalidSubmit, handleRequestInternal, isBindOnNewForm, isFormSubmission, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm

Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, suppressValidation, useDirectFieldAccess

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralSearchControllerImpl

public GeneralSearchControllerImpl()

Method Detail

ajaxSearch

public JsonReaderResponse<GeneralSearchController.SearchResultValueObject<?>> ajaxSearch(SearchSettingsValueObject settingsValueObject)

Description copied from interface: GeneralSearchController

AJAX-flavoured search. Mapped by DWR.

Specified by:

ajaxSearch in interface GeneralSearchController

doSearch

public ModelAndView doSearch(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             SearchSettings command,
                             BindException errors)

Specified by:

doSearch in interface GeneralSearchController

processFormSubmission

public ModelAndView processFormSubmission(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          SearchSettings command,
                                          BindException errors)
                                   throws Exception

Specified by:

processFormSubmission in interface GeneralSearchController

Throws:

Exception

formBackingObject

protected SearchSettings formBackingObject(javax.servlet.http.HttpServletRequest request)

This is needed or you will have to specify a commandClass in the DispatcherServlet's context

Overrides:

formBackingObject in class AbstractFormController

initBinder

@InitBinder
protected void initBinder(WebDataBinder binder)

Description copied from class: BaseFormController

Set up a custom property editor for converting form inputs to real objects. Override this to add additional custom editors (call super.initBinder() in your implementation)

Overrides:

initBinder in class BaseFormController

showForm

@Deprecated
@RequestMapping(value="/searcher.html",
                method=GET)
public ModelAndView showForm(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             BindException errors)

Deprecated.

Overrides:

showForm in class SimpleFormController

referenceData

protected Map<String,List<?>> referenceData(javax.servlet.http.HttpServletRequest request)

Overrides:

referenceData in class SimpleFormController