com.auxiliary.tool.file

Class WriteMultipleTempletFile<T extends WriteMultipleTempletFile<T>>

java.lang.Object

com.auxiliary.tool.file.WriteTempletFile<T>

com.auxiliary.tool.file.WriteMultipleTempletFile<T>

Type Parameters:

T - 子类

All Implemented Interfaces:

AddPlaceholder, WriteFilePage

Direct Known Subclasses:

WriteExcelTempletFile

public abstract class WriteMultipleTempletFile<T extends WriteMultipleTempletFile<T>>
extends WriteTempletFile<T>
implements WriteFilePage

文件名：WriteMultipleTempletFile.java

用途： 提供对多模板内容数据写入的方法，详细内容可参见父类WriteTempletFile说明

编码时间：2021年5月31日下午8:50:35

修改时间：2021年8月27日下午7:43:03

Since:

JDK 1.8

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,WriteFileData>	dataMap 存储每个模板的数据
protected String	DEFAULT_NAME 记录模板的默认名称

Fields inherited from class com.auxiliary.tool.file.WriteTempletFile

caseIndex, data, endField, KEY_CASE, KEY_CONTENT, KEY_DATA, KEY_DEFAULT, KEY_TEMPLET, KEY_TEXT, placeholder, WORD_SIGN, writeRowNum

Fields inherited from interface com.auxiliary.tool.file.WriteFilePage

KEY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriteMultipleTempletFile()
	WriteMultipleTempletFile(String templetName, FileTemplet templet) 构造对象，初始化创建文件的模板

Method Summary

Modifier and Type	Method and Description
void	addTemplet(String name, FileTemplet templet) 添加Sheet页模板，并设置模板的名称
T	end(int contentIndex) 标记完成一条用例数据的编写，并将内容插入到指定行内容下
protected List<String>	getAllTempletJson() 将类中存储的模板类转换为模板json串，通过List集合收集后，进行返回
protected HashMap<String,WriteFileData>	getDataMap() 用于返回当前的数据集合
FileTemplet	getTemplet(String name) 用于返回指定名称的模板类
WriteFileData	getWriteFileData(String name) 用于返回模板名称对应的待写入数据类对象
protected abstract boolean	isExistTemplet(File templetFile, FileTemplet templet) 用于判断当前模板是否存在于模板文件中
void	setWriteData(WriteFileData data) 用于将其他写入类对象的待写入信息设置到当前类对象中
void	switchPage(String name) 根据模板名称，对模板文件进行切换
void	write() 用于将编写的所有内容写入到文件中
void	write(FileTemplet templet, int caseStartIndex, int caseEndIndex) 用于将编写的部分内容写入到文件中

Methods inherited from class com.auxiliary.tool.file.WriteTempletFile

addContent, addContent, addContent, addContent, addReplaceFunction, addReplaceWord, analysisIndex, clearCase, clearContent, clearFieldValue, contentWriteTemplet, createTempletFile, disposeWriteFieldsContent, end, getCase, getPlaceholder, getTextJson, getWriteData, replenishDefaultContent, setContentJson, setEndField, setFieldValue, setFileTemplet, setPlaceholder, setWriteRowNum, toTempletJson, toWriteFileJson

Methods inherited from class java.lang.Object

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

Field Detail

dataMap

protected HashMap<String,WriteFileData> dataMap

存储每个模板的数据

DEFAULT_NAME

protected final String DEFAULT_NAME

记录模板的默认名称

See Also:

Constant Field Values

Constructor Detail

WriteMultipleTempletFile

public WriteMultipleTempletFile(String templetName,
                                FileTemplet templet)

构造对象，初始化创建文件的模板

Parameters:

templetName - 模板名称

templet - 模板类对象

WriteMultipleTempletFile

protected WriteMultipleTempletFile()

Method Detail

switchPage

public void switchPage(String name)

Description copied from interface: WriteFilePage

根据模板名称，对模板文件进行切换

Specified by:

switchPage in interface WriteFilePage

Parameters:

name - 模板名称

setWriteData

public void setWriteData(WriteFileData data)

Description copied from class: WriteTempletFile

用于将其他写入类对象的待写入信息设置到当前类对象中

调用该方法后，会将传入的WriteFileData类对象中，除模板外的信息覆盖到当前的模板类中，等同于进行数据的复制

Overrides:

setWriteData in class WriteTempletFile<T extends WriteMultipleTempletFile<T>>

Parameters:

data - 待写入信息类对象，可通过WriteTempletFile.getWriteData()方法获取

getTemplet

public FileTemplet getTemplet(String name)

Description copied from interface: WriteFilePage

用于返回指定名称的模板类

Specified by:

getTemplet in interface WriteFilePage

Parameters:

name - 模板名称

Returns:

相应名称的模板类

getWriteFileData

public WriteFileData getWriteFileData(String name)

Description copied from interface: WriteFilePage

用于返回模板名称对应的待写入数据类对象

Specified by:

getWriteFileData in interface WriteFilePage

Parameters:

name - 模板名称

Returns:

待写入数据类对象

addTemplet

public void addTemplet(String name,
                       FileTemplet templet)

添加Sheet页模板，并设置模板的名称

每一个模板表示写入Excel时的一个Sheet页，其模板的名称即为Sheet页的名称。若重复添加同一个名称，则会覆盖上一次设置的模板。

Specified by:

addTemplet in interface WriteFilePage

Parameters:

name - 模板名称

templet - 模板类对象

end

public T end(int contentIndex)

Description copied from class: WriteTempletFile

标记完成一条用例数据的编写，并将内容插入到指定行内容下

调用该方法后，则将数据的缓存写入到文本的缓存内容中，以表示当前段落数据编写完成， 之后再次调用添加数据方法时，则写入一段新的内容。

注意：若调用了WriteTempletFile.getCase(int)方法覆盖指定行内容的用例时，则传入的下标无效

Overrides:

end in class WriteTempletFile<T extends WriteMultipleTempletFile<T>>

Parameters:

contentIndex - 内容下标

Returns:

类本身

write

public void write()

Description copied from class: WriteTempletFile

用于将编写的所有内容写入到文件中

Specified by:

write in class WriteTempletFile<T extends WriteMultipleTempletFile<T>>

write

public void write(FileTemplet templet,
                  int caseStartIndex,
                  int caseEndIndex)

Description copied from class: WriteTempletFile

用于将编写的部分内容写入到文件中

方法支持反序遍历，即指定的下标为负数时，则表示反序遍历用例集，至指定位置的用例。若两个下标一致，则不处理数据

Specified by:

write in class WriteTempletFile<T extends WriteMultipleTempletFile<T>>

Parameters:

templet - 需要写入的模板类对象

caseStartIndex - 写入文件开始下标

caseEndIndex - 写入文件结束下标

getAllTempletJson

protected List<String> getAllTempletJson()

Description copied from class: WriteTempletFile

将类中存储的模板类转换为模板json串，通过List集合收集后，进行返回

Specified by:

getAllTempletJson in class WriteTempletFile<T extends WriteMultipleTempletFile<T>>

Returns:

返回类中所有的模板json串

isExistTemplet

protected abstract boolean isExistTemplet(File templetFile,
                                          FileTemplet templet)

用于判断当前模板是否存在于模板文件中

该方法用于作为是否需要创建模板文件的依据

Parameters:

templetFile - 模板文件对象

templet - 模板对象

Returns:

模板对象是否存在于模板文件中

getDataMap

protected HashMap<String,WriteFileData> getDataMap()

用于返回当前的数据集合

Returns:

数据集合