org.openmrs.web.controller

Class PortletController

java.lang.Object

org.openmrs.web.controller.PortletController

All Implemented Interfaces:

org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

ActiveListPortletController, GlobalPropertyPortletController, LayoutPortletController, PatientEncountersPortletController, PatientProgramsPortletController, PatientSummaryPortletController, PatientVisitsPortletController, PersonFormEntryPortletController, PersonRelationshipsPortletController

public class PortletController
extends java.lang.Object
implements org.springframework.web.servlet.mvc.Controller

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
PortletController()

Method Summary

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method produces a model containing the following mappings:
protected void	populateModel(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> model) Subclasses should override this to put more data into the model.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

Constructor Detail

PortletController

public PortletController()

Method Detail

handleRequest

public org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                           throws javax.servlet.ServletException,
                                                                  java.io.IOException

This method produces a model containing the following mappings:

     (always)
          (java.util.Date) now
          (String) size
          (Locale) locale
          (String) portletUUID // unique for each instance of any portlet
          (other parameters)
     (if there's currently an authenticated user)
          (User) authenticatedUser
     (if the request has a patientId attribute)
          (Integer) patientId
          (Patient) patient
          (List) patientObs
          (List) patientEncounters
          (List) patientVisits
          (List) activeVisits
          (Obs) patientWeight // most recent weight obs
          (Obs) patientHeight // most recent height obs
          (Double) patientBmi // BMI derived from most recent weight and most recent height
          (String) patientBmiAsString // BMI rounded to one decimal place, or "?" if unknown
          (Integer) personId
     (if the request has a personId or patientId attribute)
          (Person) person
          (List) personRelationships
          (Map>) personRelationshipsByType
     (if the request has an encounterId attribute)
          (Integer) encounterId
          (Encounter) encounter
          (Set) encounterObs
     (if the request has a userId attribute)
          (Integer) userId
          (User) user
     (if the request has a patientIds attribute, which should be a (String) comma-separated list of patientIds)
          (PatientSet) patientSet
          (String) patientIds
     (if the request has a conceptIds attribute, which should be a (String) commas-separated list of conceptIds)
          (Map) conceptMap
          (Map) conceptMapByStringIds
 

Specified by:

handleRequest in interface org.springframework.web.servlet.mvc.Controller

Throws:

javax.servlet.ServletException

java.io.IOException

populateModel

protected void populateModel(javax.servlet.http.HttpServletRequest request,
                             java.util.Map<java.lang.String,java.lang.Object> model)

Subclasses should override this to put more data into the model. This will be called AFTER handleRequest has put mappings in the model as described in its javadoc. Note that context could be null when this method is called.