XMetadata (qdbp-tools 3.3.2 API)

java.lang.Object
- com.gitee.qdbp.tools.excel.XMetadata

所有已实现的接口:

Serializable

直接已知子类:

MergeMetadata, ToJsonMetadata
```
public class XMetadata
extends Object
implements Serializable
```
excel配置数据
有哪些配置项详见MetadataTools.parseProperties(Properties)

版本:

160302

作者:

zhaohuihua

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

XMetadata()

XMetadata(Config config)
已过时。
改为MetadataTools.parseProperties(Properties)

构造器
构造器和说明
`XMetadata()`
`XMetadata(Config config)` 已过时。改为MetadataTools.parseProperties(Properties)

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addColumn(FieldInfo fieldInfo)` 增加字段名称信息
`void`	`addCopyConcatFields(CopyConcat... copyConcatFields)` 增加字段复制合并参数
`void`	`addRule(String column, List<CellRule> rule)` 增加转换规则
`void`	`addSkipRowWhen(MatchesRowCondition condition)` 增加跳过某行的关键字
`List<CopyConcat>`	`getCopyConcatFields()` 字段复制合并参数
`List<FieldInfo>`	`getFieldInfos()` 字段信息列表
`IndexRangeCondition`	`getFieldRows()` 字段名所在的行
`IndexRangeCondition`	`getFooterRows()` 页脚所在的行号
`IndexRangeCondition`	`getHeaderRows()` 表头所在的行号
`List<CellRule>`	`getRule(String column)` 获取指定列的转换规则
`Map<String,List<CellRule>>`	`getRules()` 字段与转换规则的映射表
`IndexListCondition`	`getSheetIndexs()` Sheet序号配置, 默认读取第1个Sheet
`String`	`getSheetNameFillTo()` Sheet名称填充至哪个字段
`NameListCondition`	`getSheetNames()` Sheet名称配置, 默认全部匹配
`Integer`	`getSkipRows()` 跳过几行
`List<MatchesRowCondition>`	`getSkipRowWhen()` 包含指定关键字时跳过此行
`boolean`	`isEnableSheet(int sheetIndex, String sheetName)` 判断指定页签是否有效
`boolean`	`isFieldRow(int rowIndex)` 判断指定行是否为字段行
`boolean`	`isFooterRow(int rowIndex)` 判断指定行是否为页脚
`boolean`	`isHeaderRow(int rowIndex)` 判断指定行是否为页头
`boolean`	`isSkipRow(org.apache.poi.ss.usermodel.Row row)` 判断指定行是否跳过
`void`	`setCopyConcatFields(List<CopyConcat> copyConcatFields)` 字段复制合并参数
`void`	`setFieldInfos(List<FieldInfo> fieldInfos)` 字段信息列表
`void`	`setFieldRows(IndexRangeCondition fieldRows)` 字段名所在的行
`void`	`setFooterRows(IndexRangeCondition footerRows)` 页脚所在的行号
`void`	`setHeaderRows(IndexRangeCondition headerRows)` 表头所在的行号
`void`	`setRules(Map<String,List<CellRule>> rules)` 字段与转换规则的映射表
`void`	`setSheetIndexs(IndexListCondition sheetIndexs)` Sheet序号配置, 默认读取第1个Sheet
`void`	`setSheetNameFillTo(String sheetNameFillTo)` Sheet名称填充至哪个字段
`void`	`setSheetNames(NameListCondition sheetNames)` Sheet名称配置, 默认全部匹配
`void`	`setSkipRows(Integer skipRows)` 跳过几行
`void`	`setSkipRowWhen(List<MatchesRowCondition> skipRowWhen)` 包含指定关键字时跳过此行
`<T extends XMetadata> T`	`to(Class<T> clazz)` 将当前对象转换为子类对象

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料
- XMetadata
```
public XMetadata()
```
- XMetadata
```
@Deprecated
public XMetadata(Config config)
```
  已过时。改为MetadataTools.parseProperties(Properties)
  
  构造函数
  
  参数:
  
  config - 配置项

方法详细资料

isEnableSheet

public boolean isEnableSheet(int sheetIndex,
                             String sheetName)

判断指定页签是否有效

isFieldRow
```
public boolean isFieldRow(int rowIndex)
```
判断指定行是否为字段行

isHeaderRow

public boolean isHeaderRow(int rowIndex)

判断指定行是否为页头

isFooterRow

public boolean isFooterRow(int rowIndex)

判断指定行是否为页脚

isSkipRow

public boolean isSkipRow(org.apache.poi.ss.usermodel.Row row)

判断指定行是否跳过

getFieldInfos

public List<FieldInfo> getFieldInfos()

字段信息列表

setFieldInfos

public void setFieldInfos(List<FieldInfo> fieldInfos)

字段信息列表

addColumn

public void addColumn(FieldInfo fieldInfo)

增加字段名称信息

getSkipRows
```
public Integer getSkipRows()
```
跳过几行

setSkipRows

public void setSkipRows(Integer skipRows)

跳过几行

getSkipRowWhen

public List<MatchesRowCondition> getSkipRowWhen()

包含指定关键字时跳过此行

setSkipRowWhen

public void setSkipRowWhen(List<MatchesRowCondition> skipRowWhen)

包含指定关键字时跳过此行

addSkipRowWhen

public void addSkipRowWhen(MatchesRowCondition condition)

增加跳过某行的关键字

getFieldRows

public IndexRangeCondition getFieldRows()

字段名所在的行

setFieldRows

public void setFieldRows(IndexRangeCondition fieldRows)

字段名所在的行

getHeaderRows

public IndexRangeCondition getHeaderRows()

表头所在的行号

setHeaderRows

public void setHeaderRows(IndexRangeCondition headerRows)

表头所在的行号

getFooterRows

public IndexRangeCondition getFooterRows()

页脚所在的行号

setFooterRows

public void setFooterRows(IndexRangeCondition footerRows)

页脚所在的行号

getSheetIndexs
```
public IndexListCondition getSheetIndexs()
```
Sheet序号配置, 默认读取第1个Sheet

setSheetIndexs

public void setSheetIndexs(IndexListCondition sheetIndexs)

Sheet序号配置, 默认读取第1个Sheet

getSheetNames
```
public NameListCondition getSheetNames()
```
Sheet名称配置, 默认全部匹配

setSheetNames

public void setSheetNames(NameListCondition sheetNames)

Sheet名称配置, 默认全部匹配

getSheetNameFillTo
```
public String getSheetNameFillTo()
```
Sheet名称填充至哪个字段

setSheetNameFillTo

public void setSheetNameFillTo(String sheetNameFillTo)

Sheet名称填充至哪个字段

getRules

public Map<String,List<CellRule>> getRules()

字段与转换规则的映射表

setRules

public void setRules(Map<String,List<CellRule>> rules)

字段与转换规则的映射表

addRule

public void addRule(String column,
                    List<CellRule> rule)

增加转换规则

getRule

public List<CellRule> getRule(String column)

获取指定列的转换规则

getCopyConcatFields

public List<CopyConcat> getCopyConcatFields()

字段复制合并参数

setCopyConcatFields

public void setCopyConcatFields(List<CopyConcat> copyConcatFields)