com.github.liaochong.myexcel.core

类 DefaultStreamExcelBuilder<T>

java.lang.Object

com.github.liaochong.myexcel.core.DefaultStreamExcelBuilder<T>

public class DefaultStreamExcelBuilder<T>
extends Object

版本:

1.0

作者:

liaochong

字段概要

字段

限定符和类型	字段和说明
protected Configuration	configuration
protected Map<Integer,Integer>	customWidthMap 自定义宽度
protected Map<Field,String>	defaultValueMap 默认值集合
protected List<String>	fieldDisplayOrder 字段展示顺序
protected List<FieldDefinition>	filteredFields 已排序字段
protected boolean	hasMultiColumn 是否拥有聚合列
protected boolean	isMapBuild 是否为Map类型导出
protected StyleParser	styleParser
protected int	titleLevel 标题层级
protected List<String>	titles 标题

方法概要

限定符和类型	方法和说明
void	append(List<T> dataList) 数据追加
<E> void	append(String templateFilePath, Map<String,E> renderData)
<E> void	append(String templateDir, String templateFileName, Map<String,E> renderData)
void	append(T data) 数据追加
protected List<Pair<? extends Class,?>>	assemblingMapContents(Map<String,Object> data)
void	asyncAppend(ListSupplier<T> supplier)
void	asyncAppend(Supplier<T> supplier)
DefaultStreamExcelBuilder<T>	autoMerge()
DefaultStreamExcelBuilder<T>	autoWidthStrategy(AutoWidthStrategy autoWidthStrategy) 已过时。
DefaultStreamExcelBuilder<T>	binding(Object... applicationBeans)
DefaultStreamExcelBuilder<T>	binding(Set<Object> applicationBeans)
org.apache.poi.ss.usermodel.Workbook	build() 停止追加数据，开始构建
List<Path>	buildAsPaths() 停止追加数据，path方式构建
Path	buildAsZip(String fileName) 构建为zip压缩包
void	cancel()
DefaultStreamExcelBuilder<T>	capacity(int capacity) excel容量
void	clear() clear方法仅可在异常情况下调用
void	close()
protected Table	createTable() 创建table
protected List<Tr>	createThead() 创建标题行
protected Tr	createTr(List<Pair<? extends Class,?>> contents) 创建内容行
DefaultStreamExcelBuilder<T>	fieldDisplayOrder(List<String> fieldDisplayOrder)
DefaultStreamExcelBuilder<T>	fixedTitles()
DefaultStreamExcelBuilder<T>	freezePane(FreezePane freezePane)
protected List<FieldDefinition>	getFilteredFields(ClassFieldContainer classFieldContainer, Class<?>... groups) Core methods for obtaining export related fields, styles, etc
protected List<FieldDefinition>	getGroupFields(List<FieldDefinition> preElectionFields, Class<?>[] groups)
protected <T> List<List<Pair<? extends Class,?>>>	getMultiRenderContent(T data, List<FieldDefinition> sortedFields) 获取需要被渲染的内容
protected <T> LinkedList<Pair<? extends Class,?>>	getOriginalRenderContent(T data, List<FieldDefinition> sortedFields) 获取需要被渲染的内容
protected List<FieldDefinition>	getPreElectionFields(ClassFieldContainer classFieldContainer)
DefaultStreamExcelBuilder<T>	groups(Class<?>... groups) 分组
DefaultStreamExcelBuilder<T>	hasStyle() 使用默认样式
DefaultStreamExcelBuilder<T>	hideColumns(int... columnIndexs)
DefaultStreamExcelBuilder<T>	noStyle()
static <T> DefaultStreamExcelBuilder<T>	of(Class<T> dataType) 获取实例，设定需要渲染的数据的类类型
static <T> DefaultStreamExcelBuilder<T>	of(Class<T> dataType, InputStream excelInputStream) 获取实例，设定需要渲染的数据的类类型
static <T> DefaultStreamExcelBuilder<T>	of(Class<T> dataType, Path excel) 获取实例，设定需要渲染的数据的类类型
static <T> DefaultStreamExcelBuilder<T>	of(Class<T> dataType, org.apache.poi.ss.usermodel.Workbook workbook) 获取实例，设定需要渲染的数据的类类型
DefaultStreamExcelBuilder<T>	onStartSheet(Consumer<org.apache.poi.ss.usermodel.Sheet> startSheetConsumer)
protected void	parseGlobalStyle()
DefaultStreamExcelBuilder<T>	pathConsumer(Consumer<Path> pathConsumer) path消费
DefaultStreamExcelBuilder<T>	rowHeight(int rowHeight)
protected void	setPrompt(Td td, int index)
protected void	setTitles(List<String> titles)
DefaultStreamExcelBuilder<T>	sheetName(String sheetName)
DefaultStreamExcelBuilder<T>	start() 流式构建启动，包含一些初始化操作
DefaultStreamExcelBuilder<T>	style(String... styles)
DefaultStreamExcelBuilder<T>	templateHandler(Class<? extends TemplateHandler> templateHandlerClass)
DefaultStreamExcelBuilder<T>	threadPool(ExecutorService executorService) 线程池设置
DefaultStreamExcelBuilder<T>	titleRowHeight(int titleRowHeight)
DefaultStreamExcelBuilder<T>	titles(List<String> titles)
DefaultStreamExcelBuilder<T>	waitQueueSize(int waitQueueSize)
DefaultStreamExcelBuilder<T>	width(int columnIndex, int width)
DefaultStreamExcelBuilder<T>	widths(int... widths)
DefaultStreamExcelBuilder<T>	widthStrategy(WidthStrategy widthStrategy)
DefaultStreamExcelBuilder<T>	workbookType(WorkbookType workbookType)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

fieldDisplayOrder

protected List<String> fieldDisplayOrder

字段展示顺序

filteredFields

protected List<FieldDefinition> filteredFields

已排序字段

titles

protected List<String> titles

标题

defaultValueMap

protected Map<Field,String> defaultValueMap

默认值集合

customWidthMap

protected Map<Integer,Integer> customWidthMap

自定义宽度

titleLevel

protected int titleLevel

标题层级

isMapBuild

protected boolean isMapBuild

是否为Map类型导出

configuration

protected Configuration configuration

styleParser

protected StyleParser styleParser

hasMultiColumn

protected boolean hasMultiColumn

是否拥有聚合列

方法详细资料

of

public static <T> DefaultStreamExcelBuilder<T> of(Class<T> dataType)

获取实例，设定需要渲染的数据的类类型

类型参数:

T - T

参数:

dataType - 数据的类类型

返回:

DefaultStreamExcelBuilder

of

public static <T> DefaultStreamExcelBuilder<T> of(Class<T> dataType,
                                                  org.apache.poi.ss.usermodel.Workbook workbook)

获取实例，设定需要渲染的数据的类类型

类型参数:

T - T

参数:

dataType - 数据的类类型

workbook - workbook

返回:

DefaultStreamExcelBuilder

of

public static <T> DefaultStreamExcelBuilder<T> of(Class<T> dataType,
                                                  Path excel)

获取实例，设定需要渲染的数据的类类型

类型参数:

T - T

参数:

dataType - 数据的类类型

excel - excel

返回:

DefaultStreamExcelBuilder

of

public static <T> DefaultStreamExcelBuilder<T> of(Class<T> dataType,
                                                  InputStream excelInputStream)

获取实例，设定需要渲染的数据的类类型

类型参数:

T - T

参数:

dataType - 数据的类类型

excelInputStream - excelInputStream

返回:

DefaultStreamExcelBuilder

titles

public DefaultStreamExcelBuilder<T> titles(List<String> titles)

sheetName

public DefaultStreamExcelBuilder<T> sheetName(String sheetName)

fieldDisplayOrder

public DefaultStreamExcelBuilder<T> fieldDisplayOrder(List<String> fieldDisplayOrder)

workbookType

public DefaultStreamExcelBuilder<T> workbookType(WorkbookType workbookType)

noStyle

public DefaultStreamExcelBuilder<T> noStyle()

widthStrategy

public DefaultStreamExcelBuilder<T> widthStrategy(WidthStrategy widthStrategy)

autoWidthStrategy

@Deprecated
public DefaultStreamExcelBuilder<T> autoWidthStrategy(AutoWidthStrategy autoWidthStrategy)

已过时。

fixedTitles

public DefaultStreamExcelBuilder<T> fixedTitles()

widths

public DefaultStreamExcelBuilder<T> widths(int... widths)

width

public DefaultStreamExcelBuilder<T> width(int columnIndex,
                                          int width)

hideColumns

public DefaultStreamExcelBuilder<T> hideColumns(int... columnIndexs)

threadPool

public DefaultStreamExcelBuilder<T> threadPool(ExecutorService executorService)

线程池设置

参数:

executorService - 线程池

返回:

SimpleStreamExcelBuilder

hasStyle

public DefaultStreamExcelBuilder<T> hasStyle()

使用默认样式

返回:

SimpleStreamExcelBuilder

capacity

public DefaultStreamExcelBuilder<T> capacity(int capacity)

excel容量

参数:

capacity - 容量

返回:

SimpleStreamExcelBuilder

pathConsumer

public DefaultStreamExcelBuilder<T> pathConsumer(Consumer<Path> pathConsumer)

path消费

参数:

pathConsumer - pathConsumer

返回:

SimpleStreamExcelBuilder

groups

public DefaultStreamExcelBuilder<T> groups(Class<?>... groups)

分组

参数:

groups - 分组

返回:

SimpleStreamExcelBuilder

waitQueueSize

public DefaultStreamExcelBuilder<T> waitQueueSize(int waitQueueSize)

style

public DefaultStreamExcelBuilder<T> style(String... styles)

templateHandler

public DefaultStreamExcelBuilder<T> templateHandler(Class<? extends TemplateHandler> templateHandlerClass)

onStartSheet

public DefaultStreamExcelBuilder<T> onStartSheet(Consumer<org.apache.poi.ss.usermodel.Sheet> startSheetConsumer)

freezePane

public DefaultStreamExcelBuilder<T> freezePane(FreezePane freezePane)

titleRowHeight

public DefaultStreamExcelBuilder<T> titleRowHeight(int titleRowHeight)

rowHeight

public DefaultStreamExcelBuilder<T> rowHeight(int rowHeight)

binding

public DefaultStreamExcelBuilder<T> binding(Object... applicationBeans)

binding

public DefaultStreamExcelBuilder<T> binding(Set<Object> applicationBeans)

autoMerge

public DefaultStreamExcelBuilder<T> autoMerge()

start

public DefaultStreamExcelBuilder<T> start()

流式构建启动，包含一些初始化操作

返回:

DefaultExcelBuilder

append

public void append(List<T> dataList)

数据追加

参数:

dataList - 需要追加的数据

append

public void append(T data)

数据追加

参数:

data - 数据

append

public <E> void append(String templateFilePath,
                       Map<String,E> renderData)

append

public <E> void append(String templateDir,
                       String templateFileName,
                       Map<String,E> renderData)

asyncAppend

public void asyncAppend(ListSupplier<T> supplier)

asyncAppend

public void asyncAppend(Supplier<T> supplier)

build

public org.apache.poi.ss.usermodel.Workbook build()

停止追加数据，开始构建

返回:

Workbook

buildAsPaths

public List<Path> buildAsPaths()

停止追加数据，path方式构建

返回:

path集合

buildAsZip

public Path buildAsZip(String fileName)

构建为zip压缩包

参数:

fileName - 文件名称

返回:

zip文件

close

public void close()
           throws IOException

抛出:

IOException

cancel

public void cancel()

clear

public void clear()

clear方法仅可在异常情况下调用

getFilteredFields

protected List<FieldDefinition> getFilteredFields(ClassFieldContainer classFieldContainer,
                                                  Class<?>... groups)

Core methods for obtaining export related fields, styles, etc

参数:

classFieldContainer - classFieldContainer

groups - 分组

返回:

Field

parseGlobalStyle

protected void parseGlobalStyle()

createTable

protected Table createTable()

创建table

返回:

table

createThead

protected List<Tr> createThead()

创建标题行

返回:

标题行

createTr

protected Tr createTr(List<Pair<? extends Class,?>> contents)

创建内容行

参数:

contents - 内容集合

返回:

内容行

setPrompt

protected void setPrompt(Td td,
                         int index)

setTitles

protected void setTitles(List<String> titles)

getGroupFields

protected List<FieldDefinition> getGroupFields(List<FieldDefinition> preElectionFields,
                                               Class<?>[] groups)

getPreElectionFields

protected List<FieldDefinition> getPreElectionFields(ClassFieldContainer classFieldContainer)

getMultiRenderContent

protected <T> List<List<Pair<? extends Class,?>>> getMultiRenderContent(T data,
                                                                        List<FieldDefinition> sortedFields)

获取需要被渲染的内容

类型参数:

T - 泛型

参数:

data - 数据集合

sortedFields - 排序字段

返回:

结果集

getOriginalRenderContent

protected <T> LinkedList<Pair<? extends Class,?>> getOriginalRenderContent(T data,
                                                                           List<FieldDefinition> sortedFields)

获取需要被渲染的内容

类型参数:

T - 泛型

参数:

data - 数据集合

sortedFields - 排序字段

返回:

结果集

assemblingMapContents

protected List<Pair<? extends Class,?>> assemblingMapContents(Map<String,Object> data)