public class

XsltViewResolver

extends UrlBasedViewResolver
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.web.servlet.view.xslt.XsltViewResolver

Class Overview

ViewResolver implementation that resolves instances of XsltView by translating the supplied view name into the URL of the XSLT stylesheet.

Summary

[Expand]
Inherited Constants
From class org.springframework.web.servlet.view.UrlBasedViewResolver
From interface org.springframework.core.Ordered
[Expand]
Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport
Public Constructors
XsltViewResolver()
Public Methods
void setCacheTemplates(boolean cacheTemplates)
Turn on/off the caching of the XSLT templates.
void setErrorListener(ErrorListener errorListener)
Set an implementation of the javax.xml.transform.ErrorListener interface for custom handling of transformation errors and warnings.
void setIndent(boolean indent)
Set whether the XSLT transformer may add additional whitespace when outputting the result tree.
void setOutputProperties(Properties outputProperties)
Set arbitrary transformer output properties to be applied to the stylesheet.
void setSourceKey(String sourceKey)
Set the name of the model attribute that represents the XSLT Source.
void setUriResolver(URIResolver uriResolver)
Set the URIResolver used in the transform.
Protected Methods
AbstractUrlBasedView buildView(String viewName)
Creates a new View instance of the specified view class and configures it.
Class requiredViewClass()
Return the required type of view for this resolver.
[Expand]
Inherited Methods
From class org.springframework.web.servlet.view.UrlBasedViewResolver
From class org.springframework.web.servlet.view.AbstractCachingViewResolver
From class org.springframework.web.context.support.WebApplicationObjectSupport
From class org.springframework.context.support.ApplicationObjectSupport
From class java.lang.Object
From interface org.springframework.context.ApplicationContextAware
From interface org.springframework.core.Ordered
From interface org.springframework.web.context.ServletContextAware
From interface org.springframework.web.servlet.ViewResolver

Public Constructors

public XsltViewResolver ()

Public Methods

public void setCacheTemplates (boolean cacheTemplates)

Turn on/off the caching of the XSLT templates.

The default value is "true". Only set this to "false" in development, where caching does not seriously impact performance.

public void setErrorListener (ErrorListener errorListener)

Set an implementation of the javax.xml.transform.ErrorListener interface for custom handling of transformation errors and warnings.

If not set, a default SimpleTransformErrorListener is used that simply logs warnings using the logger instance of the view class, and rethrows errors to discontinue the XML transformation.

public void setIndent (boolean indent)

Set whether the XSLT transformer may add additional whitespace when outputting the result tree.

Default is true (on); set this to false (off) to not specify an "indent" key, leaving the choice up to the stylesheet.

See Also

public void setOutputProperties (Properties outputProperties)

Set arbitrary transformer output properties to be applied to the stylesheet.

Any values specified here will override defaults that this view sets programmatically.

public void setSourceKey (String sourceKey)

Set the name of the model attribute that represents the XSLT Source. If not specified, the model map will be searched for a matching value type.

The following source types are supported out of the box: Source, Document, Node, Reader, InputStream and Resource.

public void setUriResolver (URIResolver uriResolver)

Set the URIResolver used in the transform.

The URIResolver handles calls to the XSLT document() function.

Protected Methods

protected AbstractUrlBasedView buildView (String viewName)

Creates a new View instance of the specified view class and configures it. Does not perform any lookup for pre-defined View instances.

Spring lifecycle methods as defined by the bean container do not have to be called here; those will be applied by the loadView method after this method returns.

Subclasses will typically call super.buildView(viewName) first, before setting further properties themselves. loadView will then apply Spring lifecycle methods at the end of this process.

Parameters
viewName the name of the view to build
Returns
  • the View instance
Throws
Exception

protected Class requiredViewClass ()

Return the required type of view for this resolver. This implementation returns AbstractUrlBasedView.