com.ludii.excel.parse.ExcelFieldDefined Maven / Gradle / Ivy
package com.ludii.excel.parse;
import com.ludii.excel.annotation.ExcelField;
import com.ludii.excel.handler.TypeHandler;
/**
* @author 陆迪
* @date 2022/3/24
*/
public interface ExcelFieldDefined {
/**
* 导出字段名（默认调用当前字段的“get”方法，如指定导出字段为对象，请填写“对象名.对象属性”，例：“area.name”、“office.name”）
*
* @return 返回值
*/
String attrName();
/**
* 导出字段标题（需要添加批注请用“**”分隔，标题**批注，仅对导出模板有效）
*
* @return 返回值
*/
String title();
/**
* 字段类型（0：导出导入；1：仅导出；2：仅导入）
*
* @return 返回值
*/
ExcelField.Type type();
/**
* 导出字段对齐方式（0：自动；1：靠左；2：居中；3：靠右）
*
* @return 返回值
*/
ExcelField.Align align();
/**
* 指定导出列宽（以字符宽度的1/256为单位，假如你想显示5个字符的话，就可以设置5*256，1个汉字占2个字符）
*
* @return 返回值
*/
int width();
/**
* 指定导出列宽可以显示的字符个数（words*256=width，1个汉字占2个字符） v4.2.0
*
* @return 返回值
*/
int words();
/**
* 导出字段字段排序（升序）
*
* @return 返回值
*/
int sort();
/**
* 导入时指定列索引（从0开始）在指定读取excel中的指定的列时使用
*
* @return 返回值
*/
int column();
/**
* 如果是字典类型，请设置字典的type值
*
* @return 返回值
*/
String dictType();
/**
* 反射类型
* MoneyType.class 金额类型转换（保留两位）
*
* @return 返回值
*/
Class> typeHandler();
/**
* 数值格式（例如：数值：0.00；日期：yyyy-MM-dd；金额：￥#,##0.00）
*
* @return 返回值
*/
String dataFormat();
/**
* 字段归属组（针对每一种业务的导入、导出） imp、exp
* 只有包含groups包含了传入的group参数，此注解才有效
*
* @return 返回值
*/
String[] groups();
}