org.compass.spring.web.mvc
Class CompassIndexController

java.lang.Object
  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.context.support.WebApplicationObjectSupport
          extended by org.springframework.web.servlet.support.WebContentGenerator
              extended by org.springframework.web.servlet.mvc.AbstractController
                  extended by org.springframework.web.servlet.mvc.BaseCommandController
                      extended by org.springframework.web.servlet.mvc.AbstractCommandController
                          extended by org.compass.spring.web.mvc.AbstractCompassGpsCommandController
                              extended by org.compass.spring.web.mvc.CompassIndexController
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class CompassIndexController
extends AbstractCompassGpsCommandController

A general Spring's MVC Controller that perform the index operation of CompassGps.

Will perform the index operation if the CompassIndexCommand doIndex property is set to true.

The controller has two views to be set, the indexView, which is the view that holds the screen which the user will initiate the index operation, and the indexResultsView, which will show the results of the index operation.

The results of the index operation will be saved under the indexResultsName, which defaults to "indexResults".

Author:
kimchy

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
CompassIndexController()
           
 
Method Summary
 void afterPropertiesSet()
           
 String getIndexResultsName()
          Returns the name of the results that the CompassIndexResults will be saved under.
 String getIndexResultsView()
          Returns the view which will show the results of the index operation.
 String getIndexView()
          Returns the view that holds the screen which the user will initiate the index operation.
protected  org.springframework.web.servlet.ModelAndView handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object command, org.springframework.validation.BindException errors)
           
 void setIndexResultsName(String indexResultsName)
          Sets the name of the results that the CompassIndexResults will be saved under.
 void setIndexResultsView(String indexResultsView)
          Sets the view which will show the results of the index operation.
 void setIndexView(String indexView)
          Sets the view that holds the screen which the user will initiate the index operation.
 
Methods inherited from class org.compass.spring.web.mvc.AbstractCompassGpsCommandController
getCompassGps, setCompassGps
 
Methods inherited from class org.springframework.web.servlet.mvc.AbstractCommandController
handleRequestInternal
 
Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController
bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommand, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, 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
 

Constructor Detail

CompassIndexController

public CompassIndexController()
Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception
Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
Overrides:
afterPropertiesSet in class AbstractCompassGpsCommandController
Throws:
Exception

handle

protected org.springframework.web.servlet.ModelAndView handle(javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response,
                                                              Object command,
                                                              org.springframework.validation.BindException errors)
                                                       throws Exception
Specified by:
handle in class org.springframework.web.servlet.mvc.AbstractCommandController
Throws:
Exception

getIndexView

public String getIndexView()
Returns the view that holds the screen which the user will initiate the index operation.


setIndexView

public void setIndexView(String indexView)
Sets the view that holds the screen which the user will initiate the index operation.


getIndexResultsName

public String getIndexResultsName()
Returns the name of the results that the CompassIndexResults will be saved under. Defaults to "indexResults".


setIndexResultsName

public void setIndexResultsName(String indexResultsName)
Sets the name of the results that the CompassIndexResults will be saved under. Defaults to "indexResults".

Parameters:
indexResultsName -

getIndexResultsView

public String getIndexResultsView()
Returns the view which will show the results of the index operation.


setIndexResultsView

public void setIndexResultsView(String indexResultsView)
Sets the view which will show the results of the index operation.

Parameters:
indexResultsView -


Copyright (c) 2004-2008 The Compass Project.