org.ibisph.mvc.controller.query
Class Builder

java.lang.Object
  org.ibisph.mvc.controller.AbstractModelAndView
      org.ibisph.mvc.controller.XMLModelAndDate
          org.ibisph.mvc.controller.query.AbstractQueryModule
              org.ibisph.mvc.controller.query.Builder

All Implemented Interfaces:

org.springframework.web.servlet.mvc.Controller

public class Builder
extends AbstractQueryModule

Handles Query System builder requests. This controller simply loads the query module xml file if not already loaded, puts the module document in the user's session for the result requests, and clears any existing results. The bulk of the work is done by the handler methods defined in the AbstractQueryModule and other super classes. This controller simply provides the core query module specific business rules needed for a builder type request.

Author:

Garth Braithwaite, STG

Field Summary

Fields inherited from class org.ibisph.mvc.controller.query.AbstractQueryModule

configurationNameParameterName, documentDAO, pathPrefixToRemove, queryModuleSessionName, reloadRequestParameterName, xmlPath

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

Builder()

Method Summary

protected XMLModelAndDate

getXMLModelAndDate(javax.servlet.http.HttpServletRequest request) Required method which gets the existing Query Module object from the user's session or loads a new one if doesn't exist or is not the current selection, deletes any existing results and sets the NEW_CRITERIA status flag so that subsequent controllers will know that the results need to be retrieved.

Methods inherited from class org.ibisph.mvc.controller.query.AbstractQueryModule

getQueryModule, setConfigurationNameParameterName, setDocumentDAO, setPathPrefixToRemove, setQueryModuleSessionName, setReloadRequestParameterName, setXMLPath

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

Constructor Detail

Builder

public Builder()

Method Detail

getXMLModelAndDate

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

Required method which gets the existing Query Module object from the user's session or loads a new one if doesn't exist or is not the current selection, deletes any existing results and sets the NEW_CRITERIA status flag so that subsequent controllers will know that the results need to be retrieved.

Overrides:

getXMLModelAndDate in class AbstractQueryModule

Parameters:

request - Provides access to the HTTP request which the XML System ID is typically retrieved from.

Returns:

XMLModelAndDate structure which contains the Query Module document and the file's modified date.

Throws:

java.lang.Exception