org.springframework.extensions.surf.mvc

Class PageViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

org.springframework.extensions.surf.mvc.AbstractWebFrameworkViewResolver

org.springframework.extensions.surf.mvc.PageViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

public class PageViewResolver
extends AbstractWebFrameworkViewResolver

Resolver for web framework Page views This allows for page ids to utilise uri templates by default.

Author:

kevinr, muzquiano, David Draper

Field Summary

Fields inherited from class org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

useNullSentinel

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
PageViewResolver() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.web.servlet.view.AbstractUrlBasedView	buildView(String viewName) Constructs a new PageView object using and sets it's URL to the current view name providing that a Page object is stored on the current RequestContext object.
protected boolean	canHandle(String viewName, Locale locale) Determines whether or not this view resolver can build a view to be displayed.
protected Map<String,String>	getTokens(String viewName) Retrieves the tokens matched against the configured URI templates for the supplied view name.

Methods inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkViewResolver

addPrefix, addReqParm, generateUriTemplateListIndexFromConfig, getBeanName, getModelObjectService, getServiceRegistry, getTemplatesContainer, getUriTemplateListIndex, getUrlHelperFactory, getWebframeworkConfigElement, getWebFrameworkRenderService, getWebFrameworkResourceService, getWebFrameworkServiceRegistry, lookupPage, matchUriTemplate, processView, setBeanName, setModelObjectService, setServiceRegistry, setTemplatesContainer, setUriTemplateIndex, setUrlHelperFactory, setWebframeworkConfigElement, setWebFrameworkRenderService, setWebFrameworkResourceService

Methods inherited from class org.springframework.extensions.webscripts.servlet.mvc.AbstractWebScriptViewResolver

clearCache, removeFromCache, resolveViewName

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

createView, getAttributesMap, getCacheKey, getContentType, getExposePathVariables, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

getCacheLimit, isCache, isCacheUnresolved, setCache, setCacheLimit, setCacheUnresolved

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

PageViewResolver

public PageViewResolver()

Constructor

Method Detail

canHandle

protected boolean canHandle(String viewName,
                Locale locale)

Determines whether or not this view resolver can build a view to be displayed. This method will return true providing one of the following criteria are met:

• No view name has been specified (indicating that the root page will be loaded
• The view name directly matches a page id
• The view name maps to a template that contains a page id token

If a page id is found then it will be used to attempt to load a page. If a page can be loaded it will be stored in the current RequestContext object to that the associated view can retrieve it. Finally, if the view name maps to a template uri then the tokens in the uri will also be saved into the current RequestContext.

Overrides:

canHandle in class AbstractWebFrameworkViewResolver

Parameters:

viewName - The view name to check.

locale - The current locale.

getTokens

protected Map<String,String> getTokens(String viewName)

Retrieves the tokens matched against the configured URI templates for the supplied view name.

Parameters:

viewName - The view name to map tokens from.

Returns:

A map of tokens generated from the view name

buildView

protected org.springframework.web.servlet.view.AbstractUrlBasedView buildView(String viewName)

Constructs a new PageView object using and sets it's URL to the current view name providing that a Page object is stored on the current RequestContext object.

Overrides:

buildView in class org.springframework.web.servlet.view.UrlBasedViewResolver

Parameters:

viewName - The name of the view to build.