org.ttzero.excel.reader

类 HeaderRow

java.lang.Object

org.ttzero.excel.reader.Row

org.ttzero.excel.reader.HeaderRow

public class HeaderRow
extends Row

表头行，包含列与对象的映射关系

作者:

guanquan.wang at 2019-04-17 11:55

字段概要

字段

限定符和类型	字段和说明
static int	CAMEL_CASE Camel Case (CAMEL_CASE to camelCase)
protected Class<?>	clazz
protected ListSheet.EntryColumn[]	columns
static int	FORCE_IMPORT Force Import (Match with field name if without ExcelColumn annotation)
protected int	headRows
static int	IGNORE_CASE Ignore Case (Ignore case matching column names)
protected Map<String,Integer>	mapping
protected String[]	names
protected int	option Simple properties Bit | Contents ------+--------- 31. 1 | Force Import 30. 1 | Ignore Case (Ignore case matching column names) 29. 1 | Camel Case
protected Object	t

从类继承的字段 org.ttzero.excel.reader.Row

cells, fc, hr, lc, LOGGER, rowNum, sharedCalc, sst, styles, unknownLength

构造器概要

构造器

构造器和说明
HeaderRow()

方法概要

限定符和类型	方法和说明
protected Map<String,Method>	attachOtherColumn(Class<?> clazz) Attach some others column
protected int	check(String first, String second)
protected ListSheet.EntryColumn	createColumn(AccessibleObject ao) Create column from ExcelColumn annotation Override the method to extend custom comments
protected ListSheet.EntryColumn	createColumnByAnnotation(Annotation anno) Create column by ExcelColumn annotation
static HeaderRow	emptyHeader()
protected void	fieldPut(int i, Row row, Object t)
String	get(int columnIndex) Get the column name by column index
CellType	getCellType(int columnIndex) 获取单元格的数据类型 注意：这里仅是一个近似的类型，因为从原始文件中只能获取到numeric，string， boolean三种类型。
Class<?>	getClazz()
protected ListSheet.EntryColumn[]	getColumns()
int	getIndex(String columnName) Returns the position in cell range
String[]	getNames() Get the name of columns
<T> T	getT()
protected boolean	ignoreColumn(AccessibleObject ao) Ignore some columns, override this method to add custom filtering
boolean	is(Class<?> clazz)
protected String	makeKey(String key)
protected void	mergeCellsIfNull(List<Dimension> mergeCells, Row[] rows) Copy column name on merge cells
protected void	methodPut(int i, Row row, Object t)
protected HeaderRow	setClass(Class<?> clazz) mapping
protected HeaderRow	setClassOnce(Class<?> clazz) mapping and instance
HeaderRow	setOptions(int option)
protected int	simpleTestLength(String name) 已过时。 未使用，后续删除
String	toMarkdownString() 已过时。 未使用，后续删除
String	toString()
HeaderRow	with(int headRows, Row... rows)
HeaderRow	with(List<Dimension> mergeCells, int headRows, Row... rows)
HeaderRow	with(List<Dimension> mergeCells, Row... rows)
HeaderRow	with(Row... rows)

从类继承的方法 org.ttzero.excel.reader.Row

asHeader, copyCells, copyCells, geet, get, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCell, getCell, getCellStyle, getCellStyle, getCellStyle, getCellType, getCellType, getChar, getChar, getChar, getDate, getDate, getDate, getDecimal, getDecimal, getDecimal, getDouble, getDouble, getDouble, getFirstColumnIndex, getFloat, getFloat, getFloat, getFormula, getFormula, getFormula, getHeader, getHeight, getInt, getInt, getInt, getLastColumnIndex, getLocalDate, getLocalDate, getLocalDate, getLocalDateTime, getLocalDateTime, getLocalDateTime, getLocalTime, getLocalTime, getLocalTime, getLong, getLong, getLong, getRowIndex, getRowNum, getSharedStrings, getShort, getShort, getShort, getString, getString, getString, getStyles, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, hasFormula, hasFormula, hasFormula, isBlank, isBlank, isBlank, isBlank, isEmpty, isHidden, nonBlank, nonEmpty, rangeCheck, setCells, setCells, setHeader, testNumberType, to, toCellIndex, toMap, too

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

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

字段详细资料

FORCE_IMPORT

public static final int FORCE_IMPORT

Force Import (Match with field name if without ExcelColumn annotation)

另请参阅:

常量字段值

IGNORE_CASE

public static final int IGNORE_CASE

Ignore Case (Ignore case matching column names)

另请参阅:

常量字段值

CAMEL_CASE

public static final int CAMEL_CASE

Camel Case (CAMEL_CASE to camelCase)

另请参阅:

常量字段值

names

protected String[] names

clazz

protected Class<?> clazz

t

protected Object t

mapping

protected Map<String,Integer> mapping

columns

protected ListSheet.EntryColumn[] columns

headRows

protected int headRows

option

protected int option

Simple properties

  Bit  | Contents
 ------+---------
 31. 1 | Force Import
 30. 1 | Ignore Case (Ignore case matching column names)
 29. 1 | Camel Case
 

构造器详细资料

HeaderRow

public HeaderRow()

方法详细资料

with

public HeaderRow with(Row... rows)

with

public HeaderRow with(int headRows,
                      Row... rows)

with

public HeaderRow with(List<Dimension> mergeCells,
                      Row... rows)

with

public HeaderRow with(List<Dimension> mergeCells,
                      int headRows,
                      Row... rows)

emptyHeader

public static HeaderRow emptyHeader()

is

public final boolean is(Class<?> clazz)

setClass

protected HeaderRow setClass(Class<?> clazz)

mapping

参数:

clazz - the type of binding

返回:

the header row

check

protected int check(String first,
                    String second)

setClassOnce

protected HeaderRow setClassOnce(Class<?> clazz)
                          throws IllegalAccessException,
                                 InstantiationException

mapping and instance

参数:

clazz - the type of binding

返回:

the header row

抛出:

IllegalAccessException - -

InstantiationException - -

getColumns

protected ListSheet.EntryColumn[] getColumns()

getT

public <T> T getT()

getClazz

public Class<?> getClazz()

getCellType

public CellType getCellType(int columnIndex)

从类复制的说明: Row

获取单元格的数据类型

注意：这里仅是一个近似的类型，因为从原始文件中只能获取到numeric，string， boolean三种类型。在解析到原始类型之后对于numeric类型会根据数字大小和格式重新设置类型， 比如小于0x7fffffff的值为int，超过这个范围时为long，如果带日期格式化则为date类型， 小数也是同样处理，有日期格式化为data类型否则为decimal类型

覆盖:

getCellType 在类中 Row

参数:

columnIndex - 列索引

返回:

单元格的数据类型 CellType

get

public String get(int columnIndex)

Get the column name by column index

参数:

columnIndex - the cell index

返回:

name of column

getNames

public String[] getNames()

Get the name of columns

返回:

name of columns

getIndex

public int getIndex(String columnName)

Returns the position in cell range

参数:

columnName - the column name

返回:

the position if found otherwise -1

toString

public String toString()

覆盖:

toString 在类中 Row

toMarkdownString

@Deprecated
public String toMarkdownString()

已过时。 未使用，后续删除

markdown string

返回:

markdown string

simpleTestLength

@Deprecated
protected int simpleTestLength(String name)

已过时。 未使用，后续删除

简单计算文本长度

参数:

name - 标题

返回:

文本长度

fieldPut

protected void fieldPut(int i,
                        Row row,
                        Object t)
                 throws IllegalAccessException

抛出:

IllegalAccessException

methodPut

protected void methodPut(int i,
                         Row row,
                         Object t)
                  throws IllegalAccessException,
                         InvocationTargetException

抛出:

IllegalAccessException

InvocationTargetException

ignoreColumn

protected boolean ignoreColumn(AccessibleObject ao)

Ignore some columns, override this method to add custom filtering

参数:

ao - Method or Field

返回:

true if ignore current column

attachOtherColumn

protected Map<String,Method> attachOtherColumn(Class<?> clazz)

Attach some others column

参数:

clazz - Target class

返回:

a column and Write method mapping

createColumn

protected ListSheet.EntryColumn createColumn(AccessibleObject ao)

Create column from ExcelColumn annotation

Override the method to extend custom comments

参数:

ao - AccessibleObject witch defined the ExcelColumn annotation

返回:

the Worksheet's ListSheet.EntryColumn information

createColumnByAnnotation

protected ListSheet.EntryColumn createColumnByAnnotation(Annotation anno)

Create column by ExcelColumn annotation

参数:

anno - an java annotation

返回:

Column or null if annotation is null

mergeCellsIfNull

protected void mergeCellsIfNull(List<Dimension> mergeCells,
                                Row[] rows)

Copy column name on merge cells

参数:

mergeCells - merged cell in header rows

rows - the header rows

setOptions

public HeaderRow setOptions(int option)

makeKey

protected String makeKey(String key)