DocDir (OFDRW Package 2.3.8 API)

java.lang.Object
- org.ofdrw.pkg.container.VirtualContainer
- - org.ofdrw.pkg.container.DocDir

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class DocDir
extends VirtualContainer
```
文档容器

Since:

2020-01-18 03:57:59

Author:

权观宇

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AnnotationsFileName` 注释入口文件名称
`static String`	`AnnotsDir` 注释文件虚拟容器
`static String`	`Attachments` 附件入口文件名称
`static String`	`DocContainerPrefix` 文档容器名称前缀
`static String`	`DocumentFileName` 文档的根节点描述文件名称
`static String`	`DocumentResFileName` 文档自身资源索引描述文件名称
`static String`	`PageContainerPrefix` 页面容器名称前缀
`static String`	`PagesDir` 页面容器
`static String`	`PublicResFileName` 文档公共资源索引描述文件名称
`static String`	`ResDir` 资源容器
`static String`	`SignContainerPrefix` 数字签名容器名称前缀
`static String`	`SignsDir` 数字签名容器名称
`static String`	`TagsDir` 自定义标签容器名称
`static String`	`TempsDir` 临时文件容器

Constructor Summary

Constructors
Constructor and Description

DocDir(Path fullDir)

Constructors
Constructor and Description
`DocDir(Path fullDir)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocDir`	`addResource(Path resource)` 增加资源
`Path`	`addResourceWithPath(Path resource)` 增加资源并返回资源在文档中的绝对路径
`Annotations`	`getAnnotations()` 获取注释列表对象
`AnnotsDir`	`getAnnots()` 获取注释容器
`Document`	`getDocument()` 获取文档的根节点
`Res`	`getDocumentRes()` 获取文档自身资源索引对象
`Integer`	`getIndex()` 获取文档索引
`PagesDir`	`getPages()` 获取页面存储目录
`Res`	`getPublicRes()` 获取文档公共资源索引
`ResDir`	`getRes()` 获取资源容器
`Path`	`getResource(String name)` 获取资源
`SignsDir`	`getSigns()` 获取数字签名存储目录
`VirtualContainer`	`getTags()` 获取自定义标签容器
`TempsDir`	`getTemps()` 获取模板容器
`AnnotsDir`	`obtainAnnots()` 获取注释容器
`PagesDir`	`obtainPages()` 获取页面存储目录
`ResDir`	`obtainRes()` 获取资源文件夹
`SignsDir`	`obtainSigns()` 获取数字签名存储目录
`VirtualContainer`	`obtainTags()` 获取自定义标签容器
`TempsDir`	`obtainTemps()` 获取模板容器
`DocDir`	`setAnnotations(Annotations annotations)` 设置注释列表对象
`DocDir`	`setDocument(Document document)` 设置文档的根节点
`DocDir`	`setDocumentRes(Res documentRes)` 设置文档自身资源索引
`DocDir`	`setPublicRes(Res publicRes)` 设置文档公共资源索引

Methods inherited from class org.ofdrw.pkg.container.VirtualContainer
addRaw, clean, close, deleteFile, exist, exit, flush, flushContainerByName, flushFileByName, getAbsLoc, getContainer, getContainerName, getContainerPath, getFile, getFile, getObj, getObj, getParent, getSysAbsPath, obtainContainer, putFile, putFile, putFile, putFileWithPath, putObj, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DocContainerPrefix
```
public static final String DocContainerPrefix
```
    文档容器名称前缀
    
    See Also:
    
    Constant Field Values
  - DocumentFileName
```
public static final String DocumentFileName
```
    文档的根节点描述文件名称
    
    See Also:
    
    Constant Field Values
  - PublicResFileName
```
public static final String PublicResFileName
```
    文档公共资源索引描述文件名称
    
    See Also:
    
    Constant Field Values
  - DocumentResFileName
```
public static final String DocumentResFileName
```
    文档自身资源索引描述文件名称
    
    See Also:
    
    Constant Field Values
  - SignsDir
```
public static final String SignsDir
```
    数字签名容器名称
    
    See Also:
    
    Constant Field Values
  - SignContainerPrefix
```
public static final String SignContainerPrefix
```
    数字签名容器名称前缀
    
    See Also:
    
    Constant Field Values
  - TagsDir
```
public static final String TagsDir
```
    自定义标签容器名称
    GMT0099 OFD 2.0
    
    See Also:
    
    Constant Field Values
  - TempsDir
```
public static final String TempsDir
```
    临时文件容器
    OFD 2.0
    
    See Also:
    
    Constant Field Values
  - PagesDir
```
public static final String PagesDir
```
    页面容器
    
    See Also:
    
    Constant Field Values
  - PageContainerPrefix
```
public static final String PageContainerPrefix
```
    页面容器名称前缀
    
    See Also:
    
    Constant Field Values
  - ResDir
```
public static final String ResDir
```
    资源容器
    
    See Also:
    
    Constant Field Values
  - AnnotsDir
```
public static final String AnnotsDir
```
    注释文件虚拟容器
    GMT0099 OFD 2.0
    
    See Also:
    
    Constant Field Values
  - AnnotationsFileName
```
public static final String AnnotationsFileName
```
    注释入口文件名称
    
    See Also:
    
    Constant Field Values
  - Attachments
```
public static final String Attachments
```
    附件入口文件名称
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocDir
```
public DocDir(Path fullDir)
       throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
- Method Detail
  - getIndex
```
public Integer getIndex()
```
    获取文档索引
    
    Returns:
    
    文档编号（用于表示第几个），从0起
  - getDocument
```
public Document getDocument()
                     throws FileNotFoundException,
                            org.dom4j.DocumentException
```
    获取文档的根节点
    
    Returns:
    
    文档的根节点
    
    Throws:
    
    FileNotFoundException - 文档的根节点文件不存在
    
    org.dom4j.DocumentException - 文档的根节点文件解析异常
  - setDocument
```
public DocDir setDocument(Document document)
```
    设置文档的根节点
    
    Parameters:
    
    document - 文档的根节点
    
    Returns:
    
    this
  - getPublicRes
```
public Res getPublicRes()
                 throws FileNotFoundException,
                        org.dom4j.DocumentException
```
    获取文档公共资源索引
    
    Returns:
    
    文档公共资源索引
    
    Throws:
    
    FileNotFoundException - 文档公共资源索引文件不存在
    
    org.dom4j.DocumentException - 文档公共资源索引文件解析异常
  - setPublicRes
```
public DocDir setPublicRes(Res publicRes)
```
    设置文档公共资源索引
    
    Parameters:
    
    publicRes - 文档公共资源索引
    
    Returns:
    
    this
  - getDocumentRes
```
public Res getDocumentRes()
                   throws FileNotFoundException,
                          org.dom4j.DocumentException
```
    获取文档自身资源索引对象
    
    Returns:
    
    文档自身资源索引对象
    
    Throws:
    
    FileNotFoundException - 文档自身资源索引文件不存在
    
    org.dom4j.DocumentException - 文档自身资源索引文件解析异常
  - getAnnotations
```
public Annotations getAnnotations()
                           throws FileNotFoundException,
                                  org.dom4j.DocumentException
```
    获取注释列表对象
    
    Returns:
    
    注释列表对象
    
    Throws:
    
    FileNotFoundException - 文档自身资源索引文件不存在
    
    org.dom4j.DocumentException - 文档自身资源索引文件解析异常
  - setAnnotations
```
public DocDir setAnnotations(Annotations annotations)
```
    设置注释列表对象
    推荐使用 AnnotsDir.setAnnotations(Annotations)
    
    Parameters:
    
    annotations - 注释列表对象
    
    Returns:
    
    注释列表对象
  - setDocumentRes
```
public DocDir setDocumentRes(Res documentRes)
```
    设置文档自身资源索引
    
    Parameters:
    
    documentRes - 文档自身资源索引
    
    Returns:
    
    this
  - getRes
```
public ResDir getRes()
              throws FileNotFoundException
```
    获取资源容器
    
    Returns:
    
    资源容器
    
    Throws:
    
    FileNotFoundException - 资源容器不存在
  - obtainRes
```
public ResDir obtainRes()
```
    获取资源文件夹
    如果资源文件不存在则创建
    
    Returns:
    
    资源目录
  - getSigns
```
public SignsDir getSigns()
                  throws FileNotFoundException
```
    获取数字签名存储目录
    
    Returns:
    
    数字签名存储目录
    
    Throws:
    
    FileNotFoundException - 数字签名存储目录不存在
  - obtainSigns
```
public SignsDir obtainSigns()
```
    获取数字签名存储目录
    如果数字签名存储目录不存在则创建
    
    Returns:
    
    数字签名存储目录
  - getPages
```
public PagesDir getPages()
                  throws FileNotFoundException
```
    获取页面存储目录
    
    Returns:
    
    页面存储目录
    
    Throws:
    
    FileNotFoundException - 页面存储目录不存在
  - obtainPages
```
public PagesDir obtainPages()
```
    获取页面存储目录
    如果页面存储目录则会创建
    
    Returns:
    
    页面存储目录
  - obtainTags
```
public VirtualContainer obtainTags()
```
    获取自定义标签容器
    如果目录不存在则会创建
    GMT0099 OFD 2.0
    
    Returns:
    
    自定义标签容器
  - getTags
```
public VirtualContainer getTags()
                         throws FileNotFoundException
```
    获取自定义标签容器
    GMT0099 OFD 2.0
    
    Returns:
    
    自定义标签容器
    
    Throws:
    
    FileNotFoundException - 页面存储目录不存在
  - obtainTemps
```
public TempsDir obtainTemps()
```
    获取模板容器
    如果目录不存在则会创建
    GMT0099 OFD 2.0
    
    Returns:
    
    模板容器
  - getTemps
```
public TempsDir getTemps()
                  throws FileNotFoundException
```
    获取模板容器
    GMT0099 OFD 2.0
    
    Returns:
    
    模板容器
    
    Throws:
    
    FileNotFoundException - 页面存储目录不存在
  - obtainAnnots
```
public AnnotsDir obtainAnnots()
```
    获取注释容器
    如果目录不存在则会创建
    GMT0099 OFD 2.0
    
    Returns:
    
    注释容器
  - getAnnots
```
public AnnotsDir getAnnots()
                    throws FileNotFoundException
```
    获取注释容器
    GMT0099 OFD 2.0
    
    Returns:
    
    注释容器
    
    Throws:
    
    FileNotFoundException - 页面存储目录不存在
  - addResource
```
public DocDir addResource(Path resource)
                   throws IOException
```
    增加资源
    
    Parameters:
    
    resource - 资源
    
    Returns:
    
    this
    
    Throws:
    
    IOException - 文件复制过程中IO异常
  - addResourceWithPath
```
public Path addResourceWithPath(Path resource)
                         throws IOException
```
    增加资源并返回资源在文档中的绝对路径
    
    Parameters:
    
    resource - 资源
    
    Returns:
    
    文件复制后的绝对路径
    
    Throws:
    
    IOException - 文件复制过程中IO异常
  - getResource
```
public Path getResource(String name)
                 throws FileNotFoundException
```
    获取资源
    
    Parameters:
    
    name - 资源名称（包含后缀名称）
    
    Returns:
    
    资源
    
    Throws:
    
    FileNotFoundException - 资源不存在

Class DocDir

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ofdrw.pkg.container.VirtualContainer

Methods inherited from class java.lang.Object

Field Detail

DocContainerPrefix

DocumentFileName

PublicResFileName

DocumentResFileName

SignsDir

SignContainerPrefix

TagsDir

TempsDir

PagesDir

PageContainerPrefix

ResDir

AnnotsDir

AnnotationsFileName

Attachments

Constructor Detail

DocDir

Method Detail

getIndex

getDocument

setDocument

getPublicRes

setPublicRes

getDocumentRes

getAnnotations

setAnnotations

setDocumentRes

getRes

obtainRes

getSigns

obtainSigns

getPages

obtainPages

obtainTags

getTags

obtainTemps

getTemps

obtainAnnots

getAnnots

addResource

addResourceWithPath

getResource