AbstractDocMaker (Bigbird Framework 1.0.0-SNAPSHOT API)

java.lang.Object
- wang.bigbird.domain.framework.document.api.AbstractDocMaker

所有已实现的接口:

DocMaker

直接已知子类:

AbstractWordMaker, ExcelMaker, HtmlMaker, PdfMaker, PptMaker
```
public abstract class AbstractDocMaker
extends Object
implements DocMaker
```
抽象的文档制作器

作者:

Bigbird

字段概要
- 从接口继承的字段 wang.bigbird.domain.framework.document.api.DocMaker
  AREA_DEFINE_END, AREA_DEFINE_START, AT, BOOL_DATA_TYPE_DEFAULT_INDEX, DATA_TYPE_BOOL, DATA_TYPE_DATE, DATA_TYPE_DEC, DATA_TYPE_IMAGE, DATA_TYPE_INT, DATA_TYPE_SELECT, DATA_TYPE_STR, DATA_TYPE_TABLE, DATA_TYPE_TEXT, DATE_DATA_TYPE_DEFAULT_INDEX, DATE_DATA_TYPE_FORMAT_INDEX, DATE_DATA_TYPE_MAX_INDEX, DATE_DATA_TYPE_MIN_INDEX, DEC_DATA_TYPE_DEFAULT_INDEX, DEC_DATA_TYPE_MAX_INDEX, DEC_DATA_TYPE_MIN_INDEX, DEC_DATA_TYPE_PRECISION_INDEX, DEFAULT_VALUE, DRS_FILE_SUFFIX, FORMAT_RULE_BASIC, FORMAT_RULE_FILE, IMAGE_BMP, IMAGE_CELL_AREA_DEFINE_NUM, IMAGE_CELL_AREA_DEFINE_SEPARATE, IMAGE_DATA_TYPE_HEIGHT_INDEX, IMAGE_DATA_TYPE_WIDTH_INDEX, IMAGE_JPEG, IMAGE_JPG, IMAGE_PNG, INT_DATA_TYPE_DEFAULT_INDEX, INT_DATA_TYPE_MAX_INDEX, INT_DATA_TYPE_MIN_INDEX, KEYWORD_PAGE_NUMBER, RULE_DEFINE_MIN_NUM, RULE_ELEMENT_SEPARATE, RULE_ELEMENT_SEPARATE_REGEX, SELECT_DATA_TYPE_DEFAULT_INDEX, SELECT_DATA_TYPE_ITEM_TEXT_VALUE_SEPARATE, SELECT_DATA_TYPE_ITEMS_INDEX, SELECT_DATA_TYPE_ITEMS_SEPARATE, STR_DATA_TYPE_DEFAULT_INDEX, STR_DATA_TYPE_FILTER_INDEX, STR_DATA_TYPE_LENGTH_INDEX, STR_DATA_TYPE_LIMIT_INDEX, TABLE_CELL_AREA_DEFINE_PAIR_NUM, TABLE_CELL_AREA_DEFINE_SEPARATE, TABLE_CELL_AREA_START_END_SEPARATE, TABLE_CELL_SPECIAL_MERGE_AREA_DEFINE_MARK, TABLE_DATA_TYPE_PAGE_MAX_ROW_INDEX, TABLE_DATA_TYPE_PAGE_MIN_ROW_INDEX, TABLE_DATA_TYPE_TABLE_INDEX_INDEX, TAG_END, TAG_START, TEMPLATE_FILE_PREFIX, TIP_START

构造器概要

构造器
构造器和说明

AbstractDocMaker()

构造器
构造器和说明
`AbstractDocMaker()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected BufferedImage`	`createScaleBufferedImage(BufferedImage image, int scaleWidth, int scaleHeight)` 创建期望宽高的缓存图，保持原有图像宽高比
`protected abstract List<String>`	`doMakeDoc(File templateFile, LinkedHashMap<String,String> texts, LinkedHashMap<String,ImageData> images, LinkedHashMap<String,TableData> tables, String desDirPath, String desFilePrefix, String imageDir)` 根据文档模板+制作规则，接受外部传入的文档数据制作对应文档，并将文档放到指定目录
`protected BufferedImage`	`loadImage(String imageID, String imageDir)` 读取图像数据
`List<String>`	`makeDoc(File templateFile, INIData formatRule, String jsonData, File desDir, String desFilePrefix, String imageDir)` 根据文档模板+制作规则，接受外部传入的文档数据制作对应文档，并将文档放到指定目录
`List<String>`	`makeDoc(File drsFile, String jsonData, File desDir, String desFilePrefix, String imageDir)` 该方法不保证并发正确性，建议调用者采用desDir+desFilePrefix进行隔离，即每次调用传入不同路径，保证生成的文档不会被覆盖接受外部传入的文档数据，填充进drs文档，并根据drs文档组成结构中模板对应的文档类型，制作对应包含数据的文档，并将文档放到指定目录。
`protected int`	`parsePageNum(LinkedHashMap<String,TableData> tables)` 解析要输出的文档数量
`protected boolean`	`writeImage(File destFile, Image srcImage, String format)` 将图像写入指定文件

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

- 构造器详细资料
  - AbstractDocMaker
```
public AbstractDocMaker()
```
- 方法详细资料
  - makeDoc
```
public List<String> makeDoc(File drsFile,
                            String jsonData,
                            File desDir,
                            String desFilePrefix,
                            String imageDir)
                     throws IOException
```
    从接口复制的说明: DocMaker
    
    该方法不保证并发正确性，建议调用者采用desDir+desFilePrefix进行隔离，即每次调用传入不同路径，保证生成的文档不会被覆盖
    接受外部传入的文档数据，填充进drs文档，并根据drs文档组成结构中模板对应的文档类型，制作对应包含数据的文档，并将文档放到指定目录。
    drs全称：Data Recording System，表示文档数据录入系统，专用于往固定格式的文档录入数据的应用场景。这类场景具备以下特征：
    1、对文档格式要求严格 2、对录入文档的数据要求严格 3、文档格式丰富多样
    drs文档：代表后缀为.drs的文档，本质是一个用标准JAVA压缩算法制作的压缩包，其组成结构由两部分构成：模板+规则。
    其中，模板名称为：template.xxx，.xxx是现有文档的后缀，比如：template.xlsx，则表示模板采用excel制作，那么该接口返回制作好的填充数据完毕的excel文件。
    其中，规则名称为：formatRule.ini，该规则具备承前启后的作用，具体过程：前端依据该规则动态创建数据录入界面并限制数据录入的逻辑。后端依据该规则效验传入数据的正确性并制作对应格式的文档。
    
    指定者:
    
    makeDoc 在接口中 DocMaker
    
    参数:
    
    drsFile - drs文件
    
    jsonData - 文档数据
    
    desDir - 生成目标文档的存放目录，为空则采用文档模板所在目录
    
    desFilePrefix - 生成目标文档的文件名前缀，为空则采用文档模板文件名作为文件名前缀
    
    imageDir - 保存文档图片的目录路径，为空则不录入图片
    
    返回:
    
    制作生成文档的访问路径
    
    抛出:
    
    IOException - 制作过程中，可能会抛出该异常
  - makeDoc
```
public List<String> makeDoc(File templateFile,
                            INIData formatRule,
                            String jsonData,
                            File desDir,
                            String desFilePrefix,
                            String imageDir)
                     throws IOException
```
    从接口复制的说明: DocMaker
    
    根据文档模板+制作规则，接受外部传入的文档数据制作对应文档，并将文档放到指定目录
    
    指定者:
    
    makeDoc 在接口中 DocMaker
    
    参数:
    
    templateFile - 文档模板
    
    formatRule - 制作规则
    
    jsonData - 文档数据
    
    desDir - 生成目标文档的存放目录，为空则采用文档模板所在目录
    
    desFilePrefix - 生成目标文档的文件名前缀，为空则采用文档模板文件名作为文件名前缀
    
    imageDir - 保存文档图片的目录路径，为空则不录入图片
    
    返回:
    
    制作生成文档的访问路径
    
    抛出:
    
    IOException - 制作过程中，可能会抛出该异常
  - parsePageNum
```
protected int parsePageNum(LinkedHashMap<String,TableData> tables)
```
    解析要输出的文档数量
    
    参数:
    
    tables - 待录入的表格数据
    
    返回:
    
    输出的文档数量
  - loadImage
```
protected BufferedImage loadImage(String imageID,
                                  String imageDir)
                           throws IOException
```
    读取图像数据
    
    参数:
    
    imageID - 图片ID
    
    imageDir - 存放图片的目录
    
    返回:
    
    图像数据
    
    抛出:
    
    IOException
  - createScaleBufferedImage
```
protected BufferedImage createScaleBufferedImage(BufferedImage image,
                                                 int scaleWidth,
                                                 int scaleHeight)
```
    创建期望宽高的缓存图，保持原有图像宽高比
    
    参数:
    
    image - 原有缓存图
    
    scaleWidth - 缩放后期望得到的宽
    
    scaleHeight - 缩放后期望得到的高
    
    返回:
    
    图像数据
  - writeImage
```
protected boolean writeImage(File destFile,
                             Image srcImage,
                             String format)
```
    将图像写入指定文件
    
    参数:
    
    destFile - 目标文件
    
    srcImage - 源图像
    
    format - 文件格式
  - doMakeDoc
```
protected abstract List<String> doMakeDoc(File templateFile,
                                          LinkedHashMap<String,String> texts,
                                          LinkedHashMap<String,ImageData> images,
                                          LinkedHashMap<String,TableData> tables,
                                          String desDirPath,
                                          String desFilePrefix,
                                          String imageDir)
                                   throws IOException
```
    根据文档模板+制作规则，接受外部传入的文档数据制作对应文档，并将文档放到指定目录
    
    参数:
    
    templateFile - 文档模板
    
    texts - 文本数据
    
    images - 图像数据
    
    tables - 表格数据
    
    desDirPath - 生成目标文档的存放目录，为空则采用文档模板所在目录
    
    desFilePrefix - 生成目标文档的文件名前缀，为空则采用文档模板文件名作为文件名前缀
    
    imageDir - 保存文档图片的目录路径，为空则不录入图片
    
    返回:
    
    制作生成文档的访问路径集合
    
    抛出:
    
    IOException - 制作过程中，可能会抛出该异常

类 AbstractDocMaker

字段概要

从接口继承的字段 wang.bigbird.domain.framework.document.api.DocMaker

构造器概要

方法概要

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

构造器详细资料

AbstractDocMaker

方法详细资料

makeDoc

makeDoc

parsePageNum

loadImage

createScaleBufferedImage

writeImage

doMakeDoc