org.ttzero.excel.entity

类 CSVSheet

java.lang.Object

org.ttzero.excel.entity.Sheet

org.ttzero.excel.entity.CSVSheet

所有已实现的接口:

Cloneable, Storable

public class CSVSheet
extends Sheet

CSVSheet的数据源为csv文件，可用于将csv文件转为Excel工作表， 通过CSVUtil提供的迭代器使得CSVSheet与ListSheet工作表具有 相似的切片属性，输出协议调用nextBlock获取分片数据时CSVSheet从CSVIterator 中逐行读取数据并输出以此控制整个过程对内存的消耗

默认情况下CSV文件第一行数据将做为Excel表头，如果要忽略这个设定则需要调用Sheet.ignoreHeader()方法忽略表头， 忽略表头后第一行数据将被视为普通数据导了，也就是说无论是否忽略表头CSV的数据都将被完全复制到Excel文件中， 只是默认第一行将添加表头样式

作者:

guanquan.wang at 2019-09-26 08:33

字段概要

字段

限定符和类型	字段和说明
protected Charset	charset 指定读取CSV使用的字符集
protected char	delimiter Delimiter char
protected CSVUtil.RowsIterator	iterator csv行迭代器，配合工作表输出协议获取数据可以极大降低内存消耗
protected Path	path csv文件路径
protected CSVUtil.Reader	reader csv Reader
protected boolean	shouldClean 是否需要清理临时资源，实例化时如果传入InputStream或Reader时会先将数据保存到临时文件 然后创建迭代器逐行读取数据，这个过程产生的临时文件会在关闭工作表时被一起清理

从类继承的字段 org.ttzero.excel.entity.Sheet

autoSize, cellValueAndStyle, columns, comments, copyCount, copySheet, extProp, extPropMark, headerReady, headerRowHeight, headStyle, headStyleIndex, hidden, id, LOGGER, name, nonHeader, progressConsumer, relManager, rowBlock, rowHeight, rows, sheetWriter, shouldClose, showGridLines, startCoordinate, watermark, width, workbook, zebraFill, zebraFillStyle

构造器概要

构造器

构造器和说明
CSVSheet() 实例化工作表，未指定工作表名称时默认以'Sheet'+id命名
CSVSheet(InputStream is) 实例化工作表并指定csv文件字节流
CSVSheet(Path path) 实例化工作表并指定csv文件路径
CSVSheet(Reader reader) 实例化工作表并指定csv文件字符流
CSVSheet(String name, InputStream is) 实例化工作表并指定工作表名和csv文件字节流
CSVSheet(String name, Path path) 实例化工作表并指定工作表名和csv文件路径
CSVSheet(String name, Reader reader) 实例化工作表并指定工作表名和csv文件字符流

方法概要

限定符和类型	方法和说明
void	checkColumnLimit() Check the limit of columns
void	close() 清理临时文件
protected Column[]	getHeaderColumns() 获取表头，子类覆写此方法创建表头
protected void	mergeHeaderCellsIfEquals() 合并表头
protected void	resetBlockData() 重置RowBlock行块数据，使用csv行迭代器逐行读取数据并重置行块，由于csv格式并不包含任务样式 所以CSVSheet并不支持任务样式设定
CSVSheet	setCharset(Charset charset) 设置读取CSV使用的字符集
CSVSheet	setDelimiter(char delimiter) Settings delimiter char

从类继承的方法 org.ttzero.excel.entity.Sheet

addRel, afterSheetAccess, afterSheetDataWriter, autoSize, buildHeadStyle, calculateRealColIndex, cancelZebraLine, clone, createComments, defaultHeadStyle, defaultHeadStyleIndex, defaultZebraLine, findRel, fixedSize, fixedSize, getAndSortHeaderColumns, getAutoSize, getCellValueAndStyle, getColumns, getComments, getCopySheetName, getDefaultWidth, getExtPropAsMap, getExtPropValue, getFileName, getForceExport, getHeaderRowHeight, getHeadStyle, getHeadStyleIndex, getId, getName, getNonHeader, getProgressConsumer, getRelManager, getRowBlockSize, getRowHeight, getRowLimit, getSheetWriter, getStartColNum, getStartRowIndex, getStartRowNum, getWatermark, getWaterMark, getWorkbook, getZebraFill, getZebraFillStyle, hasHeaderColumns, hidden, hideGridLines, ignoreHeader, insert, int2Col, isAutoSize, isHidden, isScrollToVisibleArea, isShowGridLines, markExtProp, nextBlock, onProgress, paging, putAllExtProp, putExtProp, putExtPropIfAbsent, resetCommonProperties, reverseHeadColumn, search, setCellValueAndStyle, setColumns, setColumns, setHeaderRowHeight, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyleIndex, setId, setName, setRowHeight, setSheetWriter, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartCoordinate, setStartRowIndex, setStartRowIndex, setWatermark, setWaterMark, setWorkbook, setZebraLine, showGridLines, size, sortColumns, toCoordinate, writeTo

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

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

字段详细资料

path

protected Path path

csv文件路径

reader

protected CSVUtil.Reader reader

csv Reader

iterator

protected CSVUtil.RowsIterator iterator

csv行迭代器，配合工作表输出协议获取数据可以极大降低内存消耗

shouldClean

protected boolean shouldClean

是否需要清理临时资源，实例化时如果传入InputStream或Reader时会先将数据保存到临时文件 然后创建迭代器逐行读取数据，这个过程产生的临时文件会在关闭工作表时被一起清理

charset

protected Charset charset

指定读取CSV使用的字符集

delimiter

protected char delimiter

Delimiter char

构造器详细资料

CSVSheet

public CSVSheet()

实例化工作表，未指定工作表名称时默认以'Sheet'+id命名

CSVSheet

public CSVSheet(Path path)

实例化工作表并指定csv文件路径

参数:

path - csv文件路径

CSVSheet

public CSVSheet(String name,
                Path path)

实例化工作表并指定工作表名和csv文件路径

参数:

name - 工作表名

path - csv文件路径

CSVSheet

public CSVSheet(InputStream is)
         throws IOException

实例化工作表并指定csv文件字节流

参数:

is - csv文件字节流

抛出:

IOException - if I/O error occur.

CSVSheet

public CSVSheet(String name,
                InputStream is)
         throws IOException

实例化工作表并指定工作表名和csv文件字节流

参数:

name - 工作表名

is - csv文件字节流

抛出:

IOException - if I/O error occur.

CSVSheet

public CSVSheet(Reader reader)
         throws IOException

实例化工作表并指定csv文件字符流

参数:

reader - csv文件字符流

抛出:

IOException - if I/O error occur.

CSVSheet

public CSVSheet(String name,
                Reader reader)
         throws IOException

实例化工作表并指定工作表名和csv文件字符流

参数:

name - 工作表名

reader - csv文件字符流

抛出:

IOException - if I/O error occur.

方法详细资料

close

public void close()
           throws IOException

清理临时文件

覆盖:

close 在类中 Sheet

抛出:

IOException - if I/O error occur

resetBlockData

protected void resetBlockData()

重置RowBlock行块数据，使用csv行迭代器逐行读取数据并重置行块，由于csv格式并不包含任务样式 所以CSVSheet并不支持任务样式设定

指定者:

resetBlockData 在类中 Sheet

getHeaderColumns

protected Column[] getHeaderColumns()

从类复制的说明: Sheet

获取表头，子类覆写此方法创建表头

覆盖:

getHeaderColumns 在类中 Sheet

返回:

表头信息

checkColumnLimit

public void checkColumnLimit()

从类复制的说明: Sheet

Check the limit of columns

覆盖:

checkColumnLimit 在类中 Sheet

mergeHeaderCellsIfEquals

protected void mergeHeaderCellsIfEquals()

从类复制的说明: Sheet

合并表头

覆盖:

mergeHeaderCellsIfEquals 在类中 Sheet

setCharset

public CSVSheet setCharset(Charset charset)

设置读取CSV使用的字符集

参数:

charset - 指定字符集

返回:

当前工作表

setDelimiter

public CSVSheet setDelimiter(char delimiter)

Settings delimiter char

参数:

delimiter - delimiter char

返回:

current CSVSheet