org.shoulder.batch.spi.DataExporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shoulder-batch Show documentation

Shoulder 扩展-批处理模块，提供批量数据导入、导出、异步校验、导入历史记录管理等能力。

The newest version!

package org.shoulder.batch.spi;

import org.shoulder.batch.config.model.ExportFileConfig;

import java.io.IOException;
import java.io.OutputStream;
import java.util.List;

/**
 * 数据导出
 * 实现类可为 CSV、Excel、Json 等自定义实现
 *
 * @author lym
 */
public interface DataExporter {


    /**
     * 是否支持某个导出方式
     *
     * @param exportType 导出方式
     * @return 是否支持
     */
    default boolean support(String exportType) {
        return false;
    }

    /**
     * 输出数据前准备操作
     *
     * @param outputStream 输出流
     * @param exportFileConfig 输出配置
     * @throws IOException IO 异常
     */
    void prepare(OutputStream outputStream, ExportFileConfig exportFileConfig) throws IOException;


    /**
     * 输出 多行注释信息
     *
     * @param commentLines      头信息
     * @throws IOException IO 异常
     */
    void outputComment(List commentLines) throws IOException;

    /**
     * 输出 一行头信息
     *
     * @param headers      头信息
     * @throws IOException IO 异常
     */
    void outputHeader(List headers) throws IOException;


    /**
     * 输出 数据行
     *
     * @param dataLine     数据行
     * @throws IOException IO 异常
     */
    void outputData(List dataLine) throws IOException;


    /**
     * 刷入输出流
     *
     * @throws IOException io
     */
    void flush() throws IOException;

}