org.ibisph.mvc.controller.query
Class MapGraphic

java.lang.Object
  org.ibisph.mvc.controller.AbstractModelAndView
      org.ibisph.mvc.controller.XMLModelAndDate
          org.ibisph.mvc.controller.query.MapGraphic

All Implemented Interfaces:

org.springframework.web.servlet.mvc.Controller

public class MapGraphic
extends XMLModelAndDate

Query Results Graphic Map Controller. Handles all Query result map requests which use the query module / query results XML data. This controller gets the QueryModule object from the user's session. It then uses that XML document along with the XSLT transformation view to create the map. Note: For this controller and view to work properly, the GraphicType filter and SVGToJpeg filters are needed.

Author:

Garth Braithwaite, STG

Field Summary

protected java.lang.String

queryModuleSessionName

Fields inherited from class org.ibisph.mvc.controller.XMLModelAndDate

defaultXMLModelAndDate, defaultXMLSystemID, errorView, extraParameters, includeRequestParameters, parametersMapModelName, webAppURLContextPrefixParameterName, xmlDateFormat, xmlDateParameterName, xmlModelName

Fields inherited from class org.ibisph.mvc.controller.AbstractModelAndView

defaultResponseContentType, expiresGMTDateString, forceNoCacheHTTPHeader, view

Constructor Summary

MapGraphic()

Method Summary

protected XMLModelAndDate	getXMLModelAndDate(javax.servlet.http.HttpServletRequest request) Provides the XML model and last modified date.
void	setQueryModuleSessionName(java.lang.String key) Sets the Query XML document session name.

Methods inherited from class org.ibisph.mvc.controller.XMLModelAndDate

getModelMap, setDefaultXMLSystemID, setErrorView, setExtraParameters, setIncludeRequestParameters, setParametersMapModelName, setWebAppURLContextPrefixParameterName, setXMLDateFormat, setXMLDateParameterName, setXMLModelName

Methods inherited from class org.ibisph.mvc.controller.AbstractModelAndView

getView, handleRequest, setDefaultResponseContentType, setExpiresHTTPHeader, setHTTPHeaders, setNoCacheHTTPHeader, setNoCacheHTTPHeader, setResponseContentType, setView

Methods inherited from class java.lang.Object

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

Field Detail

queryModuleSessionName

protected java.lang.String queryModuleSessionName

Constructor Detail

MapGraphic

public MapGraphic()

Method Detail

setQueryModuleSessionName

public void setQueryModuleSessionName(java.lang.String key)

Sets the Query XML document session name. This method is simply the standardized way of setting/accessing the query module session document.

Parameters:

key - User HTTP session object container key/name. This value is the key which is used to put and get the query module XML document from the user's session container (default=QueryModule).

getXMLModelAndDate

protected XMLModelAndDate getXMLModelAndDate(javax.servlet.http.HttpServletRequest request)
                                      throws java.lang.Exception

Provides the XML model and last modified date. This method gets the query module XML data from the user's session. The GraphicType parameter is not dealt here as the GraphicTypeFilter adds this parameter to the request's parameters via reading submitted request parameters and using the user's cookie value as a default if not set.

Overrides:

getXMLModelAndDate in class XMLModelAndDate

Parameters:

request - Provides access to the HTTP request.

Returns:

XMLModelAndDate Model is the XML document, the date is the query module file's last modified date (though not used by the Map view).

Throws:

java.lang.Exception