com.alibaba.excel.write.metadata.holder

Class AbstractWriteHolder

java.lang.Object

com.alibaba.excel.metadata.AbstractHolder

com.alibaba.excel.write.metadata.holder.AbstractWriteHolder

All Implemented Interfaces:

ConfigurationHolder, Holder, WriteHolder

Direct Known Subclasses:

WriteSheetHolder, WriteTableHolder, WriteWorkbookHolder

public abstract class AbstractWriteHolder
extends AbstractHolder
implements WriteHolder

Write holder configuration

Author:

Jiaju Zhuang

Field Summary

Fields

Modifier and Type	Field and Description
CellHandlerExecutionChain	cellHandlerExecutionChain Execute the cell handler chain
SheetHandlerExecutionChain	ownSheetHandlerExecutionChain Execute the sheet handler chain Created in the sheet in the workbook interceptors will not be executed because the workbook to create an event long past.
WorkbookHandlerExecutionChain	ownWorkbookHandlerExecutionChain Execute the workbook handler chain Created in the sheet in the workbook interceptors will not be executed because the workbook to create an event long past.
RowHandlerExecutionChain	rowHandlerExecutionChain Execute the row handler chain
SheetHandlerExecutionChain	sheetHandlerExecutionChain Execute the sheet handler chain
WorkbookHandlerExecutionChain	workbookHandlerExecutionChain Execute the workbook handler chain

Constructor Summary

Constructors

Constructor and Description
AbstractWriteHolder(WriteBasicParameter writeBasicParameter, AbstractWriteHolder parentAbstractWriteHolder)

Method Summary

Modifier and Type	Method and Description
boolean	automaticMergeHead() Whether need automatic merge headers.
protected void	buildChain(WriteHandler writeHandler, boolean runOwn)
ExcelWriteHeadProperty	excelWriteHeadProperty() What 'ExcelWriteHeadProperty' does the currently operated cell need to execute
Collection<String>	excludeColumnFieldNames() Ignore the custom columns.
Collection<Integer>	excludeColumnIndexes() Ignore the custom columns.
boolean	ignore(String fieldName, Integer columnIndex) Is to determine if a field needs to be ignored
Collection<String>	includeColumnFieldNames() Only output the custom columns.
Collection<Integer>	includeColumnIndexes() Only output the custom columns.
protected void	initAnnotationConfig(List<WriteHandler> handlerList, WriteBasicParameter writeBasicParameter)
protected void	initHandler(WriteBasicParameter writeBasicParameter, AbstractWriteHolder parentAbstractWriteHolder)
boolean	needHead() Whether a header is required for the currently operated cell
boolean	orderByIncludeColumn() Data will be order by WriteHolder.includeColumnFieldNames() or WriteHolder.includeColumnIndexes().
int	relativeHeadRowIndex() Writes the head relative to the existing contents of the sheet.
protected void	sortAndClearUpHandler(List<WriteHandler> handlerList, boolean runOwn)

Methods inherited from class com.alibaba.excel.metadata.AbstractHolder

converterMap, globalConfiguration, isNew

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alibaba.excel.metadata.ConfigurationHolder

converterMap, globalConfiguration, isNew

Methods inherited from interface com.alibaba.excel.metadata.Holder

holderType

Field Detail

ownWorkbookHandlerExecutionChain

public WorkbookHandlerExecutionChain ownWorkbookHandlerExecutionChain

Execute the workbook handler chain Created in the sheet in the workbook interceptors will not be executed because the workbook to create an event long past. So when initializing sheet, supplementary workbook event.

ownSheetHandlerExecutionChain

public SheetHandlerExecutionChain ownSheetHandlerExecutionChain

Execute the sheet handler chain Created in the sheet in the workbook interceptors will not be executed because the workbook to create an event long past. So when initializing sheet, supplementary workbook event.

workbookHandlerExecutionChain

public WorkbookHandlerExecutionChain workbookHandlerExecutionChain

Execute the workbook handler chain

sheetHandlerExecutionChain

public SheetHandlerExecutionChain sheetHandlerExecutionChain

Execute the sheet handler chain

rowHandlerExecutionChain

public RowHandlerExecutionChain rowHandlerExecutionChain

Execute the row handler chain

cellHandlerExecutionChain

public CellHandlerExecutionChain cellHandlerExecutionChain

Execute the cell handler chain

Constructor Detail

AbstractWriteHolder

public AbstractWriteHolder(WriteBasicParameter writeBasicParameter,
                           AbstractWriteHolder parentAbstractWriteHolder)

Method Detail

initHandler

protected void initHandler(WriteBasicParameter writeBasicParameter,
                           AbstractWriteHolder parentAbstractWriteHolder)

initAnnotationConfig

protected void initAnnotationConfig(List<WriteHandler> handlerList,
                                    WriteBasicParameter writeBasicParameter)

sortAndClearUpHandler

protected void sortAndClearUpHandler(List<WriteHandler> handlerList,
                                     boolean runOwn)

buildChain

protected void buildChain(WriteHandler writeHandler,
                          boolean runOwn)

ignore

public boolean ignore(String fieldName,
                      Integer columnIndex)

Description copied from interface: WriteHolder

Is to determine if a field needs to be ignored

Specified by:

ignore in interface WriteHolder

Returns:

excelWriteHeadProperty

public ExcelWriteHeadProperty excelWriteHeadProperty()

Description copied from interface: WriteHolder

What 'ExcelWriteHeadProperty' does the currently operated cell need to execute

Specified by:

excelWriteHeadProperty in interface WriteHolder

Returns:

needHead

public boolean needHead()

Description copied from interface: WriteHolder

Whether a header is required for the currently operated cell

Specified by:

needHead in interface WriteHolder

Returns:

relativeHeadRowIndex

public int relativeHeadRowIndex()

Description copied from interface: WriteHolder

Writes the head relative to the existing contents of the sheet. Indexes are zero-based.

Specified by:

relativeHeadRowIndex in interface WriteHolder

Returns:

automaticMergeHead

public boolean automaticMergeHead()

Description copied from interface: WriteHolder

Whether need automatic merge headers.

Specified by:

automaticMergeHead in interface WriteHolder

Returns:

orderByIncludeColumn

public boolean orderByIncludeColumn()

Description copied from interface: WriteHolder

Data will be order by WriteHolder.includeColumnFieldNames() or WriteHolder.includeColumnIndexes(). default is false.

Specified by:

orderByIncludeColumn in interface WriteHolder

Returns:

includeColumnIndexes

public Collection<Integer> includeColumnIndexes()

Description copied from interface: WriteHolder

Only output the custom columns.

Specified by:

includeColumnIndexes in interface WriteHolder

Returns:

includeColumnFieldNames

public Collection<String> includeColumnFieldNames()

Description copied from interface: WriteHolder

Only output the custom columns.

Specified by:

includeColumnFieldNames in interface WriteHolder

Returns:

excludeColumnIndexes

public Collection<Integer> excludeColumnIndexes()

Description copied from interface: WriteHolder

Ignore the custom columns.

Specified by:

excludeColumnIndexes in interface WriteHolder

Returns:

excludeColumnFieldNames

public Collection<String> excludeColumnFieldNames()

Description copied from interface: WriteHolder

Ignore the custom columns.

Specified by:

excludeColumnFieldNames in interface WriteHolder

Returns: