com.whaleal.icefrog.poi.word.TableUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefrog-poi Show documentation
icefrog POI工具类（对MS Office操作）
The newest version!
package com.whaleal.icefrog.poi.word;

import com.whaleal.icefrog.core.bean.BeanUtil;
import com.whaleal.icefrog.core.collection.CollUtil;
import com.whaleal.icefrog.core.collection.IterUtil;
import com.whaleal.icefrog.core.convert.Convert;
import com.whaleal.icefrog.core.lang.Precondition;
import com.whaleal.icefrog.core.map.MapUtil;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFTable;
import org.apache.poi.xwpf.usermodel.XWPFTableCell;
import org.apache.poi.xwpf.usermodel.XWPFTableRow;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Word中表格相关工具
 *
 * @author Looly
 * @author wh
 * @since 1.0.0
 */
public class TableUtil {

    /**
     * 创建空表，只有一行
     *
     * @param doc {@link XWPFDocument}
     * @return {@link XWPFTable}
     */
    public static XWPFTable createTable( XWPFDocument doc ) {
        return createTable(doc, null);
    }

    /**
     * 创建表格并填充数据，默认表格
     *
     * @param doc  {@link XWPFDocument}
     * @param data 数据
     * @return {@link XWPFTable}
     */
    public static XWPFTable createTable( XWPFDocument doc, Iterable data ) {
        Precondition.notNull(doc, "XWPFDocument must be not null !");
        final XWPFTable table = doc.createTable();
        // 新建table的时候默认会新建一行，此处移除之
        table.removeRow(0);
        return writeTable(table, data);
    }

    /**
     * 为table填充数据
     *
     * @param table {@link XWPFTable}
     * @param data  数据
     * @return {@link XWPFTable}
     * @since 1.0.0
     */
    public static XWPFTable writeTable( XWPFTable table, Iterable data ) {
        Precondition.notNull(table, "XWPFTable must be not null !");
        if (IterUtil.isEmpty(data)) {
            // 数据为空，返回空表
            return table;
        }

        boolean isFirst = true;
        for (Object rowData : data) {
            writeRow(table.createRow(), rowData, isFirst);
            if (isFirst) {
                isFirst = false;
            }
        }

        return table;
    }

    /**
     * 写一行数据
     *
     * @param row              行
     * @param rowBean          行数据
     * @param isWriteKeyAsHead 如果为Map或者Bean，是否写标题
     */
    @SuppressWarnings("rawtypes")
    public static void writeRow( XWPFTableRow row, Object rowBean, boolean isWriteKeyAsHead ) {
        if (rowBean instanceof Iterable) {
            writeRow(row, (Iterable) rowBean);
            return;
        }

        Map rowMap;
        if (rowBean instanceof Map) {
            rowMap = (Map) rowBean;
        } else if (BeanUtil.isBean(rowBean.getClass())) {
            rowMap = BeanUtil.beanToMap(rowBean, new LinkedHashMap<>(), false, false);
        } else {
            // 其它转为字符串默认输出
            writeRow(row, CollUtil.newArrayList(rowBean), isWriteKeyAsHead);
            return;
        }

        writeRow(row, rowMap, isWriteKeyAsHead);
    }

    /**
     * 写行数据
     *
     * @param row              行
     * @param rowMap           行数据
     * @param isWriteKeyAsHead 是否写标题
     */
    public static void writeRow( XWPFTableRow row, Map rowMap, boolean isWriteKeyAsHead ) {
        if (MapUtil.isEmpty(rowMap)) {
            return;
        }

        if (isWriteKeyAsHead) {
            writeRow(row, rowMap.keySet());
            row = row.getTable().createRow();
        }
        writeRow(row, rowMap.values());
    }

    /**
     * 写行数据
     *
     * @param row     行
     * @param rowData 行数据
     */
    public static void writeRow( XWPFTableRow row, Iterable rowData ) {
        XWPFTableCell cell;
        int index = 0;
        for (Object cellData : rowData) {
            cell = getOrCreateCell(row, index);
            cell.setText(Convert.toStr(cellData));
            index++;
        }
    }

    /**
     * 获取或创建新行

     * 存在则直接返回，不存在创建新的行
     *
     * @param table {@link XWPFTable}
     * @param index 索引（行号），从0开始
     * @return {@link XWPFTableRow}
     */
    public static XWPFTableRow getOrCreateRow( XWPFTable table, int index ) {
        XWPFTableRow row = table.getRow(index);
        if (null == row) {
            row = table.createRow();
        }

        return row;
    }

    /**
     * 获取或创建新单元格

     * 存在则直接返回，不存在创建新的单元格
     *
     * @param row   {@link XWPFTableRow} 行
     * @param index index 索引（列号），从0开始
     * @return {@link XWPFTableCell}
     */
    public static XWPFTableCell getOrCreateCell( XWPFTableRow row, int index ) {
        XWPFTableCell cell = row.getCell(index);
        if (null == cell) {
            cell = row.createCell();
        }
        return cell;
    }
}