matlab.io.xml.dom.Document 类

命名空间: matlab.io.xml.dom

XML 文档

自 R2021a 起

描述

matlab.io.xml.dom.Document 类的一个对象，表示 XML 文档。要创建一个 XML 文档，您需要创建一个 Document 对象。如果使用 matlab.io.xml.dom.Parser 对象读取 XML 文件，解析器将创建一个 Document 对象。

matlab.io.xml.dom.Document 类是一个 handle 类。

类属性

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

有关类属性的信息，请参阅类属性。

创建对象

描述

doc = matlab.io.xml.dom.Document() 创建一个空文档。

doc = matlab.io.xml.dom.Document(docElemName) 使用具有指定名称的根元素创建文档。

根元素是 TagName 属性设置为 docElemName 的 matlab.io.xml.dom.Element 对象。

示例

doc = matlab.io.xml.dom.Document(docElemName,docTypeName,publicId,systemId) 还指定文档类型。

文档类型是一个 matlab.io.xml.dom.DocumentType 对象，其 Name 属性设置为 docTypeName，其 PublicID 属性设置为 publicID，其 SystemID 属性设置为 systemID。

doc = matlab.io.xml.dom.Document(docElemNSURI,docElemQName) 创建具有特定根元素的文档，该根元素具有指定的命名空间统一资源标识符 (URI) 和限定名称。

doc = matlab.io.xml.dom.Document(docElemNSURI,docElemQName,docTypeName,publicId,systemId) 使用指定的根元素和文档类型创建文档，其中根元素位于指定的命名空间中。

输入参量

全部展开

`docElemName` — 根元素名称
字符向量 | 字符串标量

根元素名，指定为字符向量或字符串标量。

`docTypeName` — DTD 的名称
字符向量 | 字符串标量

文档类型定义 (DTD) 的名称，指定为字符向量或字符串标量。

`publicId` — 文档类型公共标识符
字符向量 | 字符串标量

文档类型公共标识符，指定为字符向量或字符串标量。

`systemId` — 文档类型系统标识符
字符向量 | 字符串标量

文档类型系统标识符，指定为字符向量或字符串标量。

`docElemNSURI` — 根元素名称的命名空间 URI
字符向量 | 字符串标量

根元素名称的命名空间统一资源标识符 (URI)，指定为字符向量或字符串标量。

`docElemQName` — 限定的根元素名称
字符向量 | 字符串标量

限定根元素名称，指定为字符向量或字符串标量。

属性

全部展开

`Children` — 此文档的子节点
1×0 `matlab.io.xml.dom.Node` 对象 (默认) | `matlab.io.xml.dom.Element` 对象

此文档的子节点，指定为 matlab.io.xml.dom.Element 对象。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`NonCopyable`	`true`
`Transient`	`true`

`InputEncoding` — 源 XML 的字符编码
`''` (默认) | 字符向量

用于解析此文档的源 XML 文件的字符编码，指定为字符向量。

示例: 'utf-8'

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`XMLEncoding` — 由 XML 声明定义的字符编码
`''` (默认) | 字符向量

由用于解析此文档的源 XML 文件中的 XML 声明定义的字符编码，指定为字符向量。

示例: 'utf-8'

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`XMLStandalone` — 此文档是否为独立文档
`false` (默认) | `true`

此文档是否为独立文档，指定为 true 或 false。如果此值为 true，解析器将忽略 XML 中的文档类型定义 (DTD) 标记声明。如果此文档是从声明 XML 是独立文档的 XML 源创建的，解析器会将此属性设置为 true。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`XMLVersion` — 此文档的 XML 版本
`''` (默认) | 字符向量

此文档的 XML 版本，指定为字符向量。如果此文档是从声明 XML 版本的 XML 源创建的，则解析器会将此属性设置为指定的版本。

示例: '1.0'

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`DocumentURI` — 文档源文件的 URI
`''` (默认) | 字符向量

文档源文件的统一资源标识符 (URI)，指定为字符向量。如果此文档是从文件创建的，解析器会将此属性设置为指定文件位置的 URI。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Configuration` — 文档配置
`matlab.io.xml.dom.DocumentConfiguration` 对象

文档配置，指定为 matlab.io.xml.dom.DocumentConfiguration 对象，该对象指定用于标准化此文档的选项。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`NonCopyable`	`true`
`Transient`	`true`

方法

全部展开

公共方法

appendChild

childNode = appendChild(thisDoc,childNode) 向此 Document 节点追加一个节点，并返回追加的节点。

cloneNode

docClone = cloneNode(thisDoc,deep) 创建并返回此 matlab.io.xml.dom.Document 对象的副本。如果 deep 为 true，则该副本是深拷贝。如果 deep 为 false，则该副本为浅拷贝。

createAttribute

attr = createAttribute(thisDoc,attrName) 返回 matlab.io.xml.dom.Attr 对象，其 Name 属性设置为 attrName 的值。以字符向量或字符串标量形式指定 attrName。

createAttributeNS

attr = createAttributeNS(thisDoc,namespaceURI,qualifiedName) 创建并返回 matlab.io.xml.dom.Attr 对象，带有通过属性 getter 函数返回的下列属性值：

getter 函数	返回
`getNodeName`	`qualifiedName` 参量的值
`getNamespaceURI`	`namespaceURI` 参量的值
`getPrefix`	前缀，从限定名称中提取。如果没有前缀，则此值为空字符串。
`getLocalName`	本地名称，从限定名称中提取
`getName`	`qualifiedName` 参量的值
`getNodeValue`	空字符串

createComment

comment = createComment(thisDoc,charData) 创建并返回 matlab.io.xml.dom.Comment 对象，其 TextContent 属性设置为 charData 的值。以字符向量或字符串标量形式指定 charData。

createDocumentFragment frag = createDocumentFragment(thisDoc) 创建文档片段并以 matlab.io.xml.dom.DocumentFragment 对象形式返回它。

createElement

elem = createElement(thisDoc,elemName) 创建并返回 TagName 属性设置为 elemName 的 matlab.io.xml.dom.Element 对象。如果此文档具有定义默认属性的文档类型，此方法会将默认属性添加到它创建的元素中。

以字符向量或字符串标量形式指定 elemName。

createElementNS

elem = createElementNS(thisDoc,namespaceURI,qualifiedName) 创建并返回指定命名空间中的 matlab.io.xml.dom.Element 对象，其 TagName 属性设置为限定名称。如果此文档具有定义默认属性的文档类型，此方法会将默认属性添加到它创建的元素中。

将 namespaceURI 和 qualifiedName 指定为字符向量或字符串标量。

createNSResolver

resolver = createNSResolver(thisDoc,resolverNode) 创建并返回 matlab.io.xml.dom.XPathNSResolver 对象，该对象使用指定的节点来查找 XPath 表达式中出现的限定元素名称前缀的命名空间。

createProcessingInstruction

pi = createProcessingInstruction(thisDoc,target,charData) 创建并返回具有指定目标和数据的 matlab.io.xml.dom.ProcessingInstruction 对象。将 target 和 charData 指定为字符向量或字符串标量。

createTextNode

textNode = createTextNode(thisDoc,charData) 创建并返回包含指定字符数据的 matlab.io.xml.dom.Text 对象。以字符向量或字符串标量形式指定 charData。

getAttributes

attrs = getAttributes(thisDoc) 返回空的 matlab.io.xml.dom.NamedNodeMap 对象，因为文档没有属性。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB^® 代码的兼容性。

getBaseURI

name = getBaseURI(thisDoc) 以字符向量形式返回此元素的基本统一资源标识符 (URI)。如果基本 URI 未知，则该方法返回空字符数组。文档的基本 URI 是用于创建该文档的 XML 文件的 URI。

getChildNodes

nodeList = getChildNodes(thisDoc) 以 matlab.io.xml.dom.NodeList 对象形式返回此文档的子级。

getChildren

nodes = getChildren(thisDoc) 返回 1×N 对象数组，如 matlab.io.xml.dom.Element 或 matlab.io.xml.dom.Text 对象，它们表示此文档的子级。

getDoctype

doctype = getDoctype(thisDoc) 返回与此文档关联的 matlab.io.xml.dom.DocumentType 对象。

getDocumentElement

elem = getDocumentElement(thisDoc) 返回表示此文档的根元素的 matlab.io.xml.dom.Element 对象。如果此文档没有根元素，该方法将返回空的 Element 对象。

根元素包含文档的内容。

getDocumentURI

uri = getDocumentURI(thisDoc) 以字符向量形式返回此文档的统一资源标识符 (URI)。如果文档是从文件创建的，则此方法将返回该文件的 URI。如果无法确定 URI，此方法将返回空字符向量。

您可以使用 setDocumentURI 方法来设置或更改文档的 URI。

getDOMConfig

config = getDOMConfig(thisDoc) 返回与此文档关联的 matlab.io.xml.dom.DocumentConfiguration 对象。DocumentConfiguration 对象指定标准化文档的选项。

getElementByID

elem = getElementByID(thisDoc,id) 返回具有指定 ID 属性的元素，如果文档没有该属性，则返回空元素。

ID 属性是声明为 ID 属性的属性。名为 ID 的属性不一定是 ID 属性，除非它声明为 ID 属性。

getElementsByTagName

list = getElementsByTagName(thisDoc,localName) 返回 matlab.io.xml.dom.NodeList 对象，该对象列出此文档中与指定标记名匹配的元素。元素按它们在文档中出现的顺序列出。字符串标量 "*" 或字符向量 '*' 匹配任何 URI 或本地名称。

返回的 NodeList 会立即更新，以反映文档元素内容的更改。

getElementsByTagNameNS

list = getElementsByTagNameNS(thisDoc,namespaceURI,localName) 返回 matlab.io.xml.dom.NodeList 对象，该对象列出此文档中与指定的 URI 和本地名称匹配的元素。元素按它们在文档中出现的顺序列出。字符串标量 "*" 或字符向量 '*' 匹配任何 URI 或本地名称。

返回的 NodeList 会立即更新，以反映文档元素内容的更改。

getFirstChild child = getFirstChild(thisNode) 返回此文档的第一个子级。

getInputEncoding

encoding = getInputEncoding(thisDoc) 以字符向量形式返回此文档的源文件的字符编码。如果文档不是从文件创建的，则该方法返回空字符向量。

getLastChild child = getLastChild(thisDoc) 返回此文档的最后一个子级。

getLocalName

name = getLocalName(thisDoc) 返回空字符向量，因为文档没有本地名称。

getNamespaceURI

uri = getNamespaceURI(thisDoc) 返回空字符串，因为命名空间中不包含文档。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getNextSibling

getNextSibling(thisDoc) 返回一个 0×0 matlab.io.xml.dom.Node 对象，因为文档没有同级。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getNodeName

name = getNodeName(thisDoc) 返回 '#document'，这是文档的 W3C XML DOM 标准名称。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getNodeType

type = getNodeType(thisDoc) 返回整数 9，表示此节点是文档。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

对于新的 MATLAB 代码，请使用 isa 来确定节点的类型。例如：

import matlab.io.xml.dom.*
d = Document('book');
if isa(d,'matlab.io.xml.dom.Document')
    fprintf('This is a document.\n');
end

getNodeValue

value = getNodeValue(thisDoc) 返回空字符向量，因为文档没有节点值。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getOwnerDocument

doc = getOwnerDocument(thisDoc) 以 matlab.io.xml.dom.Document 对象形式返回此文档。

getParentNode parent = getParentNode(thisDoc) 返回一个 0×0 matlab.io.xml.dom.Node 对象，因为文档没有父节点。

getPrefix

prefix = getPrefix(thisDoc) 返回空字符向量，因为文档没有限定名称。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getPreviousSibling

getPreviousSibling(thisDoc) 返回一个 0×0 matlab.io.xml.dom.Node 对象，因为文档没有同级。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

getTextContent getTextContent(thisDoc) 返回空字符数组，因为文档没有文本。

getXmlEncoding

encoding = getXmlEncoding(thisDoc) 以字符向量形式返回文档的字符编码，例如 UTF-8。

字符编码可以由创建 Document 对象的文件中的 XML 声明来定义。如果该文件中未声明字符编码，或文档不是从文件创建的，则 getXmlEncoding 返回空字符数组。

getXMLStandalone

如果此文档声明为独立文档，则 tf = getXMLStandalone(thisDoc) 返回 true。当文档是独立文档时，解析器忽略文档的文档类型定义 (DTD) 中的标记声明。

您可以通过在创建 Document 对象的文件中使用 XML 声明，或通过对该对象使用 setXMLStandalone 方法，来指定文档是独立文档。

getXMLVersion

version = getXMLVersion(thisDoc) 以字符向量形式返回此文档的 XML 版本。

您可以通过在创建 Document 对象的文件中使用 XML 声明来指定 XML 版本。

hasAttributes

tf = hasAttributes(thisDoc) 返回 false，因为文档没有属性。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

hasChildNodes

如果此文档节点有子级，则 tf = hasChildNodes(thisDoc) 返回 true。

importNode

将节点从另一个文档导入此文档中。请参阅 importNode。

isDefaultNamespace

如果 namespaceURI 指定的命名空间是此文档的默认命名空间，则 tf = isDefaultNamespace(thisDoc,namespaceURI) 返回 true。以字符向量或字符串标量形式指定 namespaceURI。

默认命名空间在声明时是不带前缀的。文档中名称不带前缀的子节点属于默认工作区。要为文档声明默认命名空间，可以使用 Document(namespaceURI,qualifiedName) 语法来创建文档。例如：

import matlab.io.xml.dom.*
nsURI = "http://my.namespace.org/mybook";
d = Document(nsURI,'book');
if isDefaultNamespace(d,nsURI)
        fprintf(...
        '"%s" is the default namepace\n',nsURI);
end

isEqualNode

如果 otherNode 指定的节点是文档并且具有相同的基本 URI 和相等的子树，则 tf = isEqualNode(thisDoc,otherNode) 返回 true。

此方法测试文档的相等性，而不是文档节点是否为同一对象的句柄。要测试相同性，请使用 isSameNode。

相同的节点也会相等，但相等的节点未必相同。

在测试文档的相等性之前请先对它们进行标准化，因为标准化会影响相等性。

isSameNode

如果 otherDoc 指定的文档节点与此文档节点相同，则 tf = isSameNode(thisDoc,otherDoc) 返回 true。

lookupNamespaceURI

uri = lookupNamespaceURI(thisDoc,prefix) 返回空字符向量，因为命名空间中不包含文档。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

lookupPrefix

prefix = lookupPrefix(thisDoc,namespaceURI) 返回空字符向量，因为命名空间中不包含文档。

此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

normalize

normalize(thisDoc) 不起作用。

normalizeDocument normalizeDocument(thisDoc) 标准化此文档。标准化确保文档结构与保存和重新加载文档后的结构相同。例如，该方法会删除空的文本节点，合并相邻的文本节点，添加缺失的命名空间属性，添加或更改前缀，以及更新实体引用节点的替换树。此方法执行的归一化运算取决于文档所用 matlab.io.xml.dom.DocumentConfiguration 对象指定的选项。

removeChild

child = removeChild(thisDoc,child) 从此文档中删除 child 指定的子节点，并返回被删除的子节点。

replaceChild

child = replaceChild(thisDoc,newChild,oldChild) 用 newChild 指定的节点替换 oldChild 指定的子节点，并返回 newChild。如果新子级已在文档树中，则该方法会先从文档中删除该子级，然后再替换旧子级。

renameNode

renamedNode = renameNode(thisDoc,node,namespaceURI,name) 重命名并返回指定的节点。重命名的节点具有由 name 参量指定的名称。

进行以下指定：

将 node 指定为 matlab.io.xml.dom.Element 或 matlab.io.xml.dom.Attr 对象。
将 name 指定为字符向量或字符串标量。name 的值可以包含前缀。
将 namespaceURI 指定为字符向量或字符串标量。如果 namespaceURI 的值不为空，则重命名的节点位于指定的命名空间中。

setDocumentURI

setDocumentURI(thisDoc,locationURI) 将 DocumentURI 属性设置为 locationURI 指定的位置。以字符向量或字符串字符形式指定 locationURI。

setNodeValue

setNodeValue 不起作用。该方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

setPrefix

setPrefix 不起作用。该方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

setTextContent

setTextContent 不起作用。该方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。

setXMLStandalone

setXMLStandalone(thisDoc,true) 声明此文档是独立文档。当文档是独立文档时，解析器忽略文档的文档类型定义 (DTD) 中的标记声明。

setXMLStandalone(thisDoc,false) 声明此文档不是独立文档。

xmlwrite

xmlwrite(thisDoc,filePath) 将此文档写入 filePath 指定的文件。以字符向量或字符串标量形式指定 filePath。

示例

全部折叠

从 XML 文件创建文档

打开实时脚本

使用 XML 解析器从文件 days.xml 创建一个 Document 对象。

import matlab.io.xml.dom.*

doc = parseFile(Parser,"days.xml");

创建一个文档

打开实时脚本

创建一个具有名为 weekdays 的根元素的文档。向根元素追加内容。

import matlab.io.xml.dom.*
doc = Document("weekdays");
docRootNode = getDocumentElement(doc);

weekdays = ["Mon" "Tue" "Wed" "Thu" "Fri"];
for i=1:5
    dayElement = createElement(doc,"day");
    appendChild(dayElement,createTextNode(doc,weekdays(i)));
    appendChild(docRootNode,dayElement);
end

xmlFileName = "weekdays.xml";
writer = matlab.io.xml.dom.DOMWriter;
writeToFile(writer,doc,xmlFileName);

版本历史记录

在 R2021a 中推出

另请参阅

matlab.io.xml.dom.Document 类

描述

类属性

创建对象

描述

输入参量

docElemName — 根元素名称 字符向量 | 字符串标量

docTypeName — DTD 的名称 字符向量 | 字符串标量

publicId — 文档类型公共标识符 字符向量 | 字符串标量

systemId — 文档类型系统标识符 字符向量 | 字符串标量

docElemNSURI — 根元素名称的命名空间 URI 字符向量 | 字符串标量

docElemQName — 限定的根元素名称 字符向量 | 字符串标量

属性

Children — 此文档的子节点 1×0 matlab.io.xml.dom.Node 对象 (默认) | matlab.io.xml.dom.Element 对象

属性：

InputEncoding — 源 XML 的字符编码 '' (默认) | 字符向量

属性：

XMLEncoding — 由 XML 声明定义的字符编码 '' (默认) | 字符向量

属性：

XMLStandalone — 此文档是否为独立文档 false (默认) | true

属性：

XMLVersion — 此文档的 XML 版本 '' (默认) | 字符向量

属性：

DocumentURI — 文档源文件的 URI '' (默认) | 字符向量

属性：

Configuration — 文档配置 matlab.io.xml.dom.DocumentConfiguration 对象

属性：

方法

公共方法

示例

从 XML 文件创建文档

创建一个文档

版本历史记录

另请参阅

`docElemName` — 根元素名称
字符向量 | 字符串标量

`docTypeName` — DTD 的名称
字符向量 | 字符串标量

`publicId` — 文档类型公共标识符
字符向量 | 字符串标量

`systemId` — 文档类型系统标识符
字符向量 | 字符串标量

`docElemNSURI` — 根元素名称的命名空间 URI
字符向量 | 字符串标量

`docElemQName` — 限定的根元素名称
字符向量 | 字符串标量

`Children` — 此文档的子节点
1×0 `matlab.io.xml.dom.Node` 对象 (默认) | `matlab.io.xml.dom.Element` 对象

`InputEncoding` — 源 XML 的字符编码
`''` (默认) | 字符向量

`XMLEncoding` — 由 XML 声明定义的字符编码
`''` (默认) | 字符向量

`XMLStandalone` — 此文档是否为独立文档
`false` (默认) | `true`

`XMLVersion` — 此文档的 XML 版本
`''` (默认) | 字符向量

`DocumentURI` — 文档源文件的 URI
`''` (默认) | 字符向量

`Configuration` — 文档配置
`matlab.io.xml.dom.DocumentConfiguration` 对象