devutility.external.poi.utils.WorkbookUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of devutility.external.poi Show documentation
Some utilities for Apache POI.
The newest version!
package devutility.external.poi.utils;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.util.List;

import org.apache.poi.EncryptedDocumentException;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import devutility.external.poi.common.ExcelType;
import devutility.external.poi.model.ColumnFieldMap;
import devutility.external.poi.model.RowStyle;

public class WorkbookUtils {
	/**
	 * Load excel file with file path.
	 * @param filePath Excel file path.
	 * @return Workbook object.
	 * @throws EncryptedDocumentException
	 * @throws InvalidFormatException
	 * @throws IOException
	 */
	public static Workbook load(String filePath) throws IOException, EncryptedDocumentException, InvalidFormatException {
		File file = new File(filePath);

		if (!file.exists()) {
			throw new IOException(String.format("%s cannot found!", filePath));
		}

		return WorkbookFactory.create(file);
	}

	/**
	 * Create an Workbook instance use ExcelType.
	 * @param excelType ExcelType object.
	 * @return Workbook
	 */
	public static Workbook create(ExcelType excelType) {
		if (excelType.equals(ExcelType.Excel2003)) {
			return new HSSFWorkbook();
		}

		return new XSSFWorkbook();
	}

	/**
	 * Save list data into specific sheet in template Workbook object.
	 * @param templateInputStream Template InputStream.
	 * @param sheetName Sheet name in template.
	 * @param columnFieldMap The map between Excel column index and type T field.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @return Workbook
	 * @throws IOException from WorkbookFactory.create method.
	 * @throws EncryptedDocumentException from WorkbookFactory.create method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 */
	public static  Workbook save(InputStream templateInputStream, String sheetName, ColumnFieldMap columnFieldMap, List list, RowStyle rowStyle)
			throws EncryptedDocumentException, IOException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
		Workbook templateWorkbook = WorkbookFactory.create(templateInputStream);
		return save(templateWorkbook, sheetName, columnFieldMap, list, rowStyle);
	}

	/**
	 * Save list data into specific sheet in template Workbook object.
	 * @param templateWorkbook Template Workbook object.
	 * @param sheetName Sheet name in template.
	 * @param columnFieldMap The map between Excel column index and type T field.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @return Workbook
	 * @throws InvocationTargetException from SheetUtils.append method.
	 * @throws IllegalArgumentException from SheetUtils.append method.
	 * @throws IllegalAccessException from SheetUtils.append method.
	 */
	public static  Workbook save(Workbook templateWorkbook, String sheetName, ColumnFieldMap columnFieldMap, List list, RowStyle rowStyle) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException {
		Sheet sheet = SheetUtils.get(templateWorkbook, sheetName);

		if (rowStyle == null) {
			SheetUtils.append(sheet, columnFieldMap, list);
		} else {
			SheetUtils.append(sheet, columnFieldMap, list, rowStyle);
		}

		return templateWorkbook;
	}

	/**
	 * Create a new Workbook instance with specific ExcelType and sheet name, save list data into it.
	 * @param excelType ExcelType object.
	 * @param sheetName Sheet name.
	 * @param columnFieldMap The map between Excel column index and type T field.
	 * @param list {@code List} object.
	 * @return Workbook
	 * @throws IllegalAccessException from SheetUtils.append method.
	 * @throws IllegalArgumentException from SheetUtils.append method.
	 * @throws InvocationTargetException from SheetUtils.append method.
	 */
	public static  Workbook save(ExcelType excelType, String sheetName, ColumnFieldMap columnFieldMap, List list) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException {
		Workbook workbook = WorkbookUtils.create(excelType);
		Sheet sheet = SheetUtils.create(workbook, sheetName);
		SheetUtils.append(sheet, columnFieldMap, list);
		return workbook;
	}
}