com.alibaba.excel.write.metadata.holder

Interface WriteHolder

All Superinterfaces:

ConfigurationHolder, Holder

All Known Implementing Classes:

AbstractWriteHolder, WriteSheetHolder, WriteTableHolder, WriteWorkbookHolder

public interface WriteHolder
extends ConfigurationHolder

Get the corresponding Holder

Author:

Jiaju Zhuang

Method Summary

Modifier and Type	Method and Description
boolean	automaticMergeHead() Whether need automatic merge headers.
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.
boolean	needHead() Whether a header is required for the currently operated cell
boolean	orderByIncludeColumn() Data will be order by includeColumnFieldNames() or includeColumnIndexes().
int	relativeHeadRowIndex() Writes the head relative to the existing contents of the sheet.

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

converterMap, globalConfiguration, isNew

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

holderType

Method Detail

excelWriteHeadProperty

ExcelWriteHeadProperty excelWriteHeadProperty()

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

Returns:

ignore

boolean ignore(String fieldName,
               Integer columnIndex)

Is to determine if a field needs to be ignored

Parameters:

fieldName -

columnIndex -

Returns:

needHead

boolean needHead()

Whether a header is required for the currently operated cell

Returns:

automaticMergeHead

boolean automaticMergeHead()

Whether need automatic merge headers.

Returns:

relativeHeadRowIndex

int relativeHeadRowIndex()

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

Returns:

orderByIncludeColumn

boolean orderByIncludeColumn()

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

Returns:

includeColumnIndexes

Collection<Integer> includeColumnIndexes()

Only output the custom columns.

Returns:

includeColumnFieldNames

Collection<String> includeColumnFieldNames()

Only output the custom columns.

Returns:

excludeColumnIndexes

Collection<Integer> excludeColumnIndexes()

Ignore the custom columns.

Returns:

excludeColumnFieldNames

Collection<String> excludeColumnFieldNames()

Ignore the custom columns.

Returns: