com.feilong.excel.writer.SheetWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-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 com.feilong.excel.writer;

import static com.feilong.core.date.DateUtil.formatDuration;
import static com.feilong.core.lang.ObjectUtil.defaultIfNullOrEmpty;
import static com.feilong.core.lang.StringUtil.EMPTY;
import static com.feilong.excel.util.CellReferenceUtil.getCellRef;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellRangeAddress;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.feilong.excel.definition.ExcelBlock;
import com.feilong.excel.definition.ExcelSheet;
import com.feilong.json.JsonUtil;
import com.feilong.lib.excel.ognl.OgnlStack;

class SheetWriter{

    /** The Constant log. */
    private static final Logger LOGGER     = LoggerFactory.getLogger(SheetWriter.class);

    private static final String SHEET_NAME = "sheetName";
    //---------------------------------------------------------------

    /** Don't let anyone instantiate this class. */
    private SheetWriter(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------

    public static void write(Sheet sheet,ExcelSheet excelSheet,Map styleMap,Object ognlData){
        Date beginDate = new Date();

        OgnlStack ognlStack = new OgnlStack(ognlData);
        setSheetName(sheet, excelSheet, ognlStack);
        //---------------------------------------------------------------
        List sortedExcelBlocks = excelSheet.getSortedExcelBlocks();
        Map> mergedRegionsMap = buildMergedRegions(sheet, sortedExcelBlocks);
        //---------------------------------------------------------------
        for (ExcelBlock excelBlock : sortedExcelBlocks){
            write(sheet, excelSheet, excelBlock, styleMap, mergedRegionsMap, ognlStack);
        }
        //---------------------------------------------------------------
        if (LOGGER.isDebugEnabled()){
            LOGGER.debug("writeSheet:[{}], use time: [{}]", excelSheet.getName(), formatDuration(beginDate));
        }
    }

    private static void write(
                    Sheet sheet,
                    ExcelSheet excelSheet,
                    ExcelBlock excelBlock,

                    Map styleMap,
                    Map> mergedRegionsMap,
                    OgnlStack ognlStack){
        if (LOGGER.isDebugEnabled()){
            LOGGER.debug("excelBlock:{}", JsonUtil.format(excelBlock));
        }
        //---------------------------------------------------------------
        Date blockBeginDate = new Date();
        //循环
        if (excelBlock.isLoop()){
            List cellRangeAddressList = mergedRegionsMap.get(excelBlock);
            boolean isHorizontal = excelBlock.getDirection().equalsIgnoreCase(ExcelBlock.LOOP_DIRECTION_HORIZONAL);
            if (isHorizontal){
                BlockLoopHorizontalWriter.write(sheet, excelBlock, ognlStack, cellRangeAddressList, styleMap);
            }else{
                BlockLoopVerticalWriter.write(sheet, excelBlock, ognlStack, cellRangeAddressList, styleMap);
            }
        }else{
            BlockSimpleWriter.write(sheet, excelBlock, ognlStack, styleMap);
        }
        //---------------------------------------------------------------
        if (LOGGER.isDebugEnabled()){
            String pattern = "write sheet block:[{}]-[{}], use time: [{}]";
            LOGGER.debug(pattern, excelSheet.getName(), excelBlock.getDataName(), formatDuration(blockBeginDate));
        }
    }

    private static Map> buildMergedRegions(Sheet sheet,List sortedExcelBlocks){
        int numMergedRegions = sheet.getNumMergedRegions();

        Map> mergedRegions = new HashMap<>();
        for (int i = 0; i < numMergedRegions; i++){
            CellRangeAddress cellRangeAddress = sheet.getMergedRegion(i);
            int firstRow = cellRangeAddress.getFirstRow();
            int firstColumn = cellRangeAddress.getFirstColumn();

            int lastRow = cellRangeAddress.getLastRow();
            int lastColumn = cellRangeAddress.getLastColumn();

            //---------------------------------------------------------------
            if (LOGGER.isTraceEnabled()){
                LOGGER.trace("Merged Region:[{}-{}]", getCellRef(firstRow, firstColumn), getCellRef(lastRow, lastColumn));
            }

            //---------------------------------------------------------------
            for (ExcelBlock blockDefinition : sortedExcelBlocks){
                int startRow = blockDefinition.getStartRow();
                int endRow = blockDefinition.getEndRow();
                int startCol = blockDefinition.getStartCol();
                int endCol = blockDefinition.getEndCol();

                if (firstRow >= startRow && firstColumn >= startCol && lastRow <= endRow && lastColumn <= endCol){
                    List cellRangeAddressList = mergedRegions.get(blockDefinition);
                    if (cellRangeAddressList == null){
                        cellRangeAddressList = new ArrayList<>();
                        mergedRegions.put(blockDefinition, cellRangeAddressList);
                    }
                    cellRangeAddressList.add(cellRangeAddress);
                }
            }
        }
        return mergedRegions;
    }

    private static void setSheetName(Sheet sheet,ExcelSheet excelSheet,OgnlStack ognlStack){
        String sheetName = getSheetName(excelSheet, ognlStack);
        if (sheetName != null){
            Workbook workbook = sheet.getWorkbook();
            int sheetIndex = workbook.getSheetIndex(sheet);

            LOGGER.debug("set workbook sheet:[{}] name:[{}]", sheetIndex, sheetName);
            workbook.setSheetName(sheetIndex, sheetName);
        }
    }

    private static String getSheetName(ExcelSheet excelSheet,OgnlStack ognlStack){
        String sheetNameStack = defaultIfNullOrEmpty(//
                        (String) ognlStack.getValue(SHEET_NAME),
                        EMPTY);
        String sheetDisplayName = excelSheet.getDisplayName();

        LOGGER.debug("excelSheet DisplayName:[{}],stack value:[{}]", sheetDisplayName, sheetNameStack);
        return defaultIfNullOrEmpty(sheetNameStack, sheetDisplayName);
    }
}