matlab.io.xml.dom.DOMWriter Class

Namespace: matlab.io.xml.dom

Writer that serializes an XML document

Since R2021a

Description

Use an object of the matlab.io.xml.dom.DOMWriter class to create a writer that serializes an XML document.

The matlab.io.xml.dom.DOMWriter class is a handle class.

Class Attributes

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

For information on class attributes, see Class Attributes.

Creation

Description

writer = matlab.io.xml.dom.DOMWriter() creates a writer to serialize a matlab.io.xml.dom.Document object. Use the Configuration property to specify writer options.

example

Properties

expand all

`Configuration` — writer options
`matlab.io.xml.dom.WriterConfiguration` object

Writer options, specified as a matlab.io.xml.dom.WriterConfiguration object.

Attributes:

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

Data Types:

Methods

expand all

Public Methods

write

write(thisWriter,domDoc,fileWriter) uses the specified file writer to write XML markup serialized from the specified DOM document.

Specify domDoc as a matlab.io.xml.dom.Document object and fileWriter as a matlab.io.xml.dom.FileWriter object.

Use this method to mix non-XML text with serialized XML text.

writeToFile

writeToFile(thisWriter,domDoc,filePath) serializes the specified document and stores the resulting XML markup, encoded as UTF-8, in a file at the specified path.

writeToFile(thisWriter,domDoc,filePath,encoding) uses the specified encoding rather than UTF-8.

Specify domDoc as a matlab.io.xml.dom.Document object and filePath as a string scalar or character vector. The filePath argument can contain non-ASCII characters. The file specified by filePath must be writable.

Use this method to serialize an XML DOM document to a file.

If the file is stored at a remote location, then filePath must contain the full path of the file specified with the form:

scheme_name://path_to_file/my_file.ext

Based on the remote location, scheme_name can be one of the values in this table.

Remote Location	`scheme_name`
Amazon S3™	`s3`
Azure^® Blob Storage	`wasb`, `wasbs`
HDFS™	`hdfs`

For more information, see Work with Remote Data.

Example: 's3://bucketname/path_to_file/data.xml'

writeToString

xmlstr = writeToString(thisWriter,domDoc) serializes the specified document and returns it as a character vector.

Specify domDoc as a matlab.io.xml.dom.Document object.

setNewLine

setNewLine(thisWriter,newLine) specifies a character or characters to start a new line in serialized output.

Specify newLine as one of these values:

'' — line feed (default)
newline — line feed
char(13) — carriage return
[char(13) newline] — carriage return followed by line feed

getNewLine

newLine = getNewLine(thisWriter) returns the character or characters that this writer uses to start a new line in serialized output.

Examples

collapse all

Write XML Document to File

Open Live Script

Write an XML document to a file using a matlab.io.xml.dom.DOMWriter object.

Create an XML document as a matlab.io.xml.dom.Document object.

import matlab.io.xml.dom.*
docNode = Document("root_element");
docRootNode = getDocumentElement(docNode);
weekdays = ["Mon" "Tue" "Wed" "Thu" "Fri"];
weekdaysElement = createElement(docNode,"weekdays");
for i=1:5
    dayElement = createElement(docNode,"day");
    appendChild(dayElement,createTextNode(docNode,weekdays(i)));
    appendChild(weekdaysElement,dayElement);
end
appendChild(docRootNode,weekdaysElement);

Create a writer to serialize the XML document.

xmlFileName = "weekdays.xml";
writer = matlab.io.xml.dom.DOMWriter;

Save the XML document to a file.

writeToFile(writer,docNode,xmlFileName);

Version History

Introduced in R2021a

matlab.io.xml.dom.DOMWriter Class

Description

Class Attributes

Creation

Description

Properties

Configuration — writer options matlab.io.xml.dom.WriterConfiguration object

Attributes:

Methods

Public Methods

Examples

Write XML Document to File

Version History

See Also

`Configuration` — writer options
`matlab.io.xml.dom.WriterConfiguration` object