com.kdgcsoft.power.doc.convert

类 DocConvertService

java.lang.Object

com.kdgcsoft.power.doc.convert.DocConvertService

public class DocConvertService
extends Object

文档转换工具。调用外部程序，把office等所支持的文档格式转换为PDF等格式。 多线程执行，支持同步、异步调用。
转换后文件存放在工作目录下，可通过转换时返回的uuid作为参数，调用接口获取。
源文件与uuid的映射记录可从日志文件中获取。建议在日志配置文件中给名为"ConvertHistory"的 Logger定义专门的输出文件位置，这样记录所有文件对应关系，便于维护查错。

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	DocConvertService.OutputType

构造器概要

构造器

构造器和说明
DocConvertService()

方法概要

方法

限定符和类型	方法和说明
static String	convert(File src, DocConvertService.OutputType outType, boolean isAsync) 转换文档，可指定使用异步模式还是同步模式。
static String	convert(File src, UUID objUUID, DocConvertService.OutputType outType) 指定文档的uuid，在存储时直接使用该id。
static String	convert(File srcFile, UUID objUUID, DocConvertService.OutputType outType, boolean isAsync) 执行转换过程。
static String	convert(InputStream src, String filename, DocConvertService.OutputType outType, boolean isAsync) 转换文档，可指定使用异步模式还是同步模式。
static String	convert(InputStream src, String filename, UUID objUUID, DocConvertService.OutputType outType) 用给定的uuid转换文档，转换后返回的是相同uuid。
static String	convert(InputStream src, String srcFileName, UUID objUUID, DocConvertService.OutputType outType, boolean isAsync) 执行转换过程。
static void	deleteConvertedFileQuietly(UUID objUUID) 在转换存储库中删除指定UUID的文件，包括所有格式。
static void	finish() 关闭外部转换进程。
protected static File	getConvertedFile(String uuid, DocConvertService.OutputType outType) 获取转换后的文档
static File	getConvertedFile(UUID objUUID, DocConvertService.OutputType outType) 获取转换后的文档
static InputStream	getConvertedFileAsStream(UUID objUUID, DocConvertService.OutputType outType) 获取转换后的文档Stream。
static File	getConvertedImage(UUID objUUID, DocConvertService.OutputType outType, int page) 按页获取转换后的文档。
static InputStream	getConvertedImageAsStream(UUID objUUID, DocConvertService.OutputType outType, int page) 按页获取转换后的图片流。
static int	getPageCount(UUID objUUID, DocConvertService.OutputType outType) 获取转换后的文档的页数。
static void	init(String workDir, int threadNumber) 初始化转换环境，指定工作目录和并发数。
static void	init(String workDir, int threadNumber, String libreOfficePath) 初始化转换环境，指定工作目录和并发数。
static void	redoUnfinished() 重新执行未完成的文档转换。

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

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

构造器详细资料

DocConvertService

public DocConvertService()

方法详细资料

init

public static void init(String workDir,
        int threadNumber)
                 throws DocConvertException

初始化转换环境，指定工作目录和并发数。

参数:

workDir - 工作目录路径

threadNumber - 并发数

抛出:

DocConvertException

org.jodconverter.office.OfficeException

init

public static void init(String workDir,
        int threadNumber,
        String libreOfficePath)
                 throws DocConvertException

初始化转换环境，指定工作目录和并发数。

参数:

workDir - 工作目录路径

threadNumber - 并发数

libreOfficePath - LibreOffice的安装路径

抛出:

DocConvertException

org.jodconverter.office.OfficeException

finish

public static void finish()
                   throws DocConvertException

关闭外部转换进程。应在系统退出时调用。如果需要再次启动转换进程，要重新调用init()。

抛出:

DocConvertException

redoUnfinished

public static void redoUnfinished()

重新执行未完成的文档转换。主要用于程序终止、机器断电等异常情况下的后处理。 该函数会检查工作目录下的incoming文件夹，当发现有符合要求的未完成转换的文件时， 即将其重新投入队列开始执行转换

convert

public static String convert(File src,
             DocConvertService.OutputType outType,
             boolean isAsync)
                      throws DocConvertException

转换文档，可指定使用异步模式还是同步模式。

参数:

src - 源文档

isAsync - 是否异步

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

convert

public static String convert(InputStream src,
             String filename,
             DocConvertService.OutputType outType,
             boolean isAsync)
                      throws DocConvertException

转换文档，可指定使用异步模式还是同步模式。

参数:

src - 源文档

isAsync - 是否异步

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

convert

public static String convert(File src,
             UUID objUUID,
             DocConvertService.OutputType outType)
                      throws DocConvertException

指定文档的uuid，在存储时直接使用该id。返回的是相同值。 当外部调用者本身使用uuid管理文档时可采用此种转换方式，便于对应。 也可用于文档更新（ID不变，只重新转换）。

参数:

src - 源文档

objUUID - UUID对象

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

convert

public static String convert(InputStream src,
             String filename,
             UUID objUUID,
             DocConvertService.OutputType outType)
                      throws DocConvertException

用给定的uuid转换文档，转换后返回的是相同uuid。用于文档更新、REDO。

参数:

src - 源文档

objUUID - UUID对象

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

convert

public static String convert(File srcFile,
             UUID objUUID,
             DocConvertService.OutputType outType,
             boolean isAsync)
                      throws DocConvertException

执行转换过程。此过程通过线程池执行转换任务，并根据是否异步的参数决定是启动任务后立即返回还是等待任务执行完毕再返回。

参数:

srcFile - 源文档

objUUID - UUID对象

isAsync - 是否异步

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

convert

public static String convert(InputStream src,
             String srcFileName,
             UUID objUUID,
             DocConvertService.OutputType outType,
             boolean isAsync)
                      throws DocConvertException

执行转换过程。此过程通过线程池执行转换任务，并根据是否异步的参数决定是启动任务后立即返回还是等待任务执行完毕再返回。

参数:

src - 源文档

objUUID - UUID对象

isAsync - 是否异步

返回:

用于获取转换结果文件的uuid

抛出:

DocConvertException

getConvertedFile

public static File getConvertedFile(UUID objUUID,
                    DocConvertService.OutputType outType)

获取转换后的文档

参数:

objUUID - 文档uuid。在转换时获得。

返回:

文档File对象。如果不存在，返回null。

getConvertedFile

protected static final File getConvertedFile(String uuid,
                    DocConvertService.OutputType outType)

获取转换后的文档

参数:

uuid - 文档uuid。在转换时获得。

返回:

文档File对象。如果不存在，返回null。

getConvertedFileAsStream

public static InputStream getConvertedFileAsStream(UUID objUUID,
                                   DocConvertService.OutputType outType)

获取转换后的文档Stream。

参数:

objUUID - 文档uuid。在转换时获得。

返回:

文档Stream对象。如果不存在，返回null。

getConvertedImage

public static File getConvertedImage(UUID objUUID,
                     DocConvertService.OutputType outType,
                     int page)

按页获取转换后的文档。仅支持图片类型。

参数:

objUUID - 文档uuid

page - 第几页

返回:

图片文件对象。如果不存在，返回null。

getConvertedImageAsStream

public static InputStream getConvertedImageAsStream(UUID objUUID,
                                    DocConvertService.OutputType outType,
                                    int page)

按页获取转换后的图片流。仅支持图片类型。

参数:

objUUID - 文档uuid

page - 第几页

返回:

图片文件对象。如果不存在，返回null。

getPageCount

public static int getPageCount(UUID objUUID,
               DocConvertService.OutputType outType)
                        throws DocConvertException

获取转换后的文档的页数。只支持转换后格式为pdf、图片。

参数:

objUUID - 文档UUID

outType - 转换后的类型

返回:

页数。如果找不到文档或不支持，返回-1。

抛出:

DocConvertException

deleteConvertedFileQuietly

public static void deleteConvertedFileQuietly(UUID objUUID)

在转换存储库中删除指定UUID的文件，包括所有格式。

参数:

objUUID - 文件UUID