Class AbstractXlsView

All Implemented Interfaces:
Aware, BeanNameAware, ApplicationContextAware, ServletContextAware, View
Direct Known Subclasses:

public abstract class AbstractXlsView extends AbstractView
Convenient superclass for Excel document views in traditional XLS format. Compatible with Apache POI 3.5 and higher.

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

Juergen Hoeller
  • Constructor Details

    • AbstractXlsView

      public AbstractXlsView()
      Default Constructor. Sets the content type of the view to "application/".
  • Method Details

    • generatesDownloadContent

      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:
    • renderMergedOutputModel

      protected final void renderMergedOutputModel(Map<String,Object> model, HttpServletRequest request, HttpServletResponse response) throws 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
      Exception - if rendering failed
    • createWorkbook

      protected createWorkbook(Map<String,Object> model, HttpServletRequest request)
      Template method for creating the POI Workbook instance.

      The default implementation creates a traditional HSSFWorkbook. Spring-provided subclasses are overriding this for the OOXML-based variants; custom subclasses may override this for reading a workbook from a file.

      model - the model Map
      request - current HTTP request (for taking the URL or headers into account)
      the new Workbook instance
    • renderWorkbook

      protected void renderWorkbook( workbook, HttpServletResponse response) throws IOException
      The actual render step: taking the POI Workbook and rendering it to the given response.
      workbook - the POI Workbook to render
      response - current HTTP response
      IOException - when thrown by I/O methods that we're delegating to
    • buildExcelDocument

      protected abstract void buildExcelDocument(Map<String,Object> model, workbook, HttpServletRequest request, HttpServletResponse response) throws Exception
      Application-provided subclasses must implement this method to populate the Excel workbook document, given the model.
      model - the model Map
      workbook - the Excel workbook to populate
      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.