com.auxiliary.tool.file

Class FileTemplet

java.lang.Object

com.auxiliary.tool.file.FileTemplet

Direct Known Subclasses:

ExcelFileTemplet

public class FileTemplet
extends Object

文件名：FileTemplet.java

用途： 指定创建的模板文件时文件拥有的属性。根据不同的创建文件方式，模板的属性可能有所不同， 需要根据相关的文件写入类来决定使用的属性

编码时间：2021年5月10日上午8:26:10

修改时间：2021年6月12日下午3:21:29

Since:

JDK 1.8, autest 2.4.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FIELD
static String	KEY_INDEX
static String	KEY_NAME
static String	KEY_SAVE
protected com.alibaba.fastjson.JSONObject	templetJson 存储模板json串

Constructor Summary

Constructors

Constructor and Description
FileTemplet(File saveFile) 初始化模板文件的保存路径
FileTemplet(String templetJsonText) 根据已有的模板json串，初始化模板

Method Summary

Modifier and Type	Method and Description
void	addField(String field) 用于向模板中添加字段ID信息
void	addFieldAttribute(String field, String attName, Object attValue) 用于设置模板的属性
void	addTempletAttribute(String attName, Object attValue) 用于添加模板属性
boolean	containsAttribute(String attribute) 判断模板中是否存在指定的属性
boolean	containsField(String field) 判断模板中是否存在指定的字段
Object	getFieldAttribute(String field, String attName) 用于返回字段的属性内容
Set<String>	getFieldList() 用于返回模板中的字段集合
Object	getTempletAttribute(String attName) 用于返回模板的属性
Set<String>	getTempletAttributeList() 用于返回模板中的属性集合
String	getTempletJson() 用于返回创建的模板json串
void	setSaveFile(File saveFile) 用于变更模板的保存路径
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SAVE

public static final String KEY_SAVE

See Also:

Constant Field Values

KEY_FIELD

public static final String KEY_FIELD

See Also:

Constant Field Values

KEY_INDEX

public static final String KEY_INDEX

See Also:

Constant Field Values

KEY_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

templetJson

protected com.alibaba.fastjson.JSONObject templetJson

存储模板json串

Constructor Detail

FileTemplet

public FileTemplet(File saveFile)

初始化模板文件的保存路径

Parameters:

saveFile - 模板文件保存路径

FileTemplet

public FileTemplet(String templetJsonText)

根据已有的模板json串，初始化模板

Parameters:

templetJsonText - 模板json串

Method Detail

setSaveFile

public void setSaveFile(File saveFile)

用于变更模板的保存路径

Parameters:

saveFile - 模板文件保存路径

addField

public void addField(String field)

用于向模板中添加字段ID信息

创建写入文件内容的字段定位信息，在写入文件内容时，将根据该ID内容，查找到相应的字段，进而将相应的内容写入到文件的正确位置中

Parameters:

field - 字段ID

addFieldAttribute

public void addFieldAttribute(String field,
                              String attName,
                              Object attValue)

用于设置模板的属性

该属性为模板文件中字段所拥有的属性，用于在文件中的特殊处理。字段可拥有多个属性，需根据实际的文件写入类来确定生效的属性。当未添加字段ID时，则不会写入信息

Parameters:

field - 字段ID

attName - 属性名称

attValue - 属性值

getFieldAttribute

public Object getFieldAttribute(String field,
                                String attName)

用于返回字段的属性内容

Parameters:

field - 字段名称

attName - 属性名称

Returns:

属性对应的内容

addTempletAttribute

public void addTempletAttribute(String attName,
                                Object attValue)

用于添加模板属性

该属性为模板中的属性，对于不同的模板文件而言，可能存在不同的处理方式，故可通过添加该属性来执行处理的方式。

Parameters:

attName - 属性名称

attValue - 属性值

getTempletAttribute

public Object getTempletAttribute(String attName)

用于返回模板的属性

Parameters:

attName - 属性名

Returns:

属性值

getTempletJson

public String getTempletJson()

用于返回创建的模板json串

Returns:

模板json串

containsField

public boolean containsField(String field)

判断模板中是否存在指定的字段

Parameters:

field - 字段

Returns:

模板中是否存在指定的字段

containsAttribute

public boolean containsAttribute(String attribute)

判断模板中是否存在指定的属性

Parameters:

attribute - 属性

Returns:

模板中是否存在指定的属性

getFieldList

public Set<String> getFieldList()

用于返回模板中的字段集合

Returns:

字段Set集合

getTempletAttributeList

public Set<String> getTempletAttributeList()

用于返回模板中的属性集合

Returns:

属性集合

toString

public String toString()

Overrides:

toString in class Object