devutility.external.poi.PoiUtils 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;

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

import org.apache.poi.EncryptedDocumentException;
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 devutility.external.poi.common.ExcelType;
import devutility.external.poi.model.ColumnFieldMap;
import devutility.external.poi.model.RowStyle;
import devutility.external.poi.utils.ExcelUtils;
import devutility.external.poi.utils.SheetUtils;
import devutility.external.poi.utils.WorkbookUtils;
import devutility.internal.util.CollectionUtils;

/**
 * 
 * PoiUtils
 * 
 * @author: Aldwin Su
 * @version: 2019-09-12 23:02:06
 */
public class PoiUtils {
	/**
	 * Read data from file and convert data to List (Type T).
	 * @param filePath Excel file path.
	 * @param sheetName Sheet name in Excel file.
	 * @param clazz Class object.
	 * @return {@code List}
	 * @throws IOException from WorkbookUtils.load or workbook.close methods.
	 * @throws InvalidFormatException from WorkbookUtils.load method.
	 * @throws EncryptedDocumentException from WorkbookUtils.load method.
	 * @throws ReflectiveOperationException from SheetUtils.toList method.
	 */
	public static  List read(String filePath, String sheetName, Class clazz) throws EncryptedDocumentException, InvalidFormatException, IOException, ReflectiveOperationException {
		Workbook workbook = WorkbookUtils.load(filePath);
		Sheet sheet = SheetUtils.get(workbook, sheetName);
		List list = SheetUtils.toList(sheet, new ColumnFieldMap(clazz), clazz);
		workbook.close();
		return list;
	}

	/**
	 * Read data from InputStream and convert data to List (Type T).
	 * @param inputStream InputStream for Excel file.
	 * @param sheetName Sheet name in Excel file.
	 * @param clazz: Class object.
	 * @return {@code List}
	 * @throws IOException from WorkbookFactory.create or workbook.close methods.
	 * @throws EncryptedDocumentException from WorkbookFactory.create method.
	 * @throws ReflectiveOperationException from SheetUtils.toList method.
	 */
	public static  List read(InputStream inputStream, String sheetName, Class clazz) throws EncryptedDocumentException, IOException, ReflectiveOperationException {
		Workbook workbook = WorkbookFactory.create(inputStream);
		Sheet sheet = SheetUtils.get(workbook, sheetName);
		List list = SheetUtils.toList(sheet, new ColumnFieldMap(clazz), clazz);
		workbook.close();
		return list;
	}

	/**
	 * Append list data into template Excel file and save them into OutputStream object.
	 * @param templateInputStream InputStream for template.
	 * @param sheetName Sheet name in template and will in outputStream.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @param outputStream OutputStream object that receive list data.
	 * @throws IOException from WorkbookUtils.save, workbook.write or workbook.close methods.
	 * @throws InvocationTargetException from WorkbookUtils.save method.
	 * @throws IllegalArgumentException from WorkbookUtils.save method.
	 * @throws IllegalAccessException from WorkbookUtils.save method.
	 * @throws EncryptedDocumentException from WorkbookUtils.save method.
	 */
	public static  void save(InputStream templateInputStream, String sheetName, List list, RowStyle rowStyle, OutputStream outputStream)
			throws EncryptedDocumentException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		if (CollectionUtils.isNullOrEmpty(list)) {
			return;
		}

		Class clazz = list.get(0).getClass();
		ColumnFieldMap columnFieldMap = new ColumnFieldMap(clazz);
		Workbook workbook = WorkbookUtils.save(templateInputStream, sheetName, columnFieldMap, list, rowStyle);
		workbook.write(outputStream);
		workbook.close();
	}

	/**
	 * Append list data into template Excel file and save them into OutputStream object.
	 * @param templateInputStream InputStream for template.
	 * @param sheetName Sheet name in template and will in outputStream.
	 * @param list {@code List} object.
	 * @param outputStream OutputStream object that receive list data.
	 * @throws IOException from save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 * @throws EncryptedDocumentException from save method.
	 */
	public static  void save(InputStream templateInputStream, String sheetName, List list, OutputStream outputStream) throws EncryptedDocumentException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		save(templateInputStream, sheetName, list, null, outputStream);
	}

	/**
	 * Create a new Excel file with specific template, sheet name and file path, save list data into it.
	 * @param templateInputStream InputStream for template.
	 * @param sheetName Sheet name in template and will in output Excel file.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @param filePath File path for new Excel file.
	 * @throws IOException from FileOutputStream constructor or save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 * @throws EncryptedDocumentException from save method.
	 */
	public static  void save(InputStream templateInputStream, String sheetName, List list, RowStyle rowStyle, String filePath) throws EncryptedDocumentException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		FileOutputStream outputStream = new FileOutputStream(filePath, false);
		save(templateInputStream, sheetName, list, rowStyle, outputStream);
	}

	/**
	 * Create a new Excel file with specific template, sheet name and file path, save list data into it.
	 * @param templateInputStream InputStream for template.
	 * @param sheetName Sheet name in template and will in output Excel file.
	 * @param list {@code List} object.
	 * @param filePath File path for new Excel file.
	 * @throws IOException from save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 * @throws EncryptedDocumentException from save method.
	 */
	public static  void save(InputStream templateInputStream, String sheetName, List list, String filePath) throws EncryptedDocumentException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		save(templateInputStream, sheetName, list, null, filePath);
	}

	/**
	 * Save the list data into specific OutputStream.
	 * @param excelType ExcelType object.
	 * @param sheetName Sheet name in outputStream.
	 * @param list {@code List} object.
	 * @param outputStream OutputStream object that receive list data.
	 * @throws InvocationTargetException from WorkbookUtils.save method.
	 * @throws IllegalArgumentException from WorkbookUtils.save method.
	 * @throws IllegalAccessException from WorkbookUtils.save method.
	 * @throws IOException from workbook.write or workbook.close methods.
	 */
	public static  void save(ExcelType excelType, String sheetName, List list, OutputStream outputStream) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		if (CollectionUtils.isNullOrEmpty(list)) {
			return;
		}

		Class clazz = list.get(0).getClass();
		ColumnFieldMap columnFieldMap = new ColumnFieldMap(clazz);
		Workbook workbook = WorkbookUtils.save(excelType, sheetName, columnFieldMap, list);
		workbook.write(outputStream);
		workbook.close();
	}

	/**
	 * Save the list data into specific OutputStream.
	 * @param excelType ExcelType object.
	 * @param list {@code List} object.
	 * @param outputStream OutputStream object that receive list data.
	 * @throws IOException from save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 */
	public static  void save(ExcelType excelType, List list, OutputStream outputStream) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		String sheetName = SheetUtils.getName(1);
		save(excelType, sheetName, list, outputStream);
	}

	/**
	 * Create a new Excel file with specific excelType, sheet name and file path, save list data into it.
	 * @param sheetName Sheet name.
	 * @param list {@code List} object.
	 * @param filePath File path for new Excel file.
	 * @throws IOException from FileOutputStream constructor or save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 */
	public static  void save(String sheetName, List list, String filePath) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		FileOutputStream outputStream = new FileOutputStream(filePath, false);
		ExcelType excelType = ExcelUtils.getExcelType(filePath);
		save(excelType, sheetName, list, outputStream);
	}

	/**
	 * Create a new Excel file with specific excelType and file path, save list data into it.
	 * @param list {@code List} object.
	 * @param filePath File path for new Excel file.
	 * @throws IOException from save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 */
	public static  void save(List list, String filePath) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		String sheetName = SheetUtils.getName(1);
		save(sheetName, list, filePath);
	}

	/**
	 * Append list data into template Excel file and save them into OutputStream object.
	 * @param templateWorkbook Workbook for template, need to be closed after used.
	 * @param sheetName Sheet name in template and will in outputStream.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @param outputStream OutputStream object that receive list data.
	 * @throws InvocationTargetException from WorkbookUtils.save method.
	 * @throws IllegalArgumentException from WorkbookUtils.save method.
	 * @throws IllegalAccessException from WorkbookUtils.save method.
	 * @throws IOException from workbook.write method.
	 */
	public static  void save(Workbook templateWorkbook, String sheetName, List list, RowStyle rowStyle, OutputStream outputStream) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		if (CollectionUtils.isNullOrEmpty(list)) {
			return;
		}

		Class clazz = list.get(0).getClass();
		ColumnFieldMap columnFieldMap = new ColumnFieldMap(clazz);
		Workbook workbook = WorkbookUtils.save(templateWorkbook, sheetName, columnFieldMap, list, rowStyle);
		workbook.write(outputStream);
	}

	/**
	 * Create a new Excel file with specific template, sheet name and file path, save list data into it.
	 * @param templateWorkbook Workbook for template, need to be closed after used.
	 * @param sheetName Sheet name in template and will in output Excel file.
	 * @param list {@code List} object.
	 * @param rowStyle Style for row.
	 * @param filePath File path for new Excel file.
	 * @throws IOException from FileOutputStream constructor or save method.
	 * @throws InvocationTargetException from save method.
	 * @throws IllegalArgumentException from save method.
	 * @throws IllegalAccessException from save method.
	 */
	public static  void save(Workbook templateWorkbook, String sheetName, List list, RowStyle rowStyle, String filePath) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IOException {
		FileOutputStream outputStream = new FileOutputStream(filePath, false);
		save(templateWorkbook, sheetName, list, rowStyle, outputStream);
	}
}