org.springframework.web.servlet.view.xslt: public class: XsltViewResolver

org.springframework.web.servlet.view.xslt
public class: XsltViewResolver [javadoc | source]

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

All Implemented Interfaces:
Ordered, ViewResolver, ServletContextAware, ApplicationContextAware

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

author: Rob - Harrop

author: Juergen - Hoeller

since: 2.0 -

Fields inherited from org.springframework.web.servlet.view.UrlBasedViewResolver:
REDIRECT_URL_PREFIX, FORWARD_URL_PREFIX

Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger

Constructor:
public XsltViewResolver() { setViewClass(XsltView.class); }

Method from org.springframework.web.servlet.view.xslt.XsltViewResolver Summary:
buildView, requiredViewClass, setCacheTemplates, setErrorListener, setIndent, setOutputProperties, setSourceKey, setUriResolver

Methods from org.springframework.web.servlet.view.UrlBasedViewResolver:
buildView, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getOrder, getPrefix, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setOrder, setPrefix, setRedirectContextRelative, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods from org.springframework.web.servlet.view.UrlBasedViewResolver:

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

Methods from org.springframework.web.servlet.view.AbstractCachingViewResolver:
clearCache, createView, getCacheKey, isCache, loadView, removeFromCache, resolveViewName, setCache

Methods from org.springframework.web.context.support.WebApplicationObjectSupport:
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods from org.springframework.context.support.ApplicationObjectSupport:
getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.web.servlet.view.xslt.XsltViewResolver Detail:
protected AbstractUrlBasedView buildView(String viewName) throws Exception { XsltView view = (XsltView) super.buildView(viewName); view.setSourceKey(this.sourceKey); if (this.uriResolver != null) { view.setUriResolver(this.uriResolver); } if (this.errorListener != null) { view.setErrorListener(this.errorListener); } view.setIndent(this.indent); view.setOutputProperties(this.outputProperties); view.setCacheTemplates(this.cacheTemplates); return view; }
protected Class requiredViewClass() { return XsltView.class; }
public void setCacheTemplates(boolean cacheTemplates) { this.cacheTemplates = 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) { this.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 org.springframework.util.xml.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) { this.indent = 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.
public void setOutputProperties(Properties outputProperties) { this.outputProperties = 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) { this.sourceKey = 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: javax.xml.transform.Source , org.w3c.dom.Document , org.w3c.dom.Node , java.io.Reader , java.io.InputStream and org.springframework.core.io.Resource .
public void setUriResolver(URIResolver uriResolver) { this.uriResolver = uriResolver; } Set the URIResolver used in the transform. The URIResolver handles calls to the XSLT `document()` function.

Method from org.springframework.web.servlet.view.xslt.XsltViewResolver Detail:

 protected AbstractUrlBasedView buildView(String viewName) throws Exception {
		XsltView view = (XsltView) super.buildView(viewName);
		view.setSourceKey(this.sourceKey);
		if (this.uriResolver != null) {
			view.setUriResolver(this.uriResolver);
		}
		if (this.errorListener != null) {
			view.setErrorListener(this.errorListener);
		}
		view.setIndent(this.indent);
		view.setOutputProperties(this.outputProperties);
		view.setCacheTemplates(this.cacheTemplates);
		return view;
}

 protected Class requiredViewClass() {
		return XsltView.class;
}

 public  void setCacheTemplates(boolean cacheTemplates) {
		this.cacheTemplates = cacheTemplates;
}

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

 public  void setErrorListener(ErrorListener errorListener) {
		this.errorListener = errorListener;
}

javax.xml.transform.ErrorListener

If not set, a default org.springframework.util.xml.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) {
		this.indent = indent;
}

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

 public  void setOutputProperties(Properties outputProperties) {
		this.outputProperties = outputProperties;
}

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

 public  void setSourceKey(String sourceKey) {
		this.sourceKey = sourceKey;
}

The following source types are supported out of the box: javax.xml.transform.Source , org.w3c.dom.Document , org.w3c.dom.Node , java.io.Reader , java.io.InputStream and org.springframework.core.io.Resource .

 public  void setUriResolver(URIResolver uriResolver) {
		this.uriResolver = uriResolver;
}

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