gu.sql2java.excel.config

类 SheetConfig

java.lang.Object

gu.sql2java.excel.config.SheetConfig

public class SheetConfig
extends java.lang.Object

Excel表输出全局配置

作者:

guyadong

构造器概要

构造器

构造器和说明
SheetConfig() 默认构造方法
SheetConfig(java.lang.Class<?> beanClass) 构造方法,支持普通JavaBean类型
SheetConfig(ExcelSheet sheetAnnot, ExcelColumn... columnAnnots) 构造方法 支持从注解ExcelSheet,ExcelColumn获取配置参数
SheetConfig(java.lang.Iterable<java.util.Map> iterable) 构造方法,支持Map类型的记录对象包括JSONObject
SheetConfig(java.lang.Iterable<java.util.Map> iterable, java.lang.Iterable<java.lang.String> includeCoumns) 构造方法,支持Map类型的记录对象包括JSONObject
SheetConfig(java.lang.reflect.Method method) 构造方法,支持从服务方法中获取注解完成配置 如果方法中定义了ExcelSheet注解,注解中定义了beanClass,则调用SheetConfig(Class)构造方法基于JavaBean类型构造当前实例，再调用SheetConfig(Method)构造方法基于方法构造一个临时实例, 将临时实例合并到当前实例
SheetConfig(java.lang.Object bean) 构造方法,支持普通JavaBean实例
SheetConfig(gu.sql2java.RowMetaData metaData) 构造方法支持 UnnameRow记录

方法概要

限定符和类型	方法和说明
SheetConfig	addColumns(java.lang.Iterable<PropertyConfig> elements)
SheetConfig	addColumns(PropertyConfig... elements)
SheetConfig	addNestedColumn(java.lang.String nestedName, java.lang.String descName)
SheetConfig	addNestedColumns(java.lang.Iterable<java.lang.String> elements)
SheetConfig	addNestedColumns(java.lang.String... elements)
PropertyConfig	configByExcelName(java.lang.String excelName) 根据EXCEL输出字段名名查找对应的属性配置对象，没找到返回null,如果有多个匹配返回第一个
PropertyConfig	configOf(java.lang.String nestedName) 根据属性路径名查找对应的属性配置对象，没找到返回则创建一个默认对象 查找时如果没有找到完全匹配的值会自动切换节点名为驼峰命名格式或蛇形命名格式尝试
PropertyConfig	configOrNullOf(java.lang.String nestedName) 根据属性路径名查找对应的属性配置对象，没找到返回null
boolean	exists(java.lang.String nestedName)
java.util.Map<java.lang.String,java.lang.String>	getAvailableColumns() 返回所有可输出字段及字段显示名称
java.lang.Class<?>	getBeanClass()
java.lang.Iterable<PropertyConfig>	getColumnConfigs() 返回所有字段配置对象
CustomBeanParser	getCustomImporter()
java.lang.String	getDateFormat()
java.lang.String	getDateTimeFormat()
java.util.Set<java.lang.String>	getDefaultExportColumnNames() 根据defaultIncludeColumns过滤返回默认输出的字段名
java.util.Map<java.lang.String,java.lang.String>	getDefaultExportColumns() 根据defaultIncludeColumns过滤返回默认输出的字段名和Excel导出时的列名
java.util.Set<java.lang.String>	getDefaultIncludeColumns()
java.lang.String	getDefaultValue()
java.util.Set<java.lang.String>	getDynamicExcelNames()
java.util.Map<java.lang.String,PropertyConfig>	getExcelConfigs() 返回所有EXCEL字段名称-PropertyConfig映射
java.util.Set<java.lang.String>	getExcludeColumns()
java.lang.Iterable<PropertyConfig>	getExportedColumnConfigs() 返回需要导出的字段列表 如果字段输出白名单(includeColumns)不为空则返回此名单中的字段配置对象 如果字段输出黑名单excludeColumns不为空则返回不在此名单中的所有字段配置对象 否则返回所有字段;
java.lang.String	getFileNamePrefix()
org.apache.poi.ss.usermodel.IndexedColors	getFillColor()
org.apache.poi.ss.usermodel.IndexedColors	getFontColor()
short	getFontHeight()
java.lang.String	getFontName()
org.apache.poi.ss.usermodel.IndexedColors	getHeaderFillColor()
org.apache.poi.ss.usermodel.IndexedColors	getHeaderFontColor()
short	getHeaderFontHeight()
java.lang.String	getHeaderFontName()
org.apache.poi.ss.usermodel.HorizontalAlignment	getHeaderHorizontalAlign()
java.util.Set<java.lang.String>	getHideColumns()
org.apache.poi.ss.usermodel.HorizontalAlignment	getHorizontalAlign()
java.util.Collection<PropertyConfig>	getImportColumnConfigs() 返回需要导出的字段列表 如果字段输出黑名单excludeColumns不为空则返回不在此名单中的所有字段配置对象 否则返回所有字段;
java.util.Set<java.lang.String>	getIncludeColumns()
java.util.Set<java.lang.String>	getIncludeColumnsOrDefault()
java.lang.String	getIntegralFormat()
int	getMaxHeight()
int	getMaxWidth()
java.util.List<java.lang.String>	getNestedNames() 返回所有嵌入字段
int	getQueueTimeout()
int	getRoundingMode()
short	getRowHeight() 根据注解获取最大行高
int	getScale()
java.lang.String	getSheetName()
java.lang.String	getTimeFormat()
java.lang.String	getTimestampFormat()
java.lang.String	getTitle()
org.apache.poi.ss.usermodel.IndexedColors	getTitleFillColor()
org.apache.poi.ss.usermodel.IndexedColors	getTitleFontColor()
short	getTitleFontHeight()
java.lang.String	getTitleFontName()
org.apache.poi.ss.usermodel.HorizontalAlignment	getTitleHorizontalAlign()
long	getTotalRowCount()
boolean	isFirstBold()
static boolean	mayBeJavaBean(java.lang.Class<?> type)
SheetConfig	merge(SheetConfig other) 将输入的Excel表配置与当前对象的合并 将other中有定义的Excel Sheet配置字段复制到当前对象的对应字段 将other定义的Excel Column配置对象(PropertyConfig)合并到当前的Column配置对象中,如果存在相同的对象,则以other的为准, 如果other.beanClass不为null则复制到当前对象的同名字段
void	setBeanClass(java.lang.Class<?> beanClass)
SheetConfig	setColumnConfigs(java.lang.Iterable<PropertyConfig> columnConfigs)
void	setCustomImporter(java.lang.Class<? extends CustomBeanParser> customImporterClass)
void	setCustomImporter(CustomBeanParser customImporter)
SheetConfig	setDateFormat(java.lang.String dateFormat)
SheetConfig	setDateTimeFormat(java.lang.String dateTimeFormat)
void	setDefaultIncludeColumns(java.lang.Iterable<java.lang.String> defaultIncludeColumns)
SheetConfig	setDefaultIncludeColumns(java.util.Set<java.lang.String> defaultIncludeColumns)
void	setDefaultIncludeColumns(java.lang.String... defaultIncludeColumns)
SheetConfig	setDefaultValue(java.lang.String defaultValue)
void	setDynamicExcelNames(java.util.Set<java.lang.String> dynamicExcelNames)
SheetConfig	setExcludeColumns(java.lang.Iterable<java.lang.String> excludeColumns) 指定输出时要排序的字段(黑名单),在此名单中的字段不被输出
SheetConfig	setExcludeColumns(java.util.Set<java.lang.String> excludeColumns)
SheetConfig	setExcludeColumns(java.lang.String... excludeColumns)
SheetConfig	setFileNamePrefix(java.lang.String fileNamePrefix)
SheetConfig	setFillColor(org.apache.poi.ss.usermodel.IndexedColors fillColor)
SheetConfig	setFillColor(java.lang.String fillColor)
SheetConfig	setFirstBold(boolean firstBold)
SheetConfig	setFirstBold(java.lang.Boolean firstBold)
SheetConfig	setFontColor(org.apache.poi.ss.usermodel.IndexedColors fontColor)
SheetConfig	setFontColor(java.lang.String fontColor)
SheetConfig	setFontHeight(java.lang.Integer fontHeight)
SheetConfig	setFontHeight(short fontHeight)
SheetConfig	setFontName(java.lang.String fontName)
SheetConfig	setHeaderFillColor(org.apache.poi.ss.usermodel.IndexedColors headerFillColor)
SheetConfig	setHeaderFillColor(java.lang.String headerFillColor)
SheetConfig	setHeaderFontColor(org.apache.poi.ss.usermodel.IndexedColors headerFontColor)
SheetConfig	setHeaderFontColor(java.lang.String headerFontColor)
SheetConfig	setHeaderFontHeight(java.lang.Integer headerFontHeight)
SheetConfig	setHeaderFontHeight(short headerFontHeight)
SheetConfig	setHeaderFontName(java.lang.String headerFontName)
SheetConfig	setHeaderHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment headerHorizontalAlign)
SheetConfig	setHeaderHorizontalAlign(java.lang.String headerHorizontalAlign)
SheetConfig	setHideColumns(java.lang.Iterable<java.lang.String> hideColumns)
SheetConfig	setHideColumns(java.util.Set<java.lang.String> hideColumns)
SheetConfig	setHideColumns(java.lang.String... hideColumns)
SheetConfig	setHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlign)
SheetConfig	setHorizontalAlign(java.lang.String horizontalAlign)
SheetConfig	setIncludeColumns(java.lang.Iterable<java.lang.String> includeColumns) 指定要输出的字段(白名单),在此名单中的字段才会被输出, 此方法也定义了字段输出顺序,
SheetConfig	setIncludeColumns(java.util.Set<java.lang.String> includeColumns)
SheetConfig	setIncludeColumns(java.lang.String... includeColumns)
SheetConfig	setIncludeColumnsOrDefault(java.lang.Iterable<java.lang.String> includeColumns) 指定要输出的字段(白名单),如果输入参数为null或空,则使用getDefaultExportColumnNames()的返回值
SheetConfig	setIntegralFormat(java.lang.String integralFormat)
SheetConfig	setMaxHeight(int maxHeight)
SheetConfig	setMaxHeight(java.lang.Integer maxHeight)
SheetConfig	setMaxWidth(int maxWidth)
SheetConfig	setMaxWidth(java.lang.Integer maxWidth)
void	setQueueTimeout(int queueTimeout)
SheetConfig	setRoundingMode(int roundingMode)
SheetConfig	setScale(int scale)
SheetConfig	setSheetName(java.lang.String sheetName)
SheetConfig	setTimeFormat(java.lang.String timeFormat)
SheetConfig	setTimestampFormat(java.lang.String timestampFormat)
SheetConfig	setTitle(java.lang.String title)
SheetConfig	setTitleFillColor(org.apache.poi.ss.usermodel.IndexedColors titleFillColor)
SheetConfig	setTitleFillColor(java.lang.String titleFillColor)
SheetConfig	setTitleFontColor(org.apache.poi.ss.usermodel.IndexedColors titleFontColor)
SheetConfig	setTitleFontColor(java.lang.String titleFontColor)
SheetConfig	setTitleFontHeight(java.lang.Integer titleFontHeight)
SheetConfig	setTitleFontHeight(short titleFontHeight)
SheetConfig	setTitleFontName(java.lang.String titleFontName)
SheetConfig	setTitleHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment titleHorizontalAlign)
SheetConfig	setTitleHorizontalAlign(java.lang.String titleHorizontalAlign)
void	setTotalRowCount(long totalRowCount)

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

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

构造器详细资料

SheetConfig

public SheetConfig()

默认构造方法

SheetConfig

public SheetConfig(ExcelSheet sheetAnnot,
                   ExcelColumn... columnAnnots)

构造方法
支持从注解ExcelSheet,ExcelColumn获取配置参数

参数:

sheetAnnot -

columnAnnots -

SheetConfig

public SheetConfig(java.lang.reflect.Method method)

构造方法,支持从服务方法中获取注解完成配置
如果方法中定义了ExcelSheet注解,注解中定义了beanClass,则调用SheetConfig(Class)构造方法基于JavaBean类型构造当前实例，再调用SheetConfig(Method)构造方法基于方法构造一个临时实例, 将临时实例合并到当前实例

参数:

method -

SheetConfig

public SheetConfig(java.lang.Class<?> beanClass)

构造方法,支持普通JavaBean类型

参数:

beanClass -

SheetConfig

public SheetConfig(gu.sql2java.RowMetaData metaData)

构造方法支持 UnnameRow记录

参数:

metaData -

SheetConfig

public SheetConfig(java.lang.Object bean)

构造方法,支持普通JavaBean实例

参数:

bean -

SheetConfig

public SheetConfig(java.lang.Iterable<java.util.Map> iterable)

构造方法,支持Map类型的记录对象包括JSONObject

参数:

iterable -

SheetConfig

public SheetConfig(java.lang.Iterable<java.util.Map> iterable,
                   java.lang.Iterable<java.lang.String> includeCoumns)

构造方法,支持Map类型的记录对象包括JSONObject

参数:

iterable -

includeCoumns -

方法详细资料

getSheetName

public java.lang.String getSheetName()

setSheetName

public SheetConfig setSheetName(java.lang.String sheetName)

getFileNamePrefix

public java.lang.String getFileNamePrefix()

返回:

fileNamePrefix

setFileNamePrefix

public SheetConfig setFileNamePrefix(java.lang.String fileNamePrefix)

参数:

fileNamePrefix - 要设置的 fileNamePrefix

返回:

当前对象

getTitle

public java.lang.String getTitle()

setTitle

public SheetConfig setTitle(java.lang.String title)

getTitleFontName

public java.lang.String getTitleFontName()

setTitleFontName

public SheetConfig setTitleFontName(java.lang.String titleFontName)

getTitleFontHeight

public short getTitleFontHeight()

setTitleFontHeight

public SheetConfig setTitleFontHeight(short titleFontHeight)

setTitleFontHeight

public SheetConfig setTitleFontHeight(java.lang.Integer titleFontHeight)

getTitleFontColor

public org.apache.poi.ss.usermodel.IndexedColors getTitleFontColor()

setTitleFontColor

public SheetConfig setTitleFontColor(org.apache.poi.ss.usermodel.IndexedColors titleFontColor)

setTitleFontColor

public SheetConfig setTitleFontColor(java.lang.String titleFontColor)

getTitleFillColor

public org.apache.poi.ss.usermodel.IndexedColors getTitleFillColor()

setTitleFillColor

public SheetConfig setTitleFillColor(org.apache.poi.ss.usermodel.IndexedColors titleFillColor)

setTitleFillColor

public SheetConfig setTitleFillColor(java.lang.String titleFillColor)

getTitleHorizontalAlign

public org.apache.poi.ss.usermodel.HorizontalAlignment getTitleHorizontalAlign()

返回:

titleHorizontalAlign

setTitleHorizontalAlign

public SheetConfig setTitleHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment titleHorizontalAlign)

参数:

titleHorizontalAlign - 要设置的 titleHorizontalAlign

返回:

当前对象

setTitleHorizontalAlign

public SheetConfig setTitleHorizontalAlign(java.lang.String titleHorizontalAlign)

参数:

titleHorizontalAlign - 要设置的 titleHorizontalAlign

返回:

当前对象

getHeaderFontName

public java.lang.String getHeaderFontName()

setHeaderFontName

public SheetConfig setHeaderFontName(java.lang.String headerFontName)

getHeaderFontHeight

public short getHeaderFontHeight()

setHeaderFontHeight

public SheetConfig setHeaderFontHeight(short headerFontHeight)

setHeaderFontHeight

public SheetConfig setHeaderFontHeight(java.lang.Integer headerFontHeight)

getHeaderFontColor

public org.apache.poi.ss.usermodel.IndexedColors getHeaderFontColor()

setHeaderFontColor

public SheetConfig setHeaderFontColor(org.apache.poi.ss.usermodel.IndexedColors headerFontColor)

setHeaderFontColor

public SheetConfig setHeaderFontColor(java.lang.String headerFontColor)

getHeaderFillColor

public org.apache.poi.ss.usermodel.IndexedColors getHeaderFillColor()

setHeaderFillColor

public SheetConfig setHeaderFillColor(org.apache.poi.ss.usermodel.IndexedColors headerFillColor)

setHeaderFillColor

public SheetConfig setHeaderFillColor(java.lang.String headerFillColor)

getHeaderHorizontalAlign

public org.apache.poi.ss.usermodel.HorizontalAlignment getHeaderHorizontalAlign()

返回:

headerHorizontalAlign

setHeaderHorizontalAlign

public SheetConfig setHeaderHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment headerHorizontalAlign)

参数:

headerHorizontalAlign - 要设置的 headerHorizontalAlign

返回:

当前对象

setHeaderHorizontalAlign

public SheetConfig setHeaderHorizontalAlign(java.lang.String headerHorizontalAlign)

参数:

headerHorizontalAlign - 要设置的 headerHorizontalAlign

返回:

当前对象

isFirstBold

public boolean isFirstBold()

setFirstBold

public SheetConfig setFirstBold(boolean firstBold)

setFirstBold

public SheetConfig setFirstBold(java.lang.Boolean firstBold)

getFontHeight

public short getFontHeight()

setFontHeight

public SheetConfig setFontHeight(short fontHeight)

setFontHeight

public SheetConfig setFontHeight(java.lang.Integer fontHeight)

getFontName

public java.lang.String getFontName()

setFontName

public SheetConfig setFontName(java.lang.String fontName)

getFontColor

public org.apache.poi.ss.usermodel.IndexedColors getFontColor()

setFontColor

public SheetConfig setFontColor(org.apache.poi.ss.usermodel.IndexedColors fontColor)

setFontColor

public SheetConfig setFontColor(java.lang.String fontColor)

getFillColor

public org.apache.poi.ss.usermodel.IndexedColors getFillColor()

setFillColor

public SheetConfig setFillColor(org.apache.poi.ss.usermodel.IndexedColors fillColor)

setFillColor

public SheetConfig setFillColor(java.lang.String fillColor)

getHorizontalAlign

public org.apache.poi.ss.usermodel.HorizontalAlignment getHorizontalAlign()

setHorizontalAlign

public SheetConfig setHorizontalAlign(org.apache.poi.ss.usermodel.HorizontalAlignment horizontalAlign)

setHorizontalAlign

public SheetConfig setHorizontalAlign(java.lang.String horizontalAlign)

getIntegralFormat

public java.lang.String getIntegralFormat()

setIntegralFormat

public SheetConfig setIntegralFormat(java.lang.String integralFormat)

getDateTimeFormat

public java.lang.String getDateTimeFormat()

setDateTimeFormat

public SheetConfig setDateTimeFormat(java.lang.String dateTimeFormat)

getDateFormat

public java.lang.String getDateFormat()

setDateFormat

public SheetConfig setDateFormat(java.lang.String dateFormat)

getTimeFormat

public java.lang.String getTimeFormat()

setTimeFormat

public SheetConfig setTimeFormat(java.lang.String timeFormat)

getTimestampFormat

public java.lang.String getTimestampFormat()

setTimestampFormat

public SheetConfig setTimestampFormat(java.lang.String timestampFormat)

getScale

public int getScale()

setScale

public SheetConfig setScale(int scale)

getRoundingMode

public int getRoundingMode()

setRoundingMode

public SheetConfig setRoundingMode(int roundingMode)

getMaxWidth

public int getMaxWidth()

setMaxWidth

public SheetConfig setMaxWidth(int maxWidth)

setMaxWidth

public SheetConfig setMaxWidth(java.lang.Integer maxWidth)

getMaxHeight

public int getMaxHeight()

setMaxHeight

public SheetConfig setMaxHeight(int maxHeight)

setMaxHeight

public SheetConfig setMaxHeight(java.lang.Integer maxHeight)

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public SheetConfig setDefaultValue(java.lang.String defaultValue)

getIncludeColumns

public java.util.Set<java.lang.String> getIncludeColumns()

返回:

字段输出白名单

setIncludeColumns

public SheetConfig setIncludeColumns(java.util.Set<java.lang.String> includeColumns)

另请参阅:

setIncludeColumns(Iterable)

setIncludeColumns

public SheetConfig setIncludeColumns(java.lang.Iterable<java.lang.String> includeColumns)

指定要输出的字段(白名单),在此名单中的字段才会被输出, 此方法也定义了字段输出顺序,

参数:

includeColumns -

返回:

当前对象

setIncludeColumns

public SheetConfig setIncludeColumns(java.lang.String... includeColumns)

另请参阅:

setIncludeColumns(Iterable)

getExcludeColumns

public java.util.Set<java.lang.String> getExcludeColumns()

返回:

字段输出黑名单

setExcludeColumns

public SheetConfig setExcludeColumns(java.util.Set<java.lang.String> excludeColumns)

另请参阅:

setExcludeColumns(Iterable)

setExcludeColumns

public SheetConfig setExcludeColumns(java.lang.Iterable<java.lang.String> excludeColumns)

指定输出时要排序的字段(黑名单),在此名单中的字段不被输出

参数:

excludeColumns -

返回:

当前对象

setExcludeColumns

public SheetConfig setExcludeColumns(java.lang.String... excludeColumns)

另请参阅:

setExcludeColumns(Iterable)

getNestedNames

public java.util.List<java.lang.String> getNestedNames()

返回所有嵌入字段

从以下版本开始:

3.29.4

getHideColumns

public java.util.Set<java.lang.String> getHideColumns()

返回:

hideColumns

setHideColumns

public SheetConfig setHideColumns(java.util.Set<java.lang.String> hideColumns)

参数:

hideColumns - 要设置的 hideColumns

返回:

当前对象

setHideColumns

public SheetConfig setHideColumns(java.lang.Iterable<java.lang.String> hideColumns)

参数:

hideColumns - 要设置的 hideColumns

另请参阅:

setHideColumns(Iterable)

setHideColumns

public SheetConfig setHideColumns(java.lang.String... hideColumns)

参数:

hideColumns - 要设置的 hideColumns

返回:

当前对象

getDefaultIncludeColumns

public java.util.Set<java.lang.String> getDefaultIncludeColumns()

返回:

defaultIncludeColumns

setDefaultIncludeColumns

public SheetConfig setDefaultIncludeColumns(java.util.Set<java.lang.String> defaultIncludeColumns)

参数:

defaultIncludeColumns - 要设置的 defaultIncludeColumns

setDefaultIncludeColumns

public void setDefaultIncludeColumns(java.lang.Iterable<java.lang.String> defaultIncludeColumns)

参数:

defaultIncludeColumns - 要设置的 defaultIncludeColumns

setDefaultIncludeColumns

public void setDefaultIncludeColumns(java.lang.String... defaultIncludeColumns)

参数:

defaultIncludeColumns - 要设置的 defaultIncludeColumns

getDynamicExcelNames

public java.util.Set<java.lang.String> getDynamicExcelNames()

返回:

dynamicExcelNames

从以下版本开始:

3.26.0

setDynamicExcelNames

public void setDynamicExcelNames(java.util.Set<java.lang.String> dynamicExcelNames)

参数:

dynamicExcelNames - 要设置的 dynamicExcelNames

从以下版本开始:

3.26.0

getExportedColumnConfigs

public java.lang.Iterable<PropertyConfig> getExportedColumnConfigs()

返回需要导出的字段列表
如果字段输出白名单(includeColumns)不为空则返回此名单中的字段配置对象 如果字段输出黑名单excludeColumns不为空则返回不在此名单中的所有字段配置对象 否则返回所有字段;

getColumnConfigs

public java.lang.Iterable<PropertyConfig> getColumnConfigs()

返回所有字段配置对象

setColumnConfigs

public SheetConfig setColumnConfigs(java.lang.Iterable<PropertyConfig> columnConfigs)

getBeanClass

public java.lang.Class<?> getBeanClass()

setBeanClass

public void setBeanClass(java.lang.Class<?> beanClass)

getCustomImporter

public CustomBeanParser getCustomImporter()

setCustomImporter

public void setCustomImporter(CustomBeanParser customImporter)

setCustomImporter

public void setCustomImporter(java.lang.Class<? extends CustomBeanParser> customImporterClass)

getQueueTimeout

public int getQueueTimeout()

setQueueTimeout

public void setQueueTimeout(int queueTimeout)

getTotalRowCount

public long getTotalRowCount()

setTotalRowCount

public void setTotalRowCount(long totalRowCount)

addColumns

public SheetConfig addColumns(java.lang.Iterable<PropertyConfig> elements)

addColumns

public SheetConfig addColumns(PropertyConfig... elements)

addNestedColumns

public SheetConfig addNestedColumns(java.lang.Iterable<java.lang.String> elements)

addNestedColumns

public SheetConfig addNestedColumns(java.lang.String... elements)

addNestedColumn

public SheetConfig addNestedColumn(java.lang.String nestedName,
                                   java.lang.String descName)

exists

public boolean exists(java.lang.String nestedName)

configOrNullOf

public PropertyConfig configOrNullOf(java.lang.String nestedName)

根据属性路径名查找对应的属性配置对象，没找到返回null

参数:

nestedName -

configByExcelName

public PropertyConfig configByExcelName(java.lang.String excelName)

根据EXCEL输出字段名名查找对应的属性配置对象，没找到返回null,如果有多个匹配返回第一个

参数:

excelName - 为null或空返回null

从以下版本开始:

3.26.0

configOf

public PropertyConfig configOf(java.lang.String nestedName)

根据属性路径名查找对应的属性配置对象，没找到返回则创建一个默认对象
查找时如果没有找到完全匹配的值会自动切换节点名为驼峰命名格式或蛇形命名格式尝试

参数:

nestedName -

getRowHeight

public short getRowHeight()

根据注解获取最大行高

merge

public SheetConfig merge(SheetConfig other)

将输入的Excel表配置与当前对象的合并
将other中有定义的Excel Sheet配置字段复制到当前对象的对应字段
将other定义的Excel Column配置对象(PropertyConfig)合并到当前的Column配置对象中,如果存在相同的对象,则以other的为准,
如果other.beanClass不为null则复制到当前对象的同名字段

参数:

other -

返回:

当前对象

另请参阅:

MethodSupport.mergeAnnotaionFields(Class, Object, Object), ColumnConfig.merge(ColumnConfig)

getAvailableColumns

public java.util.Map<java.lang.String,java.lang.String> getAvailableColumns()

返回所有可输出字段及字段显示名称

getImportColumnConfigs

public java.util.Collection<PropertyConfig> getImportColumnConfigs()

返回需要导出的字段列表
如果字段输出黑名单excludeColumns不为空则返回不在此名单中的所有字段配置对象 否则返回所有字段;

从以下版本开始:

3.29.4

getExcelConfigs

public java.util.Map<java.lang.String,PropertyConfig> getExcelConfigs()

返回所有EXCEL字段名称-PropertyConfig映射

从以下版本开始:

3.29.0

getDefaultExportColumns

public java.util.Map<java.lang.String,java.lang.String> getDefaultExportColumns()

根据defaultIncludeColumns过滤返回默认输出的字段名和Excel导出时的列名

getDefaultExportColumnNames

public java.util.Set<java.lang.String> getDefaultExportColumnNames()

根据defaultIncludeColumns过滤返回默认输出的字段名

setIncludeColumnsOrDefault

public SheetConfig setIncludeColumnsOrDefault(java.lang.Iterable<java.lang.String> includeColumns)

指定要输出的字段(白名单),如果输入参数为null或空,则使用getDefaultExportColumnNames()的返回值

参数:

includeColumns -

返回:

当前对象

另请参阅:

setIncludeColumns(Iterable)

getIncludeColumnsOrDefault

public java.util.Set<java.lang.String> getIncludeColumnsOrDefault()

mayBeJavaBean

public static boolean mayBeJavaBean(java.lang.Class<?> type)