org.openmrs.web.controller.person

Class PersonFormController

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.person.PersonFormController

All Implemented Interfaces:

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

Direct Known Subclasses:

PatientFormController

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

This class controls the generic person properties (address, name, attributes). The Patient and User form controllers extend this class.

See Also:

PatientFormController

Field Summary

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
PersonFormController()

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request) Retrieve a backing object for the current form from the given request.
static <P extends Person> void	getMiniPerson(P person, String name, String gender, String date, String age) Add the given name, gender, and birthdate/age to the given Person
protected void	initBinder(javax.servlet.http.HttpServletRequest request, org.springframework.web.bind.ServletRequestDataBinder binder) Allows for other Objects to be used as values in input tags.
protected org.springframework.web.servlet.ModelAndView	onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object command, org.springframework.validation.BindException errors) Submit callback with all parameters.
protected org.springframework.web.servlet.ModelAndView	processFormSubmission(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, 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 err) Create a reference data map for the given request and command, consisting of bean name/bean instance pairs as expected by ModelAndView.
protected Person	setupFormBackingObject(Person person) Setup the person object.
protected Map	setupReferenceData(Map map, Person person) Setup the reference map object.
protected org.springframework.web.servlet.ModelAndView	showForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.validation.BindException errors) Redirects to the patient form if the given personId points to a patient.
protected org.springframework.web.servlet.ModelAndView	showForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.validation.BindException errors, Map controlModel) Redirects to the patient form if the given personId points to a patient.
protected void	updatePersonAddresses(javax.servlet.http.HttpServletRequest request, Person person, org.springframework.validation.BindException errors) Updates person addresses based on request parameters
protected void	updatePersonAttributes(javax.servlet.http.HttpServletRequest request, org.springframework.validation.BindException errors, Person person) Updates person attributes based on request parameters
protected void	updatePersonNames(javax.servlet.http.HttpServletRequest request, Person person) Updates person names based on request parameters

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

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

Constructor Detail

PersonFormController

public PersonFormController()

Method Detail

initBinder

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

Allows for other Objects to be used as values in input tags. Normally, only strings and lists are expected

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.initBinder(javax.servlet.http.HttpServletRequest, org.springframework.web.bind.ServletRequestDataBinder)

formBackingObject

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

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

Retrieve a backing object for the current form from the given request.

The properties of the form object will correspond to the form field values in your form view. This object will be exposed in the model under the specified command name, to be accessed under that name in the view: for example, with a "spring:bind" tag. The default command name is "command".

Note that you need to activate session form mode to reuse the form-backing object across the entire form workflow. Else, a new instance of the command class will be created for each submission attempt, just using this backing object as template for the initial form.

The default implementation calls BaseCommandController.createCommand(), creating a new empty instance of the specified command class. Subclasses can override this to provide a preinitialized backing object.

Overrides:

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

Parameters:

request - current HTTP request

Returns:

the backing object

Throws:

Exception - in case of invalid state or arguments

See Also:

BaseCommandController.setCommandName(java.lang.String), BaseCommandController.setCommandClass(java.lang.Class), BaseCommandController.createCommand()

showForm

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

Redirects to the patient form if the given personId points to a patient.

Overrides:

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

Parameters:

request - current HTTP request

response - current HTTP response

errors - validation errors holder

Returns:

the prepared form view, or null if handled directly

Throws:

Exception - in case of invalid state or arguments

See Also:

SimpleFormController.showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException)

showForm

protected org.springframework.web.servlet.ModelAndView showForm(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                org.springframework.validation.BindException errors,
                                                                Map controlModel)
                                                         throws Exception

Redirects to the patient form if the given personId points to a patient.

Overrides:

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

Parameters:

request - current HTTP request

errors - validation errors holder

controlModel - model map containing controller-specific control data (e.g. current page in wizard-style controllers or special error message)

Returns:

the prepared form view

Throws:

Exception - in case of invalid state or arguments

See Also:

SimpleFormController.showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException, java.util.Map)

processFormSubmission

protected org.springframework.web.servlet.ModelAndView processFormSubmission(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response,
                                                                             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

response - 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:

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

onSubmit

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

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

Submit callback with all parameters. Called in case of submit without errors reported by the registered validator, or on every submit if no validator.

The default implementation delegates to SimpleFormController.onSubmit(Object, BindException). For simply performing a submit action and rendering the specified success view, consider implementing SimpleFormController.doSubmitAction(java.lang.Object) rather than an onSubmit variant.

Subclasses can override this to provide custom submission handling like storing the object to the database. Implementations can also perform custom validation and call showForm to return to the form. Do not implement multiple onSubmit methods: In that case, just this method will be called by the controller.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

Overrides:

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

Parameters:

request - current servlet request

response - current servlet response

command - 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(Object, BindException), SimpleFormController.doSubmitAction(java.lang.Object), SimpleFormController.showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException), Errors, BindException.getModel()

referenceData

protected Map<String,Object> referenceData(javax.servlet.http.HttpServletRequest request,
                                           Object obj,
                                           org.springframework.validation.Errors err)
                                    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

err - 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

updatePersonAttributes

protected void updatePersonAttributes(javax.servlet.http.HttpServletRequest request,
                                      org.springframework.validation.BindException errors,
                                      Person person)

Updates person attributes based on request parameters

Parameters:

request -

errors -

person -

updatePersonNames

protected void updatePersonNames(javax.servlet.http.HttpServletRequest request,
                                 Person person)

Updates person names based on request parameters

Parameters:

request -

person -

updatePersonAddresses

protected void updatePersonAddresses(javax.servlet.http.HttpServletRequest request,
                                     Person person,
                                     org.springframework.validation.BindException errors)
                              throws ParseException

Updates person addresses based on request parameters

Parameters:

request -

person -

errors -

Throws:

ParseException

setupFormBackingObject

protected Person setupFormBackingObject(Person person)

Setup the person object. Should be called by the PersonFormController.formBackingObject(request)

Parameters:

person -

Returns:

the given person object

setupReferenceData

protected Map setupReferenceData(Map map,
                                 Person person)
                          throws Exception

Setup the reference map object. Should be called by the PersonFormController.referenceData(...)

Parameters:

person -

Returns:

the given map object

Throws:

Exception

getMiniPerson

public static <P extends Person> void getMiniPerson(P person,
                                                    String name,
                                                    String gender,
                                                    String date,
                                                    String age)

Add the given name, gender, and birthdate/age to the given Person

Type Parameters:

P - Should be a Patient or User object

Parameters:

person -

name -

gender -

date - birthdate

age -