AbstractExcelView

Class Overview

Convenient superclass for Excel document views. Compatible with Apache POI 3.0 as well as 3.5, as of Spring 3.0.

Properties:

• url (optional): The url of an existing Excel document to pick as a starting point. It is done without localization part nor the ".xls" extension.

The file will be searched with locations in the following order:

• [url]_[language]_[country].xls
• [url]_[language].xls
• [url].xls

For working with the workbook in the subclass, see Jakarta's POI site

As an example, you can try this snippet:

 protected void buildExcelDocument(
     Map<String, Object> model, HSSFWorkbook workbook,
     HttpServletRequest request, HttpServletResponse response) {

   // Go to the first sheet.
   // getSheetAt: only if workbook is created from an existing document
 	 // HSSFSheet sheet = workbook.getSheetAt(0);
 	 HSSFSheet sheet = workbook.createSheet("Spring");
 	 sheet.setDefaultColumnWidth(12);

   // Write a text at A1.
   HSSFCell cell = getCell(sheet, 0, 0);
   setText(cell, "Spring POI test");

   // Write the current date at A2.
   HSSFCellStyle dateStyle = workbook.createCellStyle();
   dateStyle.setDataFormat(HSSFDataFormat.getBuiltinFormat("m/d/yy"));
   cell = getCell(sheet, 1, 0);
   cell.setCellValue(new Date());
   cell.setCellStyle(dateStyle);

   // Write a number at A3
   getCell(sheet, 2, 0).setCellValue(458);

   // Write a range of numbers.
   HSSFRow sheetRow = sheet.createRow(3);
   for (short i = 0; i < 10; i++) {
     sheetRow.createCell(i).setCellValue(i * 10);
   }
 }

Summary

[Expand] Inherited Constants
From class org.springframework.web.servlet.view.AbstractView String DEFAULT_CONTENT_TYPE Default content type.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses
From interface org.springframework.web.servlet.View public static final String RESPONSE_STATUS_ATTRIBUTE Name of the HttpServletRequest attribute that contains the response status code.

[Expand] Inherited Methods
From class org.springframework.web.servlet.view.AbstractView void addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view. RequestContext createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name. ByteArrayOutputStream createTemporaryOutputStream() Create a temporary OutputStream for this view. void exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes. boolean generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files). Map<String, Object> getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries. String getBeanName() Return the view's name. String getContentType() Return the content type for this view. String getRequestContextAttribute() Return the name of the RequestContext attribute, if any. Map getStaticAttributes() Return the static attributes for this view. void prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering. void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary. abstract void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view. void setAttributes(Properties attributes) Set static attributes for this view from a java.util.Properties object. void setAttributesCSV(String propString) Set static attributes as a CSV string. void setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map. void setBeanName(String beanName) Set the view's name. void setContentType(String contentType) Set the content type for this view. void setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view. String toString() void writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.
From class org.springframework.web.context.support.WebApplicationObjectSupport final ServletContext getServletContext() Return the current ServletContext. final File getTempDir() Return the temporary directory for the current web application, as provided by the servlet container. final WebApplicationContext getWebApplicationContext() Return the current application context as WebApplicationContext. void initApplicationContext(ApplicationContext context) Calls initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext. void initServletContext(ServletContext servletContext) Subclasses may override this for custom initialization based on the ServletContext that this application object runs in. boolean isContextRequired() Overrides the base class behavior to enforce running in an ApplicationContext. final void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. final MessageSourceAccessor getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access. void initApplicationContext() Subclasses can override this for custom initialization behavior. void initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior. boolean isContextRequired() Determine whether this application object needs to run in an ApplicationContext. Class requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.BeanNameAware abstract void setBeanName(String name) Set the name of the bean in the bean factory that created this bean.
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.View abstract String getContentType() Return the content type of the view, if predetermined. abstract void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Render the view given the specified model.