XDocService

java.lang.Object
- com.hg.xdoc.XDocService

public class XDocService
extends java.lang.Object

XDoc服务

版本:: A.6.5
作者:: xdoc

嵌套类概要

嵌套类
限定符和类型类和说明

static interface XDocService.XDoc
XDOC注解

static interface XDocService.XParam
XDOC参数注解

嵌套类
限定符和类型	类和说明
`static interface`	`XDocService.XDoc` XDOC注解
`static interface`	`XDocService.XParam` XDOC参数注解

字段概要

字段
限定符和类型字段和说明

static java.lang.String DEFAULT_KEY
默认账号口令

static java.lang.String DEFAULT_URL
默认服务器地址

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_KEY` 默认账号口令
`static java.lang.String`	`DEFAULT_URL` 默认服务器地址

构造器概要

构造器
构造器和说明

XDocService()
构造器

XDocService(java.lang.String url)
构造器

XDocService(java.lang.String url, java.lang.String key)
构造器

构造器
构造器和说明
`XDocService()` 构造器
`XDocService(java.lang.String url)` 构造器
`XDocService(java.lang.String url, java.lang.String key)` 构造器

方法概要

方法
限定符和类型	方法和说明
`java.lang.String`	`about()` 关于
`java.util.Map<java.lang.String,java.lang.String>`	`acc()` 账户信息
`java.lang.String`	`ckey()` 修改口令
`java.util.List<java.util.Map<java.lang.String,java.lang.String>>`	`dirlist(java.lang.String dir)` 目录列表
`java.lang.String`	`dkey()` 动态口令
`void`	`down(java.lang.String dir, java.io.File file)` 下载
`void`	`down(java.lang.String dir, java.lang.Object out)` 下载
`boolean`	`exists(java.lang.String dir)` 文件是否存在
`java.util.List<java.util.Map<java.lang.String,java.lang.String>>`	`filelist(java.lang.String dir)` 文件列表
`java.lang.String`	`getKey()` 账号口令
`java.lang.String`	`getUrl()` 服务地址
`boolean`	`hi()` 招呼
`static void`	`main(java.lang.String[] args)` 通过url地址调用服务，支持本地文件xdoc和xdata
`boolean`	`mkdir(java.lang.String dir)` 创建目录
`java.util.List<java.util.Map<java.lang.String,java.lang.String>>`	`query(java.lang.String sql)` 数据查询
`java.lang.String`	`reg(java.lang.String mail)` 注册
`boolean`	`remove(java.lang.String dir)` 删除
`void`	`run(java.lang.Object obj, java.io.File file)` 运行注解XDoc
`void`	`run(java.lang.Object obj, java.lang.Object out, java.lang.String format)` 运行注解XDoc
`void`	`run(java.lang.Object obj, java.lang.String to, java.lang.String format)` 运行注解XDoc
`void`	`run(java.lang.String xdoc, java.util.Map<java.lang.String,java.lang.Object> param, java.io.File file)` 运行xdoc
`void`	`run(java.lang.String xdoc, java.util.Map<java.lang.String,java.lang.Object> param, java.lang.Object out, java.lang.String format)` 运行xdoc
`java.lang.String`	`run(java.lang.String xdoc, java.util.Map<java.lang.String,java.lang.Object> param, java.lang.String to, java.lang.String format)` 运行xdoc并发送
`void`	`sdown(java.lang.String id, java.io.File file)` 基于ID下载
`void`	`sdown(java.lang.String id, java.lang.Object out)` 基于ID下载
`void`	`setKey(java.lang.String key)` 账号口令
`void`	`setUrl(java.lang.String url)` 服务地址
`boolean`	`sremove(java.lang.String id)` 基于ID删除
`void`	`sup(java.lang.String id, java.io.File file)` 基于ID上传
`void`	`sup(java.lang.String id, java.io.InputStream in)` 基于ID上传
`void`	`to(java.lang.String xdoc, java.io.File file)` 转换为其它格式文件
`void`	`to(java.lang.String xdoc, java.lang.Object out, java.lang.String format)` 转换为其它格式，保存到指定流中
`java.lang.String`	`to(java.lang.String xdoc, java.lang.String to, java.lang.String format)` 转换为其它格式并发送
`void`	`up(java.lang.String dir, java.io.File file)` 上传
`void`	`up(java.lang.String dir, java.io.InputStream in)` 上传
`java.lang.String`	`xdata(java.lang.String xdata, java.lang.String format)` XDATA转换
`java.lang.String`	`xdataById(java.lang.String id, java.lang.String format)` 基于ID的XDATA转换

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

字段详细资料

DEFAULT_URL

public static java.lang.String DEFAULT_URL

默认服务器地址

DEFAULT_KEY

public static java.lang.String DEFAULT_KEY

默认账号口令

构造器详细资料
- XDocService
```
public XDocService()
```
  构造器
- XDocService
```
public XDocService(java.lang.String url)
```
  构造器
  
  参数:
  url - 服务地址
- XDocService
```
public XDocService(java.lang.String url,
           java.lang.String key)
```
  构造器
  
  参数:
  url - 服务地址
  key - 账号

方法详细资料

getUrl
```
public java.lang.String getUrl()
```
服务地址

返回:

setUrl

public void setUrl(java.lang.String url)

服务地址

参数:: url -

getKey
```
public java.lang.String getKey()
```
账号口令

返回:

setKey

public void setKey(java.lang.String key)

账号口令

参数:: key -

to
```
public void to(java.lang.String xdoc,
      java.io.File file)
        throws java.io.IOException
```
转换为其它格式文件

参数:
xdoc - xdoc文本
URL：文档URL地址，格式支持：xdoc、json、docx、epub、txt、rtf等，支持datauri协议，可传递二进制数据，支持本地文件
纯文本：以"text:"开头的文本
JSON：符合XDOC-JSON规范的JSON文本
XML：符合XDOC-XML规范的XML文本
HTML：用html标签括起来的html文本，如：<html><h1>Hello</h1></html>
file - 其它格式文件，如：a.pdf

抛出:

java.io.IOException

to
```
public void to(java.lang.String xdoc,
      java.lang.Object out,
      java.lang.String format)
        throws java.io.IOException
```
转换为其它格式，保存到指定流中

参数:
xdoc - xdoc
out - 输出目标，OutputStream或HttpServletResponse
format - format

抛出:

java.io.IOException

to

public java.lang.String to(java.lang.String xdoc,
                  java.lang.String to,
                  java.lang.String format)
                    throws java.io.IOException

转换为其它格式并发送

参数:: xdoc - xdoc; to - 目标，支持ftp、http、mail、datauri等; format - format
抛出:: java.io.IOException

run

public void run(java.lang.String xdoc,
       java.util.Map<java.lang.String,java.lang.Object> param,
       java.io.File file)
         throws java.io.IOException

运行xdoc

参数:: xdoc - xdoc; param - 参数; file - 目标文件
抛出:: java.io.IOException

run

public void run(java.lang.String xdoc,
       java.util.Map<java.lang.String,java.lang.Object> param,
       java.lang.Object out,
       java.lang.String format)
         throws java.io.IOException

运行xdoc

参数:: xdoc - xdoc; param - 参数; out - 输出目标，OutputStream或HttpServletResponse; format - 目标格式
抛出:: java.io.IOException

run

public java.lang.String run(java.lang.String xdoc,
                   java.util.Map<java.lang.String,java.lang.Object> param,
                   java.lang.String to,
                   java.lang.String format)
                     throws java.io.IOException

运行xdoc并发送

参数:: xdoc - xdoc; param - 参数; to - 目标，支持ftp、http、mail、datauri等; format - 目标格式
抛出:: java.io.IOException

run

public void run(java.lang.Object obj,
       java.io.File file)
         throws java.io.IOException

运行注解XDoc

参数:: obj -; file -
抛出:: java.io.IOException

run

public void run(java.lang.Object obj,
       java.lang.Object out,
       java.lang.String format)
         throws java.io.IOException

运行注解XDoc

参数:: obj -; out - 目标流; format - 目标格式
抛出:: java.io.IOException

run

public void run(java.lang.Object obj,
       java.lang.String to,
       java.lang.String format)
         throws java.io.IOException

运行注解XDoc

参数:: obj -; to - 目标，支持ftp、http、mail、datauri等; format - 目标格式
抛出:: java.io.IOException

hi

public boolean hi()
           throws java.io.IOException

招呼

返回:
抛出:: java.io.IOException

about

public java.lang.String about()
                       throws java.io.IOException

关于

抛出:: java.io.IOException

dkey

public java.lang.String dkey()
                      throws java.io.IOException

动态口令

返回:
抛出:: java.io.IOException

ckey

public java.lang.String ckey()
                      throws java.io.IOException

修改口令

返回:
抛出:: java.io.IOException

reg

public java.lang.String reg(java.lang.String mail)
                     throws java.io.IOException

参数:: mail - 邮件
返回:
抛出:: java.io.IOException

acc

public java.util.Map<java.lang.String,java.lang.String> acc()
                                                     throws java.io.IOException

账户信息

返回:
抛出:: java.io.IOException

sup

public void sup(java.lang.String id,
       java.io.File file)
         throws java.io.IOException

基于ID上传

参数:: id -; file -
抛出:: java.io.IOException

sup

public void sup(java.lang.String id,
       java.io.InputStream in)
         throws java.io.IOException

基于ID上传

参数:: id -; in -
抛出:: java.io.IOException

sdown

public void sdown(java.lang.String id,
         java.io.File file)
           throws java.io.IOException

基于ID下载

参数:: id -; file -
抛出:: java.io.IOException

sdown

public void sdown(java.lang.String id,
         java.lang.Object out)
           throws java.io.IOException

基于ID下载

参数:: id -; out - 输出目标，OutputStream或HttpServletResponse
抛出:: java.io.IOException

sremove

public boolean sremove(java.lang.String id)
                throws java.io.IOException

基于ID删除

参数:: id -
返回:
抛出:: java.io.IOException

mkdir

public boolean mkdir(java.lang.String dir)
              throws java.io.IOException

创建目录

参数:: dir -
返回:
抛出:: java.io.IOException

dirlist

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> dirlist(java.lang.String dir)
                                                                         throws java.io.IOException

目录列表

参数:: dir -
返回:
抛出:: java.io.IOException

filelist

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> filelist(java.lang.String dir)
                                                                          throws java.io.IOException

文件列表

参数:: dir -
返回:
抛出:: java.io.IOException

up

public void up(java.lang.String dir,
      java.io.File file)
        throws java.io.IOException

上传

参数:: dir -; file -
抛出:: java.io.IOException

up

public void up(java.lang.String dir,
      java.io.InputStream in)
        throws java.io.IOException

上传

参数:: dir -; in -
抛出:: java.io.IOException

down

public void down(java.lang.String dir,
        java.io.File file)
          throws java.io.IOException

下载

参数:: dir -; file -
抛出:: java.io.IOException

down

public void down(java.lang.String dir,
        java.lang.Object out)
          throws java.io.IOException

下载

参数:: dir -; out - 输出目标，OutputStream或HttpServletResponse
抛出:: java.io.IOException

remove

public boolean remove(java.lang.String dir)
               throws java.io.IOException

删除

参数:: dir -
返回:
抛出:: java.io.IOException

exists

public boolean exists(java.lang.String dir)
               throws java.io.IOException

文件是否存在

参数:: dir -
返回:
抛出:: java.io.IOException

query

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> query(java.lang.String sql)
                                                                       throws java.io.IOException

数据查询

参数:: sql - SQL
返回:
抛出:: java.io.IOException

xdataById

public java.lang.String xdataById(java.lang.String id,
                         java.lang.String format)
                           throws java.io.IOException

基于ID的XDATA转换

参数:: id -; format - 目标格式：xml、json、csv
返回:
抛出:: java.io.IOException

xdata

public java.lang.String xdata(java.lang.String xdata,
                     java.lang.String format)
                       throws java.io.IOException

XDATA转换

参数:: data - xdata数据，格式：xml、json、csv; format - 目标格式：xml、json、csv
返回:
抛出:: java.io.IOException

main
```
public static void main(java.lang.String[] args)
```
通过url地址调用服务，支持本地文件xdoc和xdata

参数:
args -

类 XDocService

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

DEFAULT_URL

DEFAULT_KEY

构造器详细资料

XDocService

XDocService

XDocService

方法详细资料

getUrl

setUrl

getKey

setKey

to

to

to

run

run

run

run

run

run

hi

about

dkey

ckey

reg

acc

sup

sup

sdown

sdown

sremove

mkdir

dirlist

filelist

up

up

down

down

remove

exists

query

xdataById

xdata

main