matlab.io.xml.dom.DocumentFragment 类

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

文档节点组

自 R2021a 起

描述

使用 matlab.io.xml.dom.DocumentFragment 类的对象作为一组文档节点的容器。将一个文档片段追加到另一个节点会追加该片段的子级，但不追加片段本身。同样，插入一个片段会插入子级，但不插入该片段。片段不必是格式良好的 XML。例如，片段可以包含多个顶层节点，也可以只包含一个文本节点。

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

类属性

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

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

创建对象

您可以使用 matlab.io.xml.dom.Document 对象的 createDocumentFragment 方法创建 matlab.io.xml.dom.DocumentFragment 对象。

属性

全部展开

`TextContent` — 文档片段的文本内容
`''` (默认) | 字符向量 | 字符串标量

此文档片段的文本内容，指定为字符向量或字符串标量。此属性包含此片段的子级的串联文本内容。

属性：

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

方法

全部展开

公共方法

`appendChild`	`childNode = appendChild(thisFragment,childNode)` 向此片段追加节点，并返回追加的节点对象。
`child`	`node = child(thisFragment,index)` 返回此片段在指定索引（从 1 开始）处的子级。索引值 1 指定第一个子级，值 2 指定第二个子级，依此类推。
`cloneNode`	`docClone = cloneNode(thisFragment,deep)` 创建并返回此 `matlab.io.xml.dom.DocumentFragment` 对象的副本。如果 `deep` 为 `true`，则该副本是深拷贝。如果 `deep` 为 `false`，则该副本为浅拷贝。
`compareDocumentPosition`	`posEnum = compareDocumentPosition(thisFragment,otherNode)` 返回 35，表示此片段与文档中其他节点的位置没有关系。文档片段与其他文档节点没有关系，因为片段并非文档的子级。
`getAttributes`	`attrs = getAttributes(thisFragment)` 返回空的 `matlab.io.xml.dom.NamedNodeMap` 对象，因为文档片段没有属性。
`getChildNodes`	`nodeList = getChildNodes(thisFragment)` 以 `matlab.io.xml.dom.NodeList` 对象形式返回此片段的子级。
`getChildren`	`nodes = getChildren(thisFragment)` 返回一个 1×N 对象数组，如 `matlab.io.xml.dom.Element` 或 `matlab.io.xml.dom.Text` 对象，它们表示此片段的子级。
`getFirstChild`	`child = getFirstChild(thisFragment)` 返回此片段的第一个子级。
`getLastChild`	`child = getLastChild(thisFragment)` 返回此片段的最后一个子级。
`getLength`	`length = getLength(thisFragment)` 以双精度值形式返回此片段的子级数。
`getLocalName`	`name = getLocalName(thisFragment)` 返回空字符数组，因为文档片段没有名称。
`getNamespaceURI`	`uri = getNamespaceURI(thisFragment)` 返回空字符数组，因为文档片段没有名称。
`getNextSibling`	`getNextSibling(thisFragment)` 返回空节点对象，因为片段不能有同级。
`getNodeName`	`name = getNodeName(thisFragment)` 返回 `'#document-fragment'`，这是 W3C XML DOM 标准指定的文档片段节点的名称。
`getNodeType`	`type = getNodeType(thisFragment)` 返回双精度值 `11`，表示此节点是文档片段。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB^® 代码的兼容性。对于新的 MATLAB 代码，请使用 `isa` 来确定节点的类型。例如： import matlab.io.xml.dom.* d = Document('book'); frag= createDocumentFragment(d); if isa(frag,'matlab.io.xml.dom.DocumentFragment') fprintf('This is an document fragment.\n'); end
`getNodeValue`	`name = getNodeValue(thisFragment)` 返回空字符向量，因为片段没有节点值。
`getOwnerDocument`	`doc = getOwnerDocument(thisFragment)` 以 `matlab.io.xml.dom.Document` 对象形式返回拥有此元素的文档。所有者文档是创建此片段的文档。
`getParentNode`	`parent = getParentNode(thisFragment)` 返回空节点对象，因为文档片段没有父级。
`getPrefix`	`prefix = getPrefix(thisFragment)` 返回空字符向量，因为片段没有名称。
`getPreviousSibling`	`getPreviousSibling(thisFragment)` 返回空节点对象，因为文档片段没有同级。
`getTextContent`	`getTextContent(thisFragment)` 返回此片段的文本内容。如果此片段有子级，则该方法返回子级的串联文本内容。
`hasAttributes`	`tf = hasAttributes(thisFragment)` 返回 `false`，因为片段没有属性。
`hasChildNodes`	如果此片段有子级，则 `tf = hasChildNodes(thisFragment)` 返回 `true`。
`insertBefore`	`node = insertBefore(thisFragment,newChild,refChild)` 在此文档片段中的 `refChild` 之前插入 `newChild`。如果 `refChild` 为空，该方法将在此片段的子级列表的末尾插入 `newChild`。如果 `newChild` 是文档片段节点，则该方法会将片段的子级按照它们在片段中出现的顺序插入到引用节点之前。如果片段中已存在 `newChild`，该方法将删除并重新插入它。如果 `refChild` 是从未追加或插入到片段中的节点，则它将被视为空对象，而 `newChild` 将插入到此片段的子级列表的末尾。
`isDefaultNamespace`	`tf = isDefaultNamespace(thisFragment,namespaceURI)` 返回 `false`，因为文档片段没有名称。
`isEqualNode`	如果 `otherNode` 指定的节点是片段，并且此片段的子级与另一个片段节点相等，则 `tf = isEqualNode(thisFragment,otherNode)` 返回 `true`。此方法测试节点的相等性，而不测试节点是否为同一对象的句柄。要测试相同性，请使用 `isSameNode` 方法。相同的节点也会相等，但相等的节点未必相同。
`isSameNode`	如果 `otherNode` 与 `thisFragment` 是同一个节点，则 `tf = isSameNode(thisFragment,otherNode)` 返回 `true`。
`item`	`node = item(thisFragment,index)` 返回由索引（从 0 开始）指定的此片段的子级。索引值 0 指定第一个子级，值 1 指定第二个子级，依此类推。
`lookupNamespaceURI`	`uri = lookupNamespaceURI(thisFragment,prefix)` 返回空字符数组，因为文档片段没有命名空间。
`lookupPrefix`	`prefix = lookupPrefix(thisFragment,namespaceURI)` 返回空字符向量，因为片段没有名称。
`normalize`	`normalize(thisFragment)` 从此片段中删除空文本节点，并将相邻的文本节点合并成一个文本节点。
`removeChild`	`child = removeChild(thisFragment,child)` 从此片段中删除 `child` 指定的子节点，并返回删除的子节点。
`replaceChild`	`child = replaceChild(thisFragment,newChild,oldChild)` 将 `oldChild` 替换为 `newChild`，并返回 `newChild`。如果 `newChild` 是 `matlab.io.dom.xml.DocumentFragment` 对象，则该方法会将 `oldChild` 替换为 `DocumentFragment` 对象的所有子级，并以相同的顺序插入这些子级。如果新子级已在片段中，则该方法会先从文档中删除该子级，然后再替换旧子级。
`setNodeValue`	`setNodeValue(thisFragment,value)` 不会更改此片段的节点值。根据定义，片段的节点值为 `''`。
`setPrefix`	`setPrefix(thisFragment,prefix)` 返回错误，因为文档片段没有名称。
`setTextContent`	`setTextContent(thisFragment,textContent)` 用包含指定文本的 `matlab.io.xml.dom.Text` 节点替换此片段中的现有节点。以字符向量或字符串标量形式指定 `textContent`。

示例

全部折叠

使用文档片段基于运行时数据创建内容

打开实时脚本

假设您的应用程序创建章节，并且章节的数量是在运行时确定的。您可以编写一个函数（如此示例末尾定义的 createChapters 函数）来创建指定数量的章节元素，并以文档片段形式返回它们。

创建一个具有名为 book 的根元素的文档。

import matlab.io.xml.dom.*

doc = Document("book");
docElemRoot = getDocumentElement(doc);

调用函数 createChapters 以 matlab.io.xml.dom.DocumentFragment 对象形式返回三个章节。将该片段追加到文档中。

docFrag = createChapters(doc,3);
appendChild(docElemRoot,docFrag);

将文档写入文件 book.xml。

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

显示生成的 XML。

type(xmlFileName);

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book [
<!ENTITY chapter SYSTEM "chapter.xml">
]>
<book>
    &chapter;
</book>

createChapters 函数

函数 createChapters 返回 DocumentFragment 对象，该对象包含指定数量的章节元素。

function docFrag = createChapters(doc,n)
docFrag = createDocumentFragment(doc);
for i=1:n
    chapter = createElement(doc,"chapter");
    appendChild(chapter,createTextNode(doc,sprintf("Chapter %d",i)));
    appendChild(docFrag,chapter);
end
end