org.sakaiproject.jsf.spreadsheet.SpreadsheetDataFileWriterXls Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsf-spreadsheet Show documentation

This provides some utility classes to support downloading of spreadsheet-style data as an XLS or CSV file. It has been broken out into its own artifact to avoid adding a POI dependency to the standard Sakai JSF components JAR.

There is a newer version: 23.3

Show newest version

/**********************************************************************************
*
* $Id$
*
***********************************************************************************
*
 * Copyright (c) 2007, 2008 The Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.opensource.org/licenses/ECL-2.0
 *
 * 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 License for the specific language governing permissions and
 * limitations under the License.
*
**********************************************************************************/

package org.sakaiproject.jsf.spreadsheet;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Iterator;
import java.util.List;

import javax.servlet.http.HttpServletResponse;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
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.HSSFColor;

import org.sakaiproject.component.cover.ServerConfigurationService;

/**
 *
 */
public class SpreadsheetDataFileWriterXls implements SpreadsheetDataFileWriter {
	private static final Log log = LogFactory.getLog(SpreadsheetDataFileWriter.class);

	public void writeDataToResponse(List> spreadsheetData, String fileName, HttpServletResponse response) {
		response.setContentType("application/vnd.ms-excel");
		SpreadsheetUtil.setEscapedAttachmentHeader(response, fileName + ".xls");

		OutputStream out = null;
		try {
			out = response.getOutputStream();
			getAsWorkbook(spreadsheetData).write(out);
			out.flush();
		} catch (IOException e) {
			if (log.isErrorEnabled()) log.error(e);
		} finally {
			try {
				if (out != null) out.close();
			} catch (IOException e) {
				if (log.isErrorEnabled()) log.error(e);
			}
		}
	}
	
	private HSSFWorkbook getAsWorkbook(List> spreadsheetData) {
		HSSFWorkbook wb = new HSSFWorkbook();
		HSSFSheet sheet = wb.createSheet();
		HSSFCellStyle headerCs = wb.createCellStyle();
		Iterator> dataIter = spreadsheetData.iterator();
		
		// Set the header style
		headerCs.setBorderBottom(HSSFCellStyle.BORDER_THIN);
		headerCs.setFillBackgroundColor(HSSFColor.BLUE_GREY.index);

		// Set the font
		HSSFCellStyle cellStyle = null;
		String fontName = ServerConfigurationService.getString("spreadsheet.font");
		if (fontName != null) {
			HSSFFont font = wb.createFont();
			font.setFontName(fontName);
			headerCs.setFont(font);
			cellStyle = wb.createCellStyle();
			cellStyle.setFont(font);
		}

		// By convention, the first list in the list contains column headers.
		HSSFRow headerRow = sheet.createRow((short)0);
		List