Package org.springframework.web.servlet.view.document

Class AbstractExcelView

  • All Implemented Interfaces:
    Aware, BeanNameAware, ApplicationContextAware, ServletContextAware, View
    @Deprecated
public abstract class AbstractExcelView
extends AbstractView
    Deprecated.
    as of Spring 4.2, in favor of AbstractXlsView and its AbstractXlsxView and AbstractXlsxStreamingView variants
    Convenient superclass for Excel document views. Compatible with Apache POI 3.5 and higher, as of Spring 4.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 Apache'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);
   }
 }
    This class is similar to the AbstractPdfView class in usage style.
    Author:
    Jean-Pierre Pawlak, Juergen Hoeller
    See Also:
    AbstractPdfView

    • Constructor Detail

      • AbstractExcelView

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

    • Method Detail

      • setUrl

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

      • getTemplateSource

        protected org.apache.poi.hssf.usermodel.HSSFWorkbook getTemplateSource​(String url,
                                                                       HttpServletRequest request)
                                                                throws Exception
        Deprecated.
        Creates the workbook from an existing XLS document.
        Parameters:
        url - the URL of the Excel template without localization part nor extension
        request - current HTTP request
        Returns:
        the HSSFWorkbook
        Throws:
        Exception - in case of failure

      • buildExcelDocument

        protected abstract void buildExcelDocument​(Map<String,​Object> model,
                                           org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                                           HttpServletRequest request,
                                           HttpServletResponse response)
                                    throws Exception
        Deprecated.
        Subclasses must implement this method to create an Excel HSSFWorkbook document, given the model.
        Parameters:
        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.
        Throws:
        Exception

      • getCell

        protected org.apache.poi.hssf.usermodel.HSSFCell getCell​(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                                                         int row,
                                                         int col)
        Deprecated.
        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.

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

      • setText

        protected void setText​(org.apache.poi.hssf.usermodel.HSSFCell cell,
                       String text)
        Deprecated.
        Convenient method to set a String as text content in a cell.
        Parameters:
        cell - the cell in which the text must be put
        text - the text to put in the cell