org.ttzero.excel.entity

类 ListSheet<T>

java.lang.Object

org.ttzero.excel.entity.Sheet

org.ttzero.excel.entity.ListSheet<T>

所有已实现的接口:

Cloneable, Storable

直接已知子类:

ListMapSheet

public class ListSheet<T>
extends Sheet

List is the most important data source, you can pass all the data at a time, or customize the worksheet to extends the ListSheet, and then override the more() method to achieve segmented loading of data. The more() method returns NULL or an empty array to complete the current worksheet write

作者:

guanquan.wang at 2018-01-26 14:48

另请参阅:

ListMapSheet

嵌套类概要

从类继承的嵌套类/接口 org.ttzero.excel.entity.Sheet

Sheet.Column

字段概要

字段

限定符和类型	字段和说明
protected List<T>	data
protected int	end
protected boolean	eof
protected int	start

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

autoOdd, autoSize, cellValueAndStyle, columns, comments, copyCount, copySheet, headerReady, headStyle, hidden, id, LOGGER, name, oddFill, relManager, rowBlock, rows, sheetWriter, shouldClose, waterMark, width, workbook

构造器概要

构造器

构造器和说明
ListSheet() Constructor worksheet
ListSheet(List<T> data) Constructor worksheet
ListSheet(List<T> data, Sheet.Column... columns) Constructor worksheet
ListSheet(List<T> data, WaterMark waterMark, Sheet.Column... columns) Constructor worksheet
ListSheet(String name) Constructor worksheet
ListSheet(String name, List<T> data) Constructor worksheet
ListSheet(String name, List<T> data, Sheet.Column... columns) Constructor worksheet
ListSheet(String name, List<T> data, WaterMark waterMark, Sheet.Column... columns) Constructor worksheet
ListSheet(String name, Sheet.Column... columns) Constructor worksheet
ListSheet(String name, WaterMark waterMark, Sheet.Column... columns) Constructor worksheet

方法概要

限定符和类型	方法和说明
protected void	append() Call this method to get more data when the data length less than the row-block size until there is no more data or more than the row limit
void	close() Release resources
int	dataSize() Returns total data size before split
protected int	getEndIndex() Returns the end index of row-block
protected T	getFirst() Returns the first not null object
Sheet.Column[]	getHeaderColumns() Returns the header column info
protected int	left() Returns left data in array to be write
protected List<T>	more() This method is used for the worksheet to get the data.
protected void	paging() Split worksheet data
protected void	resetBlockData() Reset the row-block data
ListSheet<T>	setData(List<T> data) Setting the worksheet data
int	size() Returns total rows in this worksheet

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

addRel, afterSheetAccess, autoSize, cancelOddStyle, checkColumnLimit, clone, createComments, defaultHeadStyle, findRel, fixSize, fixSize, getAutoOdd, getAutoSize, getComments, getCopySheetName, getDefaultWidth, getFileName, getId, getName, getOddFill, getRowBlockSize, getSst, getWaterMark, getWorkbook, hasHeaderColumns, hasNonHeader, hidden, int2Col, isAutoSize, isHidden, nextBlock, nonOrIntDefault, setAutoOdd, setCellValueAndStyle, setColumns, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyle, setId, setName, setOddFill, setSheetWriter, setWaterMark, setWorkbook, what, what, writeTo

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

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

字段详细资料

data

protected List<T> data

start

protected int start

end

protected int end

eof

protected boolean eof

构造器详细资料

ListSheet

public ListSheet()

Constructor worksheet

ListSheet

public ListSheet(String name)

Constructor worksheet

参数:

name - the worksheet name

ListSheet

public ListSheet(String name,
                 Sheet.Column... columns)

Constructor worksheet

参数:

name - the worksheet name

columns - the header info

ListSheet

public ListSheet(String name,
                 WaterMark waterMark,
                 Sheet.Column... columns)

Constructor worksheet

参数:

name - the worksheet name

waterMark - the water mark

columns - the header info

ListSheet

public ListSheet(List<T> data)

Constructor worksheet

参数:

data - the worksheet's body data

ListSheet

public ListSheet(String name,
                 List<T> data)

Constructor worksheet

参数:

name - the worksheet name

data - the worksheet's body data

ListSheet

public ListSheet(List<T> data,
                 Sheet.Column... columns)

Constructor worksheet

参数:

data - the worksheet's body data

columns - the header info

ListSheet

public ListSheet(String name,
                 List<T> data,
                 Sheet.Column... columns)

Constructor worksheet

参数:

name - the worksheet name

data - the worksheet's body data

columns - the header info

ListSheet

public ListSheet(List<T> data,
                 WaterMark waterMark,
                 Sheet.Column... columns)

Constructor worksheet

参数:

data - the worksheet's body data

waterMark - the water mark

columns - the header info

ListSheet

public ListSheet(String name,
                 List<T> data,
                 WaterMark waterMark,
                 Sheet.Column... columns)

Constructor worksheet

参数:

name - the worksheet name

data - the worksheet's body data

waterMark - the water mark

columns - the header info

方法详细资料

setData

public ListSheet<T> setData(List<T> data)

Setting the worksheet data

参数:

data - the body data

返回:

worksheet

getFirst

protected T getFirst()

Returns the first not null object

返回:

the object

close

public void close()
           throws IOException

Release resources

覆盖:

close 在类中 Sheet

抛出:

IOException - if I/O error occur

resetBlockData

protected void resetBlockData()

Reset the row-block data

指定者:

resetBlockData 在类中 Sheet

append

protected void append()

Call this method to get more data when the data length less than the row-block size until there is no more data or more than the row limit

getHeaderColumns

public Sheet.Column[] getHeaderColumns()

Returns the header column info

覆盖:

getHeaderColumns 在类中 Sheet

返回:

array of column

getEndIndex

protected int getEndIndex()

Returns the end index of row-block

返回:

the end index

size

public int size()

Returns total rows in this worksheet

覆盖:

size 在类中 Sheet

返回:

-1 if unknown or uncertain

left

protected int left()

Returns left data in array to be write

返回:

the left number

paging

protected void paging()

Split worksheet data

覆盖:

paging 在类中 Sheet

dataSize

public int dataSize()

Returns total data size before split

返回:

the total size

more

protected List<T> more()

This method is used for the worksheet to get the data. This is a data source independent method. You can get data from any data source. Since this method is stateless, you should manage paging or other information in your custom Sheet.

The more data you get each time, the faster write speed. You should minimize the database query or network request, but the excessive data will put pressure on the memory. Please balance this value between the speed and memory. You can refer to 2^8 ~ 2^10

This method is blocked

返回:

The data output to the worksheet, if a null or empty ArrayList returned, mean that the current worksheet is finished written.