OFDReader (ofdrw-reader 2.0.5 API)

java.lang.Object
- org.ofdrw.reader.OFDReader

所有已实现的接口:

Closeable, AutoCloseable

直接已知子类:

DLOFDReader, SealOFDReader
```
public class OFDReader
extends Object
implements Closeable
```
OFD解析器

从以下版本开始:

2020-04-01 21:39:25

作者:

权观宇

字段概要

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

protected ResourceLocator rl
资源定位器解析路径获取资源

字段
限定符和类型	字段和说明
`protected ResourceLocator`	`rl` 资源定位器解析路径获取资源

构造器概要

构造器
构造器和说明
`OFDReader(InputStream stream)` 构造一个 OFDReader
`OFDReader(Path ofdFile)` 构造一个 OFDReader
`OFDReader(String ofdFileLoc)` 构造一个 OFDReader
`OFDReader(String unzippedPathRoot, boolean deleteOnClose)` 因一些ofd文件无法使用ZipUtil解压缩，可以让用户自己在外面解压缩好后，传入根目录创建例如用户可以使用unzip或者unar等命令行方式解压缩，因此通过参数控制是否删除目录。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Document`	`cdDefaultDoc()` 切换目录到默认的文档目录下下该操作将会导致资源加载器变更目录如果需要恢复被切换的目录请主动在外部调用restore
`Document`	`cdDoc(int numOfDoc)` 切换目录到指定的文档下该操作将会导致资源加载器变更目录如果需要恢复被切换的目录请主动在外部调用restore
`void`	`close()` 关闭文档删除工作区
`List<AnnotionEntity>`	`getAnnotationEntities()` 获取默认文档中的所有注释信息
`Annotations`	`getAnnotations()` 获取注解列表文件对象如果文档中没有注释文件，那么返还null
`CT_Attachment`	`getAttachment(String name)` 获取附件对象该方法不会恢复资源定位器
`Path`	`getAttachmentFile(CT_Attachment attachment)` 获取附件文件注意：该文件会在Close Reader时候被删除，请在之前复制到其他地方
`Path`	`getAttachmentFile(String name)` 获取附件文件注意：该文件会在Close Reader时候被删除，请在之前复制到其他地方
`List<CT_Attachment>`	`getAttachmentList()` 获取所有附件对象注意该对象均为只读
`ST_Loc`	`getDefaultDocSignaturesPath()` 获取默认文档Doc_0中的签名列表文件的绝对路径
`Signatures`	`getDefaultSignatures()` 获取默认的签名列表对象如果文件不存在则返还null
`Document`	`getDoc(int numOfDoc)` 获取文档对象
`int`	`getNumberOfPages()` 获取OFD含有的总页面数量
`OFDDir`	`getOFDDir()` 获取文档虚拟容器
`Page`	`getPage(int pageNum)` 通过页面页码获取页面对象
`PageInfo`	`getPageInfo(int pageNum)` 获取页面信息
`List<PageInfo>`	`getPageList()` 获取页面信息集合
`ST_ID`	`getPageObjectId(int pageNum)` 获取页面的对象ID
`ST_Box`	`getPageSize(int num)` 获取页面物理大小
`ST_Box`	`getPageSize(Page page)` 获取页面物理大小如果页面没有定义页面区域，则使用文件 CommonData中的定义
`ResourceManage`	`getResMgt()` 获取资源管理器资源管理器获取到的对象均为只读对象
`ResourceLocator`	`getResourceLocator()` 获取资源定位器
`List<StampAnnotEntity>`	`getStampAnnots()` 获取默认文档中的签章信息
`TemplatePageEntity`	`getTemplate(String id)` 解析页面模板对象
`Path`	`getWorkDir()`
`boolean`	`hasSignature()` 文档是否包含数字签名
`static void`	`setNamespaceStrictMode(boolean enable)` 启用或关闭命名空间严格解析模式启用严格模式后将会忽略非ofd命名空间的元素。
`static void`	`setZipFileMaxSize(long size)` 设置 OFD解压后最大占用文件大小默认值： 100MB

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

- 字段详细资料
  - rl
```
protected ResourceLocator rl
```
    资源定位器
    解析路径获取资源
- 构造器详细资料
  - OFDReader
```
public OFDReader(Path ofdFile)
          throws IOException
```
    构造一个 OFDReader
    
    参数:
    
    ofdFile - OFD文件
    
    抛出:
    
    IOException - OFD文件操作IO异常
  - OFDReader
```
public OFDReader(String ofdFileLoc)
          throws IOException
```
    构造一个 OFDReader
    
    参数:
    
    ofdFileLoc - OFD文件位置，例如：”/home/user/myofd.ofd“
    
    抛出:
    
    IOException - OFD文件操作IO异常
  - OFDReader
```
public OFDReader(InputStream stream)
          throws IOException
```
    构造一个 OFDReader
    
    参数:
    
    stream - OFD文件输入流，流由调用者负责关闭。
    
    抛出:
    
    IOException - OFD文件操作IO异常
  - OFDReader
```
public OFDReader(String unzippedPathRoot,
                 boolean deleteOnClose)
```
    因一些ofd文件无法使用ZipUtil解压缩，可以让用户自己在外面解压缩好后，传入根目录创建例如用户可以使用unzip或者unar等命令行方式解压缩，因此通过参数控制是否删除目录。
    
    参数:
    
    unzippedPathRoot - 已经解压的OFD根目录位置
    
    deleteOnClose - 退出时是否删除 unzippedPathRoot 文件， true - 退出时删除；false - 不删除
- 方法详细资料
  - getWorkDir
```
public Path getWorkDir()
```
  - setZipFileMaxSize
```
public static void setZipFileMaxSize(long size)
```
    设置 OFD解压后最大占用文件大小
    默认值： 100MB
    
    参数:
    
    size - 解压文件大小，单位字节（Byte）
  - getOFDDir
```
public OFDDir getOFDDir()
```
    获取文档虚拟容器
    
    返回:
    
    OFD文档虚拟容器
  - getDefaultDocSignaturesPath
```
public ST_Loc getDefaultDocSignaturesPath()
```
    获取默认文档Doc_0中的签名列表文件的绝对路径
    
    返回:
    
    签名列表文件绝对路径
    
    抛出:
    
    BadOFDException - 错误OFD结构和文件格式导致结构无法解析
  - getDefaultSignatures
```
public Signatures getDefaultSignatures()
```
    获取默认的签名列表对象
    如果文件不存在则返还null
    
    返回:
    
    签名列表对象
  - hasSignature
```
public boolean hasSignature()
```
    文档是否包含数字签名
    
    返回:
    
    true - 含有；false - 不含；
  - getAnnotations
```
public Annotations getAnnotations()
```
    获取注解列表文件对象
    如果文档中没有注释文件，那么返还null
    
    返回:
    
    注解列表文件对象或null
  - getNumberOfPages
```
public int getNumberOfPages()
```
    获取OFD含有的总页面数量
    
    返回:
    
    总页数
  - getPageInfo
```
public PageInfo getPageInfo(int pageNum)
```
    获取页面信息
    
    参数:
    
    pageNum - 页码，从1开始
    
    返回:
    
    页面信息
  - getPageList
```
public List<PageInfo> getPageList()
```
    获取页面信息集合
    
    返回:
    
    页面信息集合
  - getTemplate
```
public TemplatePageEntity getTemplate(String id)
```
    解析页面模板对象
    
    参数:
    
    id - 模板ID
    
    返回:
    
    模板实体，如果模板不存在返还null
  - cdDoc
```
public Document cdDoc(int numOfDoc)
               throws org.dom4j.DocumentException,
                      FileNotFoundException
```
    切换目录到指定的文档下
    该操作将会导致资源加载器变更目录
    如果需要恢复被切换的目录请主动在外部调用restore
    
    参数:
    
    numOfDoc - 文档序号
    
    返回:
    
    文档对象
    
    抛出:
    
    org.dom4j.DocumentException - 文档解析异常
    
    FileNotFoundException - Document.xml文档不存在
  - getDoc
```
public Document getDoc(int numOfDoc)
                throws org.dom4j.DocumentException,
                       FileNotFoundException
```
    获取文档对象
    
    参数:
    
    numOfDoc - 文档序号
    
    返回:
    
    文档对象
    
    抛出:
    
    org.dom4j.DocumentException - 文档解析异常
    
    FileNotFoundException - Document.xml文档不存在
  - cdDefaultDoc
```
public Document cdDefaultDoc()
                      throws org.dom4j.DocumentException,
                             FileNotFoundException
```
    切换目录到默认的文档目录下下
    该操作将会导致资源加载器变更目录
    如果需要恢复被切换的目录请主动在外部调用restore
    
    返回:
    
    文档对象
    
    抛出:
    
    org.dom4j.DocumentException - 文档解析异常
    
    FileNotFoundException - Document.xml文档不存在
  - getPageSize
```
public ST_Box getPageSize(Page page)
```
    获取页面物理大小
    如果页面没有定义页面区域，则使用文件 CommonData中的定义
    
    参数:
    
    page - 页面对象
    
    返回:
    
    页面大小
  - getPageSize
```
public ST_Box getPageSize(int num)
```
    获取页面物理大小
    
    参数:
    
    num - 页码，从1起
    
    返回:
    
    页面物理尺寸
  - getPage
```
public Page getPage(int pageNum)
```
    通过页面页码获取页面对象
    
    参数:
    
    pageNum - 页码，从1起
    
    返回:
    
    页面对象
  - getPageObjectId
```
public ST_ID getPageObjectId(int pageNum)
```
    获取页面的对象ID
    
    参数:
    
    pageNum - 页码
    
    返回:
    
    对象ID
  - getResourceLocator
```
public ResourceLocator getResourceLocator()
```
    获取资源定位器
    
    返回:
    
    资源定位器
  - getAttachmentList
```
public List<CT_Attachment> getAttachmentList()
```
    获取所有附件对象
    注意该对象均为只读
    
    返回:
    
    附件数组，如果没有附件返还空数组
    
    抛出:
    
    BadOFDException - 文档结构损坏
  - getAttachmentFile
```
public Path getAttachmentFile(CT_Attachment attachment)
```
    获取附件文件
    注意：该文件会在Close Reader时候被删除，请在之前复制到其他地方
    
    参数:
    
    attachment - 附件信息
    
    返回:
    
    附件文件路径
  - getAttachment
```
public CT_Attachment getAttachment(String name)
```
    获取附件对象
    该方法不会恢复资源定位器
    
    参数:
    
    name - 附件名称
    
    返回:
    
    附件对象
  - getAttachmentFile
```
public Path getAttachmentFile(String name)
```
    获取附件文件
    注意：该文件会在Close Reader时候被删除，请在之前复制到其他地方
    
    参数:
    
    name - 附件名称
    
    返回:
    
    附件文件路径
  - getStampAnnots
```
public List<StampAnnotEntity> getStampAnnots()
```
    获取默认文档中的签章信息
    
    返回:
    
    签章信息
  - getAnnotationEntities
```
public List<AnnotionEntity> getAnnotationEntities()
```
    获取默认文档中的所有注释信息
    
    返回:
    
    注释实体信息列表
  - getResMgt
```
public ResourceManage getResMgt()
```
    获取资源管理器
    资源管理器获取到的对象均为只读对象
    
    返回:
    
    资源管理器
  - setNamespaceStrictMode
```
public static void setNamespaceStrictMode(boolean enable)
```
    启用或关闭命名空间严格解析模式
    启用严格模式后将会忽略非ofd命名空间的元素。
    默认：关闭严格模式
    
    参数:
    
    enable - true - 启用; false - 兼容模式（默认），兼容ofd命名空间
  - close
```
public void close()
           throws IOException
```
    关闭文档
    删除工作区
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - 工作区删除异常

类 OFDReader

字段概要

构造器概要

方法概要

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

字段详细资料

rl

构造器详细资料

OFDReader

OFDReader

OFDReader

OFDReader

方法详细资料

getWorkDir

setZipFileMaxSize

getOFDDir

getDefaultDocSignaturesPath

getDefaultSignatures

hasSignature

getAnnotations

getNumberOfPages

getPageInfo

getPageList

getTemplate

cdDoc

getDoc

cdDefaultDoc

getPageSize

getPageSize

getPage

getPageObjectId

getResourceLocator

getAttachmentList

getAttachmentFile

getAttachment

getAttachmentFile

getStampAnnots

getAnnotationEntities

getResMgt

setNamespaceStrictMode

close