com.alibaba.excel.write.metadata.holder

类 AbstractWriteHolder

java.lang.Object

com.alibaba.excel.metadata.AbstractHolder

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

所有已实现的接口:

ConfigurationHolder, Holder, WriteHolder

直接已知子类:

WriteSheetHolder, WriteTableHolder, WriteWorkbookHolder

public abstract class AbstractWriteHolder
extends AbstractHolder
implements WriteHolder

Write holder configuration

作者:

Jiaju Zhuang

属性概要

类型	属性和说明
ExcelWriteHeadProperty	excelWriteHead What 'ExcelWriteHeadProperty' does the currently operated cell need to execute

构造器概要

构造器

构造器和说明
AbstractWriteHolder(WriteBasicParameter writeBasicParameter, AbstractWriteHolder parentAbstractWriteHolder, Boolean convertAllFiled)

方法概要

限定符和类型	方法和说明
boolean	automaticMergeHead() Whether need automatic merge headers.
ExcelWriteHeadProperty	excelWriteHeadProperty() What 'ExcelWriteHeadProperty' does the currently operated cell need to execute
Boolean	getAutomaticMergeHead()
ExcelWriteHeadProperty	getExcelWriteHeadProperty()
Collection<String>	getExcludeColumnFiledNames()
Collection<Integer>	getExcludeColumnIndexes()
Collection<String>	getIncludeColumnFiledNames()
Collection<Integer>	getIncludeColumnIndexes()
Boolean	getNeedHead()
Map<Class<? extends WriteHandler>,List<WriteHandler>>	getOwnWriteHandlerMap()
Integer	getRelativeHeadRowIndex()
Boolean	getUseDefaultStyle()
Map<Class<? extends WriteHandler>,List<WriteHandler>>	getWriteHandlerMap()
boolean	ignore(String fieldName, Integer columnIndex) Is to determine if a field needs to be ignored
protected void	initAnnotationConfig(List<WriteHandler> handlerList, WriteBasicParameter writeBasicParameter)
boolean	needHead() Whether a header is required for the currently operated cell
Map<Class<? extends WriteHandler>,List<WriteHandler>>	ownWriteHandlerMap() create your own write handler.
int	relativeHeadRowIndex() Writes the head relative to the existing contents of the sheet.
void	setAutomaticMergeHead(Boolean automaticMergeHead)
void	setExcelWriteHeadProperty(ExcelWriteHeadProperty excelWriteHeadProperty)
void	setExcludeColumnFiledNames(Collection<String> excludeColumnFiledNames)
void	setExcludeColumnIndexes(Collection<Integer> excludeColumnIndexes)
void	setIncludeColumnFiledNames(Collection<String> includeColumnFiledNames)
void	setIncludeColumnIndexes(Collection<Integer> includeColumnIndexes)
void	setNeedHead(Boolean needHead)
void	setOwnWriteHandlerMap(Map<Class<? extends WriteHandler>,List<WriteHandler>> ownWriteHandlerMap)
void	setRelativeHeadRowIndex(Integer relativeHeadRowIndex)
void	setUseDefaultStyle(Boolean useDefaultStyle)
void	setWriteHandlerMap(Map<Class<? extends WriteHandler>,List<WriteHandler>> writeHandlerMap)
protected Map<Class<? extends WriteHandler>,List<WriteHandler>>	sortAndClearUpAllHandler(List<WriteHandler> handlerList, Map<Class<? extends WriteHandler>,List<WriteHandler>> parentHandlerMap)
protected Map<Class<? extends WriteHandler>,List<WriteHandler>>	sortAndClearUpHandler(List<WriteHandler> handlerList)
Map<Class<? extends WriteHandler>,List<WriteHandler>>	writeHandlerMap() What handler does the currently operated cell need to execute

从类继承的方法 com.alibaba.excel.metadata.AbstractHolder

converterMap, getClazz, getConverterMap, getGlobalConfiguration, getHead, getNewInitialization, globalConfiguration, isNew, setClazz, setConverterMap, setGlobalConfiguration, setHead, setNewInitialization

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

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

从接口继承的方法 com.alibaba.excel.metadata.ConfigurationHolder

converterMap, globalConfiguration, isNew

从接口继承的方法 com.alibaba.excel.metadata.Holder

holderType

属性详细信息

excelWriteHead

public ExcelWriteHeadProperty excelWriteHeadProperty

指定者:

excelWriteHeadProperty 在接口中 WriteHolder

返回:

构造器详细资料

AbstractWriteHolder

public AbstractWriteHolder(WriteBasicParameter writeBasicParameter,
                           AbstractWriteHolder parentAbstractWriteHolder,
                           Boolean convertAllFiled)

方法详细资料

initAnnotationConfig

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

sortAndClearUpAllHandler

protected Map<Class<? extends WriteHandler>,List<WriteHandler>> sortAndClearUpAllHandler(List<WriteHandler> handlerList,
                                                                                         Map<Class<? extends WriteHandler>,List<WriteHandler>> parentHandlerMap)

sortAndClearUpHandler

protected Map<Class<? extends WriteHandler>,List<WriteHandler>> sortAndClearUpHandler(List<WriteHandler> handlerList)

ignore

public boolean ignore(String fieldName,
                      Integer columnIndex)

从接口复制的说明: WriteHolder

Is to determine if a field needs to be ignored

指定者:

ignore 在接口中 WriteHolder

返回:

getNeedHead

public Boolean getNeedHead()

setNeedHead

public void setNeedHead(Boolean needHead)

getWriteHandlerMap

public Map<Class<? extends WriteHandler>,List<WriteHandler>> getWriteHandlerMap()

setWriteHandlerMap

public void setWriteHandlerMap(Map<Class<? extends WriteHandler>,List<WriteHandler>> writeHandlerMap)

getOwnWriteHandlerMap

public Map<Class<? extends WriteHandler>,List<WriteHandler>> getOwnWriteHandlerMap()

setOwnWriteHandlerMap

public void setOwnWriteHandlerMap(Map<Class<? extends WriteHandler>,List<WriteHandler>> ownWriteHandlerMap)

getExcelWriteHeadProperty

public ExcelWriteHeadProperty getExcelWriteHeadProperty()

setExcelWriteHeadProperty

public void setExcelWriteHeadProperty(ExcelWriteHeadProperty excelWriteHeadProperty)

getRelativeHeadRowIndex

public Integer getRelativeHeadRowIndex()

setRelativeHeadRowIndex

public void setRelativeHeadRowIndex(Integer relativeHeadRowIndex)

getUseDefaultStyle

public Boolean getUseDefaultStyle()

setUseDefaultStyle

public void setUseDefaultStyle(Boolean useDefaultStyle)

getAutomaticMergeHead

public Boolean getAutomaticMergeHead()

setAutomaticMergeHead

public void setAutomaticMergeHead(Boolean automaticMergeHead)

getExcludeColumnIndexes

public Collection<Integer> getExcludeColumnIndexes()

setExcludeColumnIndexes

public void setExcludeColumnIndexes(Collection<Integer> excludeColumnIndexes)

getExcludeColumnFiledNames

public Collection<String> getExcludeColumnFiledNames()

setExcludeColumnFiledNames

public void setExcludeColumnFiledNames(Collection<String> excludeColumnFiledNames)

getIncludeColumnIndexes

public Collection<Integer> getIncludeColumnIndexes()

setIncludeColumnIndexes

public void setIncludeColumnIndexes(Collection<Integer> includeColumnIndexes)

getIncludeColumnFiledNames

public Collection<String> getIncludeColumnFiledNames()

setIncludeColumnFiledNames

public void setIncludeColumnFiledNames(Collection<String> includeColumnFiledNames)

excelWriteHeadProperty

public ExcelWriteHeadProperty excelWriteHeadProperty()

从接口复制的说明: WriteHolder

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

指定者:

excelWriteHeadProperty 在接口中 WriteHolder

返回:

writeHandlerMap

public Map<Class<? extends WriteHandler>,List<WriteHandler>> writeHandlerMap()

从接口复制的说明: WriteHolder

What handler does the currently operated cell need to execute

指定者:

writeHandlerMap 在接口中 WriteHolder

返回:

ownWriteHandlerMap

public Map<Class<? extends WriteHandler>,List<WriteHandler>> ownWriteHandlerMap()

从接口复制的说明: WriteHolder

create your own write handler.

指定者:

ownWriteHandlerMap 在接口中 WriteHolder

返回:

needHead

public boolean needHead()

从接口复制的说明: WriteHolder

Whether a header is required for the currently operated cell

指定者:

needHead 在接口中 WriteHolder

返回:

relativeHeadRowIndex

public int relativeHeadRowIndex()

从接口复制的说明: WriteHolder

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

指定者:

relativeHeadRowIndex 在接口中 WriteHolder

返回:

automaticMergeHead

public boolean automaticMergeHead()

从接口复制的说明: WriteHolder

Whether need automatic merge headers.

指定者:

automaticMergeHead 在接口中 WriteHolder

返回: