|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.XmlViewResolver
public class XmlViewResolver
Implementation of ViewResolver that uses bean definitions in an XML file, specified by resource location. The file will typically be located in the WEB-INF directory; default is "/WEB-INF/views.xml".
This ViewResolver does not support internationalization. Consider ResourceBundleViewResolver if you need to apply different view resources per locale.
Note: This ViewResolver implements the Ordered interface to allow for flexible participation in ViewResolver chaining. For example, some special views could be defined via this ViewResolver (giving it 0 as "order" value), while all remaining views could be resolved by a UrlBasedViewResolver.
ResourceLoader.getResource(java.lang.String)
,
ResourceBundleViewResolver
,
UrlBasedViewResolver
Field Summary | |
---|---|
static String |
DEFAULT_LOCATION
Default if no other location is supplied |
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Fields inherited from interface org.springframework.core.Ordered |
---|
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE |
Constructor Summary | |
---|---|
XmlViewResolver()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
Pre-initialize the factory from the XML file. |
void |
destroy()
Close the view bean factory on context shutdown. |
protected Object |
getCacheKey(String viewName,
Locale locale)
This implementation returns just the view name, as XmlViewResolver doesn't support localized resolution. |
int |
getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting. |
protected BeanFactory |
initFactory()
Initialize the view bean factory from the XML file. |
protected View |
loadView(String viewName,
Locale locale)
Subclasses must implement this method, building a View object for the specified view. |
void |
setLocation(Resource location)
Set the location of the XML file that defines the view beans. |
void |
setOrder(int order)
|
Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver |
---|
clearCache, createView, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, 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, initApplicationContext, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_LOCATION
Constructor Detail |
---|
public XmlViewResolver()
Method Detail |
---|
public void setOrder(int order)
public int getOrder()
Ordered
Normally starting with 0, with Integer.MAX_VALUE
indicating the greatest value. Same order values will result
in arbitrary positions for the affected objects.
Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).
getOrder
in interface Ordered
public void setLocation(Resource location)
The default is "/WEB-INF/views.xml".
location
- the location of the XML file.public void afterPropertiesSet() throws BeansException
afterPropertiesSet
in interface InitializingBean
BeansException
protected Object getCacheKey(String viewName, Locale locale)
getCacheKey
in class AbstractCachingViewResolver
protected View loadView(String viewName, Locale locale) throws BeansException
AbstractCachingViewResolver
Subclasses are not forced to support internationalization: A subclass that does not may simply ignore the locale parameter.
loadView
in class AbstractCachingViewResolver
viewName
- the name of the view to retrievelocale
- the Locale to retrieve the view for
null
if not found
(optional, to allow for ViewResolver chaining)
BeansException
AbstractCachingViewResolver.resolveViewName(java.lang.String, java.util.Locale)
protected BeanFactory initFactory() throws BeansException
BeansException
- in case of initialization errorspublic void destroy() throws BeansException
destroy
in interface DisposableBean
BeansException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |