com.jingyue.DocConversion

类 Converter

java.lang.Object

com.jingyue.DocConversion.Converter

public class Converter
extends java.lang.Object

调用九云图文档转换服务的入口类。

九云图是一个文档转换的云计算服务，帮助用户把各类文档转成 HTML5(SVG)、长图片、PDF 等格式。在移动端缺少字库的情况下，也能保持字体和版式完全不变，支持高清平滑缩放。转换生成的 HTML 不含任何脚本和外链，下载后可独立使用，最大支持 500M 文档。

版本:

1.0

构造器概要

构造器

构造器和说明
Converter() 构建九云图文档转换类。
Converter(java.lang.String appCode) 构建九云图文档转换类，需提供授权码。

方法概要

限定符和类型	方法和说明
YuntuDoc	convert(java.io.File file) 转换指定的文档。
YuntuDoc	convert(java.io.InputStream inputStream, java.lang.String fileName) 转换指定的文档。
YuntuDoc	convert(java.lang.String docUrl) 转换指定的文档。
YuntuConfig	getConfig() 获取文档转换的参数配置。
java.lang.String	getLongImage(YuntuDoc doc) 获取文档转换生成的长图片。
java.util.List<java.lang.String>	getPagingHTMLs(YuntuDoc doc) 获取文档分页 HTMLs。
java.util.List<java.lang.String>	getPagingImages(YuntuDoc doc) 获取文档分页图片。
java.util.List<java.lang.String>	getPagingSVGs(YuntuDoc doc) 获取文档分页 SVG。
java.lang.String	getPDF(YuntuDoc doc) 获取文档转换生成的 PDF。
java.lang.String	getStatusPage(YuntuDoc doc) 获取文档转换状态页，该页面包含文档信息和转换状态。
java.lang.String	getWebviewURL(YuntuDoc doc) 获取用于展现文档的 URL，打开此 URL 需访问九云图服务器。
java.lang.String	getWholeHTML(YuntuDoc doc) 获取一个包含文档完整内容的 HTML，其中无任何外链和脚本，可下载后脱离九云图独立使用。
void	setConfig(YuntuConfig config) 设置文档转换的参数配置。

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

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

构造器详细资料

Converter

public Converter()

构建九云图文档转换类。该方法未提供授权码，转换的结果会带有 “九云图 DEMO” 水印。

Converter

public Converter(java.lang.String appCode)

构建九云图文档转换类，需提供授权码。

参数:

appCode - 授权码。如果该授权码无效，转换的结果会被添加 “九云图 DEMO” 水印。

方法详细资料

setConfig

public void setConfig(YuntuConfig config)

设置文档转换的参数配置。

参数:

config - 文档转换的参数配置。

getConfig

public YuntuConfig getConfig()

获取文档转换的参数配置。

返回:

文档转换的参数配置。

convert

public YuntuDoc convert(java.lang.String docUrl)
                 throws YuntuException

转换指定的文档。

参数:

docUrl - 被转换的文档 URL。

返回:

返回一个 YuntuDoc 实例, 其中包含了文档转换状态等信息。

抛出:

YuntuException - 文档转换异常。

convert

public YuntuDoc convert(java.io.File file)
                 throws YuntuException

转换指定的文档。

参数:

file - 被转换的文档。

返回:

返回一个 YuntuDoc 实例, 其中包含了文档转换状态等信息。

抛出:

YuntuException - 文档转换异常。

convert

public YuntuDoc convert(java.io.InputStream inputStream,
                        java.lang.String fileName)
                 throws YuntuException

转换指定的文档。

参数:

inputStream - 被转换的文档数据流。

fileName - 被转换的文档的fileName（必须包含扩展名）。

返回:

返回一个 YuntuDoc 实例, 其中包含了文档转换状态等信息。

抛出:

YuntuException - 文档转换异常。

getStatusPage

public java.lang.String getStatusPage(YuntuDoc doc)

获取文档转换状态页，该页面包含文档信息和转换状态。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回一个用于显示文档转换状态的 URL。

getWebviewURL

public java.lang.String getWebviewURL(YuntuDoc doc)

获取用于展现文档的 URL，打开此 URL 需访问九云图服务器。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回一个用于展现文档的 URL。

getWholeHTML

public java.lang.String getWholeHTML(YuntuDoc doc)
                              throws YuntuException

获取一个包含文档完整内容的 HTML，其中无任何外链和脚本，可下载后脱离九云图独立使用。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回一个 URL，指向完整的 HTML，其中包含文档的所有页面内容。

抛出:

YuntuException - 获取文档转换结果时，出现错误。

getPagingHTMLs

public java.util.List<java.lang.String> getPagingHTMLs(YuntuDoc doc)
                                                throws YuntuException

获取文档分页 HTMLs。每页生成一个独立的 HTML，其中无任何外链和脚本，可下载后脱离九云图独立使用。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回包含一组 URL 的 List 实例，其中每个 URL 指向一个文档页面的 HTML。

抛出:

YuntuException - 获取文档转换结果时，出现错误。

getPDF

public java.lang.String getPDF(YuntuDoc doc)
                        throws YuntuException

获取文档转换生成的 PDF。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回一个 URL，指向转换生成的 PDF。

抛出:

YuntuException - 获取文档转换结果时，出现错误。

getLongImage

public java.lang.String getLongImage(YuntuDoc doc)
                              throws YuntuException

获取文档转换生成的长图片。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回一个 URL，指向转换生成的长图片。

抛出:

YuntuException - 获取文档转换结果时，出现错误。

getPagingImages

public java.util.List<java.lang.String> getPagingImages(YuntuDoc doc)
                                                 throws YuntuException

获取文档分页图片。每页生成一个单独的图片。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回包含一组 URL 的 List 实例，其中每个 URL 指向转换生成的 一页图片。

抛出:

YuntuException - 获取文档转换结果时，出现错误。

getPagingSVGs

public java.util.List<java.lang.String> getPagingSVGs(YuntuDoc doc)
                                               throws YuntuException

获取文档分页 SVG。每页生成一个单独的 SVG 文件。

参数:

doc - 指定的 YuntuDoc 实例。

返回:

返回包含一组 URL 的 List 实例，其中每个 URL 指向转换生成的 一页 SVG。

抛出:

YuntuException - 获取文档转换结果时，出现错误。