CT_DocInfo (ofdrw-core 1.13.4 API)

java.lang.Object
- org.ofdrw.core.DefaultElementProxy
- - org.ofdrw.core.OFDElement
  - - org.ofdrw.core.basicStructure.ofd.docInfo.CT_DocInfo

所有已实现的接口:

Cloneable, org.dom4j.Branch, org.dom4j.Element, org.dom4j.Node
```
public class CT_DocInfo
extends OFDElement
```
文档元数据信息描述

从以下版本开始:

2019-09-29 10:14:41

作者:

权观宇

字段概要
- 从类继承的字段 org.ofdrw.core.DefaultElementProxy
  proxy
- 从接口继承的字段 org.dom4j.Node
  ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

构造器概要

构造器
构造器和说明

CT_DocInfo()

CT_DocInfo(org.dom4j.Element proxy)

构造器
构造器和说明
`CT_DocInfo()`
`CT_DocInfo(org.dom4j.Element proxy)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CT_DocInfo`	`addKeyword(String keyword)` 添加关键词
`String`	`getAbstract()` 【可选】获取文档摘要与注释
`String`	`getAuthor()` 【可选】获取文档作者
`ST_Loc`	`getCover()` 【可选】获取文档封面，此路径指向一个图片文件
`LocalDate`	`getCreationDate()` 【可选】获取文件创建日期
`String`	`getCreator()` 【可选】获取创建文档的应用程序
`String`	`getCreatorVersion()` 【可选】获取创建文档的应用程序版本信息
`CustomDatas`	`getCustomDatas()` 【可选】获取用户自定义元数据集合。
`String`	`getDocID()` 【必选】采用UUID算法生成的由32个字符组成的文件标识。
`DocUsage`	`getDocUsage()` 【可选】获取文档分类默认值为 Normal
`Keywords`	`getKeywords()` 【可选】获取关键词集合
`LocalDate`	`getModDate()` 【可选】获取文档最近修改日期
`String`	`getQualifiedName()` OFD元素采用OFD的命名空间，所以直接调用代理对象
`String`	`getSubject()` 【可选】获取文档主题
`String`	`getTile()` 【可选】获取文档标题。
`CT_DocInfo`	`randomDocID()` 随机产生一个UUID作为文件标识符
`CT_DocInfo`	`setAbstract(String abstractTxt)` 【可选】设置文档摘要与注释
`CT_DocInfo`	`setAuthor(String author)` 【可选】设置文档作者
`CT_DocInfo`	`setCover(ST_Loc cover)` 【可选】设置文档封面，此路径指向一个图片文件
`CT_DocInfo`	`setCreationDate(LocalDate creationDate)` 【可选】设置文件创建日期
`CT_DocInfo`	`setCreator(String creator)` 【可选】设置创建文档的应用程序
`CT_DocInfo`	`setCreatorVersion(String creatorVersion)` 【可选】设置创建文档的应用程序版本信息
`CT_DocInfo`	`setCustomDatas(CustomDatas customDatas)` 【可选】设置用户自定义元数据集合。
`CT_DocInfo`	`setDocID(UUID docID)` 【必选】设置文件标识符，标识符应该是一个UUID
`CT_DocInfo`	`setDocUsage(DocUsage docUsage)` 【可选】文档分类，可取值如下： Normal——普通文档 EBook——电子书 ENewsPaper——电子报纸 EMagzine——电子期刊默认值为 Normal
`CT_DocInfo`	`setKeywords(Keywords keywords)` 【可选】设置关键词集合每一个关键词用一个“Keyword”子节点来表达
`CT_DocInfo`	`setModDate(LocalDate modDate)` 【可选】设置文档最近修改日期
`CT_DocInfo`	`setSubject(String subject)` 【可选】设置文档主题
`CT_DocInfo`	`setTile(String title)` 【可选】设置文档标题。

从类继承的方法 org.ofdrw.core.OFDElement
addOFDEntity, getElements, getInstance, getObjID, getOFDElement, getOFDElement, getOFDElements, getOFDElementText, removeAll, removeAttr, removeOFDElemByNames, set, setObjID, setObjID, setOFDEntity, setOFDName

从类继承的方法 org.ofdrw.core.DefaultElementProxy
accept, add, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addElement, addElement, addEntity, additionalNamespaces, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, appendContent, asXML, asXPathResult, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, attributeValue, attributeValue, attributeValue, attributeValue, clearContent, clone, content, createCopy, createCopy, createCopy, createXPath, declaredNamespaces, detach, element, element, elementByID, elementIterator, elementIterator, elementIterator, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, equals, getData, getDocument, getName, getNamespace, getNamespaceForPrefix, getNamespaceForURI, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getNodeType, getNodeTypeName, getParent, getPath, getPath, getProxy, getQName, getQName, getStringValue, getText, getTextTrim, getUniquePath, getUniquePath, getXPathResult, hasContent, hasMixedContent, indexOf, isReadOnly, isRootElement, isTextOnly, matches, node, nodeCount, nodeIterator, normalize, numberValueOf, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, remove, remove, remove, remove, remove, removeProcessingInstruction, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setAttributes, setAttributeValue, setAttributeValue, setContent, setData, setDocument, setName, setParent, setProcessingInstructions, setProxy, setQName, setText, supportsParent, valueOf, write

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

- 构造器详细资料
  - CT_DocInfo
```
public CT_DocInfo(org.dom4j.Element proxy)
```
  - CT_DocInfo
```
public CT_DocInfo()
```
- 方法详细资料
  - setDocID
```
public CT_DocInfo setDocID(UUID docID)
```
    【必选】设置文件标识符，标识符应该是一个UUID
    
    参数:
    
    docID - UUID文件标识
    
    返回:
    
    this
  - randomDocID
```
public CT_DocInfo randomDocID()
```
    随机产生一个UUID作为文件标识符
    
    返回:
    
    this
  - getDocID
```
public String getDocID()
```
    【必选】采用UUID算法生成的由32个字符组成的文件标识。每个DocID在文件创建或生成的时候进行分配。
    
    返回:
    
    文件标识符
  - setTile
```
public CT_DocInfo setTile(String title)
```
    【可选】设置文档标题。标题可以与文件名不同
    
    参数:
    
    title - 标题
    
    返回:
    
    this
  - getTile
```
public String getTile()
```
    【可选】获取文档标题。标题可以与文件名不同
    
    返回:
    
    档标题
  - setAuthor
```
public CT_DocInfo setAuthor(String author)
```
    【可选】设置文档作者
    
    参数:
    
    author - 文档作者
    
    返回:
    
    this
  - getAuthor
```
public String getAuthor()
```
    【可选】获取文档作者
    
    返回:
    
    文档作者
  - setSubject
```
public CT_DocInfo setSubject(String subject)
```
    【可选】设置文档主题
    
    参数:
    
    subject - 文档主题
    
    返回:
    
    this
  - getSubject
```
public String getSubject()
```
    【可选】获取文档主题
    
    返回:
    
    文档主题
  - setAbstract
```
public CT_DocInfo setAbstract(String abstractTxt)
```
    【可选】设置文档摘要与注释
    
    参数:
    
    abstractTxt - 文档摘要与注释
    
    返回:
    
    this
  - getAbstract
```
public String getAbstract()
```
    【可选】获取文档摘要与注释
    
    返回:
    
    文档摘要与注释
  - setCreationDate
```
public CT_DocInfo setCreationDate(LocalDate creationDate)
```
    【可选】设置文件创建日期
    
    参数:
    
    creationDate - 文件创建日期
    
    返回:
    
    this
  - getCreationDate
```
public LocalDate getCreationDate()
```
    【可选】获取文件创建日期
    
    返回:
    
    创建日期
  - setModDate
```
public CT_DocInfo setModDate(LocalDate modDate)
```
    【可选】设置文档最近修改日期
    
    参数:
    
    modDate - 文档最近修改日期
    
    返回:
    
    this
  - getModDate
```
public LocalDate getModDate()
```
    【可选】获取文档最近修改日期
    
    返回:
    
    文档最近修改日期
  - setDocUsage
```
public CT_DocInfo setDocUsage(DocUsage docUsage)
```
    【可选】文档分类，可取值如下：
    Normal——普通文档
    EBook——电子书
    ENewsPaper——电子报纸
    EMagzine——电子期刊
    默认值为 Normal
    
    参数:
    
    docUsage - 文档分类
    
    返回:
    
    this
  - getDocUsage
```
public DocUsage getDocUsage()
```
    【可选】获取文档分类
    默认值为 Normal
    
    返回:
    
    文档分类
  - setCover
```
public CT_DocInfo setCover(ST_Loc cover)
```
    【可选】设置文档封面，此路径指向一个图片文件
    
    参数:
    
    cover - 文档封面路径
    
    返回:
    
    this
  - getCover
```
public ST_Loc getCover()
```
    【可选】获取文档封面，此路径指向一个图片文件
    
    返回:
    
    文档封面路径
  - setKeywords
```
public CT_DocInfo setKeywords(Keywords keywords)
```
    【可选】设置关键词集合每一个关键词用一个“Keyword”子节点来表达
    
    参数:
    
    keywords - 关键词集合
    
    返回:
    
    this
  - addKeyword
```
public CT_DocInfo addKeyword(String keyword)
```
    添加关键词
    
    参数:
    
    keyword - 关键词
    
    返回:
    
    this
  - getKeywords
```
public Keywords getKeywords()
```
    【可选】获取关键词集合
    
    返回:
    
    关键词集合或null
  - setCreator
```
public CT_DocInfo setCreator(String creator)
```
    【可选】设置创建文档的应用程序
    
    参数:
    
    creator - 创建文档的应用程序
    
    返回:
    
    this
  - getCreator
```
public String getCreator()
```
    【可选】获取创建文档的应用程序
    
    返回:
    
    创建文档的应用程序或null
  - setCreatorVersion
```
public CT_DocInfo setCreatorVersion(String creatorVersion)
```
    【可选】设置创建文档的应用程序版本信息
    
    参数:
    
    creatorVersion - 创建文档的应用程序版本信息
    
    返回:
    
    this
  - getCreatorVersion
```
public String getCreatorVersion()
```
    【可选】获取创建文档的应用程序版本信息
    
    返回:
    
    创建文档的应用程序版本信息或null
  - setCustomDatas
```
public CT_DocInfo setCustomDatas(CustomDatas customDatas)
```
    【可选】设置用户自定义元数据集合。其子节点为 CustomData
    
    参数:
    
    customDatas - 用户自定义元数据集合
    
    返回:
    
    this
  - getCustomDatas
```
public CustomDatas getCustomDatas()
```
    【可选】获取用户自定义元数据集合。其子节点为 CustomData
    
    返回:
    
    用户自定义元数据集合
  - getQualifiedName
```
public String getQualifiedName()
```
    从类复制的说明: OFDElement
    
    OFD元素采用OFD的命名空间，所以直接调用代理对象
    
    指定者:
    
    getQualifiedName 在接口中 org.dom4j.Element
    
    覆盖:
    
    getQualifiedName 在类中 OFDElement
    
    返回:
    
    元素全名（含有前缀）

类 CT_DocInfo

字段概要

从类继承的字段 org.ofdrw.core.DefaultElementProxy

从接口继承的字段 org.dom4j.Node

构造器概要

方法概要

从类继承的方法 org.ofdrw.core.OFDElement

从类继承的方法 org.ofdrw.core.DefaultElementProxy

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

构造器详细资料

CT_DocInfo

CT_DocInfo

方法详细资料

setDocID

randomDocID

getDocID

setTile

getTile

setAuthor

getAuthor

setSubject

getSubject

setAbstract

getAbstract

setCreationDate

getCreationDate

setModDate

getModDate

setDocUsage

getDocUsage

setCover

getCover

setKeywords

addKeyword

getKeywords

setCreator

getCreator

setCreatorVersion

getCreatorVersion

setCustomDatas

getCustomDatas

getQualifiedName