com.orion.office.excel.reader.ExcelMapReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of orion-office Show documentation
orion office (excel csv and more...)
There is a newer version: 1.0.9
package com.orion.office.excel.reader;

import com.orion.lang.define.collect.MutableHashMap;
import com.orion.lang.define.collect.MutableLinkedHashMap;
import com.orion.lang.define.collect.MutableMap;
import com.orion.office.excel.Excels;
import com.orion.office.excel.option.ImportFieldOption;
import com.orion.office.excel.type.ExcelReadType;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;

import java.util.*;
import java.util.function.Consumer;

/**
 * excel map 读取器
 * 
 * 支持高级数据类型
 * 
 * {@link Excels#getCellValue(Cell, ExcelReadType, com.orion.office.excel.option.CellOption)}
 *
 * @author Jiahang Li
 * @version 1.0.0
 * @since 2021/1/5 11:52
 */
public class ExcelMapReader extends BaseExcelReader> {

    /**
     * 默认值
     * key: 列
     * value: 默认值
     */
    private final Map defaultValue;

    /**
     * 为null是否插入kay
     */
    private boolean nullPutKey;

    /**
     * 是否使用 linkedMap
     */
    private boolean linked;

    public ExcelMapReader(Workbook workbook, Sheet sheet) {
        this(workbook, sheet, new ArrayList<>(), null);
    }

    public ExcelMapReader(Workbook workbook, Sheet sheet, List> rows) {
        this(workbook, sheet, rows, null);
    }

    public ExcelMapReader(Workbook workbook, Sheet sheet, Consumer> consumer) {
        this(workbook, sheet, null, consumer);
    }

    private ExcelMapReader(Workbook workbook, Sheet sheet, List> rows, Consumer> consumer) {
        super(workbook, sheet, rows, consumer);
        this.init = false;
        this.nullPutKey = true;
        this.options = new HashMap<>();
        this.defaultValue = new HashMap<>();
    }

    public ExcelMapReader option(K key, ImportFieldOption option) {
        this.addOption(key, option, null);
        return this;
    }

    public ExcelMapReader option(K key, ImportFieldOption option, V defaultValue) {
        this.addOption(key, option, defaultValue);
        return this;
    }

    public ExcelMapReader option(int column, K key, ExcelReadType type) {
        this.addOption(key, new ImportFieldOption(column, type), null);
        return this;
    }

    /**
     * 添加配置
     *
     * @param column       列
     * @param key          key
     * @param type         类型
     * @param defaultValue 默认值
     * @return this
     */
    public ExcelMapReader option(int column, K key, ExcelReadType type, V defaultValue) {
        this.addOption(key, new ImportFieldOption(column, type), defaultValue);
        return this;
    }

    /**
     * 添加配置
     *
     * @param key          key
     * @param option       配置
     * @param defaultValue 默认值
     */
    protected void addOption(K key, ImportFieldOption option, V defaultValue) {
        super.addOption(key, option);
        // 默认值
        if (defaultValue != null) {
            this.defaultValue.put(key, defaultValue);
        }
    }

    /**
     * 设置默认值
     *
     * @param key   key
     * @param value 默认值
     * @return this
     */
    public ExcelMapReader defaultValue(K key, V value) {
        defaultValue.put(key, value);
        return this;
    }

    /**
     * 使用 linkedMap
     *
     * @return this
     */
    public ExcelMapReader linked() {
        this.linked = true;
        this.options = new LinkedHashMap<>(options);
        return this;
    }

    /**
     * 如果为null是否插入key
     *
     * @param nullPutKey ignore
     * @return this
     */
    public ExcelMapReader nullPutKey(boolean nullPutKey) {
        this.nullPutKey = nullPutKey;
        return this;
    }

    @Override
    @SuppressWarnings("unchecked")
    protected MutableMap parserRow(Row row) {
        if (row == null) {
            return null;
        }
        MutableMap map;
        if (linked) {
            map = new MutableLinkedHashMap<>();
        } else {
            map = new MutableHashMap<>();
        }
        options.forEach((key, option) -> {
            int column = option.getIndex();
            Cell cell = row.getCell(column);
            ExcelReadType type = option.getType();
            Object value = null;
            if (cell != null) {
                if (type.equals(ExcelReadType.PICTURE)) {
                    // 获取图片
                    value = this.getPicture(column, row);
                } else {
                    // 获取值
                    value = Excels.getCellValue(cell, type, option.getCellOption());
                }
            }
            if (value == null) {
                // 默认值
                V defaultValue = this.defaultValue.get(key);
                if (defaultValue != null || nullPutKey) {
                    map.put(key, defaultValue);
                } else {
                    map.put(key, null);
                }
            } else {
                if (trim && value instanceof String) {
                    value = ((String) value).trim();
                }
                map.put(key, (V) value);
            }
        });
        return map;
    }

}