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

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ListSheet.EntryColumn

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

Sheet.Column

字段概要

字段

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

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

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

构造器概要

构造器

构造器和说明
ListSheet() Constructor worksheet
ListSheet(List<T> data) Constructor worksheet
ListSheet(List<T> data, Column... columns) Constructor worksheet
ListSheet(List<T> data, WaterMark waterMark, Column... columns) Constructor worksheet
ListSheet(String name) Constructor worksheet
ListSheet(String name, Column... columns) Constructor worksheet
ListSheet(String name, List<T> data) Constructor worksheet
ListSheet(String name, List<T> data, Column... columns) Constructor worksheet
ListSheet(String name, List<T> data, WaterMark waterMark, Column... columns) Constructor worksheet
ListSheet(String name, WaterMark waterMark, 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
protected void	attachFreezePanes(Class<?> clazz) Parse and attach freeze info
protected List<Column>	attachOtherColumn(Map<String,Method> existsMethodMapper, Class<?> clazz) Attach some custom columns
protected void	buildHeaderComment(AccessibleObject main, AccessibleObject sub, Column column) Build header comment
protected void	buildHeaderStyle(AccessibleObject main, AccessibleObject sub, Column column) Build header style
void	close() Release resources
protected ListSheet.EntryColumn	createColumn(AccessibleObject ao) Create column from ExcelColumn annotation Override the method to extend custom comments
int	dataSize() Returns total data size before split
protected Method[]	filterOthersMethodsCanExport(Map<String,Method> existsMethodMapper, Class<?> clazz) Filter methods that need to be exported
protected StyleProcessor<?>	getDesignStyle(StyleDesign styleDesign) Set custom styleProcessor for declarations on Entry Class
protected int	getEndIndex() Returns the end index of row-block
protected T	getFirst() Returns the first not null object
protected Column[]	getHeaderColumns() Returns the header column info
StyleProcessor<T>	getStyleProcessor() Returns the row style processor
protected Class<?>	getTClass()
protected boolean	ignoreColumn(AccessibleObject ao) Ignore some columns, override this method to add custom filtering
protected int	init() Get the first object of the object array witch is not NULL, reflect all declared fields, and then do the following steps step 1.
protected int	left() Returns left data in array to be write
protected void	mergeGlobalSetting(Class<?> clazz) Merge Header Style defined on Entry Class
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
Sheet	setStyleProcessor(StyleProcessor<T> styleProcessor) Setting a row style processor
int	size() Returns total rows in this worksheet

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

addRel, afterSheetAccess, autoSize, buildHeadStyle, cancelForceExport, cancelOddStyle, checkColumnLimit, clone, createComments, defaultHeadStyle, defaultHeadStyleIndex, findRel, fixSize, fixSize, forceExport, getAndSortHeaderColumns, getAutoOdd, getAutoSize, getComments, getCopySheetName, getDefaultWidth, getExtPropAsMap, getExtPropValue, getFileName, getForceExport, getHeadStyle, getHeadStyleIndex, getId, getName, getNonHeader, getOddFill, getRowBlockSize, getRowLimit, getSst, getWaterMark, getWorkbook, hasHeaderColumns, hidden, ignoreHeader, int2Col, isAutoSize, isHidden, markExtProp, nextBlock, nonOrIntDefault, putAllExtProp, putExtProp, putExtPropIfAbsent, resetCommonProperties, search, setAutoOdd, setCellValueAndStyle, setColumns, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyleIndex, setId, setName, setOddFill, setSheetWriter, setWaterMark, setWorkbook, sortColumns, 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

styleProcessor

protected StyleProcessor<T> styleProcessor

The row styleProcessor

构造器详细资料

ListSheet

public ListSheet()

Constructor worksheet

ListSheet

public ListSheet(String name)

Constructor worksheet

参数:

name - the worksheet name

ListSheet

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

Constructor worksheet

参数:

name - the worksheet name

columns - the header info

ListSheet

public ListSheet(String name,
                 WaterMark waterMark,
                 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,
                 Column... columns)

Constructor worksheet

参数:

data - the worksheet's body data

columns - the header info

ListSheet

public ListSheet(String name,
                 List<T> data,
                 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,
                 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,
                 Column... columns)

Constructor worksheet

参数:

name - the worksheet name

data - the worksheet's body data

waterMark - the water mark

columns - the header info

方法详细资料

setStyleProcessor

public Sheet setStyleProcessor(StyleProcessor<T> styleProcessor)

Setting a row style processor

参数:

styleProcessor - a row style processor

返回:

current worksheet

getStyleProcessor

public StyleProcessor<T> getStyleProcessor()

Returns the row style processor

返回:

StyleProcessor

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

getTClass

protected Class<?> getTClass()

init

protected int init()

Get the first object of the object array witch is not NULL, reflect all declared fields, and then do the following steps

step 1. If the method has ExcelColumn annotation, the value of this annotation is used as the column name.

step 2. If the ExcelColumn annotation has no value or empty value, the field name is used as the column name.

step 3. If the field has ExcelColumn annotation, the value of this annotation is used as the column name.

step 4. Skip this Field if it has a IgnoreExport annotation, or the field which has not ExcelColumn annotation.

The column order is the same as the order in declared fields.

返回:

the column array length

createColumn

protected ListSheet.EntryColumn createColumn(AccessibleObject ao)

Create column from ExcelColumn annotation

Override the method to extend custom comments

参数:

ao - AccessibleObject witch defined the ExcelColumn annotation

返回:

the Worksheet's Column information

buildHeaderStyle

protected void buildHeaderStyle(AccessibleObject main,
                                AccessibleObject sub,
                                Column column)

Build header style

参数:

main - the getter method

sub - the defined field

column - the header column

buildHeaderComment

protected void buildHeaderComment(AccessibleObject main,
                                  AccessibleObject sub,
                                  Column column)

Build header comment

参数:

main - the getter method

sub - the defined field

column - the header column

mergeGlobalSetting

protected void mergeGlobalSetting(Class<?> clazz)

Merge Header Style defined on Entry Class

参数:

clazz - Class of <T>

getDesignStyle

protected StyleProcessor<?> getDesignStyle(StyleDesign styleDesign)

Set custom styleProcessor for declarations on Entry Class

参数:

styleDesign - StyleDesign

返回:

a style processor

ignoreColumn

protected boolean ignoreColumn(AccessibleObject ao)

Ignore some columns, override this method to add custom filtering

参数:

ao - Method or Field

返回:

true if ignore current column

attachOtherColumn

protected List<Column> attachOtherColumn(Map<String,Method> existsMethodMapper,
                                         Class<?> clazz)

Attach some custom columns

参数:

existsMethodMapper - all exists method collection by default

clazz - Class of <T>

返回:

list of Column or null if no more columns to attach

getHeaderColumns

protected 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.

attachFreezePanes

protected void attachFreezePanes(Class<?> clazz)

Parse and attach freeze info

参数:

clazz - Class of <T>

filterOthersMethodsCanExport

protected Method[] filterOthersMethodsCanExport(Map<String,Method> existsMethodMapper,
                                                Class<?> clazz)

Filter methods that need to be exported

参数:

existsMethodMapper - all exists method collection by default

clazz - Class of <T>

返回:

All Read-Method witch can be export