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

Modifier and Type	Field and Description
protected static 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
PersonFormController()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	formBackingObject(javax.servlet.http.HttpServletRequest request)
static <P extends Person> void	getMiniPerson(P person, java.lang.String name, java.lang.String gender, java.lang.String date, java.lang.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, java.lang.Object command, org.springframework.validation.BindException errors)
protected org.springframework.web.servlet.ModelAndView	processFormSubmission(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object obj, org.springframework.validation.BindException errors)
protected java.util.Map<java.lang.String,java.lang.Object>	referenceData(javax.servlet.http.HttpServletRequest request, java.lang.Object obj, org.springframework.validation.Errors err)
protected Person	setupFormBackingObject(Person person) Setup the person object.
protected java.util.Map	setupReferenceData(java.util.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, java.util.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) 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, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, 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 static final org.apache.commons.logging.Log log

Logger for this class and subclasses

Constructor Detail

PersonFormController

public PersonFormController()

Method Detail

initBinder

protected void initBinder(javax.servlet.http.HttpServletRequest request,
                          org.springframework.web.bind.ServletRequestDataBinder binder)
                   throws java.lang.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

Throws:

java.lang.Exception

See Also:

BaseCommandController.initBinder(javax.servlet.http.HttpServletRequest, org.springframework.web.bind.ServletRequestDataBinder)

formBackingObject

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

Overrides:

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

Throws:

java.lang.Exception

showForm

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

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

Overrides:

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

Throws:

java.lang.Exception

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,
                                                                java.util.Map controlModel)
                                                         throws java.lang.Exception

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

Overrides:

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

Throws:

java.lang.Exception

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,
                                                                             java.lang.Object obj,
                                                                             org.springframework.validation.BindException errors)
                                                                      throws java.lang.Exception

Overrides:

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

Throws:

java.lang.Exception

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,
                                                                java.lang.Object command,
                                                                org.springframework.validation.BindException errors)
                                                         throws java.lang.Exception

Overrides:

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

Throws:

java.lang.Exception

referenceData

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

Overrides:

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

Throws:

java.lang.Exception

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)
                              throws java.text.ParseException

Updates person addresses based on request parameters

Parameters:

request -

person -

Throws:

java.text.ParseException

setupFormBackingObject

protected Person setupFormBackingObject(Person person)

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

Parameters:

person -

Returns:

setupReferenceData

protected java.util.Map setupReferenceData(java.util.Map map,
                                           Person person)
                                    throws java.lang.Exception

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

Parameters:

person -

Returns:

Throws:

java.lang.Exception

getMiniPerson

public static <P extends Person> void getMiniPerson(P person,
                                                    java.lang.String name,
                                                    java.lang.String gender,
                                                    java.lang.String date,
                                                    java.lang.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 -