org.openmrs.web.controller.form

Class FieldFormController

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

org.openmrs.web.controller.form.FieldFormController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class FieldFormController
extends org.springframework.web.servlet.mvc.SimpleFormController

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log Logger for this class and subclasses

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 and Description
FieldFormController()

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request) This is called prior to displaying a form for the first time.
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Initialize the given binder instance, for example with custom editors.
protected org.springframework.web.servlet.ModelAndView	onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object obj, org.springframework.validation.BindException errors) The onSubmit function receives the form/command object that was modified by the input form and saves it to the db
protected org.springframework.web.servlet.ModelAndView	processFormSubmission(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse reponse, Object obj, org.springframework.validation.BindException errors) This implementation calls SimpleFormController.showForm(HttpServletRequest, HttpServletResponse, BindException) in case of errors, and delegates to the full SimpleFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException)'s variant else.
protected Map<String,Object>	referenceData(javax.servlet.http.HttpServletRequest request, Object obj, org.springframework.validation.Errors errors) Create a reference data map for the given request and command, consisting of bean name/bean instance pairs as expected by ModelAndView.

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

doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, isFormChangeRequest, onFormChange, onFormChange, onSubmit, onSubmit, referenceData, setFormView, setSuccessView, showForm, 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, 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

Field Detail

log

protected final org.apache.commons.logging.Log log

Logger for this class and subclasses

Constructor Detail

FieldFormController

public FieldFormController()

Method Detail

initBinder

protected void initBinder(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.bind.ServletRequestDataBinder binder)
                   throws Exception

Description copied from class: org.springframework.web.servlet.mvc.BaseCommandController

Initialize the given binder instance, for example with custom editors. Called by BaseCommandController.createBinder(javax.servlet.http.HttpServletRequest, java.lang.Object).

This method allows you to register custom editors for certain fields of your command class. For instance, you will be able to transform Date objects into a String pattern and back, in order to allow your JavaBeans to have Date properties and still be able to set and display them in an HTML interface.

The default implementation is empty.

Overrides:

initBinder in class org.springframework.web.servlet.mvc.BaseCommandController

Parameters:

request - current HTTP request

binder - the new binder instance

Throws:

Exception - in case of invalid state or arguments

See Also:

BaseCommandController.createBinder(javax.servlet.http.HttpServletRequest, java.lang.Object), DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor), CustomDateEditor

processFormSubmission

protected org.springframework.web.servlet.ModelAndView processFormSubmission(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse reponse,
                                                                             Object obj,
                                                                             org.springframework.validation.BindException errors)
                                                                      throws Exception

Description copied from class: org.springframework.web.servlet.mvc.SimpleFormController

This implementation calls SimpleFormController.showForm(HttpServletRequest, HttpServletResponse, BindException) in case of errors, and delegates to the full SimpleFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException)'s variant else.

This can only be overridden to check for an action that should be executed without respect to binding errors, like a cancel action. To just handle successful submissions without binding errors, override one of the onSubmit methods or SimpleFormController.doSubmitAction(java.lang.Object).

Overrides:

processFormSubmission in class org.springframework.web.servlet.mvc.SimpleFormController

Parameters:

request - current servlet request

reponse - current servlet response

obj - form object with request parameters bound onto it

errors - holder without errors (subclass can add errors if it wants to)

Returns:

the prepared model and view, or null

Throws:

Exception - in case of errors

See Also:

SimpleFormController.showForm(HttpServletRequest, HttpServletResponse, BindException), SimpleFormController.onSubmit(HttpServletRequest, HttpServletResponse, Object, BindException), SimpleFormController.onSubmit(Object, BindException), SimpleFormController.onSubmit(Object), SimpleFormController.doSubmitAction(Object)

onSubmit

protected org.springframework.web.servlet.ModelAndView onSubmit(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                Object obj,
                                                                org.springframework.validation.BindException errors)
                                                         throws Exception

The onSubmit function receives the form/command object that was modified by the input form and saves it to the db

Overrides:

onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController

Parameters:

request - current servlet request

response - current servlet response

obj - form object with request parameters bound onto it

errors - Errors instance without errors (subclass can add errors if it wants to)

Returns:

the prepared model and view, or null

Throws:

Exception - in case of errors

See Also:

SimpleFormController.onSubmit(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, org.springframework.validation.BindException)

formBackingObject

protected Object formBackingObject(javax.servlet.http.HttpServletRequest request)
                            throws javax.servlet.ServletException

This is called prior to displaying a form for the first time. It tells Spring the form/command object to load into the request

Overrides:

formBackingObject in class org.springframework.web.servlet.mvc.AbstractFormController

Parameters:

request - current HTTP request

Returns:

the backing object

Throws:

javax.servlet.ServletException

See Also:

AbstractFormController.formBackingObject(javax.servlet.http.HttpServletRequest)

referenceData

protected Map<String,Object> referenceData(javax.servlet.http.HttpServletRequest request,
                                           Object obj,
                                           org.springframework.validation.Errors errors)
                                    throws Exception

Description copied from class: org.springframework.web.servlet.mvc.SimpleFormController

Create a reference data map for the given request and command, consisting of bean name/bean instance pairs as expected by ModelAndView.

The default implementation delegates to SimpleFormController.referenceData(HttpServletRequest). Subclasses can override this to set reference data used in the view.

Overrides:

referenceData in class org.springframework.web.servlet.mvc.SimpleFormController

Parameters:

request - current HTTP request

obj - form object with request parameters bound onto it

errors - validation errors holder

Returns:

a Map with reference data entries, or null if none

Throws:

Exception - in case of invalid state or arguments

See Also:

ModelAndView