org.sentilo.web.catalog.view.ExcelBuilder.java Source code

Introduction

Here is the source code for org.sentilo.web.catalog.view.ExcelBuilder.java

Source

/*
 * Sentilo
 * 
 * Copyright (C) 2013 Institut Municipal dInformtica, Ajuntament de Barcelona.
 * 
 * This program is licensed and may be used, modified and redistributed under the terms of the
 * European Public License (EUPL), either version 1.1 or (at your option) any later version as soon
 * as they are approved by the European Commission.
 * 
 * Alternatively, you may redistribute and/or modify this program under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied.
 * 
 * See the licenses for the specific language governing permissions, limitations and more details.
 * 
 * You should have received a copy of the EUPL1.1 and the LGPLv3 licenses along with this program;
 * if not, you may find them at:
 * 
 * https://joinup.ec.europa.eu/software/page/eupl/licence-eupl http://www.gnu.org/licenses/ and
 * https://www.gnu.org/licenses/lgpl.txt
 */
package org.sentilo.web.catalog.view;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.hssf.util.HSSFCellUtil;
import org.apache.poi.ss.usermodel.Font;
import org.sentilo.web.catalog.utils.Constants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.view.document.AbstractExcelView;

@Component
public class ExcelBuilder extends AbstractExcelView {

    @Autowired
    private MessageSource messageSource;

    @SuppressWarnings("unchecked")
    @Override
    protected void buildExcelDocument(final Map<String, Object> model, final HSSFWorkbook workbook,
            final HttpServletRequest request, final HttpServletResponse response) throws Exception {

        final List<List<String>> resourceList = (List<List<String>>) model.get(Constants.RESULT_LIST);
        final List<String> columnsKeys = buildColumnKeys(model);

        final boolean ignoreFirstValue = (!CollectionUtils.isEmpty(resourceList)
                && columnsKeys.size() != resourceList.get(0).size());

        final HSSFSheet sheet = workbook.createSheet("list");

        final HSSFRow header = sheet.createRow(0);
        final HSSFCellStyle style = workbook.createCellStyle();
        final HSSFFont font = workbook.createFont();
        font.setBoldweight(Font.BOLDWEIGHT_BOLD);
        style.setFont(font);
        // Call method to put the Column names Headers
        getHeaderExcel(header, style, columnsKeys);
        int i = 0;
        for (final List<String> rowValues : resourceList) {
            final HSSFRow row = sheet.createRow(++i);
            // put the content in the rows
            toExcelRow(rowValues, row, sheet, ignoreFirstValue);
        }

        for (int j = 0; j <= columnsKeys.size(); j++) {
            sheet.autoSizeColumn(j);
        }
    }

    private void toExcelRow(final List<String> rowValues, final HSSFRow row, final HSSFSheet sheet,
            final boolean ignoreFirstValue) {
        int column = 0;
        for (int i = (ignoreFirstValue ? 1 : 0); i < rowValues.size(); i++) {
            final String value = rowValues.get(i);
            HSSFCellUtil.createCell(row, column++, cleanLabelwrapper(value));
        }
    }

    private String cleanLabelwrapper(final String value) {
        // Some values are HTML <span> content so before we add them into the cell this HTML code must
        // be removed
        String cleanValue = StringUtils.hasText(value) ? value : "";

        if (StringUtils.hasText(cleanValue) && value.endsWith("</span>")) {
            final int begin = cleanValue.indexOf(">");
            final int end = cleanValue.lastIndexOf("<");
            cleanValue = cleanValue.substring(begin + 1, end);
        }

        return cleanValue;
    }

    @SuppressWarnings("unchecked")
    private List<String> buildColumnKeys(final Map<String, Object> model) {
        final List<String> columnKeys = new ArrayList<String>();
        final List<String> columKeySuffixes = (List<String>) model.get(Constants.LIST_COLUMN_NAMES);
        final String keysPreffix = (String) model.get(Constants.MESSAGE_KEYS_PREFFIX);

        Assert.hasLength(keysPreffix, "Message keys preffix must not be empty");

        for (final String columnKeySuffix : columKeySuffixes) {
            columnKeys.add(keysPreffix + Constants.DEFAULT_KEY_TOKEN_SPLITTER + columnKeySuffix);
        }

        return columnKeys;
    }

    private void getHeaderExcel(final HSSFRow header, final HSSFCellStyle style, final List<String> columnsKeys) {
        int i = 0;
        final Locale locale = LocaleContextHolder.getLocale();
        for (final String columnKey : columnsKeys) {
            final HSSFCell cellHeader = header.createCell(i++);
            cellHeader.setCellStyle(style);
            cellHeader.setCellValue(messageSource.getMessage(columnKey, null, locale).toUpperCase(locale));
        }
    }
}