org.compass.spring.web.mvc
Class AbstractCompassCommandController

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.AbstractCommandController
                          org.compass.spring.web.mvc.AbstractCompassCommandController

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

CompassSearchController

public abstract class AbstractCompassCommandController
extends org.springframework.web.servlet.mvc.AbstractCommandController
implements org.springframework.beans.factory.InitializingBean

A general base class for Spring's MVC Command Controllers that use Compass.

Expects Compass instance to be injected, and provides access to both Compass and CompassTemplate instances.

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

AbstractCompassCommandController()

Method Summary

void	afterPropertiesSet()
Compass	getCompass() Returns Compass instance.
protected CompassTemplate	getCompassTemplate() Returns a CompassTemplate that wraps the injected Compass instance.
void	setCompass(Compass compass) Sets the Compass instance.

Methods inherited from class org.springframework.web.servlet.mvc.AbstractCommandController

handle, 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

AbstractCompassCommandController

public AbstractCompassCommandController()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getCompass

public Compass getCompass()

Returns Compass instance.

Returns:

The compass instance.

setCompass

public void setCompass(Compass compass)

Sets the Compass instance.

Parameters:

compass -

getCompassTemplate

protected CompassTemplate getCompassTemplate()

Returns a CompassTemplate that wraps the injected Compass instance.

Returns:

Compass template that wraps the injected Compass instance.