Spring Framework

Class AbstractExcelView

  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.context.support.WebApplicationObjectSupport
          extended by org.springframework.web.servlet.view.AbstractView
              extended by org.springframework.web.servlet.view.document.AbstractExcelView
All Implemented Interfaces:
Aware, BeanNameAware, ApplicationContextAware, ServletContextAware, View

public abstract class AbstractExcelView
extends AbstractView

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


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

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");

   // 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();
   cell = getCell(sheet, 1, 0);
   cell.setCellValue(new Date());

   // 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);
This class is similar to the AbstractPdfView class in usage style.

Jean-Pierre Pawlak, Juergen Hoeller
See Also:

Field Summary
Fields inherited from class org.springframework.web.servlet.view.AbstractView
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
Fields inherited from interface org.springframework.web.servlet.View
Constructor Summary
          Default Constructor.
Method Summary
protected abstract  void buildExcelDocument(java.util.Map<java.lang.String,java.lang.Object> model, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Subclasses must implement this method to create an Excel HSSFWorkbook document, given the model.
protected  boolean generatesDownloadContent()
          Return whether this view generates download content (typically binary content like PDF or Excel files).
protected  org.apache.poi.hssf.usermodel.HSSFCell getCell(org.apache.poi.hssf.usermodel.HSSFSheet sheet, int row, int col)
          Convenient method to obtain the cell in the given sheet, row and column.
protected  org.apache.poi.hssf.usermodel.HSSFWorkbook getTemplateSource(java.lang.String url, javax.servlet.http.HttpServletRequest request)
          Creates the workbook from an existing XLS document.
protected  void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Renders the Excel view, given the specified model.
protected  void setText(org.apache.poi.hssf.usermodel.HSSFCell cell, java.lang.String text)
          Convenient method to set a String as text content in a cell.
 void setUrl(java.lang.String url)
          Set the URL of the Excel workbook source, without localization part nor extension.
Methods inherited from class org.springframework.web.servlet.view.AbstractView
addStaticAttribute, createMergedOutputModel, createRequestContext, createTemporaryOutputStream, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, isExposePathVariables, prepareResponse, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposePathVariables, setRequestContextAttribute, toString, writeToResponse
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, wait, wait, wait

Constructor Detail


public AbstractExcelView()
Default Constructor. Sets the content type of the view to "application/vnd.ms-excel".

Method Detail


public void setUrl(java.lang.String url)
Set the URL of the Excel workbook source, without localization part nor extension.


protected boolean generatesDownloadContent()
Description copied from class: AbstractView
Return whether this view generates download content (typically binary content like PDF or Excel files).

The default implementation returns false. Subclasses are encouraged to return true here if they know that they are generating download content that requires temporary caching on the client side, typically via the response OutputStream.

generatesDownloadContent in class AbstractView
See Also:
AbstractView.prepareResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), ServletResponse.getOutputStream()


protected final void renderMergedOutputModel(java.util.Map<java.lang.String,java.lang.Object> model,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.lang.Exception
Renders the Excel view, given the specified model.

Specified by:
renderMergedOutputModel in class AbstractView
model - combined output Map (never null), with dynamic values taking precedence over static attributes
request - current HTTP request
response - current HTTP response
java.lang.Exception - if rendering failed


protected org.apache.poi.hssf.usermodel.HSSFWorkbook getTemplateSource(java.lang.String url,
                                                                       javax.servlet.http.HttpServletRequest request)
                                                                throws java.lang.Exception
Creates the workbook from an existing XLS document.

url - the URL of the Excel template without localization part nor extension
request - current HTTP request
the HSSFWorkbook
java.lang.Exception - in case of failure


protected abstract void buildExcelDocument(java.util.Map<java.lang.String,java.lang.Object> model,
                                           org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                    throws java.lang.Exception
Subclasses must implement this method to create an Excel HSSFWorkbook document, given the model.

model - the model Map
workbook - the Excel workbook to complete
request - in case we need locale etc. Shouldn't look at attributes.
response - in case we need to set cookies. Shouldn't write to it.


protected org.apache.poi.hssf.usermodel.HSSFCell getCell(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                                                         int row,
                                                         int col)
Convenient method to obtain the cell in the given sheet, row and column.

Creates the row and the cell if they still doesn't already exist. Thus, the column can be passed as an int, the method making the needed downcasts.

sheet - a sheet object. The first sheet is usually obtained by workbook.getSheetAt(0)
row - thr row number
col - the column number
the HSSFCell


protected void setText(org.apache.poi.hssf.usermodel.HSSFCell cell,
                       java.lang.String text)
Convenient method to set a String as text content in a cell.

cell - the cell in which the text must be put
text - the text to put in the cell

Spring Framework