|
The Spring Framework | |||||||||
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.AbstractView org.springframework.web.servlet.view.xslt.AbstractXsltView
public abstract class AbstractXsltView
Convenient superclass for views rendered using an XSLT stylesheet.
Subclasses typically must provide the Source
to transform
by overriding createXsltSource(java.util.Map, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
. Subclasses do not need to
concern themselves with XSLT other than providing a valid stylesheet location.
Properties:
stylesheetLocation
:
a Resource
pointing to the XSLT stylesheet
root
: the name of the root element; defaults to "DocRoot"
uriResolver
:
the URIResolver
to be used in the transform
errorListener
(optional):
the ErrorListener
implementation instance for custom handling of warnings and errors during TransformerFactory operations
indent
(optional): whether additional whitespace
may be added when outputting the result; defaults to true
cache
(optional): are templates to be cached; debug setting only; defaults to true
Note that setting "cache"
to false
will cause the template objects to be reloaded for each rendering. This is
useful during development, but will seriously affect performance in production
and is not thread-safe.
Field Summary | |
---|---|
static String |
DEFAULT_ROOT
The default document root name |
static String |
XML_CONTENT_TYPE
The default content type if no stylesheet specified |
Fields inherited from class org.springframework.web.servlet.view.AbstractView |
---|
DEFAULT_CONTENT_TYPE |
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
protected |
AbstractXsltView()
This constructor sets the content type to "text/xml;charset=ISO-8859-1" by default. |
Method Summary | |
---|---|
protected void |
applyTransformerParameters(Map parameters,
Transformer transformer)
Apply the specified parameters to the given Transformer. |
protected Transformer |
buildTransformer(Map parameters)
Build a Transformer object for immediate use, based on the given parameters. |
protected Source |
createXsltSource(Map model,
String root,
HttpServletRequest request,
HttpServletResponse response)
Return the XML Source to transform. |
protected void |
doTransform(Map model,
Source source,
HttpServletRequest request,
HttpServletResponse response)
Perform the actual transformation, writing to the HTTP response. |
protected void |
doTransform(Source source,
Map parameters,
Result result,
String encoding)
Perform the actual transformation, writing to the given result. |
protected Map |
getParameters()
Deprecated. as of Spring 2.0.4, in favor of the getParameters(HttpServletRequest) variant |
protected Map |
getParameters(HttpServletRequest request)
Return a Map of transformer parameters to be applied to the stylesheet. |
protected Map |
getParameters(Map model,
HttpServletRequest request)
Return a Map of transformer parameters to be applied to the stylesheet. |
protected Resource |
getStylesheetLocation()
Return the location of the XSLT stylesheet, if any. |
protected Source |
getStylesheetSource(Resource stylesheetLocation)
Load the stylesheet from the specified location. |
protected Templates |
getTemplates()
Obtain the Templates object to use, based on the configured stylesheet, either a cached one or a freshly built one. |
protected TransformerFactory |
getTransformerFactory()
Return the TransformerFactory used by this view. |
protected void |
initApplicationContext()
Here we load our template, as we need the ApplicationContext to do it. |
protected void |
renderMergedOutputModel(Map model,
HttpServletRequest request,
HttpServletResponse response)
Subclasses must implement this method to actually render the view. |
void |
resetCachedTemplates()
Reset the cached Templates object, if any. |
void |
setCache(boolean cache)
Set whether to activate the template cache for this view. |
void |
setContentType(String contentType)
Set the content type for this view. |
void |
setErrorListener(ErrorListener errorListener)
Set an implementation of the 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 |
setRoot(String root)
The document root element name. |
void |
setStylesheetLocation(Resource stylesheetLocation)
Set the location of the XSLT stylesheet. |
void |
setUriResolver(URIResolver uriResolver)
Set the URIResolver used in the transform. |
void |
setUseSingleModelNameAsRoot(boolean useSingleModelNameAsRoot)
Set whether to use the name of a given single model object as the document root element name. |
protected boolean |
useWriter()
Return whether to use a java.io.Writer to write text content
to the HTTP response. |
Methods inherited from class org.springframework.web.servlet.view.AbstractView |
---|
addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setRequestContextAttribute, toString |
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport |
---|
getServletContext, getTempDir, getWebApplicationContext, 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, wait, wait, wait |
Field Detail |
---|
public static final String XML_CONTENT_TYPE
public static final String DEFAULT_ROOT
Constructor Detail |
---|
protected AbstractXsltView()
A specific content type can be configured via the
"contentType"
bean property.
Method Detail |
---|
public void setContentType(String contentType)
AbstractView
May be ignored by subclasses if the view itself is assumed to set the content type, e.g. in case of JSPs.
setContentType
in class AbstractView
public void setStylesheetLocation(Resource stylesheetLocation)
If the TransformerFactory
used by this instance has already
been initialized then invoking this setter will result in the
attendant templates
being re-cached.
stylesheetLocation
- the location of the XSLT stylesheetResourceLoader.getResource(java.lang.String)
protected Resource getStylesheetLocation()
public void setRoot(String root)
"DocRoot"
.
Only used if we're not passed a single Node
as the model.
root
- the document root element nameDEFAULT_ROOT
public void setUseSingleModelNameAsRoot(boolean useSingleModelNameAsRoot)
Default is true
: If you pass in a model with a single object
named "myElement", then the document root will be named "myElement"
as well. Set this flag to false
if you want to pass in a single
model object while still using the root element name configured
through the "root" property
.
useSingleModelNameAsRoot
- true
if the name of a given single
model object is to be used as the document root element namesetRoot(java.lang.String)
public void setUriResolver(URIResolver uriResolver)
The URIResolver handles calls to the XSLT document()
function.
public void setErrorListener(ErrorListener errorListener)
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.
SimpleTransformErrorListener
public void setIndent(boolean indent)
Default is true
(on); set this to false
(off)
to not specify an "indent" key, leaving the choice up to the stylesheet.
OutputKeys.INDENT
public void setOutputProperties(Properties outputProperties)
Any values specified here will override defaults that this view sets programmatically.
public void setCache(boolean cache)
Default is true
. Turn this off to refresh
the Templates object on every access, e.g. during development.
resetCachedTemplates()
public final void resetCachedTemplates()
The Templates object will subsequently be rebuilt on next
access
, if caching is enabled.
setCache(boolean)
protected final void initApplicationContext() throws ApplicationContextException
ApplicationContext
to do it.
initApplicationContext
in class ApplicationObjectSupport
ApplicationContextException
- in case of initialization errorsApplicationObjectSupport.setApplicationContext(org.springframework.context.ApplicationContext)
protected final TransformerFactory getTransformerFactory()
protected final void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception
AbstractView
The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.
renderMergedOutputModel
in class AbstractView
model
- combined output Map (never null
),
with dynamic values taking precedence over static attributesrequest
- current HTTP requestresponse
- current HTTP response
Exception
- if rendering failedprotected Source createXsltSource(Map model, String root, HttpServletRequest request, HttpServletResponse response) throws Exception
Source
to transform.
model
- the model Maproot
- name for root element. This can be supplied as a bean property
to concrete subclasses within the view definition file, but will be overridden
in the case of a single object in the model map to be the key for that object.
If no root property is specified and multiple model objects exist, a default
root tag name will be supplied.request
- HTTP request. Subclasses won't normally use this, as
request processing should have been complete. However, we might want to
create a RequestContext to expose as part of the model.response
- HTTP response. Subclasses won't normally use this,
however there may sometimes be a need to set cookies.
Exception
- if an error occursprotected void doTransform(Map model, Source source, HttpServletRequest request, HttpServletResponse response) throws Exception
The default implementation delegates to the
doTransform(javax.xml.transform.Source, java.util.Map, javax.xml.transform.Result, String)
method, building a StreamResult for the ServletResponse OutputStream
or for the ServletResponse Writer (according to useWriter()
).
model
- the model Mapsource
- the Source to transformrequest
- current HTTP requestresponse
- current HTTP response
Exception
- if an error occursStreamResult
,
ServletResponse.getOutputStream()
,
ServletResponse.getWriter()
,
useWriter()
protected Map getParameters(Map model, HttpServletRequest request)
Subclasses can override this method in order to apply one or more parameters to the transformation process.
The default implementation delegates to the
getParameters(HttpServletRequest)
variant.
model
- the model Maprequest
- current HTTP request
getParameters()
,
Transformer.setParameter(java.lang.String, java.lang.Object)
protected Map getParameters(HttpServletRequest request)
Subclasses can override this method in order to apply one or more parameters to the transformation process.
The default implementation delegates to the simple
getParameters()
variant.
request
- current HTTP request
getParameters(Map, HttpServletRequest)
,
Transformer.setParameter(java.lang.String, java.lang.Object)
protected Map getParameters()
getParameters(HttpServletRequest)
variant
protected boolean useWriter()
java.io.Writer
to write text content
to the HTTP response. Else, a java.io.OutputStream
will be used,
to write binary content to the response.
The default implementation returns false
, indicating a
a java.io.OutputStream
.
true
) or an OutputStream
(false
)ServletResponse.getWriter()
,
ServletResponse.getOutputStream()
protected void doTransform(Source source, Map parameters, Result result, String encoding) throws Exception
source
- the Source to transformparameters
- a Map of parameters to be applied to the stylesheet
(as determined by getParameters(Map, HttpServletRequest)
)result
- the result to write toencoding
- the preferred character encoding that the underlying Transformer should use
Exception
- if an error occursprotected Transformer buildTransformer(Map parameters) throws TransformerConfigurationException
parameters
- a Map of parameters to be applied to the stylesheet
(as determined by getParameters(Map, HttpServletRequest)
)
null
)
TransformerConfigurationException
- if the Transformer object
could not be builtprotected Templates getTemplates() throws TransformerConfigurationException
Subclasses may override this method e.g. in order to refresh
the Templates instance, calling resetCachedTemplates()
before delegating to this getTemplates()
implementation.
null
if there is
no stylesheet specified)
TransformerConfigurationException
- if the Templates object
could not be builtsetStylesheetLocation(org.springframework.core.io.Resource)
,
setCache(boolean)
,
resetCachedTemplates()
protected void applyTransformerParameters(Map parameters, Transformer transformer)
parameters
- the transformer parameters
(as determined by getParameters(Map, HttpServletRequest)
)transformer
- the Transformer to aply the parametersprotected Source getStylesheetSource(Resource stylesheetLocation) throws ApplicationContextException
stylesheetLocation
- the stylesheet resource to be loaded
ApplicationContextException
- if the stylesheet resource could not be loaded
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |